WoW:API GetAchievementInfo: Difference between revisions
Jump to navigation
Jump to search
(Added flag values) |
m (Move page script moved page API GetAchievementInfo to API GetAchievementInfo without leaving a redirect) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
Returns information about the given Achievement. New in [[Patch 3.0]] | Returns information about the given Achievement. New in [[Patch 3.0]] | ||
IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText = GetAchievementInfo(achievementID) | IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText, isGuildAch = GetAchievementInfo(achievementID) | ||
'''''OR''''' | '''''OR''''' | ||
IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText = GetAchievementInfo(categoryID, index) | IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText, isGuildAch = GetAchievementInfo(categoryID, index) | ||
---- | ---- | ||
| Line 32: | Line 32: | ||
:;Month : Integer - Month this was completed. Returns nil if Completed is false. | :;Month : Integer - Month this was completed. Returns nil if Completed is false. | ||
:;Day : Integer - Day this was completed. Returns nil if Completed is false. | :;Day : Integer - Day this was completed. Returns nil if Completed is false. | ||
:;Year : Integer - 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 : String - The Description of the Achievement. | :;Description : String - The Description of the Achievement. | ||
:;Flags : Integer | :;Flags : Integer | ||
| Line 40: | Line 40: | ||
:;Image : String - Path & file of the icon used for this achievement | :;Image : String - Path & file of the icon used for this achievement | ||
:;RewardText : String - Text describing the reward you get for completing this achievement. | :;RewardText : String - Text describing the reward you get for completing this achievement. | ||
:;isGuildAch : Boolean - true if guild achievement, false otherwise | |||
Latest revision as of 04:45, 15 August 2023
← WoW API < GetAchievementInfo
Returns information about the given Achievement. New in Patch 3.0
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
- (Integer achievementID)
- achievementID
- The ID number of the Achievement.
OR
- (Integer categoryID, Integer index)
- categoryID
- The achievement's category ID, as per GetAchievementCategory(achievementID).
- index
- The index for this achievement in the category. Between 1 and GetCategoryNumAchievements(categoryID).
- Returns
- IDNumber
- Integer - The achievement's ID number.
- Name
- String - The Name of the Achievement.
- Points
- Integer - Points awarded for completing this achievement.
- Completed
- Boolean - Returns true/false depending if you've completed this achievement.
- Month
- Integer - Month this was completed. Returns nil if Completed is false.
- Day
- Integer - Day 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
- String - The Description of the Achievement.
- Flags
- Integer
- 0x01 = Statistic
- 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