WoW:API HasPetUI: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Move page script moved page API HasPetUI to API HasPetUI without leaving a redirect)
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<center>'''HasPetUI''' ''-Documentation by AlexanderYoshi-''</center>
{{wowapi}}
Returns <tt>1</tt> if the player has a pet User Interface.


Returns true if the player has a pet User Interface.
  hasUI, isHunterPet = HasPetUI();
 
  hasUI = HasPetUI();


----
----
Line 13: Line 12:
;''Returns''
;''Returns''


:hasUI
:hasUI, isHunterPet
:;hasUI :Boolean - <tt>true</tt> if the player has a pet User Interface.
:;hasUI :The number <tt>1</tt> if the player has a pet User Interface, <tt>nil</tt> if he does not.
:;isHunterPet :The number <tt>1</tt> if the pet is a hunter pet, <tt>nil</tt> if it is not.


----
----
Line 20: Line 20:
   if ( HasPetUI() ) then DoPetStuff(); end
   if ( HasPetUI() ) then DoPetStuff(); end


;''Result''
;''Example''
true | false
  local hasUI, isHunterPet = HasPetUI();
 
  if hasUI then
----
    if isHunterPet then
;''Description''
      DoHunterPetStuff(); -- For hunters
 
    else
: Returns true if the player has a pet User Interface.
      DoMinionStuff(); -- For Warlock minions
    end
  end


----
----
{{Template:WoW API}}
;''Known Issues''
[[Category:API Functions|HasPetUI]]
Does not work for Frost Mages' Water Elemental pets.  Even with a Water Elemental out (and the Pet UI showing), HasPetUI() returns nil,nil
[[Category:API Pet Functions|HasPetUI]]

Latest revision as of 04:46, 15 August 2023

WoW API < HasPetUI

Returns 1 if the player has a pet User Interface.

hasUI, isHunterPet = HasPetUI();

Arguments
none

Returns
hasUI, isHunterPet
hasUI
The number 1 if the player has a pet User Interface, nil if he does not.
isHunterPet
The number 1 if the pet is a hunter pet, nil if it is not.

Example
 if ( HasPetUI() ) then DoPetStuff(); end
Example
 local hasUI, isHunterPet = HasPetUI();
 if hasUI then
   if isHunterPet then
     DoHunterPetStuff(); -- For hunters
   else
     DoMinionStuff(); -- For Warlock minions
   end
 end

Known Issues

Does not work for Frost Mages' Water Elemental pets. Even with a Water Elemental out (and the Pet UI showing), HasPetUI() returns nil,nil