Compaions API broken ?

gmarco · 11-16-12, 01:01 AM

Hi,

I am trying to make an addon about companions / pets but I always get an error when I use the function:

Lua Code:

CallCompanion("CRITTER",index);

where index <= GetNumCompanions("CRITTER")

The error is something like in English "You don't have any pets" (in italian is "Non hai un famiglio").

But a simple for loop print the name of all my pets:

Lua Code:

for index=1,GetNumCompanions("CRITTER") do
   local _,name=GetCompanionInfo("CRITTER",index);
   print(name:lower())
end

Also the other summon function

Lua Code:

SummonRandomCritter()

gives to me the same error.

Probably the new pet combat system broken the api.

Am I looking in a wrong place for outdated documentation ? (http://wowprogramming.com and http://www.wowwiki.com/API_CallCompanion)

Should I use an external library like LibPetJournal ?

Or simply I missing something ? :-)

Thanks in advance for any help.

Torhal · 11-16-12, 01:41 AM

The code you posted will only work for old-style (pre 5.x) pets. You'll need to use the C_PetJournal functions for them now to access both old and new-style. Take a look at some of the newer Pet-centric AddOns (such as Pet Theory) for some code examples.

I'd use WoWPedia over WoWWiki, as it's much better maintained.

Phanx · 11-16-12, 02:49 AM

To clarify, the old API functions will still work for any companion pets your character had before Patch 5.0.4, but they will not work for any companion pets that were originally learned by one of your other characters before Patch 5.0.4 (even though they are now "known" by all of your characters), and they will not work for any companion pets learned by any character after the release of Patch 5.0.4.

gmarco · 11-16-12, 02:32 PM

Ok I made a little addon to summon a random companion fom the full collection or from a custom category is defined.

Like mine first addon you can define some samples category like:

Lua Code:

pets = { 
   
   funny = {
        "Willy",
        "Toothy",
   },
   
   rare = {
        "Senegal",
        "Pengu",
        "Azure Whelphling",
        "Baby Blizzard Bear",
   },
    
    cat = {
        "Cornish Rex Cat",
        "Bombay Cat",
        "Orange Tabby Cat",
    },
   
    favorite = {
        "Ravasaur Hatchling",
        "Razzashi Hatchling",
        "Proto-Drake Whelp",
    },
   
   -- add your custom categories here
}

and then use the magic way "Phanx" macro :-) to use the program:

/gimb [btn:2] rare; [btn:3] funny;

There is a little "help" switch to show the available options.

I post it here so I hope that someone can give it a try to check it before I commit to the public :-)

Thanks again to you for all the help and suggestions.

gmarco · 11-16-12, 03:03 PM

- first little bug I have found: /gimb remove could not be launched in a macro.

"gimbolino unable to find category remove"

Uhm ... I think I should check the args parsing ... this unknown thing ! :-)

Any tips are welcome :-)

SDPhantom · 11-16-12, 05:36 PM

I'm trying to find the problem too, but I'm not seeing it. I'm at work now, I'll have to run the code later and poke around in it.

gmarco · 11-17-12, 03:36 AM

Could it be due the fact that only category is parsed in the "SecureCmdOptionParse" function ? If I add the call also for args ...

SlashCmdList["GIMBOLINO"] = function(args)

local category=SecureCmdOptionParse(args);
local args=SecureCmdOptionParse(args);

if args:lower() == "help" then
print(prgname .. " commands");
print("/gimb help - This help");
print("/gimb remove - Dismiss an active pets");
print("/gimb - Random summon a pet from your complete collection");
print("/gimb <category> - Random summon a pet from your custom <category> ");
return;
end

if args:lower() == "remove" then
print(prgname .. " is dismiss the active companion");
DismissCompanion("CRITTER");
return;
end

if not category then
return;
end

etc etc....

In this way it seems to work... but is it fine ?

macro like:
/gimb [btn:2] rare; [mod:alt] funny; [mod:shift] remove;

gmarco · 11-17-12, 04:10 AM

I also added a declaration of :

-- if categories.lua is not found
pets = {};

otherwhise it triggers an error if trying to summon from a category when the category.lua is missing.

Now it returns with "category not found message" much more friendly :-)

and modified the toc files in this way:

core.lua
categories.lua

if the order of definitions is important.

I think now it should be ready to be committed ...

Phanx · 11-17-12, 10:28 PM

If you do this:

Code:

	local category=SecureCmdOptionParse(args);
	local args=SecureCmdOptionParse(args);

... then both category and args will have identical values.

After looking through your code, I see that you're currently creating a global named pets. This is a really bad idea, since pets is a very generic name, and any other addon that creates a global variable with the same name (even by accident) will overwrite it, breaking your addon (or theirs). I'd suggest using the "private namespace table" that all addons get nowadays. Put this at the top of each of your Lua files:

Code:

local _, pets = ...

Now pets is a table local to your addon, but accessible from all of your addon's files.

Also, your example macro in the comments in the addon file:

Code:

/gimb [btn:2] rare [mod:alt] funny [mod:shift] remove

... is incorrect. Remember, this needs to follow all the same rules as "real" macros, so each condition needs to be separated by a semicolon:

Code:

/gimb [btn:2] rare; [mod:alt] funny; [mod:shift] remove

Finally, you don't need a semicolon at the end of lines in Lua. Unless you're used to programming in another language where semicolons are required, and find the habit hard to break, I'd suggest getting rid of them to keep your code clean.

See attached file for these modifications, plus some general cleanup.

SDPhantom · 11-18-12, 06:10 AM

I removed the LibPetJournal-2.0 library and converted the code to use the C_PetJournal API directly. I also made the code a bit more verbose as well as added the ability for the user to modify the categories in-game through the chat command system. Categories should now be saved across sessions too. The new code also uses an experimental method of unregistering the filter update event before setting them to what it needs, then resetting them to the previous settings before restoring the event. This should improve performance slightly since it'll prevent the filter update from running unnecessary code while Gambolino is trying to work.

Code:

Gimbolino usage
/gimb help - This help
/gimb dismiss - Dismiss an active pet
/gimb add <category> <pet> - Adds a pet to a category
/gimb remove <category> <pet> - Removes a pet from a category
/gimb delete <category> - Deletes a category
/gimb - Random summon a pet from your complete collection
/gimb <category> - Random summon a pet from your custom <category>

<< Download removed to conserve attachment space >>