WoW:API GetAchievementInfo: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| 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( | IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText = GetAchievementInfo(achievementID) | ||
'''''OR''''' | |||
IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText = GetAchievementInfo(categoryID, index) | |||
---- | ---- | ||
;''Arguments'' | ;''Arguments'' | ||
:( | :(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). | |||
---- | ---- | ||
;''Returns'' | ;''Returns'' | ||
:;IDNumber : Integer - The | :;IDNumber : Integer - The achievement's ID number. | ||
:;Name : String - The Name of the Achievement. | :;Name : String - The Name of the Achievement. | ||
:;Points : Integer - Points awarded for completing this achievement. | :;Points : Integer - Points awarded for completing this achievement. | ||
Revision as of 00:38, 8 January 2009
← 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 = GetAchievementInfo(achievementID) OR IDNumber, Name, Points, Completed, Month, Day, Year, Description, Flags, Image, RewardText = 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.
- Description
- String - The Description of the Achievement.
- Flags
- Integer - Purpose unknown.
- Image
- String - Path & file of the icon used for this achievement
- RewardText
- String - Text describing the reward you get for completing this achievement.