Achievements
C→S 219 - RequestAchievements
Nitro:
ACHIEVEMENT_LIST- Request achievements→achievement list.
Requests the full achievement list with the current progress on each achievement.
Body: (empty)
S→C 305 - Achievements
Nitro:
ACHIEVEMENT_LISTSource:AchievementListComposer,AchievementsEvent
Delivers the full achievement list with level, points, badge codes, and progress data for each achievement. Displayed in the achievements screen.
| Field | Type | Notes |
|---|---|---|
| count | int | Number of achievement entries |
| [count × entry] | - | Achievement entry |
| entry.achievementId | int | Achievement ID |
| entry.level | int | Current level achieved |
| entry.badgeCode | string | Badge code |
| entry.scoreAtStartOfLevel | int | Score value at the start of current level |
| entry.scoreLimit | int | Total score value for current level |
| entry.levelRewardPoints | int | Points rewarded on completing this level |
| entry.levelRewardPointType | int | Currency type for level reward |
| entry.currentPoints | int | Player's current progress score |
| entry.finalLevel | boolean | Whether this is the last level of the achievement |
| entry.category | string | Category name |
| entry.subCategory | string | Sub-category name |
| entry.levelCount | int | Total number of levels in this achievement |
| entry.displayMethod | int | -1=obsolete, 0=show level progress, 1=never, 2=show total progress |
| defaultCategory | string | Default category to highlight in the achievements UI |
S→C 2107 - AchievementProgressed
Nitro:
ACHIEVEMENT_PROGRESSEDSource:AchievementProgressComposer,AchievementEvent
Pushes an updated progress for an achievement. Same fields as AchievementUnlocked (806).
| Field | Type | Notes |
|---|---|---|
| type | int | Achievement type ID |
| level | int | New level |
| badgeId | int | Badge numeric ID |
| badgeCode | string | Badge code string |
| points | int | Points at new level |
| levelRewardPoints | int | Reward points |
| levelRewardPointType | int | Reward currency type |
| bonusPoints | int | Bonus points |
| achievementId | int | Achievement ID |
| removedBadgeCode | string | Previous level badge code |
| category | string | Achievement category |
| showDialogToUser | boolean | Whether to show dialog |
Body:
badgeId: int
level: int
badgeCode: string
points: int
maxPoints: int
achieved: boolean
category: string
displayMethod: int
levelCount: int
S→C 806 - AchievementUnlocked
Nitro:
ACHIEVEMENT_NOTIFICATIONSource:AchievementUnlockedComposer,AchievementNotificationMessageEvent
Notifies the client that an achievement was unlocked. Same fields as AchievementProgressed (2107).
| Field | Type | Notes |
|---|---|---|
| type | int | Achievement type ID |
| level | int | New level achieved |
| badgeId | int | Badge numeric ID |
| badgeCode | string | Badge code |
| points | int | Points at the new level |
| levelRewardPoints | int | Reward points for this level |
| levelRewardPointType | int | Reward currency type |
| bonusPoints | int | Bonus points awarded |
| achievementId | int | Achievement ID |
| removedBadgeCode | string | Badge code of the previous level (now removed) |
| category | string | Achievement category |
| showDialogToUser | boolean | Whether to show the level-up dialog |