1
0
EQ2Emu/docs/lua_functions/GetCosmeticPet.md
2025-05-13 22:57:49 -04:00

17 lines
556 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Function: GetCosmeticPet(Spawn)
Description: Returns the cosmetic pet (fun pet) entity of the given player if one is currently summoned.
Parameters:
Spawn: Spawn The player whose cosmetic pet to retrieve.
Returns: Spawn The cosmetic pet spawn if active, or nil if the player has no cosmetic pet out.
Example:
-- Example usage (pet-related quest checking if a particular pet is summoned)
local pet = GetCosmeticPet(Player)
if pet ~= nil and GetName(pet) == "Frostfell Elf" then
Say(NPC, "I see you have a festive friend with you!")
end