Update 3 API Patch Notes & Change Log (LIVE) - ESOUI
Thread Tools Display Modes
08/05/14, 02:19 AM   #1
Credendo Vides
Cairenn's Avatar
Premium Member
WoWInterface Admin
Join Date: Mar 2004
Posts: 432
Update 3 API Patch Notes & Change Log (LIVE)

ESO UI API Patch Notes (Version 100008)
For the full, updated API take a look at the newest version of the ESO UI documentation.

We added several new functions for querying item information using an item link as the argument. This API provides a general way to fetch item properties, regardless of the system that owns the item. It also reveals more information about items that were part of systems that didn’t have dedicated query functions for all of their properties. Many systems already return item links such as crafting, trading house, inventory, etc.

Added Item Link API
  • GetItemLinkName
  • GetItemLinkItemType
  • GetItemLinkArmorType
  • GetItemLinkWeaponType
  • GetItemLinkWeaponPower
  • GetItemLinkArmorRating(string itemLink, bool considerCondition)
  • If considerCondition is true, the result value is scaled down based on how damaged the armor is.
  • GetItemLinkRequiredLevel
  • GetItemLinkRequiredVeteranRank
  • GetItemLinkValue(string itemLink, bool considerCondition)
  • If considerCondition is true, the result value is scaled down based on how damaged the armor is.
  • GetItemLinkCondition
  • Return value is a percentage from 0% - 100%.
  • DoesItemLinkHaveArmorDecay
  • GetItemLinkMaxEnchantCharges
  • GetItemLinkNumEnchantCharges
  • DoesItemLinkHaveEnchantCharges
  • GetItemLinkOnUseAbilityInfo
  • GetItemLinkTraitInfo
  • GetItemLinkSetInfo
  • GetItemLinkSetBonusInfo
  • GetItemLinkFlavorText
  • IsItemLinkCrafted
  • IsItemLinkVendorTrash
  • GetItemLinkSiegeMaxHP
  • Returns the max HP of the siege created by this item.
  • GetItemLinkQuality
  • GetItemLinkSiegeType
  • IsItemLinkUnique
  • IsItemLinkUniqueEquipped
  • GetItemLinkEquipType
  • IsItemLinkConsumable
  • GetItemLinkCraftingSkillType
  • IsItemLinkEnchantingRune
  • GetItemLinkEnchantingRuneClassification
  • IsItemLinkBound
  • GetItemLinkBindType
  • GetItemLinkGlyphMinMaxLevels
  • GetItemLinkBookTitle
  • IsItemLinkBookKnown
We also added some new functions that take the bagId and slotIndex of an item as arguments.

Added Item API
  • GetItemRequiredLevel
  • GetItemRequiredVeteranRank
  • GetItemCreatorName
  • GetItemArmorType
  • GetItemWeaponType
  • GetItemUniqueId
  • Returns a 64 bit value that uniquely identifies that particular item. To compare these 64 bit values use AreId64sEqual or CompareId64s. Relational operators are not guaranteed to work in all cases.


We are in the early stages of adding PC support for gamepad input. Several functions for querying trigger, stick, and button states will appear in the documentation, but these functions have not yet been enabled.

We modified the bag API to remove some deprecated information and add more information about free and used slots.

Added Bag API
  • GetBagSize(Bag bagId)
  • GetNumBagUsedSlots(Bag bagId)
  • GetNumBagFreeSlots(Bag bagId)
Removed Bag API
  • GetBagInfo(Bag bagId)
  • This function has been replaced with GetBagSize because the icon return value was no longer valid.

Guild Rank Icons

Guild rank icons were previously static textures assigned to each rank, but now players can select from a range of icons when creating or editing a rank. These new API functions reflect this change. You can query the icon index for a guild rank using GetGuildRankIconIndex and then query texture paths using the index as an argument with the other functions. Existing helper functions such as GetFinalGuildRankTextureLarge will continue to work. Functions that used to map from a rank to a hard coded texture path such as GetDefaultGuildRankTextureLarge no longer exist.

Added New Guild Rank Icon API
  • GetGuildRankIconIndex
  • GetNumGuildRankIcons
  • GetGuildRankSmallIcon
  • GetGuildRankLargeIcon
  • GetGuildRankListHighlightIcon
  • GetGuildRankListUpIcon
  • GetGuildRankListDownIcon
  • Removed Old Guild Rank Icon API
  • GetDefaultGuildRankTextureListUp
  • GetDefaultGuildRankTextureListDown
  • GetDefaultGuildRankHighlight
  • GetDefaultGuildRankTextureLarge
  • GetDefaultGuildRankTextureSmall
Guild Kiosk (Trader)
New functions and events were added to support guild kiosks. These functions (except for GetKioskPurchaseCost and GetGuildOwnedKioskInfo) will only return results while the player is interacting with a guild kiosk.

Added Guild Kiosk API
  • GetKioskBidWindowSecondsRemaining
  • GetKioskGuildInfo
  • Returns information about the guild you are inquiring on behalf of.
  • GuildKioskBid
  • GuildKioskPurchase
  • GetGuildOwnedKioskInfo
  • Returns the name of the kiosk that the guild owns.
  • GetKioskPurchaseCost
  • Returns the cost to purchase an unclaimed guild kiosk.
Added Guild Kiosk Events

Guild Bank

We added new API for managing the guild bank. These functions are only usable when the player is connected to a specific guild bank.

Added Guild Bank API
  • GetGuildBankedMoney
  • DepositMoneyIntoGuildBank
  • WithdrawMoneyFromGuildBank
We also added functions for managing guild heraldry. These functions join the heraldry functions from last patch.

Added Heraldry API
  • IsCreatingHeraldryForFirstTime
  • RevertToSavedHeraldry
  • GetNumHeraldryItems
  • GetHeraldryItemInfo
  • BuyHeraldryItem
  • GetHeraldryItemLink
  • GetHeraldryGuildBankedMoney
Newly Functional Heraldry API
  • ApplyPendingHeraldryChanges
  • IsPlayerAllowedToEditHeraldry
  • IsCurrentlyCustomizingHeraldry
  • GetHeraldryCustomizationCosts
  • HasPendingHeraldryChanges
  • GetPendingHeraldryCost
  • SetPendingHeraldryIndices
  • GetPendingHeraldryIndices
  • GetNumHeraldryColors
  • GetHeraldryColorInfo
  • GetNumHeraldryBackgroundCategories
  • GetHeraldryBackgroundCategoryInfo
  • GetNumHeraldryBackgroundStyles
  • GetHeraldryBackgroundStyleInfo
  • GetNumHeraldryCrestCategories
  • GetHeraldryCrestCategoryInfo
  • GetNumHeraldryCrestStyles
  • GetHeraldryCrestStyleInfo
  • StartHeraldryCustomization
  • EndHeraldryCustomization


We added several new functions for querying ability information. These functions use an abilityId as the argument. In this patch, abilityIds are only returned by GetAbilityIdByIndex, but more sources of abilityIds will be added in coming patches.

Added AbilityId API
  • GetAbilityIdByIndex(luaindex abilityIndex)
  • Returns an abilityId (integer) to be used in the following API calls.
  • DoesAbilityExist
  • GetAbilityName
  • IsAbilityPassive
  • GetAbilityCastInfo
  • Returns if the ability is channeled or casted, its channel time, and its cast time.
  • GetAbilityTargetDescription
  • Returns a textual description of how the ability is targeted (self, group, cone, etc).
  • GetAbilityRange
  • GetAbilityRadius
  • GetAbilityAngleDistance
  • GetAbilityCost
  • GetAbilityDescription
  • Returns a textual description of what the ability does.
  • GetAbilityUpgradeLines
  • Returns information about how the ability upgrades when the player morphs an existing ability into this new one. The function returns a set of three strings for each upgrade line. The strings are: a label for what is changing (for example, cooldown), the old value (for example, 10 seconds), and the new value (for example, 5 seconds).
  • GetAbilityNewEffectLines
  • Returns information about how the ability changes when the player morphs an existing ability into this new one. New effects are described with a single string.
We also added new functions to query ability progression by abilityId.

Added Ability Progression API
  • GetAbilityProgressionRankFromAbilityId
  • GetAbilityProgressionXPInfoFromAbilityId
Miscellaneous Functions

Added Functions
  • CanJumpToGroupMember(string unitTag)
  • Returns true if the game client believes the local player can teleport to the group member in question. This function may return true even if a jump isn't possible due to the limits of the client's knowledge.
  • IsGroupMemberInRemoteRegion(string unitTag)
  • Returns true if the group member is not in the same zone as the local player. This includes being in a different instance of the same zone as well as being in a different zone.
  • GetGamepadIconPathForKeyCode
  • GetMouseIconPathForKeyCode
  • IsPlayerTryingToMove
  • GetMaxTraits
  • Returns the maximum number of traits that could be on an item.
  • GetCurrentTradingHouseGuildDetails
  • AnimationTimeline:SetPlaybackLoopsRemaining
  • LabelControl:SetDesaturation
  • TooltipControl:SetHeraldryItem
  • WindowManager:GetOverscanOffsets
  • WindowManager:SetOverscanOffsets
  • This function allows you to adjust the size of the GUI root control.
  • WindowManager:SetMouseFocusByName
Changed Functions
  • GetGuildEventInfo now returns six parameters describing the history event instead of five.
  • GetGameCameraInteractableActionInfo now returns an additional value which is a contextual link. This is used to return the name of the key when the additional info type is ADDITIONAL_INTERACT_INFO_REQUIRES_KEY.
Removed Functions
  • GetShortAllianceName
  • All short name functions and short strings were removed from localization. This also impacts ItemFilterType and KeyCode short names.
  • Added BIND_TYPE Enumeration
  • Returned by GetItemLinkBindType.
  • Values for all enumerations are listed in the full API documentation. Search for the enumeration prefix (for example, BIND_TYPE).
  • Added CAMPAIGN_LEVEL_REQ Enumeration
  • New Value for POWERTYPE Enumeration
  • Added ENCHANTMENT_CATEGORY Enumeration
  • Intended for future trading house functionality. Not presently usable.
  • Intended for future trading house functionality. Not presently usable.
  • New Value for ADDITIONAL_INTERACT_INFO Enumeration
  • Returned by GetGameCameraInteractableActionInfo.
  • Added GAMEPAD_SETTING Enumeration
  • Added GAMEPAD_TOOLTIP_COLOR Enumeration
  • New Value for GUILD_PERMISSION Enumeration
  • Added INSTANCE_DISPLAY_TYPE Enumeration
  • Returned by GetGameCameraInteractableActionInfo as the context when the additional info type is ADDITIONAL_INTERACT_INFO_INSTANCE_TYPE.
  • New Values for ITEM_SOUND_CATEGORY
  • Many new values. See the full documentation.
  • Returned by item sound query functions such as GetSlotItemSound and GetItemSoundCategoryFromLink.
  • Added SIEGE_TYPE Enumeration
  • Retuned by GetItemLinkSiegeType.
  • Many new values. See the full documentation.
  • New Value for CAMPAIGN_REASSIGN_ERROR Enumeration
  • New Values for GUILD_KIOSK Enumeration
  • New Value for GUILD_PRIVILEGE Enumeration
  • New Values for KEY Enumeration
  • Added values for gamepad keys. These begin with KEY_GAMEPAD_*, but are not currently generated.
  • Many new values. See the full documentation.
  • Used with the translate animation’s SetTranslateDeltas, SetDeltaOffsetX, and SetDeltaOffsetY
Attached Files
File Type: txt ESOUIDocumentationP3.txt (330.2 KB, 866 views)

Last edited by Cairenn : 08/05/14 at 01:16 PM.
  Reply With Quote
08/05/14, 08:40 AM   #2
farangkao's Avatar
AddOn Author - Click to view addons
Join Date: May 2014
Posts: 59
Thanks Caireen, the API Txt is very useful for updating the EsoAddonDev
@farangkao on EU Servers. My Addon: Mobile Bank Extended, For Developers: ZeroBrane Studio - ESOAddonDev Plugin
  Reply With Quote
07/18/16, 09:34 AM   #3
Ayantir's Avatar
AddOn Author - Click to view addons
Join Date: Jul 2014
Posts: 1,022
Can we unsticky this post?
Obsessive Compulsive Coder

My little french Guild: Cercle de l'Eveil
  Reply With Quote

ESOUI » Developer Discussions » Tutorials & Other Helpful Info » Update 3 API Patch Notes & Change Log (LIVE)

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

vB code is On
Smilies are On
[IMG] code is On
HTML code is Off