WoW:API GetQuestLogLeaderBoard: Difference between revisions

WoW:API GetQuestLogLeaderBoard (source)

293 bytes added , 9 November 2005

m

fixed parameter name

Anonymous user

@@ Line 1: / Line 1: @@
 This function returns up to 3 values:
-local title, type, done GetQuestLogLeaderBoard(i)
+ local desc, type, done = GetQuestLogLeaderBoard(i, [questID])
-Where "i" is the index of the quests objectives (see GetNumQuestLeaderBoards ).
+----
-title is something like: "Kill foo: 0/3"
+;''Arguments''
-type could be the following things: "item" or "monster"
-and done is nil if this sub objective is not completed yet, else it is 1
+:;i : Index of the quests objectives (see [[API GetNumQuestLeaderBoards|GetNumQuestLeaderBoards()]] ).
+:;questID : Identifier of the quest. If not provided, default to the currently selected Quest, via [[API SelectQuestLogEntry|SelectQuestLogEntry()]].
+----
+;''Return values''
+:;desc : String - The text description of the objective, like: "Kill foo: 0/3"
+:;type : String - could be the following things: "item" or "monster".
+:;done : Boolean - ''nil'' if this sub objective is not completed yet, else 1
 [[Category:API Functions|GetQuestLogLeaderBoard]]
 [[Category:API Quest Functions|GetQuestLogLeaderBoard]]