At my wits end. UseCollectible doesn't work for just one character

RicAlmighty · 06/13/24, 01:20 PM

Hello all. An add-on that I used all the time (Armory Style Manager) has broken after the Gold Road update, so I went in to simplify and fix it. I am completely baffled though because the code works fine except for one of my characters (I have 8). When the add-on was working, it worked for all of my characters and honestly I did not change much in this specific area.

For some reason the call to

Code:

UseCollectible(id, GAMEPLAY_ACTOR_CATEGORY_PLAYER)

results in a "COLLECTIBLE IS NOT READY YET" error for this one character, but not any of the others. For background, the failing character has 4 Armory Builds, and the others range from 2 to 3. It doesn't matter which build I switch to though as it fails every time with this character, but works with others.

For example, I will set a specific mount and personality for one Armory Build. The code fires after the event EVENT_ARMORY_BUILD_RESTORE_RESPONSE and iterates over the currently equipped items and attempts to replace the current items with the ones saved in my SavedVariables. I've triple checked the SavedVariables and they are fine. The code that saves the items works perfectly even for the character that is failing, it's only when I call UseCollectible() that I get the error for this one character.

At this point, I have no idea what else to do here. Perhaps there is just something borked with this one character? Did Gold Road change how this works in some way? I cannot understand why the same code works for the others but not for this one. I'd appreciate any insight or suggestions. Thanks

Relevant Code:

Lua Code:

local function ArmoryBuildLoaded(_, result, buildIndex)
    if result ~= ARMORY_BUILD_RESTORE_RESULT_SUCCESS then
        d("Armory Load Failed")
        return false
    end
 
    ArmoryStyle.savedVariables.currentBuildIndex = buildIndex
 
    for collectibleType, id in pairs(ArmoryStyle.savedVariables.builds[buildIndex].collectibles) do
        local eqippedCollectible = GetActiveCollectibleByType(collectibleType, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
        if eqippedCollectible ~= id then
            if id ~= 0 then
                if IsCollectibleUnlocked(id) and IsCollectibleUsable(id, GAMEPLAY_ACTOR_CATEGORY_PLAYER) and IsCollectibleValidForPlayer(id) then
                    UseCollectible(id, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
                else
                    d("Error occurred Setting Collectible")
                end
            else
                if eqippedCollectible ~= 0 then
                    -- If a collectible is already equipped then we want to 'un-use' the current one
                    UseCollectible(eqippedCollectible, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
                end
            end
        end
    end

**Baertram** · 06/14/24, 06:59 AM

As you call that in a for loop it might be a timing issue where collectibles cannot be used "directly after another".
Same like if you click some collectibles in your collections list and have to wait 9/45s afterwards.

Are you use the error happens at that line 14 and not at line 21 (because your 1 char already wears another collectible)?
You should add the same "IsCollectible* checks at that line 21 then and see if that helps, add some d() debug messages to see what hapepns when with that 1 character.

Lua Code:

local function checkCollectibleUsableByPlayer(collectibleId)
        return ( collectibleId ~= nil and collectibleId ~= 0
                and IsCollectibleUnlocked(collectibleId)
                and IsCollectibleUsable(collectibleId, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
                and IsCollectibleValidForPlayer(collectibleId) )
                    or false
    end
 
    local function ArmoryBuildLoaded(_, result, buildIndex)
        if result ~= ARMORY_BUILD_RESTORE_RESULT_SUCCESS then
            d("Armory Load Failed")
            return false
        end
 
        ArmoryStyle.savedVariables.currentBuildIndex = buildIndex
 
        for collectibleType, id in pairs(ArmoryStyle.savedVariables.builds[buildIndex].collectibles) do
            local eqippedCollectible = GetActiveCollectibleByType(collectibleType, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
            if eqippedCollectible ~= id then
                if id ~= 0 then
                    if checkCollectibleUsableByPlayer(id) then
                        UseCollectible(id, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
                    else
                        d("Error occurred Setting Collectible: " ..tostring(id))
                    end
                else
                    if eqippedCollectible ~= 0 then
                        if checkCollectibleUsableByPlayer(eqippedCollectible) then
                            -- If a collectible is already equipped then we want to 'un-use' the current one
                            UseCollectible(eqippedCollectible, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
                        else
                            d("Error occurred with eqippedCollectible: " ..tostring(eqippedCollectible))
                        end
                    end
                end
            end
        end
 
        ...
 
    end

RicAlmighty · 06/14/24, 09:48 AM

Thanks for the reply, I appreciate it. I agree with your assessment that it is a timing issue and that perhaps I am trying to assign too many collectibles in too short of a time frame.

The error "COLLECTIBLE IS NOT READY YET" was actually happening on line 21 (I used debug statements to verify that), so you're correct in that was the problem.

I modified that section of the code to add a delayed callback and it seems to have fixed the issue! I guess I overlooked the fact that the one character did have a lot of collectible switching between Armory builds whereas the others were more simple.

This is what I added:

Lua Code:

if eqippedCollectible ~= id then
            if id ~= 0 then
                if IsCollectibleUnlocked(id) and IsCollectibleUsable(id, GAMEPLAY_ACTOR_CATEGORY_PLAYER) and IsCollectibleValidForPlayer(id) then
                    local msg = zo_strformat("Equipping <<1>>", GetCollectibleName(id))
                    --d(msg)
                    zo_callLater(function() UseCollectible(id, GAMEPLAY_ACTOR_CATEGORY_PLAYER) end, 1500)
                else
                    d("Error occurred Setting Collectible")
                end
            else
                if eqippedCollectible ~= 0 then
                    -- If a collectible is already equipped then we want to 'un-use' the current one
                    local msg = zo_strformat("Un-Equipping <<1>>", GetCollectibleName(eqippedCollectible))
                    --d(msg)
                    zo_callLater(function() UseCollectible(eqippedCollectible, GAMEPLAY_ACTOR_CATEGORY_PLAYER) end, 1500)
                end
            end

It results in a slight delay where the costume will be applied very shortly after you exit the Armory UI, but it does work.

Thanks again for pointing me in the right direction!

**Baertram** · 06/14/24, 10:40 AM

Maybe there is even a better way using EVENT_MANAGER:RegisterForUpdate (which basically is the same as zo_callLater but you can reuse it with multiple calls, e.g. every 500ms).
Within the callback function you check ech time it is called with functions like

if IsCollectibleUnlocked(id) and IsCollectibleUsable(id, GAMEPLAY_ACTOR_CATEGORY_PLAYER) and IsCollectibleValidForPlayer(id)

and maybe others that provide a return value like "Currently blocked because of reason BLOCK_REASON_ONE (I think there is such an API function like IsCollectibleBlocked which might return any blocked reasons or at least a true then)

if the item is still blocked. If not:
Unregister that update and equip the collectible then:

Lua Code:

local function checkCollectibleUsableByPlayer(collectibleId)
        return ( collectibleId ~= nil and collectibleId ~= 0
                and IsCollectibleUnlocked(collectibleId)
                and IsCollectibleUsable(collectibleId, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
                and IsCollectibleValidForPlayer(collectibleId) )
                    or false
    end
 
    local uniqueEventUpdaterName = "MYADDON_NAME_COLLECTIBLE_EQUIP_UPDATER"
    local triedAlreadyNTimes = 0
    local function isStillBlocked(collectibleId)
        triedAlreadyNTimes = triedAlreadyNTimes + 1
        if triedAlreadyNTimes >= 10                                          --maximum 10 iterations = 5 seconds, to prevent an endless update check
                or not checkCollectibleUsableByPlayer(collectibleId) then    --can the player use this collectible at all?
            EVENT_MANAGER:UnregisterForUpdate(uniqueEventUpdaterName)
            triedAlreadyNTimes = 0
 
            return false
        end
 
        if not IsCollectibleBlocked(collectibleId, GAMEPLAY_ACTOR_CATEGORY_PLAYER) then --Is it not blocked any longer?
            EVENT_MANAGER:UnregisterForUpdate(uniqueEventUpdaterName)
            triedAlreadyNTimes = 0
 
            UseCollectible(collectibleId, GAMEPLAY_ACTOR_CATEGORY_PLAYER)   --Use the collectible now
            return true
        end
        return false
    end
 
 
    local function ArmoryBuildLoaded(_, result, buildIndex)
        if result ~= ARMORY_BUILD_RESTORE_RESULT_SUCCESS then
            d("Armory Load Failed")
            return false
        end
 
        ArmoryStyle.savedVariables.currentBuildIndex = buildIndex
 
        --Unregister any stil pending 2every 500ms" check
        EVENT_MANAGER:UnregisterForUpdate(uniqueEventUpdaterName)
 
        for collectibleType, id in pairs(ArmoryStyle.savedVariables.builds[buildIndex].collectibles) do
            local eqippedCollectible = GetActiveCollectibleByType(collectibleType, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
            if eqippedCollectible ~= id then
                if id ~= 0 then
                    if checkCollectibleUsableByPlayer(id) then
                        UseCollectible(id, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
 
                        return --exit the for ... do loop here as 1 collectible was equiped!
                    else
                        d("Error occurred Setting Collectible: " ..tostring(id))
 
                        --Check every 500ms if the collectible can be equipped - max 5 seconds
                        EVENT_MANAGER:RegisterForUpdate(uniqueEventUpdaterName, function() isStillBlocked(id) end, 500)
 
                        return --exit the for ... do loop here as 1 collectible will be equipped once it is not blocked anymore
                    end
                else
                    if eqippedCollectible ~= 0 then
                        if checkCollectibleUsableByPlayer(eqippedCollectible) then
                            -- If a collectible is already equipped then we want to 'un-use' the current one
                            UseCollectible(eqippedCollectible, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
 
                            return --exit the for ... do loop here as 1 collectible was equiped!
                        else
                            d("Error occurred with eqippedCollectible: " ..tostring(eqippedCollectible))
 
                            --Check every 500ms if the collectible can be equipped - max 5 seconds
                            EVENT_MANAGER:RegisterForUpdate(uniqueEventUpdaterName, function() isStillBlocked(eqippedCollectible) end, 500)
 
                            return --exit the for ... do loop here as 1 collectible will be equipped once it is not blocked anymore
                        end
                    end
                end
            end
        end
    end

I'm assuiming you only equip 1 collectible during that loop.
Else you'd have to create multiple of these EVENT_MANAGER:RegisterForUpdate with different unique names, one for each item slot to equip.

IsJustaGhost · 06/17/24, 03:22 AM

You can also call later using the collectible's cooldown time

I do that in one of my addons

Lua Code:

if id ~= 0 then
    if IsCollectibleUnlocked(id) and IsCollectibleUsable(id, GAMEPLAY_ACTOR_CATEGORY_PLAYER) and IsCollectibleValidForPlayer(id) then
        local remainingMs, durationMs = GetCollectibleCooldownAndDuration(id)
        local msg = zo_strformat("Equipping <<1>>", GetCollectibleName(id))
        --d(msg)
        zo_callLater(function()
            UseCollectible(id, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
        end, durationMs)
    else
        d("Error occurred Setting Collectible")
    end
else
    if eqippedCollectible ~= 0 then
        -- If a collectible is already equipped then we want to 'un-use' the current one
        local remainingMs, durationMs = GetCollectibleCooldownAndDuration(eqippedCollectible)
        local msg = zo_strformat("Un-Equipping <<1>>", GetCollectibleName(eqippedCollectible))
        --d(msg)
        zo_callLater(function()
            UseCollectible(eqippedCollectible, GAMEPLAY_ACTOR_CATEGORY_PLAYER)
        end, durationMs)
    end
end

remainingMs did not work but, durationMs did
Can even add a few MS for safety.