WoW:API GetAchievementInfo: Difference between revisions

← Older edit

WoW:API GetAchievementInfo (source)

Revision as of 04:45, 15 August 2023

813 bytes added , 15 August 2023

m

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

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
 {{wowapi}}
-Returns information about the given Achievement.
+Returns information about the given Achievement.  New in [[Patch 3.0]]
-  IDNumber, Title, Points, Completed, Month, Day, Year, Description, Unknown1, Image, Unknown2 = GetAchievementInfo(AchievementID);
+  IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText, isGuildAch = GetAchievementInfo(achievementID)
+ '''''OR'''''
+ IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText, isGuildAch = GetAchievementInfo(categoryID, index)
 ----
 ;''Arguments''
-:(Number AchievementID)
+:(Integer achievementID)
+:;achievementID : The ID number of the Achievement.
+'''''OR'''''
+:(Integer categoryID, Integer index)
+:;categoryID : The achievement's category ID, as per [[API_GetAchievementCategory|GetAchievementCategory]](achievementID).
+:;index : The index for this achievement in the category. Between 1 and [[API_GetCategoryNumAchievements|GetCategoryNumAchievements]](categoryID).
-:;AchievementID : The ID of the Achievement.
 ----
 ;''Returns''
-:;IDNumber : The AchievementID Number.
+:;IDNumber : Integer - The achievement's ID number.
-:;Title : The Title of the Achievement.
+:;Name : String - The Name of the Achievement.
-:;Points : Points awarded for completing this achievement.
+:;Points : Integer - Points awarded for completing this achievement.
-:;Completed : Returns true/false depending if you've completed this achievement.
+:;Completed : Boolean - Returns true/false depending if you've completed this achievement.
-:;Month : Month this was completed. Returns nil if Completed is false.
+:;Month : Integer - Month this was completed. Returns nil if Completed is false.
-:;Day : Day this was completed. Returns nil if Completed is false.
+:;Day : Integer - Day this was completed. Returns nil if Completed is false.
-:;Year : Year this was completed. Returns nil if Completed is false.
+:;Year : Integer - Year this was completed. Returns nil if Completed is false. Returns number of years since 2000.
-:;Description : The Description of the Achievement.
+:;Description : String - The Description of the Achievement.
-:;Unknown1 : Unknown
+:;Flags : Integer
-:;Image : Path & file of the icon used for this achievement
+:::0x01 = Statistic
-:;Unknown2 : Unknown, usually returns blank, not nil.
+:::0x02 = Hidden
+:::0x80 = Progress Bar
+:;Image : String - Path & file of the icon used for this achievement
+:;RewardText : String - Text describing the reward you get for completing this achievement.
+:;isGuildAch : Boolean - true if guild achievement, false otherwise