WoW:API UnitSex: Difference between revisions

← Older edit

WoW:API UnitSex (source)

Revision as of 04:47, 15 August 2023

252 bytes removed , 15 August 2023

m

Move page script moved page API UnitSex to WoW:API UnitSex without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-<center>'''UnitSex''' - ''Documentation by [[User:Itchyban|Itchyban]]''</center>
+{{wowapi}}
-== Synopsis ==
 Returns the gender of the specified unit.
   gender_code = UnitSex("unit")
-== Arguments ==
+== Parameters ==
+=== Arguments ===
 :("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 : Integer -- 0 => Male, 1 => Female, 2 => Neuter/Unknown
+;gender_code : Number:
+:* 1 = Neutrum / Unknown
+:* 2 = Male
+:* 3 = Female
-NOTE:
-In 1.11 this will change to 0 => Unknown, 1 => Male and 2=> Female (I think)
-[[User:Sarf|Sarf]] 01:01, 16 June 2006 (EDT)
-In 1.11 For UnitSex("player") : 2 => Male, 3 => Female, Another ... I don't know ^^
+== Example ==
-[[User:Mortasgus|Mortasgus]] 20:08, 24 June 2006 (EDT)
+ local genderTable = { "neuter or unknown", "male", "female" };
+ DEFAULT_CHAT_FRAME:AddMessage('Target is ' .. genderTable[UnitSex("target")] .. '.');
-== Example ==
-<!-- begin code -->
- local genderTable = {};
- 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 ====
-:Prints the target's gender to the chat frame. e.g.,
-<!-- begin code -->
   Target is female.
-<!-- end code -->
 == 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]])