Skip to main content

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_LIST Source: AchievementListComposer, AchievementsEvent

Delivers the full achievement list with level, points, badge codes, and progress data for each achievement. Displayed in the achievements screen.

FieldTypeNotes
countintNumber of achievement entries
[count × entry]-Achievement entry
entry.achievementIdintAchievement ID
entry.levelintCurrent level achieved
entry.badgeCodestringBadge code
entry.scoreAtStartOfLevelintScore value at the start of current level
entry.scoreLimitintTotal score value for current level
entry.levelRewardPointsintPoints rewarded on completing this level
entry.levelRewardPointTypeintCurrency type for level reward
entry.currentPointsintPlayer's current progress score
entry.finalLevelbooleanWhether this is the last level of the achievement
entry.categorystringCategory name
entry.subCategorystringSub-category name
entry.levelCountintTotal number of levels in this achievement
entry.displayMethodint-1=obsolete, 0=show level progress, 1=never, 2=show total progress
defaultCategorystringDefault category to highlight in the achievements UI

S→C 2107 - AchievementProgressed​

Nitro: ACHIEVEMENT_PROGRESSED Source: AchievementProgressComposer, AchievementEvent

Pushes an updated progress for an achievement. Same fields as AchievementUnlocked (806).

FieldTypeNotes
typeintAchievement type ID
levelintNew level
badgeIdintBadge numeric ID
badgeCodestringBadge code string
pointsintPoints at new level
levelRewardPointsintReward points
levelRewardPointTypeintReward currency type
bonusPointsintBonus points
achievementIdintAchievement ID
removedBadgeCodestringPrevious level badge code
categorystringAchievement category
showDialogToUserbooleanWhether 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_NOTIFICATION Source: AchievementUnlockedComposer, AchievementNotificationMessageEvent

Notifies the client that an achievement was unlocked. Same fields as AchievementProgressed (2107).

FieldTypeNotes
typeintAchievement type ID
levelintNew level achieved
badgeIdintBadge numeric ID
badgeCodestringBadge code
pointsintPoints at the new level
levelRewardPointsintReward points for this level
levelRewardPointTypeintReward currency type
bonusPointsintBonus points awarded
achievementIdintAchievement ID
removedBadgeCodestringBadge code of the previous level (now removed)
categorystringAchievement category
showDialogToUserbooleanWhether to show the level-up dialog