ESO UI API Patch Notes (Version 100017)
These patch notes highlight the larger changes to the ESO API. For the full updated API, take a look at the newest version of the ESO UI documentation (attached).
Dueling
The dueling feature has been added to the game.
Added the DUEL_RESULT enumeration:
- DUEL_RESULT_FORFEIT
- DUEL_RESULT_WON
Added the DUEL_STATE enumeration:
- DUEL_STATE_DUELING
- DUEL_STATE_DUEL_PENDING
- DUEL_STATE_DUEL_TERMINATING
- DUEL_STATE_IDLE
- DUEL_STATE_INVITE_CONSIDERING
- DUEL_STATE_INVITE_REQUESTING
Added Functions:
- IsDuelingDeath()
- GetDuelInfo() – DUEL_STATE, partnerCharacterName, partnerDisplayName
- ChallengeTargetToDuel(characterOrDisplayName)
- AcceptDuel()
- DeclineDuel()
- IsNearDuelBoundary()
Added Events:
- EVENT_DUEL_COUNTDOWN – startTimeMS
- EVENT_DUEL_FINISHED – DUEL_RESULT, wasLocalPlayersResult, opponentCharacterName, opponentDisplayName, opponentAlliance, opponentGender, opponentClassId, opponentRaceId
- EVENT_DUEL_INVITE_ACCEPTED
- EVENT_DUEL_INVITE_CANCELED
- EVENT_DUEL_INVITE_DECLINED
- EVENT_DUEL_INVITE_FAILED – DUEL_INVITE_FAIL_REASON, targetCharacterName, targetDisplayName
- EVENT_DUEL_INVITE_RECEIVED - inviterCharacterName, inviterDisplayName
- EVENT_DUEL_INVITE_REMOVED
- EVENT_DUEL_INVITE_SENT - inviteeCharacterName, inviteeDisplayName
- EVENT_DUEL_NEAR_BOUNDARY
Added lots of reasons a duel could fail under the prefix DUEL_INVITE_FAIL_REASON.
Added NOTIFICATION_TYPE_DUEL.
Added a setting for automatically declining duels, UI_SETTING_AUTO_DECLINE_DUEL_INVITES.
Craft Bag
There is a new option that allows the player to choose if crafting materials are automatically placed in the Craft Bag named LOOT_SETTING_AUTO_ADD_TO_CRAFT_BAG. There is also a new function for placing all items into the Craft Bag manually named StowAllVirtualItems. It is valid to use StowAllVirtualItems if CanAnyItemsBeStoredInCraftBag(BAG_BACKPACK) returns true.
Repeatable Quest Pins
Repeatable quests received their own pin types:
- MAP_PIN_TYPE_ASSISTED_QUEST_REPEATABLE_CONDITION
- MAP_PIN_TYPE_ASSISTED_QUEST_REPEATABLE_ENDING
- MAP_PIN_TYPE_ASSISTED_QUEST_REPEATABLE_OPTIONAL_CONDITION
- MAP_PIN_TYPE_QUEST_OFFER_REPEATABLE
- MAP_PIN_TYPE_TRACKED_QUEST_REPEATABLE_CONDITION
- MAP_PIN_TYPE_TRACKED_QUEST_REPEATABLE_ENDING
- MAP_PIN_TYPE_TRACKED_QUEST_REPEATABLE_OPTIONAL_CONDITION
We also exposed two functions for converting between assisted and tracked quest pin types:
- AssistedQuestPinForTracked(trackedType) – assistedType
- TrackedQuestPinForAssisted(assistedType) – trackedType
3D UI APIs
The preliminary 3D texture/3D label control APIs have been finalized. However, the decision was made to privatize these functions to prevent addons from trivializing some dungeon mechanics by drawing markers on the ground in 3D space. The privatization of these functions will occur with the second PTS patch. If you have questions or comments about this change, please reply to this thread.
Nameplates
Added functions:
- SetNameplateKeyboardFont(fontName, FONT_STYLE)
- GetNameplateKeyboardFont() – fontName, FONT_STYLE
- SetNameplateGamepadFont(fontName, FONT_STYLE)
- GetNameplateGamepadFont() – fontName, FONT_STYLE
Miscellaneous
- Added STAT_HEALING_DONE and removed STAT_PARRY.
- The INSTANCE_DISPLAY_TYPE_GROUP has been removed and replaced with the more nuanced values:
- INSTANCE_DISPLAY_TYPE_DUNGEON
- INSTANCE_DISPLAY_TYPE_GROUP_AREA
- INSTANCE_DISPLAY_TYPE_PUBLIC_DUNGEON
- Removed GetJournalQuestRewardInfoInZone as the zone is no longer important in reward calculations.
- Added QUEST_TYPE_HOLIDAY_EVENT.
- Added CancelRequestJournalQuestConditionAssistance to cancel an in-progress quest position path find.
- Maps now have description text. It was added as the final return from GetMapInfo.
- EVENT_COLLECTIBLE_NOTIFICATION_NEW now passed the collectibleId along.