Summon: 1 particular companion

[jlrm365]

There are many addons to summon random pets (companions, if you prefer, known as pets in this post / thread).

NugMiniPet seemed to be working until recently but, for some reason, has just started to cause me interface issues.

I've yet to find a currently working addon that can summon just one chosen pet.

What I imagine is opening the lua and typing in a pet's name.
I then imagine a set of commands, using logic something like this:

- If player has a pet summoned, do not summon.
- If player does not have a pet summoned, then:
-- If player is not moving, don't summon.
-- If player is moving, summon [NAME]

I can see it being less than half a dozen lines, with no GUI. It only summons one pet and opening the LUA is the only way to change which pet is summoned.

I'm sure any solution would be more elegant than my logic, but that was just to illustrate my thinking.
Is such a thing, as an addon with the above logic steps, possible?

Thanks!

[semlar]

You only want it to summon a pet if the player is moving?

[Phanx]

1. The default UI already has a "/summonpet White Kitten" command to summon a specific companion pet.

2. However, if you really want to use an addon that prevents you from summoning the pet if you already have another one summoned or if you're not moving (why???) here you go. Use the "/favpet" command to summon the pet. You can optionally specify a different pet name, eg. "/favpet Leaping Hatchling".

-- Change this to the exact name of the pet you want to summon:
local DEFAULT_PET = "White Kitten"

-- Nothing below here needs to be changed.
SLASH_CALLFAVORITEPET1 = "/favpet"
SlashCmdList.CALLFAVORITEPET = function(petName)
	if InCombatLockdown() then
		-- You can't summon a pet in combat from insecure code.
		return
	end

	if GetUnitSpeed("player") == 0 then
		-- You aren't moving.
		return
	end

	if C_PetJournal.GetSummonedPetGUID() then
		-- You already have a summoned pet.
		return
	end

	if petName and strlen(petName) == 0 then
		-- Summon the default pet specified above if no other pet name
		-- was provided with the command:
		petName = DEFAULT_PET
	end

	local _, petGUID = C_PetJournal.FindPetIDByName(petName)
	if petGUID then
		-- Summon the desired pet:
		C_PetJournal.SummonPetByGUID(petGUID)
	else
		-- Pet not found. Alert the user so they can fix it:
		print(format("Pet %q not found!", petName))
	end
end

If you need help turning the above code into an addon, copy and paste it into this page:
http://addon.ziuo.net/

If that's not what you want, please describe what you want more clearly. If it doesn't work correctly, please describe what doesn't work and provide any error messages captured by BugSack.

[jlrm365]

Originally Posted by semlar You only want it to summon a pet if the player is moving?

No. I just wanted movement to be the trigger - as with NugMiniPet.
Often, standing still, I don't want a companion pet to be out.
Essentially what I wanted was the operation of NugMiniPet, but stripped down and to work with just a single companion.

Originally Posted by Phanx 1. The default UI already has a "/summonpet White Kitten" command to summon a specific companion pet.

Thanks for your code, as ever.
I shall study it and then form it into an addon.

[Phanx]

If you want it to happen automatically you probably want something like this:

local petName = "White Kitten"

local function CheckAndSummonPet()
	if InCombatLockdown() then
		-- You can't summon a pet in combat from insecure code.
		return
	end

	if C_PetJournal.GetSummonedPetGUID() then
		-- You already have a summoned pet.
		return
	end

	local _, petGUID = C_PetJournal.FindPetIDByName(petName)
	if petGUID then
		-- Summon the desired pet:
		C_PetJournal.SummonPetByGUID(petGUID)
	end
end

hooksecurefunc("MoveBackwardStart", CheckAndSummonPet)
hooksecurefunc("MoveForwardStart", CheckAndSummonPet)
hooksecurefunc("StrafeLeftStart", CheckAndSummonPet)
hooksecurefunc("StrafeRightStart", CheckAndSummonPet)

[jlrm365]

Originally Posted by Phanx If you want it to happen automatically you probably want something like this: local petName = "White Kitten" local function CheckAndSummonPet() if InCombatLockdown() then -- You can't summon a pet in combat from insecure code. return end if C_PetJournal.GetSummonedPetGUID() then -- You already have a summoned pet. return end local _, petGUID = C_PetJournal.FindPetIDByName(petName) if petGUID then -- Summon the desired pet: C_PetJournal.SummonPetByGUID(petGUID) end end hooksecurefunc("MoveBackwardStart", CheckAndSummonPet) hooksecurefunc("MoveForwardStart", CheckAndSummonPet) hooksecurefunc("StrafeLeftStart", CheckAndSummonPet) hooksecurefunc("StrafeRightStart", CheckAndSummonPet)

That's even better. I'll test it out now.

Really appreciate the time.

I realise you may not look at PMs, but never be in doubt that your help is appreciated.

It is.

[Phanx]

Originally Posted by jlrm365 I realise you may not look at PMs, ...

I do, in general, but any PMs asking for help with addons or coding are either ignored or replied with a form letter, so if your PM started with a request for help of some kind, I probably did not read the rest of it before deleting it.

[ravagernl]

In case you want to unsummon your pet when entering stealth/prowl/camouflage:

local petName = "White Kitten"
 
local _, class = UnitClass("player")
local stealthBuff = class == "ROGUE" and GetSpellInfo(1784) -- Stealth
    or class == "DRUID" and GetSpellInfo(5215) -- Prowl
    or class == "HUNTER" and GetSpellInfo(51753) -- Camouflage
--  or class == "MAGE" and GetSpellInfo(66) -- Invisibility (not sure if minipet also turns invisible??)
 
local function CheckAndSummonPet()
    if stealthBuff and UnitBuff("player", stealthBuff) and C_PetJournal.GetSummonedPetGUID() then
        -- You have a stealth buff and you have a companion out.
        DismissCompanion("CRITTER") -- I'm assuming this function still works and is available in combat??
        return
    end
    
    if InCombatLockdown() then
        -- You can't summon a pet in combat from insecure code.
        return
    end
 
    if C_PetJournal.GetSummonedPetGUID() then
        -- You already have a summoned pet.
        return
    end
 
    local _, petGUID = C_PetJournal.FindPetIDByName(petName)
    if petGUID then
        -- Summon the desired pet:
        C_PetJournal.SummonPetByGUID(petGUID)
    end
end
 
hooksecurefunc("MoveBackwardStart", CheckAndSummonPet)
hooksecurefunc("MoveForwardStart", CheckAndSummonPet)
hooksecurefunc("StrafeLeftStart", CheckAndSummonPet)
hooksecurefunc("StrafeRightStart", CheckAndSummonPet)

Note: this is untested

[jlrm365]

Originally Posted by ravagernl In case you want to unsummon your pet when entering stealth/prowl/camouflage: local petName = "White Kitten"   local _, class = UnitClass("player") local stealthBuff = class == "ROGUE" and GetSpellInfo(1784) -- Stealth     or class == "DRUID" and GetSpellInfo(5215) -- Prowl     or class == "HUNTER" and GetSpellInfo(51753) -- Camouflage --  or class == "MAGE" and GetSpellInfo(66) -- Invisibility (not sure if minipet also turns invisible??)   local function CheckAndSummonPet()     if stealthBuff and UnitBuff("player", stealthBuff) and C_PetJournal.GetSummonedPetGUID() then         -- You have a stealth buff and you have a companion out.         DismissCompanion("CRITTER") -- I'm assuming this function still works and is available in combat??         return     end         if InCombatLockdown() then         -- You can't summon a pet in combat from insecure code.         return     end       if C_PetJournal.GetSummonedPetGUID() then         -- You already have a summoned pet.         return     end       local _, petGUID = C_PetJournal.FindPetIDByName(petName)     if petGUID then         -- Summon the desired pet:         C_PetJournal.SummonPetByGUID(petGUID)     end end   hooksecurefunc("MoveBackwardStart", CheckAndSummonPet) hooksecurefunc("MoveForwardStart", CheckAndSummonPet) hooksecurefunc("StrafeLeftStart", CheckAndSummonPet) hooksecurefunc("StrafeRightStart", CheckAndSummonPet) Note: this is untested

Cool.
I've got the latest from Phanx in my folder.
I'll see how that goes and then try yours out another time.
If you happen to test it yourself, in the meantime, please do let us know how it went.

Thanks for the contribution, as that appears to be a nice tweak.

[endx7]

Originally Posted by ravagernl -- You have a stealth buff and you have a companion out.         DismissCompanion("CRITTER") -- I'm assuming this function still works and is available in combat??

Not sure if DismissCompanion still works in combat from insecure code, but when I last tested it, it only worked with pets you originally owned on that character before patch 5.0

[ravagernl]

Originally Posted by endx7 Not sure if DismissCompanion still works in combat from insecure code, but when I last tested it, it only worked with pets you originally owned on that character before patch 5.0

Thanks, confirmed. It doesn't work. There doesn't seem to be any way to dismiss an account wide minipet in combat

Updated/changed slightly, I included a way to trigger random pets (either from your favorites or from all your pets)

local petName = "Egbert"
local random = 1 -- 1 for favorite random, 0 for a random pet from all pets, false to disable a random pet

local _, class = UnitClass("player")
local stealthBuff = class == "ROGUE" and GetSpellInfo(1784) -- Stealth
    or class == "DRUID" and GetSpellInfo(5215) -- Prowl
    or class == "HUNTER" and GetSpellInfo(51753) -- Camouflage
--  or class == "MAGE" and GetSpellInfo(66) -- Invisibility (not sure if minipet also turns invisible??)

local function CheckAndSummonPet()
    local activePet = C_PetJournal.GetSummonedPetGUID()

    if stealthBuff and UnitBuff("player", stealthBuff) then
        if activePet then
            -- You have a stealth buff and you have a minipet out.
            -- Can we use the journal functions?
            if not InCombatLockdown() then
                -- if the active pet is summoned again, it is dismissed using the journal function
                C_PetJournal.SummonPetByGUID(activePet)
            else
                -- Try the old function, this one works in combat for pets you actually own on your character.
                -- There is no way to unsummon account wide minipets in combat :(
                DismissCompanion("CRITTER")
            end
        end
        return
    end

    if InCombatLockdown() then
        -- You can't summon a pet in combat from insecure code.
        return
    end

    if activePet then
        -- You already have a summoned pet.
        return
    end

    if random == 1 or random == 0 then
        -- Summon a random pet (either a favorite(1) or from all pets(0) )
        C_PetJournal.SummonRandomPet(random == 1)
        return
    end

    local _, petGUID = C_PetJournal.FindPetIDByName(petName)
    if petGUID then
        -- Summon the desired pet:
        C_PetJournal.SummonPetByGUID(petGUID)
    end
end

hooksecurefunc("MoveBackwardStart", CheckAndSummonPet)
hooksecurefunc("MoveForwardStart", CheckAndSummonPet)
hooksecurefunc("StrafeLeftStart", CheckAndSummonPet)
hooksecurefunc("StrafeRightStart", CheckAndSummonPet)

This was tested

[Phanx]

You can detect stealth more efficiently by using macro conditionals:

if SecureCmdOptionParse("[stealth]") then
     print("You are stealthed.")
end

[semlar]

There's no point in dismissing your pet while stealthed, nobody else will be able to see it.

[ravagernl]

Originally Posted by semlar There's no point in dismissing your pet while stealthed, nobody else will be able to see it.

I didn't know that, since which patch?

EDIT: since 4.2 /facepalm

[semlar]

Pets have stealthed with the player since 4.1, which was 2 years ago.