[Cata] C_MountJournal.SummonByID

[Emasym]

print("Summoning Mount: " .. companion.name .. " " .. companion.id)
C_MountJournal.SummonByID(companion.id)

Hello!

Anyone have any idea by C_MountJournal.SummonById randomly summons Swift Gray Ram even though that's totally not the argument it's getting?

Happens truly sporadically and I can't make sense of it

[Xrystal]

Where is your companion info coming from ?

Is companion.id the mountID ?

My dragonriding addon had no issues using SummonByID so unless something has messed up since then, maybe you are using the wrong id, or using it or getting the info at the wrong time ?

[Emasym]

I'm ghetto-updating an existing addon from WotLK so it's possible something goes amiss.

local mountIDs = C_MountJournal.GetMountIDs()
for i, mountID in ipairs(mountIDs) do
   local name, spellId, _, _, _, _, _, _, faction, hideOnChar, isCollected = C_MountJournal.GetMountInfoByID(mountID)
   if (isCollected and hideOnChar ~= true) then
      if faction == nil then
         faction = playerFaction
      end
      if faction == playerFaction then
         needsCacheUpdate = needsCacheUpdate or (name == nil)
         local info = MountSpellIds[spellId]
         if info ~= nil then
            local creatureId = C_MountJournal.GetMountInfoExtraByID(mountID) or 0
            local e = {name = name, spellId = spellId, id = mountID, type = info, creatureId = creatureId}
            table.insert(allMounts, e)
         end
      end
   end
end

Later their ids get normalised to spellID
(I've added prints here and it doesn't ever seem to do anything)

for k, v in pairs(self.allMounts) do
   if v.spellId == spellId and v.id ~= i then
      v.id = i
      break
   end
end

While it's possible Ids get retrieved / stored incorrectly, the bug happen utterly at random, with different expected mounts each time.

Every now and then it will just randomly decide "we're not doing this mount - we're doing the ram instead".
It is not populated in the table.

In the below screenshot, after doing the blue dragonhawk correctly a couple of times, suddenly it's the ram again.
The table only gets modified on load.

/script C_MountJournal.SummonByID(291)

This will always pull out the Blue Dragonhawk and I can't get it to bug

"MountSpellIds" is a local hardcoded list of mounts and their ids, all mounts are present and while shitty code it shouldn't affect this.

[Xrystal]

What is i in this block of code ?
Where did you put the print statements and are you saying they didn't show ? Or didn't show anything unexpected ?
What version of wow are you using this in ? In case that is a factor.

for k, v in pairs(self.allMounts) do
   if v.spellId == spellId and v.id ~= i then
      v.id = i
      break
   end
end

The reason why I ask is because if this is a step between setting up the table and using the table it might be setting the id to the wrong value.

[Xrystal]

As an example.. my Dragonflight Mount addon calls the below function once on PLAYER_LOGIN
I've made an adjustment for testing purposes to see whether there is a problem with other mounts.
But, adding valid mounts to the list for use in the random mount selection criteria part of my addon consistently summoned the right mount.

The only difference between mine and yours is that you are making changes to the mountID for some reason ( see my previous response ). Depending on what your addon is aimed to do, is whether it needs to change it.

local function BuildDynamicFlightMountsList()
    
    local mountIDs = C_MountJournal.GetMountIDs()
    --local mountIDs = C_MountJournal.GetCollectedDragonridingMounts()
    local englishFaction, localizedFaction = UnitFactionGroup("player")
    addonNS.mountList = {}
    
    for i,v in ipairs(mountIDs) do
        local name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding = C_MountJournal.GetMountInfoByID(v)
 
        local isWrongFaction = isFactionSpecific and ( faction ~= englishFaction)
        
        if isCollected and (not isWrongFaction) and isUsable then
        
            table.insert(addonNS.mountList,
            {
                ["index"] = i,
                ["mountID"] = mountID,
                ["name"] = name,
                ["spellID"] = spellID,
                ["icon"] = icon,
                ["isActive"] = isActive,
                ["isUsable"] = isUsable,
                ["isCollected"] = isCollected,
                ["isForDragonriding"] = isForDragonriding,
            })
        end
    end
    
end

[Emasym]

Thank you very much for your replies.

The full code for the "updating id" thing and where i comes from:

for i = 1, GetNumCompanions("MOUNT") do
local _, name, spellId = GetCompanionInfo("MOUNT", i)

However, I've commented out every part of this code and the behavior is still the same.

The print() statements I added that didn't fire where right before setting

v.id = i

Which lead me to believe this part didn't do anything, anyway.

I've made a pastebin of the complete lua file
https://pastebin.com/b5iiDhbQ

[Xrystal]

Looking at the code it looks like this was written for the original Wrath of the Lich King. So, it is possible that some of the functionality is silently failing in the current versions of wow at the moment.

I couldn't test it fully as half the code doesn't execute because it is behind a custom frame ( likely in an xml file ).

Summonning a random pet worked fine ( if it was supposed to ignore the ones I had favourited in the blizzard pet journal).


Which version of wow are you using this on ?

Classic Era
Classic Cata
Retail Dragonflight

Seeing as a fair bunch of the API in Classic Cata is from Dragonflight, you might find it easier to rethink the project based on what is currently available in the game and API and add what's missing. Especially seeing as it looks like it was created before Blizzard added the PetJournal and MountJournal in game themselves.

For example: You might be able to utilise ( https://warcraft.wiki.gg/wiki/API_C_....SetTypeFilter ) to automatically filter specific types of mounts to generate a list that way. I did try to test this in my dragonriding addon but ended up breaking it in a different area for some reason. So might have to rig up a blank addon for that purpose.

[Emasym]

It was fully functional on wotlk classic (and does feature a couple "ifs" regarding game version).
I'm now attempting to use it on Cata classic (which, as you mentioned, should use the DF API). And it works! Except for the occassional ram!

The most striking thing to me is how I can fully print that the info is correct and well received, and the next thing is a wow lua api call using the printed argument, yet the result is inconsistent.
No amount of faulty code should cause this to happen, and it's really stumping me on a low-level level.
(Mind you, good point about using more C_MountJournal functionality, it definitely should).

Thank you very much for testing and helping so in depth.
If you're curious as well, and it's clear you have a better view of this than I have, I've uploaded the addon in its entirety (lua, xml, toc) on wetransfer https://we.tl/t-Rzci8I2wB9 .

The key of this, to me, is still in where it goes wrong in:

function RandomMount_SummonMount(companion)
   print("Summoning Mount: " .. companion.name .. " " .. companion.id)
   C_MountJournal.SummonByID(companion.id)
end

The printing is fine and consistent, but the SummonById is not.

Again, thank you very much for giving this your time. I'm aware there's potentially up-to-date addons out there that will do the same thing, and will do it without throwing a ram in there, but I'm still simply curious.

EDIT: I'm testing further, without the `UpdateCompanionIds` called, Violet Netherwing Drake does get id 95, and SummonByID(95) ís the ram. So you're correct that it's entirely possible it's fetching wrong info at some point. Argh!

EDIT2: I threw out Violet Netherwing Drake from my addon "favourites" and now it seems fine. Must be a data mismatch between wotlk & cata. I see the addon scans current list of mounts by number, and it's entirely possible the logic is screwed somewhere.
Again, thank you very much for your help.
Instead of an addon, I'll simply resort to C_MountJournal.SummonByID(0) :-)

[Xrystal]

I'm giving the new functions a test ( never used them before ) but it seems like you can adjust the filters programmatically and then generate a list based on that ( probably best to see if you can store the players setup before doing so for public use ).

So, instead of a hard coded list, you might be able to generate a list based on type ( ground, flying, aquatic, dragonriding ) which you could then use in conjunction with the environment the player is in, at the time of summoning.

For quick access to the main api for the mount journal ( https://warcraft.wiki.gg/wiki/World_...#Mount_Journal )


But yes, it is quite annoying, but, maybe the issue is perhaps the hardcoded list has been slowly getting out of date so to speak.


There are two events which may be of use :
MOUNT_JOURNAL_USABILITY_CHANGED
MOUNT_JOURNAL_SEARCH_UPDATED

The first one triggers at least on login
The second one triggers every time you adjust the filters ( either manually or automatically ).

But .. I ended up not using those events... At player login I just filtered the journal and generated a filtered list of mounts and filled the appropriate table with the info I wanted.

Feel free to grab, test and utilise as needed

local function GenerateMountLists()
    
    C_MountJournal.SetAllSourceFilters(true)
    C_MountJournal.SetAllTypeFilters(false)
    C_MountJournal.SetCollectedFilterSetting(1, true) -- Collected
    C_MountJournal.SetCollectedFilterSetting(2, true) -- Not Collected
    C_MountJournal.SetCollectedFilterSetting(3, false) -- Unusable - setting this to false will remove the mounts that are for a different class/faction etc
    -- None of these filters will filter out mounts you can't fly in a no fly zone ( because you haven't gained that ability yet in the area etc )
 
    -- Clear Saved Variable Tables used for Testing
    XMount_Flying = {}
    XMount_Ground = {}
    XMount_Dragonriding = {}
    XMount_Aquatic = {}
    
    for i = 1,4 do
        
        -- Set the type filter up 
        C_MountJournal.SetTypeFilter(i, true)
        
        -- Get the number of mounts that fit the filter
        local numMounts = C_MountJournal.GetNumDisplayedMounts()
        
        for index = 1, numMounts do
        
            local name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID
        = C_MountJournal.GetDisplayedMountInfo(index)
 
-- There might be more return values here including whether it is a dragonriding mount -- 
-- I forgot to check that when I copied the function in -- 
           
            if i == 1 then
                XMount_Ground[mountID] = {
                    ["Name"] = name,
                    ["spellID"] = spellID,                    
                }
            elseif i == 2 then
                XMount_Flying[mountID] = {
                    ["Name"] = name,
                    ["spellID"] = spellID,                    
                }
            elseif i == 3 then
                XMount_Aquatic[mountID] = {
                    ["Name"] = name,
                    ["spellID"] = spellID,                    
                }
            elseif i == 4 then
                XMount_Dragonriding[mountID] = {
                    ["Name"] = name,
                    ["spellID"] = spellID,                    
                }
            end
        end
        
        C_MountJournal.SetTypeFilter(i, false)
    end
    
end

I didn't use them ( as this is just a fun project ) but, they do have these functions which I assume can be used to grab the various filter settings on login that the user may have set up

C_MountJournal.GetCollectedFilterSetting(filterIndex)
C_MountJournal.IsSourceChecked(filterIndex)
C_MountJournal.IsTypeChecked(filterIndex)
-- Addon does stuff
C_MountJournal.SetSourceFilter(filterIndex, isChecked)
C_MountJournal.SetTypeFilter(filterIndex, isChecked)
C_MountJournal.SetCollectedFilterSetting(filterIndex, isChecked)

You could check for this first though and use the appropriate setting afterwards and if they are not using the default filters then use the functions above to do the manual gets and sets.

C_MountJournal.IsUsingDefaultFilters()
--- Addon does stuff
C_MountJournal.SetDefaultFilters()

[Xrystal]

Yes, the built in one should work fine for what you need. That's the reason why I only created a dragonriding one, because they just wanted a button to randomise their dragonriding mounts instead.

[Emasym]

That is genius - thank you very much, very clean code :-)

I've never done an addon from scratch, just tinkering where required / interesting, so thank you very much for pointing me to the right direction.

You've been a scholar and a gentleman, thank you again.

[Xrystal]

No problem.

It could be a learning curve for you.