WoW:API UnitCreatureFamily: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(created)
 
(Function returns nil if unit is not a creature)
Line 1: Line 1:
  <center>'''UnitCreatureFamily''' ''-Documentation by [[User:Boro|Boro]]-''</center>
  <center>'''UnitCreatureFamily''' ''-Documentation by [[User:Boro|Boro]]-''</center>


Returns the creature family of the specified unit (e.g., "Crab" or "Wolf").
Returns the creature family of the specified unit (e.g., "Crab" or "Wolf"), or nil if the unit does not have a creature family (e.g. because it is not a creature).


  local creatureFamily = UnitCreatureFamily(unit);
  local creatureFamily = UnitCreatureFamily(unit);
Line 30: Line 30:
;''Description''
;''Description''


: Returns the creature family of the specified unit (e.g., "Crab" or "Wolf").
: Returns the creature family of the specified unit (e.g., "Crab" or "Wolf"), or nil if the unit does not have a creature family (e.g. because it is not a creature).


----
----
{{Template:WoW API}}
{{Template:WoW API}}

Revision as of 22:40, 18 August 2005

UnitCreatureFamily -Documentation by Boro-

Returns the creature family of the specified unit (e.g., "Crab" or "Wolf"), or nil if the unit does not have a creature family (e.g. because it is not a creature).

local creatureFamily = UnitCreatureFamily(unit);

Arguments
(String unit)
unit
the unit name (e.g., "target", "mouseover")

Returns
creatureFamily
creatureFamily
a string representing the creature family (e.g., "Crab" or "Wolf")

Example
 if ( UnitCreatureFamily("target") == "Bear" ) then
   Jump(); -- jump for joy because you found Pooh bear
  end
Result

If the target is a bear, then you jump.


Description
Returns the creature family of the specified unit (e.g., "Crab" or "Wolf"), or nil if the unit does not have a creature family (e.g. because it is not a creature).

Template:WoW API