WoW:API UnitSex: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
m (Move page script moved page API UnitSex to API UnitSex without leaving a redirect)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<center>'''UnitSex''' - ''Documentation by [[User:Itchyban|Itchyban]]''</center>
{{wowapi}}


== Synopsis ==
Returns the gender of the specified unit.
Returns the gender of the specified unit.


  gender_code = UnitSex("unit")
  gender_code = UnitSex("unit")


== Arguments ==
== Parameters ==
=== Arguments ===
:("unit")
:("unit")


:;unit : String -- The [[API TYPE UnitId|UnitId]] to query (e.g. "player", "party2", "pet", "target" etc.)
;unit : String -- The [[API TYPE UnitId|UnitId]] to query (e.g. "player", "party2", "pet", "target" etc.)


== Returns ==
=== Returns ===
:gender_code
:gender_code


:;gender_code : Integer -- 0 => Male, 1 => Female, 2 => Neuter/Unknown
;gender_code : Number:
:* 1 = Neutrum / Unknown
:* 2 = Male
:* 3 = Female




== Example ==
== Example ==
<!-- begin code -->
  local genderTable = { "neuter or unknown", "male", "female" };
  local genderTable = {};
  DEFAULT_CHAT_FRAME:AddMessage('Target is ' .. genderTable[UnitSex("target")] .. '.');
genderTable[0] = "male";
 
genderTable[1] = "female";
genderTable[2] = "neuter or unknown";
local targetGenderCode = UnitSex("target");
  DEFAULT_CHAT_FRAME:AddMessage('Target is ' .. genderTable[targetGenderCode] .. '.');
<!-- end code -->
==== Result ====
==== Result ====
:Prints the target's gender to the chat frame. e.g.,
<!-- begin code -->
  Target is female.
  Target is female.
<!-- end code -->


== Details ==
== Details ==
: UnitSex("target") (or any likely any other unit) will return 2 (neuter/unknown) on "sheeped" mobs, no matter their "true" gender.
* UnitSex("target") will return 1 (neuter/unknown) on "sheeped" mobs, no matter their "true" gender. <small>(Needs reverification after 1.11)</small>. UnitSex("player") does not return 1 on "penguinification".
 
 
== Comments ==
 
Thanks to Octon for the nicely formatted [[API UnitName|UnitName]] page I "stole" for this.


* Prior to v1.11, the codes were 0=male, 1=female, 2=unknown.


----
== Notes ==
{{WoW API}}
* If "unit" doesn't exist (e.g. UnitSex("target") when you have no target), UnitSex() will return 0.<br/> Previously, it would return 2. (As seen on [[Talk:World of Warcraft API#API_UnitSex.28.22target.22.29_:_What_if_there_is_no_selected_target_.3F|Talk:World of Warcraft API]])

Latest revision as of 04:47, 15 August 2023

← WoW API < UnitSex

Returns the gender of the specified unit. 

gender_code = UnitSex("unit")

Parameters[edit]

Arguments[edit]

("unit")
unit
String -- The UnitId to query (e.g. "player", "party2", "pet", "target" etc.)

Returns[edit]

gender_code
gender_code
Number:
  • 1 = Neutrum / Unknown
  • 2 = Male
  • 3 = Female


Example[edit]

local genderTable = { "neuter or unknown", "male", "female" };
DEFAULT_CHAT_FRAME:AddMessage('Target is ' .. genderTable[UnitSex("target")] .. '.');

Result[edit]

Target is female.

Details[edit]

  • UnitSex("target") will return 1 (neuter/unknown) on "sheeped" mobs, no matter their "true" gender. (Needs reverification after 1.11). UnitSex("player") does not return 1 on "penguinification".
  • Prior to v1.11, the codes were 0=male, 1=female, 2=unknown.

Notes[edit]

  • If "unit" doesn't exist (e.g. UnitSex("target") when you have no target), UnitSex() will return 0.
    Previously, it would return 2. (As seen on Talk:World of Warcraft API)
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_UnitSex&oldid=20107"