Interface: Player

# Interface: Player

Components.Schemas.Player

The player object has many properties that define specific things. There are many of these properties, and due to their iterative nature no point in typing them.

# Booleans

Additional properties that are the boolean type (true/false) are usually a setting toggle or a one time event/action.

Properties with keys that start with "levelingReward_" and end with a number indicate when that leveling reward has been claimed. The number itself is the network level of the reward.
Properties with keys that look like "xmas2019_MAIN_LOBBY_1" - I believe these correlate with Christmas events but not sure what true/false means for these.
- The general property key format is "xmasYEAR_TYPE_NUMBER".
- A regex to match these would be: /^xmas(\d{4})([A-Z]+?)_(\d+)$/

# Numbers

Additional properties that are the number type will generally either be some form of statistic, or a timestamp.

Properties with keys that start with "claimed_solo_bank_" will be a timestamp indicating when it was claimed. The full key will include a Minecraft UUID at the end.
Properties with keys that roughly match "completed_christmas_quests_YEAR" will be a timestamp that indicates when they completed all the available quests for that event.
Properties with keys that start with "anniversaryNPCProgress" will indicate how many event NPCs have been visited by the player.

# Arrays

Some arrays will fit into a certain schema based on the property's key.

Properties with keys that start with "anniversaryNPCVisited" will be an array of numbers.

# Objects

Some objects will fit into a certain schema based on the property's key.

Properties with keys starting with "adventRewards" will fit the "PlayerAdventRewards" schema.
Properties with keys ending with "Cooldowns" will fit the "PlayerEventCooldown" schema.
Properties with keys starting with "upcomingLanguageRelease_" will fit the "PlayerUpcomingLanguageRelease" schema.
Properties with keys starting with "dmcrates-" will fit the "PlayerMonthlyCrates" schema.

# Indexable

The player object has many properties that define specific things. There are many of these properties, and due to their iterative nature no point in typing them.

# Booleans

Additional properties that are the boolean type (true/false) are usually a setting toggle or a one time event/action.

Properties with keys that start with "levelingReward_" and end with a number indicate when that leveling reward has been claimed. The number itself is the network level of the reward.
Properties with keys that look like "xmas2019_MAIN_LOBBY_1" - I believe these correlate with Christmas events but not sure what true/false means for these.
- The general property key format is "xmasYEAR_TYPE_NUMBER".
- A regex to match these would be: /^xmas(\d{4})([A-Z]+?)_(\d+)$/

# Numbers

Additional properties that are the number type will generally either be some form of statistic, or a timestamp.

Properties with keys that start with "claimed_solo_bank_" will be a timestamp indicating when it was claimed. The full key will include a Minecraft UUID at the end.
Properties with keys that roughly match "completed_christmas_quests_YEAR" will be a timestamp that indicates when they completed all the available quests for that event.
Properties with keys that start with "anniversaryNPCProgress" will indicate how many event NPCs have been visited by the player.

# Arrays

Some arrays will fit into a certain schema based on the property's key.

Properties with keys that start with "anniversaryNPCVisited" will be an array of numbers.

# Objects

Some objects will fit into a certain schema based on the property's key.

Properties with keys starting with "adventRewards" will fit the "PlayerAdventRewards" schema.
Properties with keys ending with "Cooldowns" will fit the "PlayerEventCooldown" schema.
Properties with keys starting with "upcomingLanguageRelease_" will fit the "PlayerUpcomingLanguageRelease" schema.
Properties with keys starting with "dmcrates-" will fit the "PlayerMonthlyCrates" schema.

# Properties

# SANTA_FINISHED

• Optional SANTA_FINISHED: boolean

Defined in: types/api.ts:726 (opens new window)

# SANTA_QUEST_STARTED

• Optional SANTA_QUEST_STARTED: boolean

Defined in: types/api.ts:727 (opens new window)

# _id

• _id: string

Defined in: types/api.ts:561 (opens new window)

# achievementPoints

• achievementPoints: number

Defined in: types/api.ts:832 (opens new window)

# achievementRewardsNew

• Optional achievementRewardsNew: PlayerAchievementRewardsNew

Defined in: types/api.ts:833 (opens new window)

# achievementSync

• Optional achievementSync: PlayerAchievementSync

Defined in: types/api.ts:834 (opens new window)

# achievementTotem

• Optional achievementTotem: PlayerAchievementTotem

Defined in: types/api.ts:835 (opens new window)

# achievementTracking

• achievementTracking: string[]

Defined in: types/api.ts:836 (opens new window)

# achievementTrackingHideMessages

• Optional achievementTrackingHideMessages: boolean

Defined in: types/api.ts:837 (opens new window)

# achievements

• achievements: PlayerAchievements

Defined in: types/api.ts:838 (opens new window)

# achievementsOneTime

• achievementsOneTime: string[]

Array of values, each value representing an achievement.

Defined in: types/api.ts:842 (opens new window)

• Optional adsense_tokens: number

Defined in: types/api.ts:626 (opens new window)

# adventRewards2017

• Optional adventRewards2017: PlayerAdventRewards

Defined in: types/api.ts:738 (opens new window)

# adventRewards2018

• Optional adventRewards2018: PlayerAdventRewards

Defined in: types/api.ts:744 (opens new window)

# adventRewards2019

• Optional adventRewards2019: PlayerAdventRewards

Defined in: types/api.ts:756 (opens new window)

# adventRewards_v2_2018

• Optional adventRewards_v2_2018: PlayerAdventRewards

Defined in: types/api.ts:750 (opens new window)

# adventRewards_v2_2019

• Optional adventRewards_v2_2019: PlayerAdventRewards

Defined in: types/api.ts:762 (opens new window)

# anniversaryNPCProgress2020

• Optional anniversaryNPCProgress2020: number

Defined in: types/api.ts:724 (opens new window)

# anniversaryNPCVisited2020

• Optional anniversaryNPCVisited2020: number[]

Defined in: types/api.ts:725 (opens new window)

# aprilFoolsStaffClicked_0

• Optional aprilFoolsStaffClicked_0: string[]

Defined in: types/api.ts:723 (opens new window)

# autoDetectLanguage

• Optional autoDetectLanguage: boolean

Defined in: types/api.ts:667 (opens new window)

# auto_spawn_pet

• Optional auto_spawn_pet: boolean

Defined in: types/api.ts:668 (opens new window)

# battlePassGlowStatus

• Optional battlePassGlowStatus: boolean

Defined in: types/api.ts:669 (opens new window)

# challenges

• Optional challenges: PlayerChallenges

Defined in: types/api.ts:717 (opens new window)

# channel

• Optional channel: string

Defined in: types/api.ts:670 (opens new window)

# chat

• Optional chat: boolean

Defined in: types/api.ts:671 (opens new window)

# christmas2019Cooldowns

• Optional christmas2019Cooldowns: PlayerEventCooldown

Defined in: types/api.ts:768 (opens new window)

# claimed_century_cake

• Optional claimed_century_cake: number

Timestamp of when the SkyBlock Century Cake was claimed.

Defined in: types/api.ts:573 (opens new window)

# claimed_potato_basket

• Optional claimed_potato_basket: number

Timestamp of when the Potato Basket was claimed.

Defined in: types/api.ts:577 (opens new window)

# claimed_potato_talisman

• Optional claimed_potato_talisman: number

Timestamp of when the Potato Talisman was claimed.

Defined in: types/api.ts:581 (opens new window)

# clock

• Optional clock: boolean

Defined in: types/api.ts:672 (opens new window)

# coins

• Optional coins: number

Defined in: types/api.ts:629 (opens new window)

• Optional collectibles_menu_sort: string

Defined in: types/api.ts:673 (opens new window)

• Optional collectibles_menu_visibility_sort: string

Defined in: types/api.ts:674 (opens new window)

# combatTracker

• Optional combatTracker: boolean

Defined in: types/api.ts:675 (opens new window)

# compassStats

• Optional compassStats: PlayerCompassStats

Defined in: types/api.ts:728 (opens new window)

# cooldowns

• Optional cooldowns: PlayerCooldowns

Defined in: types/api.ts:729 (opens new window)

# currentClickEffect

• Optional currentClickEffect: string

Defined in: types/api.ts:676 (opens new window)

# currentCloak

• Optional currentCloak: string

Defined in: types/api.ts:677 (opens new window)

# currentEmote

• Optional currentEmote: string

Defined in: types/api.ts:678 (opens new window)

# currentGadget

• Optional currentGadget: string

Defined in: types/api.ts:679 (opens new window)

# currentHat

• Optional currentHat: string

Defined in: types/api.ts:680 (opens new window)

# currentPet

• Optional currentPet: string

Defined in: types/api.ts:681 (opens new window)

# customFilter

• Optional customFilter: string

Defined in: types/api.ts:682 (opens new window)

# deaths

• Optional deaths: number

Defined in: types/api.ts:633 (opens new window)

# disableTipMessages

• Optional disableTipMessages: boolean

Defined in: types/api.ts:683 (opens new window)

# disguise

• Optional disguise: string

Defined in: types/api.ts:684 (opens new window)

# displayname

• displayname: string

Defined in: types/api.ts:564 (opens new window)

# easter2020Cooldowns

• Optional easter2020Cooldowns: PlayerEventCooldown

Defined in: types/api.ts:780 (opens new window)

# easter2020Cooldowns2

• Optional easter2020Cooldowns2: PlayerEventCooldown

Defined in: types/api.ts:786 (opens new window)

# eulaCoins

• Optional eulaCoins: boolean

Defined in: types/api.ts:630 (opens new window)

# fireworksStorage

• Optional fireworksStorage: PlayerFireworksStorage

Defined in: types/api.ts:730 (opens new window)

# firstLogin

• Optional firstLogin: number

Defined in: types/api.ts:565 (opens new window)

# flashingSaleClicks

• Optional flashingSaleClicks: number

Defined in: types/api.ts:734 (opens new window)

# flashingSaleOpens

• Optional flashingSaleOpens: number

Defined in: types/api.ts:735 (opens new window)

# flashingSalePoppedUp

• Optional flashingSalePoppedUp: number

Defined in: types/api.ts:736 (opens new window)

# flashingSalePopup

• Optional flashingSalePopup: number

Defined in: types/api.ts:737 (opens new window)

# fortuneBuff

• Optional fortuneBuff: number

Defined in: types/api.ts:635 (opens new window)

# friendBlocksUuid

• Optional friendBlocksUuid: string[]

Defined in: types/api.ts:711 (opens new window)

# friendRequests

• Optional friendRequests: string[]

Defined in: types/api.ts:712 (opens new window)

# friendRequestsUuid

• Optional friendRequestsUuid: string[]

Defined in: types/api.ts:713 (opens new window)

# gadget

• Optional gadget: string

Defined in: types/api.ts:685 (opens new window)

# giftingMeta

• Optional giftingMeta: PlayerGiftingMeta

Defined in: types/api.ts:731 (opens new window)

# gifts_grinch

• Optional gifts_grinch: number

Defined in: types/api.ts:636 (opens new window)

# guildInvites

• Optional guildInvites: string[]

Defined in: types/api.ts:714 (opens new window)

# guildKickReason

• Optional guildKickReason: string

Defined in: types/api.ts:715 (opens new window)

# guildNotifications

• Optional guildNotifications: boolean

Defined in: types/api.ts:716 (opens new window)

# halloween2016Cooldowns

• Optional halloween2016Cooldowns: PlayerEventCooldown

Defined in: types/api.ts:792 (opens new window)

# halloween2020Cooldowns

• Optional halloween2020Cooldowns: PlayerEventCooldown

Defined in: types/api.ts:798 (opens new window)

# hasTheHotPotato

• Optional hasTheHotPotato: boolean

Defined in: types/api.ts:637 (opens new window)

# holiday2016Cooldowns

• Optional holiday2016Cooldowns: PlayerEventCooldown

Defined in: types/api.ts:804 (opens new window)

# housingMeta

• Optional housingMeta: PlayerHousingMeta

Defined in: types/api.ts:732 (opens new window)

# karma

• Optional karma: number

Defined in: types/api.ts:628 (opens new window)

# kills

• Optional kills: number

Defined in: types/api.ts:631 (opens new window)

# killstreaks

• Optional killstreaks: number

Defined in: types/api.ts:632 (opens new window)

# knownAliases

• knownAliases: string[]

Defined in: types/api.ts:568 (opens new window)

# knownAliasesLower

• knownAliasesLower: string[]

Defined in: types/api.ts:569 (opens new window)

# language

• Optional language: string

Defined in: types/api.ts:666 (opens new window)

# lastAdsenseGenerateTime

• Optional lastAdsenseGenerateTime: number

Defined in: types/api.ts:609 (opens new window)

# lastClaimedReward

• Optional lastClaimedReward: number

Defined in: types/api.ts:608 (opens new window)

# lastLogin

• Optional lastLogin: number

Defined in: types/api.ts:566 (opens new window)

# lastLogout

• Optional lastLogout: number

Defined in: types/api.ts:567 (opens new window)

# lastMapVote

• Optional lastMapVote: number

Defined in: types/api.ts:610 (opens new window)