Skip to content
This repository was archived by the owner on Sep 28, 2025. It is now read-only.

structures.md

Latest commit

 

History

History
259 lines (244 loc) · 4.7 KB

structures.md

File metadata and controls

259 lines (244 loc) · 4.7 KB
Raw

Data structures

Commonly seen data structures will be placed here for easier reference. Names are made up.

Attributes labeled with #Type# are documented here.

Asset

Seen in most structures, as it contains image refs for basically everything.

assetType: str
path: str

Challenge

GetUserLeaderboard

id: str
name: str
url: str
gameId: str
createDate: int
updateDate: int
startDate: int
endDate: int
state: int (enum)
description: str
rules: str
numPlayers: int
exactPlayers: int
playerMatchMode: int (enum)
timeDirections: int
enforceMs: bool
coverImagePath: str
contest: bool
contestRules: str
runCommentsMode: int (enum)
prizeConfig
    prizePool: int
    currency: str
    prizes[]
        place: int
        amount: int
runsCommentsMode: int

GameInfo

GetSearch, GetLatestLeaderboard, GetForumList, GetGameSettings, GetModerationGames, GetModerationRuns, GetSeriesSettings, GetSession, GetUserSettings, PutGame, GetTickets, GetRun, GetUserLeaderboard, GetStreamList, GetGameSummary

id: str
name: str
url: str
type: str (enum)
loadtimes: bool
milliseconds: bool
igt: bool
verification: bool
autoVerify: bool
requireVideo: bool
emulator: int (enum)
defaultTimer: int (enum)
validTimers[int (enum)]
releaseDate: int
addedDate: int
touchDate: int
coverPath: str
?trophy1stPath: str
?trophy2ndPath: str
?trophy3rdPath: str
runCommentsMode: int (enum?)
runCount: int
activePlayerCount: int
totalPlayerCount: int
boostReceivedCount: int
boostDistinctDonorsCount: int
rules: str
viewPowerLevel: int (enum)
platformIds[str]
regionIds[str]
gameTypeIds[int]
websiteUrl: str
discordUrl: str
defaultView: int (enum)
guidePermissionType: int (enum)
resourcePermissionType: int (enum)
staticAssets[]
    #Asset#

Category

GetGameData, GetLatestLeaderboard, GetModerationRuns, GetRun, GetUserLeaderboard, GetGameLevelSummary

id: str
name: str
url: str
pos: int
gameId: str
isMisc: bool
isPerLevel: bool
numPlayers: int
exactPlayers: bool
playerMatchMode: int (enum)
timeDirection: int (0 = fastest)
enforceMs: bool
archived: bool
rules: str

Level

GetGameData, GetLatestLeaderboard, GetModerationRuns, GetRun, GetUserLeaderboard

id: str
gameId: str
name: str
url: str
pos: int
rules: str
archived: bool

Platform

GetGameData, GetLatestLeaderboard, GetModerationRuns, GetRun, GetUserLeaderboard

id: str
name: str
url: str
year: int

Player

GetRun, GetUserLeaderboard

id: str
name: str
url: str
powerLevel: int
color1Id: str
color2Id: str
colorAnimate: int
areaId: str

Region

GetGameData, GetLatestLeaderboard, GetRun, GetUserLeaderboard

id: str
name: str
url: str
flag: str

Run

GetGameLeaderboard2, GetGameRecordHistory, GetLatestLeaderboard, GetModerationRuns, GetRun, GetUserLeaderboard, GetGameLevelSummary

id: str
gameId: str
?levelId: str
?categoryId: str
?challengeId: str
?time: int|float
?timeWithLoads: int|float
?(another for IGT?) : int|float
?enforceMs: bool
platformId: str
emulator: bool
regionId: str
video: str
comment: str
submittedById: str
verified: int
?verifiedById: str
?reason: str
date: int
dateSubmitted: int
dateVerified: int
hasSplits: bool
obsolete: bool
place: int
issues: ?
playerIds[str]
valueIds[str]

Theme

GetGameSettings, GetSeriesSettings, GetSession, GetThemeSettings, GetUserSettings, GetGameSummary

id: str
url: str
primaryColor: str
panelColor: str
panelOpacity: int
navbarColor: int
backgroundColor: str (hex)
backgroundFit: int
backgroundPosition: int
backgroundRepeat: int
backgroundScrolling: int
foregroundFit: 0
foregroundPosition: int
foregroundRepeat: int
foregroundScrolling: int
touchDate: int
staticAssets[]
    #Asset#

Variable

GetLatestLeaderboard, GetRun, GetUserLeaderboard

    id: str
    name: str
    url: str
    pos: int
    gameId: str
    categoryScope: int (enum?)
    categoryId: str
    levelScope: int (enum?)
    ?levelId: str
    isMandatory: bool
    isSubcategory: bool
    isUserDefined: bool
    isObsoleting: bool
    defaultValue: str
    archived: bool
    ?displayMode: int (enum?)

Value

GetLatestLeaderboard, GetRun, GetUserLeaderboard

id: str
name: str
url: str
pos: int
variableId: str
isMisc: bool
?rules: str
archived: bool

User

GetGameData, GetSearch, GetCommentList, GetConversationMessages, GetConversations, GetForumList, GetGameSettings, GetRunSettings, GetSeriesSettings, GetSession, GetThread, GetTickets, GetRun, GetUserLeaderboard, GetStreamList, GetGuideList, GetResourceList, GetNewsList

id: str
name: str
url: str
powerLevel: int
pronouns[str]
areaId: str
color1Id: str
color2Id: str
?isSupporter
?colorAnimate: int # No clue when this shows up
?iconType # Where specific user details are desired (user profile?)
?onlineDate: int
?signupDate: int
?touchDate: int
?staticAssets[]
    #Asset#