ESOUI - Update 2.5

ESOUI (https://www.esoui.com/forums/index.php)

- Tutorials & Other Helpful Info (https://www.esoui.com/forums/forumdisplay.php?f=172)

- - Update 2.5 (https://www.esoui.com/forums/showthread.php?t=6384)

You cant communicate throught chat...
the only way to communicate is grpsocket and it's an unoficial usage of a feature not meaned for this...

Quote:

Originally Posted by sirinsidiator (Post 27656)

It will be a problem for German players if it stays like this. The live version does not have this bug, so any character save data will disappear for names that start with a lowercase letter, unless it gets fixed.

We just checked out live and it does capitalize the first letter of the character name (improperly), but it seems to have been doing this for a while. Did you see it behave differently somewhere?

I've updated http://wiki.esoui.com/Collectibles even if I still don't know if anyone use it... :rolleyes:

Quote:

Originally Posted by ZOS_ChipHilseberg (Post 27683)

We just checked out live and it does capitalize the first letter of the character name (improperly), but it seems to have been doing this for a while. Did you see it behave differently somewhere?

I tried it again and found that it works as you describe when I set the language to "de" during character creation and like I said when the selected language is "en" and I switch to "de" right after creation. Meaning it won't be a problem for players that always play in one language.

Quote:

Originally Posted by sirinsidiator (Post 27687)

Ah, gotcha. Thanks.

Because I looked at this, there is a typo error in new dye system in patchnotes and txt.

When referring to a DyeDefId , you should remove the "Def" from your function names, etc. It's a DyeId

ex:

GetItemLinkDyeDefIds doesn't exist : it's GetItemLinkDyeIds
GetDyeDefColorsById doesn't exist : it's GetDyeColorsById
GetDyeDefInfoById doesn't exist : it's GetDyeInfoById

And because, I needed doc on the control type TextureComposite (who knows it ? :rolleyes: ) .. I updated the 2 years old page http://wiki.esoui.com/Controls

It was really needed because since few updates ZOS added a lot of methods on this topic and we had 0 doc uptodate except the txt and patchnotes.

And I wrote how to update the page at the bottom of 1st topic of thread :
http://www.esoui.com/forums/showthread.php?p=26365

PS: Basically this page list all methods (functions) you can do with a control type.

ex if your control is a EditControl and the control name is Foo,

you can , per exemple, do :

Lua Code:

Foo:TakeFocus()

I also added few things at the top of the page, and tried to keep refs with globals page.

Here's the updated docs for the next PTS update.

Quote:

Originally Posted by ZOS_ChipHilseberg (Post 27767)

Here's the updated docs for the next PTS update.

Thank you very much!
There are some nice changes:

Code:

MAX_TEXT_CHAT_INPUT_CHARACTERS



* GetLocationName(*integer* _worldId_)

** _Returns:_ *string* _worldName_



* GetCurrentCharacterId()

** _Returns:_ *string* _id_



* RequestOpenUnsafeURL(*string* _URL_)





* GetNumCharacters()

** _Returns:_ *integer* _numCharacters_



* GetCharacterInfo(*luaindex* _index_)

** _Returns:_ *string* _name_, *[Gender|#Gender]* _gender_, *integer* _level_, *integer* _championRank_, *integer* _classId_, *integer* _raceId_, *[Alliance|#Alliance]* _alliance_, *string* _id_, *integer* _locationId_



* EVENT_KEEP_ALLIANCE_OWNER_CHANGED (*integer* _keepId_, *integer* _battlegroundContext_, *integer* _owningAlliance_, *integer* _oldOwningAlliance_)

Will GetLocationName return the same worldName as GetWorldName and will there be constant values for the IDs (e.g. WORLD_EU, WORLD_NA, WORLD_PTS)?
And does RequestOpenUnsafeURL mean there has been a change of policy regarding exchanging data with external services? If it is what I think it is, it would allow addons to send data to external servers pretty easily, which would make me hope that CopyAllTextToClipboard will be made public again and we may get functions to access saveData files directly without the need for an UI reload.

Quote:

Originally Posted by sirinsidiator (Post 27772)

Thank you very much!
Will GetLocationName return the same worldName as GetWorldName and will there be constant values for the IDs (e.g. WORLD_EU, WORLD_NA, WORLD_PTS)?
And does RequestOpenUnsafeURL mean there has been a change of policy regarding exchanging data with external services? If it is what I think it is, it would allow addons to send data to external servers pretty easily, which would make me hope that CopyAllTextToClipboard will be made public again and we may get functions to access saveData files directly without the need for an UI reload.

worldName is the zone name that the character is in. It doesn't refer to the server. RequestOpenUnsafeURL requires a secure confirmation so it will not function as an automatic export mechanism. Data can already be exported through the saved variables on reload UI so we don't see it as contradicting the existing policies.

Then it looks like instead of using either of these 2 functions to store addon data against:

GetUnitName("player")
GetRawUnitName("player")

We should actually be using:

GetCurrentCharacterId()

I did a very quick test and the ID seems unique to the character and was the same after using a character name change token.

Also looking forward to making use of GetCharacterInfo(index) :)

right now i tried to teleport to player who in REapers march according to Guild roster

i tried few times but every time it port me to Worthgar
is new changes will fix it?

GetCharacterInfo() bug?

I just found something a bit odd
When you create a brand new character and log in for the first time, the character does not show up in the GetCharacterInfo() function
It doesn't seem to appear in the functions data until you log out to the character selection screen and back in.

Lua Code:

d("GetCurrentCharacterId: "..GetCurrentCharacterId())
d("GetNumCharacters: "..GetNumCharacters())
for i = 1, GetNumCharacters() do
    local name, gender, level, championRank, classId, raceId, alliance, id, locationId = GetCharacterInfo(i)
    d("id="..tostring(id))
end
local name, gender, level, championRank, classId, raceId, alliance, id, locationId = GetCharacterInfo(GetCurrentCharacterId())
d("id2="..tostring(id))

In the above code example GetCurrentCharacterId() does not appear in the for loop.
And id2 prints out nothing, not even nil

Quote:

Originally Posted by Weolo (Post 27844)

Lua Code:

d("GetCurrentCharacterId: "..GetCurrentCharacterId())
d("GetNumCharacters: "..GetNumCharacters())
for i = 1, GetNumCharacters() do
    local name, gender, level, championRank, classId, raceId, alliance, id, locationId = GetCharacterInfo(i)
    d("id="..tostring(id))
end
local name, gender, level, championRank, classId, raceId, alliance, id, locationId = GetCharacterInfo(GetCurrentCharacterId())
d("id2="..tostring(id))

In the above code example GetCurrentCharacterId() does not appear in the for loop.
And id2 prints out nothing, not even nil

Yup, that's a bug. We'll get a fix in for it.

Quote:

Originally Posted by Ayantir (Post 27686)

I've updated http://wiki.esoui.com/Collectibles even if I still don't know if anyone use it... :rolleyes:

Is there also a page like that with all motifs? I still need the ingame ID's of the new ones for eso-database.

I finally automatized the Events page a bit better.
Guide is here : http://www.esoui.com/forums/showthread.php?t=6141
It create the new source and warn for thing to add manually

This reduce page update to 10min from 2hours.

Ex for 2.5 :

Quote:

Event found on Wiki but not in ZOS ref -> * [[EVENT_DIFFICULTY_LEVEL_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_VETERAN_POINTS_GAIN]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_VETERAN_POINTS_UPDATE]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_VETERAN_RANK_UPDATE]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_DATA_LOADED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_DESCRIPTION_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_HISTORY_CATEGORY_UPDATED]] ('''integer''' ''eventCode'', '''integer''' ''guildId'', '''[[Globals#GuildHistoryCategory|GuildHistoryCategory]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_HISTORY_RESPONSE_RECEIVED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_KEEP_CLAIM_UPDATED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_MEMBER_ADDED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_MEMBER_CHARACTER_LEVEL_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_MEMBER_CHARACTER_UPDATED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_MEMBER_CHARACTER_VETERAN_RANK_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_MEMBER_CHARACTER_ZONE_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_MEMBER_NOTE_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_MEMBER_PLAYER_STATUS_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_MEMBER_RANK_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_MEMBER_REMOVED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_MOTD_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_RANK_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_RANKS_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_SELF_JOINED_GUILD]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GUILD_SELF_LEFT_GUILD]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_SAVE_GUILD_RANKS_RESPONSE]] ('''integer''' ''eventCode'', '''integer''' ''guildId'', '''[[Globals#SocialActionResult|SocialActionResult]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_GROUPING_TOOLS_STATUS_UPDATE]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_FRIEND_ADDED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_FRIEND_CHARACTER_LEVEL_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_FRIEND_CHARACTER_UPDATED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_FRIEND_CHARACTER_VETERAN_RANK_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_FRIEND_CHARACTER_ZONE_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_FRIEND_NOTE_UPDATED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_FRIEND_PLAYER_STATUS_CHANGED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_FRIEND_REMOVED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_IGNORE_ADDED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_IGNORE_NOTE_UPDATED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_IGNORE_REMOVED]]
Event found on Wiki but not in ZOS ref -> * [[EVENT_SOCIAL_DATA_LOADED]]
New ZOS event -> * [[EVENT_GROUP_ELECTION_REQUESTED]] ('''integer''' ''eventCode'', '''string''' ''descriptor'')
New ZOS event -> * [[EVENT_CURRENT_SUBZONE_LIST_CHANGED]] ('''number''' ''eventCode'')
New ZOS event -> * [[EVENT_GROUP_ELECTION_NOTIFICATION_REMOVED]] ('''number''' ''eventCode'')
New ZOS event -> * [[EVENT_CHAMPION_POINT_UPDATE]] ('''integer''' ''eventCode'', '''string''' ''unitTag'', '''number''' ''oldChampionPoints'', '''number''' ''currentChampionPoints'')
New ZOS event -> * [[EVENT_INVENTORY_ITEMS_AUTO_TRANSFERRED_TO_CRAFT_BAG]] ('''number''' ''eventCode'')
New ZOS event -> * [[EVENT_ITEM_PREVIEW_READY]] ('''number''' ''eventCode'')
New ZOS event -> * [[EVENT_PLAYER_QUEUED_FOR_CYCLIC_RESPAWN]] ('''number''' ''eventCode'')
New ZOS event -> * [[EVENT_CAMPAIGN_UNASSIGNMENT_RESULT]] ('''integer''' ''eventCode'', '''number''' ''result'')
New ZOS event -> * [[EVENT_ACTIVITY_FINDER_ACTIVITY_COMPLETE]] ('''number''' ''eventCode'')
New ZOS event -> * [[EVENT_CHAMPION_LEVEL_ACHIEVED]] ('''integer''' ''eventCode'', '''boolean''' ''wasChampionSystemUnlocked'')
New ZOS event -> * [[EVENT_COLLECTIBLE_NEW_STATUS_CLEARED]] ('''integer''' ''eventCode'', '''number''' ''collectibleId'')
New ZOS event -> * [[EVENT_GROUP_ELECTION_RESULT]] ('''integer''' ''eventCode'', '''number''' ''electionResult'', '''string''' ''descriptor'')
New ZOS event -> * [[EVENT_GROUP_ELECTION_FAILED]] ('''integer''' ''eventCode'', '''number''' ''failureReason'', '''string''' ''descriptor'')
New ZOS event -> * [[EVENT_HOUSING_EDITOR_MODE_CHANGED]] ('''integer''' ''eventCode'', '''number''' ''oldMode'', '''number''' ''newMode'')
New ZOS event -> * [[EVENT_VISUAL_LAYER_CHANGED]] ('''number''' ''eventCode'')
New ZOS event -> * [[EVENT_DYE_STAMP_USE_FAIL]] ('''integer''' ''eventCode'', '''number''' ''reason'')
New ZOS event -> * [[EVENT_COLLECTIBLE_USE_BLOCKED]] ('''integer''' ''eventCode'', '''number''' ''reason'')
New ZOS event -> * [[EVENT_WEAPON_PAIR_LOCK_CHANGED]] ('''integer''' ''eventCode'', '''boolean''' ''locked'')
New ZOS event -> * [[EVENT_CADWELL_PROGRESSION_LEVEL_CHANGED]] ('''integer''' ''eventCode'', '''number''' ''progressionLevel'')
New ZOS event -> * [[EVENT_GROUP_ELECTION_NOTIFICATION_ADDED]] ('''number''' ''eventCode'')
New ZOS event -> * [[EVENT_CRAFT_BAG_AUTO_TRANSFER_NOTIFICATION_CLEARED]] ('''number''' ''eventCode'')
New ZOS event -> * [[EVENT_ACTIVITY_FINDER_STATUS_UPDATE]] ('''integer''' ''eventCode'', '''number''' ''status'')
New ZOS event -> * [[EVENT_PERSONALITY_CHANGED]] ('''number''' ''eventCode'')

Quote:

Originally Posted by Ayantir (Post 27881)

http://wiki.esoui.com/StyleItemIndex

Exactly what I needed. Thanks!

I've updated Keeps page & I've updated API page :

Lua Code:

@@ -79,6 +79,9 @@
 * GetRaceName(number [[Globals#Gender|Gender]] gender, number raceId)
 ** Returns: string raceName
 
+* GetLocationName(number worldId)
+** Returns: string worldName
+
 * GetGenderFromNameDescriptor(string nameDescriptor)
 ** Returns: number [[Globals#Gender|Gender]] gender
 
@@ -123,6 +126,8 @@
 * IsInternalBuild()
 ** Returns: boolean isInternalBuild
 
+* SaveLoadDialogResult(number [[Globals#SaveLoadDialogError|SaveLoadDialogError]] errorType, number [[Globals#SaveLoadDialogAnswer|SaveLoadDialogAnswer]] result)
+
 * GetSecondsSinceMidnight()
 ** Returns: number secondsSinceMidnight
 
@@ -216,6 +221,33 @@
 * HashString(string text)
 ** Returns: number hashValue
 
+* Create3DRenderSpace()
+** Returns: number spaceId
+
+* Set3DRenderSpaceOrigin(number spaceId, number x, number y, number z)
+
+* Set3DRenderSpaceRight(number spaceId, number x, number y, number z)
+
+* Set3DRenderSpaceUp(number spaceId, number x, number y, number z)
+
+* Set3DRenderSpaceForward(number spaceId, number x, number y, number z)
+
+* Set3DRenderSpaceSystem(number spaceId, number [[Globals#GuiRender3DSpaceSystem|GuiRender3DSpaceSystem]] system)
+
+* Set3DRenderSpaceToCurrentCamera(number spaceId)
+
+* ComputeDepthAtWhichWorldWidthRendersAsUIWidth(number worldWidth, number UIWidth)
+** Returns: number depth
+
+* GetWorldDimensionsOfViewFrustumAtDepth(number depth)
+** Returns: number frustumWidth, number frustumHeight
+
+* GetESOVersionString()
+** Returns: string versionString
+
+* Is64BitClient()
+** Returns: boolean is64Bit
+
 * GetEULADetails(number [[Globals#EULAType|EULAType]] eulaType)
 ** Returns: string message, string agreeText, string disagreeText, boolean hasAgreed, string dialogText
 
@@ -619,7 +651,7 @@
 * GetNumPlayerStatuses()
 ** Returns: number numStatuses
 
-* GetCriticalStrikeChance(number statValue, boolean useMin)
+* GetCriticalStrikeChance(number statValue)
 ** Returns: number chance
 
 * TakeScreenshot()
@@ -681,6 +713,9 @@
 * GetUnitChampionPoints(string unitTag)
 ** Returns: number championPoints
 
+* GetUnitEffectiveChampionPoints(string unitTag)
+** Returns: number championPoints
+
 * CanUnitGainChampionPoints(string unitTag)
 ** Returns: boolean canGainChampionPoints
 
@@ -861,6 +896,9 @@
 * GetUnitPower(string unitTag, number [[Globals#CombatMechanicType|CombatMechanicType]] powerType)
 ** Returns: number current, number max, number effectiveMax
 
+* GetCurrentCharacterId()
+** Returns: string id
+
 * GetPlayerStat(number [[Globals#DerivedStats|DerivedStats]] derivedStat, number [[Globals#StatBonusOption|StatBonusOption]] statBonusOption)
 ** Returns: number value
 
@@ -1692,6 +1730,8 @@
 * IsFeedbackGatheringEnabled()
 ** Returns: boolean enabled
 
+* RequestOpenUnsafeURL(string URL)
+
 * Logout()
 
 * Quit()
@@ -1828,6 +1868,12 @@
 * GetActiveActionLayerIndex(number activeActionLayerIndex)
 ** Returns: number:nilable layerIndex
 
+* GetNumCharacters()
+** Returns: number numCharacters
+
+* GetCharacterInfo(number index)
+** Returns: string name, number [[Globals#Gender|Gender]] gender, number level, number championRank, number classId, number raceId, number [[Globals#Alliance|Alliance]] alliance, string id, number locationId
+
 * GetNumAttributes()
 ** Returns: number numAttributes
 
@@ -2351,6 +2397,11 @@
 
 * SetChatFontSize(number fontSize)
 
+* GetGamepadChatFontSize()
+** Returns: number gamepadFontSize
+
+* SetGamepadChatFontSize(number gamepadFontSize)
+
 * ResetChatFontSizeToDefault()
 
 * GetChatCategoryColor(number [[Globals#ChatChannelCategories|ChatChannelCategories]] category)
@@ -2680,6 +2731,27 @@
 * CanItemBeVirtual(number bagId, number slotIndex)
 ** Returns: boolean canBeVirtualItem
 
+* IsItemPlaceableFurniture(number bagId, number slotIndex)
+** Returns: boolean isPlaceable
+
+* IsDisplayNameInItemBoPAccountTable(number bagId, number slotIndex, string displayName)
+** Returns: boolean isInTable
+
+* IsItemBoPAndTradeable(number bagId, number slotIndex)
+** Returns: boolean isBoPAndTradeable
+
+* GetItemBoPTimeRemainingSeconds(number bagId, number slotIndex)
+** Returns: number timeRemainingS
+
+* GetItemBoPTradeableDisplayNamesString(number bagId, number slotIndex)
+** Returns: string namesString
+
+* GetItemBoPTradeableNumEligibleNames(number bagId, number slotIndex)
+** Returns: number numNames
+
+* GetItemBoPTradeableEligibleNameByIndex(number bagId, number slotIndex, number nameIndex)
+** Returns: string name
+
 * HasCraftBagAccess()
 ** Returns: boolean hasAccess
 
@@ -2728,6 +2800,9 @@
 * GetItemLinkItemType(string itemLink)
 ** Returns: number [[Globals#ItemType|ItemType]] itemType, number [[Globals#SpecializedItemType|SpecializedItemType]] specializedItemType
 
+* GetItemLinkItemUseType(string itemLink)
+** Returns: number [[Globals#ItemUseType|ItemUseType]] onUseType
+
 * GetItemLinkArmorType(string itemLink)
 ** Returns: number [[Globals#ArmorType|ArmorType]] armorType
 
@@ -2902,6 +2977,12 @@
 * CanItemLinkBeVirtual(string itemLink)
 ** Returns: boolean canBeVirtual
 
+* GetItemLinkDyeIds(string itemLink)
+** Returns: number primaryDefId, number secondaryDefId, number accentDefId
+
+* GetItemLinkDyeStampId(string itemLink)
+** Returns: number dyeStampId
+
 * ShouldHideTooltipRequiredLevel(string itemLink)
 ** Returns: boolean shouldHideLevel
 
@@ -3812,6 +3893,15 @@
 * GetTradeItemInfo(number [[Globals#TradeParticipant|TradeParticipant]] who, number tradeIndex)
 ** Returns: string name, textureName icon, number stack, number quality, string creatorName, number sellPrice, boolean meetsUsageRequirement, number [[Globals#EquipType|EquipType]] equipType, number [[Globals#ItemStyle|ItemStyle]] itemStyle
 
+* IsTradeItemBoPAndTradeable(number [[Globals#TradeParticipant|TradeParticipant]] who, number tradeIndex)
+** Returns: boolean isBoPAndTradeable
+
+* GetTradeItemBoPTimeRemainingSeconds(number [[Globals#TradeParticipant|TradeParticipant]] who, number tradeIndex)
+** Returns: number timeRemainingS
+
+* GetTradeItemBoPTradeableDisplayNamesString(number [[Globals#TradeParticipant|TradeParticipant]] who, number tradeIndex)
+** Returns: string namesString
+
 * GetTradeItemBagAndSlot(number [[Globals#TradeParticipant|TradeParticipant]] who, number tradeIndex)
 ** Returns: number:nilable [[Globals#Bag|Bag]] bagId, number:nilable slotIndex
 
@@ -4005,10 +4095,13 @@
 * IsCollectibleCategoryUsable(number [[Globals#CollectibleCategoryType|CollectibleCategoryType]] collectibleCategoryType)
 ** Returns: boolean isUsable
 
-* IsCollectibleCategoryBlocked(number [[Globals#CollectibleCategoryType|CollectibleCategoryType]] collectibleCategoryType)
+* IsCollectibleBlocked(number collectibleId)
 ** Returns: boolean isBlocked
 
-* GetCollectibleCategoryBlockReason(number [[Globals#CollectibleCategoryType|CollectibleCategoryType]] collectibleCategoryType)
+* IsCollectibleValidForPlayer(number collectibleId)
+** Returns: boolean isValidForPlayer
+
+* GetCollectibleBlockReason(number collectibleId)
 ** Returns: number [[Globals#CollectibleUsageBlockReason|CollectibleUsageBlockReason]] usageBlockReason
 
 * IsCollectibleSlottable(number collectibleId)
@@ -4052,6 +4145,11 @@
 * GetCollectibleHelpIndices(number collectibleId)
 ** Returns: number:nilable helpCategoryIndex, number:nilable helpIndex
 
+* IsCollectibleNew(number collectibleId)
+** Returns: boolean isNew
+
+* ClearCollectibleNewStatus(number collectibleId)
+
 * GetNumCollectibleNotifications()
 ** Returns: number count
 
@@ -4083,6 +4181,17 @@
 * GetCollectibleCooldownAndDuration(number collectibleId)
 ** Returns: number cooldownRemaining, number cooldownDuration
 
+* GetCollectiblePersonalityOverridenEmoteDisplayNames(number collectibleId)
+** Uses variable returns...
+** Returns: string overriddenEmoteDisplayName
+
+* GetCollectiblePersonalityOverridenEmoteSlashCommandNames(number collectibleId)
+** Uses variable returns...
+** Returns: string overriddenEmoteSlashCommandName
+
+* GetCollectibleRestrictionsByType(number collectibleId, number [[Globals#CollectibleRestrictionType|CollectibleRestrictionType]] restrictionType)
+** Returns: boolean hasRestrictions, boolean passesRestrictions, string allowedNamesString
+
 * GetNumAchievementCategories()
 ** Returns: number numCategories
 
@@ -4144,6 +4253,9 @@
 * GetAchievementLink(number achievementId, number [[Globals#LinkStyle|LinkStyle]] linkStyle)
 ** Returns: string link
 
+* GetAchievementIdFromLink(string link)
+** Returns: number achievementId
+
 * GetAchievementNameFromLink(string link)
 ** Returns: string name
 
@@ -4161,7 +4273,7 @@
 ** Returns: boolean hasRewardOfType, string titleName
 
 * GetAchievementRewardDye(number achievementId)
-** Returns: boolean hasRewardOfType, number dyeIndex
+** Returns: boolean hasRewardOfType, number dyeId
 
 * GetAchievementRewardCollectible(number achievementId)
 ** Returns: boolean hasRewardOfType, number collectibleId
@@ -4351,6 +4463,9 @@
 * IsGamepadHelpOption(number [[Globals#HelpShowOptions|HelpShowOptions]] showOption)
 ** Returns: boolean isGamepadOption
 
+* IsSubmitFeedbackSupported()
+** Returns: boolean isSupported
+
 * GetCraftingInteractionType()
 ** Returns: number [[Globals#TradeskillType|TradeskillType]] currentCraftingInteraction
 
@@ -4491,20 +4606,20 @@
 * GetNumSmithingStyleItems()
 ** Returns: number numStyleItems
 
-* GetSmithingStyleItemInfo(number [[StyleItemIndex|styleItemIndex]])
-** Returns: string itemName, textureName icon, number sellPrice, boolean meetsUsageRequirement, number itemStyle, number quality
-
-* GetSmithingStyleItemLink(number [[StyleItemIndex|styleItemIndex]], number [[Globals#LinkStyle|linkStyle]])
+* GetSmithingStyleItemInfo(number styleItemIndex)
+** Returns: string itemName, textureName icon, number sellPrice, boolean meetsUsageRequirement, number itemStyle, number quality, boolean alwaysHideIfLocked
+
+* GetSmithingStyleItemLink(number styleItemIndex, number [[Globals#LinkStyle|LinkStyle]] linkStyle)
 ** Returns: string link
 
-* GetCurrentSmithingStyleItemCount(number [[StyleItemIndex|styleItemIndex]])
+* GetCurrentSmithingStyleItemCount(number styleItemIndex)
 ** Returns: number count
 
-* IsSmithingStyleKnown(number [[StyleItemIndex|styleItemIndex]], number patternIndex)
+* IsSmithingStyleKnown(number styleItemIndex, number patternIndex)
 ** Returns: boolean known
 
 * GetFirstKnownStyleIndex(number patternIndex)
-** Returns: number [[StyleItemIndex|styleItemIndex]]
+** Returns: number styleItemIndex
 
 * CanSmithingStyleBeUsedOnPattern(number styleIndex, number patternIndex, number materialIndex, number materialQuantity)
 ** Returns: boolean canBeUsed, number levelRequirement, number championPointsRequirement
@@ -4749,19 +4864,30 @@
 * GetNumTelvarStonesLost()
 ** Returns: number telvarStonesLost
 
-* SetPendingEquippedItemDye(number [[Globals#EquipSlot|EquipSlot]] equipSlot, number:nilable primaryDyeIndex, number:nilable secondaryDyeIndex, number:nilable accentDyeIndex)
-
-* GetPendingEquippedItemDye(number [[Globals#EquipSlot|EquipSlot]] equipSlot)
-** Returns: number:nilable primaryDyeIndex, number:nilable secondaryDyeIndex, number:nilable accentDyeIndex
+* InitializePendingDyes(number [[Globals#DyeMode|DyeMode]] dyeMode)
+
+* SetPendingSlotDyes(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot, number primaryDyeId, number secondaryDyeId, number accentDyeId)
+
+* GetPendingSlotDyes(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot)
+** Returns: number primaryDyeId, number secondaryDyeId, number accentDyeId
 
 * GetNumDyes()
 ** Returns: number numDyes
 
 * GetDyeInfo(number dyeIndex)
+** Returns: string dyeName, boolean known, number [[Globals#DyeRarity|DyeRarity]] rarity, number [[Globals#DyeHueCategory|DyeHueCategory]] hueCategory, number achievementId, number r, number g, number b, number sortKey, number dyeId
+
+* GetDyeInfoById(number dyeId)
 ** Returns: string dyeName, boolean known, number [[Globals#DyeRarity|DyeRarity]] rarity, number [[Globals#DyeHueCategory|DyeHueCategory]] hueCategory, number achievementId, number r, number g, number b, number sortKey
 
+* GetDyeColorsById(number dyeId)
+** Returns: number r, number g, number b
+
 * GetCurrentItemDyes(number bagId, number slotIndex)
-** Returns: number:nilable primaryDyeIndex, number:nilable secondaryDyeIndex, number:nilable accentDyeIndex
+** Returns: number primaryDyeIndex, number secondaryDyeIndex, number accentDyeIndex
+
+* GetCurrentCollectibleDyes(number collectibleId)
+** Returns: number primaryDyeIndex, number secondaryDyeIndex, number accentDyeIndex
 
 * ApplyPendingDyes()
 
@@ -4769,9 +4895,68 @@
 ** Returns: number numSavedDyeSets
 
 * GetSavedDyeSetDyes(number dyeSetIndex)
-** Returns: number:nilable primaryDyeIndex, number:nilable secondaryDyeIndex, number:nilable accentDyeIndex
-
-* SetSavedDyeSetDyes(number dyeSetIndex, number:nilable primaryDyeIndex, number:nilable secondaryDyeIndex, number:nilable accentDyeIndex)
+** Returns: number primaryDyeId, number secondaryDyeId, number accentDyeId
+
+* SetSavedDyeSetDyes(number dyeSetIndex, number primaryDyeId, number secondaryDyeId, number accentDyeId)
+
+* CanUseCollectibleDyeing()
+** Returns: boolean collectibleDyeingAllowed
+
+* IsDyeableSlotDyeable(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot)
+** Returns: boolean isDyeable
+
+* IsDyeableSlotBound(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot)
+** Returns: boolean isBound
+
+* AreDyeableSlotDyeChannelsDyeable(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot)
+** Returns: boolean primary, boolean secondary, boolean accent
+
+* GetDyeableSlotDyeData(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot)
+** Returns: number dyeData
+
+* GetDyeableSlotId(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot)
+** Returns: number id
+
+* GetDyeableSlotIcon(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot)
+** Returns: textureName icon
+
+* GetDyeableSlotCurrentDyes(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot)
+** Returns: number primaryDyeId, number secondaryDyeId, number accentDyeId
+
+* IsDyeIndexKnown(number dyeIndex)
+** Returns: boolean isKnown
+
+* CanPlayerUseCostumeDyeStamp(number dyeStampId)
+** Returns: number [[Globals#DyeStampUseResult|DyeStampUseResult]] dyeStampUseResult
+
+* CanPlayerUseItemDyeStamp(number dyeStampId)
+** Returns: number [[Globals#DyeStampUseResult|DyeStampUseResult]] dyeStampUseResult
+
+* SetupDyeStampPreview(number bagId, number slotIndex)
+
+* GetNumDyeableEquipSlots()
+** Returns: number numDyeableEquipSlots
+
+* GetNumDyeableCollectibleCategories()
+** Returns: number numDyeableCollectibleCategories
+
+* GetDyeableEquipSlot(number dyeableEquipSlotIndex)
+** Returns: number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot
+
+* GetDyeableCollectibleCategory(number dyeableCollectibleCategoryIndex)
+** Returns: number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot
+
+* GetDyeableEquipSlotGamepadOrder(number dyeableEquipSlotIndex)
+** Returns: number gamepadOrder
+
+* GetDyeableCollectibleCategoryGamepadOrder(number dyeableCollectibleCategoryIndex)
+** Returns: number gamepadOrder
+
+* GetEquipSlotFromDyeableSlot(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot)
+** Returns: number [[Globals#EquipSlot|EquipSlot]] equipSlot
+
+* GetCollectibleCategoryFromDyeableSlot(number [[Globals#DyeableSlot|DyeableSlot]] dyeableSlot)
+** Returns: number [[Globals#CollectibleCategoryType|CollectibleCategoryType]] collectibleCategory
 
 * IsJusticeEnabled()
 ** Returns: boolean isJusticeEnabled
@@ -4997,6 +5182,12 @@
 * {{Private function}} IsCurrentlyPreviewing()
 ** Returns: boolean isPreviewing
 
+* {{Private function}} IsInPreviewMode()
+** Returns: boolean isInPreviewMode
+
+* IsCharacterPreviewingAvailable()
+** Returns: boolean canPreview
+
 * {{Private function}} EndCurrentItemPreview()
 
 * {{Private function}} BeginItemPreviewSpin()
@@ -5006,6 +5197,14 @@
 * {{Private function}} CanSpinPreviewCharacter()
 ** Returns: boolean canSpin
 
+* {{Private function}} PreviewCollectible (number collectibleDefId, number variation, number dyeBrushId)
+
+* {{Private function}} PreviewDyeStamp (number dyeStampId, number [[Globals#ItemUseType|ItemUseType]] itemType)
+
+* {{Private function}} PreviewCraftItem (number patternIndex, number materialIndex, number materialQuantity, number styleIndex, number traitIndex, boolean useUniversalStyleItem, number aDyeStampId)
+
+* {{Private function}} SetPreviewDyeMode (number [[Globals#DyeMode|DyeMode]] dyeMode)
+
 * GetNumDefaultQuickChats()
 ** Returns: number numQuickChats
 
@@ -5182,4 +5381,33 @@
 ** Returns: string emailAddress
 
 * GetCurrentZoneDungeonDifficulty()
-** Returns: number [[Globals#DungeonDifficulty|DungeonDifficulty]] isVeteranDifficulty
\ No newline at end of file
+** Returns: number [[Globals#DungeonDifficulty|DungeonDifficulty]] isVeteranDifficulty
+
+* {{Private function}} HousingEditorToggleSnapMode()
+
+* {{Private function}} HousingEditorRequestPlacement()
+
+* {{Private function}} HousingEditorRotateFixture (number [[Globals#AxisTypes|AxisTypes]] axis, number magnitude)
+
+* {{Private function}} HousingEditorPushFixture (number magnitude)
+
+* {{Private function}} HousingEditorPreviewItemFurniture (number [[Globals#Bag|Bag]] bagId, number slotIndex)
+** Returns: boolean success
+
+* {{Private function}} HousingEditorHasPendingFixture()
+** Returns: boolean isPreview
+
+* {{Private function}} HousingEditorSelectFurniture()
+
+* {{Private function}} HousingEditorCanSelectFurniture()
+
+* {{Private function}} HousingEditorRequestModeChange (number [[Globals#HousingEditorMode|HousingEditorMode]] mode)
+
+* {{Private function}} GetHousingEditorMode()
+** Returns: number [[Globals#HousingEditorMode|HousingEditorMode]] mode
+
+* {{Private function}} DebugHousingEditorPreviewTestFurniture (number index)
+** Returns: boolean success
+
+* {{Private function}} DebugGetNumTestFurniture()
+** Returns: number size
\ No newline at end of file

Shadow of the Hist - Storing addon data

Shadow of the Hist now comes with API functions to allow your addon data to survive a character rename, class change, race change and even figure out if the player has deleted an old character.

Old way of storing addon data

Lua Code:

local settings =  ZO_SavedVars:NewAccountWide("Test Addon", 1, nil, defaults)
local name = zo_strformat("<<1>>",GetRawUnitName("player"))
settings[name] = {
  [something] = 1,
  [show] = true
}

This would produce a saved variables file like this:

Lua Code:

{
  ["Fred Smith"] = {
    ["something"] = 1,
    ["show"] = false,
  },
  ["John Smith"] = {
    ["something"] = 2,
    ["show"] = true,
  }
}

The problem with that is if the player purchases a rename token they will not have access to their old addon data.

This can all be fixed with these few functions

GetNumCharacters()
GetCharacterInfo()
GetCurrentCharacterId()

The "CharacterId" is unique for each character you have.

Example of the new way to store addon data

Lua Code:

local id = GetCurrentCharacterId()
settings[id] = {
  [something] = 1,
  [show] = true
}

This would produce a saved variables file like this:

Lua Code:

{
  ["11111111"] = {
    ["something"] = 1,
    ["show"] = false,
  },
  ["22222222"] = {
    ["something"] = 2,
    ["show"] = true,
  }
}

And they can also be used to convert the old format over to the new one.

Lua Code:

for i = 1, GetNumCharacters() do
  local name, gender, level, championRank, classId, raceId, alliance, id, locationId = GetCharacterInfo(i)
  name = zo_strformat("<<1>>",name)
  if settings[name] then
    --Found the old data, now convert it
    settings[id] = {
      [something] = settings[name].something,
      [show] = settings[name].show
    }
    --Now tidy up/remove the old data
    settings[name] = nil
  end
end
 
local id = GetCurrentCharacterId()
settings[id] = {
  [something] = 1,
  [show] = true
}

This last example just tidies up old/deleted characters

Lua Code:

local found = {}
for i = 1, GetNumCharacters() do
  local name, gender, level, championRank, classId, raceId, alliance, id, locationId = GetCharacterInfo(i)
  found[id] = true
end
 
for id,data in pairs(settings) do
  if not found[id] then
    settings[id] = nil
  end
end
 
local id = GetCurrentCharacterId()
settings[id] = {
  [something] = 1,
  [show] = true
}

I did find one bug with GetCharacterInfo() on PTS which is being fixed and that was if you created a brand new character they did not appear in GetCharacterInfo(). But that is easy enough to fix with a small bit of code for now. I need to test live once Shadow of the Hist is all patched up to see if the bug fix is there.