WoW:API SetCurrentTitle: Difference between revisions

WoW:API SetCurrentTitle (source)

Revision as of 21:50, 10 December 2009

43 bytes added , 10 December 2009

boilerplate

Anonymous user

WoWWiki>Starlightblunder

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
+Changes your character's displayed title.
-One line summary description of function.
+ SetCurrentTitlte(titleId);
 == Arguments ==
-[[TitleId]]
+; titleId : Number - ID of the title you want to set. The identifiers are global and therefore do not depend on which titles you have learned. Invalid or unlearned values clear your title. See [[TitleId]] for a list.
-: Number - Index of the title you want to set.
-== Returns ==
-nil
 == Example ==
@@ Line 15: / Line 11: @@
 This sets the title "Chef" if your character had earned the title, otherwise it removes any active title.
-  /script i=0 while (IsTitleKnown(i)==0) do i=random(GetNumTitles()) end SetCurrentTitle(i)
+  /script repeat i = random(GetNumTitles()) until IsTitleKnown(i) == 1; SetCurrentTitle(i)
 This will set a random title. (Warning: quick'n'dirty: may hang WoW if no title available. May cause lag if only few titles are available.)
 == Details ==
-*The last indexed value (currently 143) returns nil and removes the player's name completely (not available to players).
+* The last indexed value (currently 143) returns nil and removes the player's name completely (not available to players).
-*Title index -1 will clear titles from the player's name. (Option "None" from the Character frame's title dropdown menu.)
+* [[API GetTitleName|GetTitleName]] can be used to find the name associated with the [[TitleId]].
-*[[API GetTitleName|GetTitleName]] can be used to find the name associated with the [[TitleId]].