Skip to main content

Get Leaderboard Info

Input

NameData TypeDescription
EnterExecThe input execution that triggers this node
IndexNumberThe index to use to retrieve the ranking information. Valid indices are 1 to 6. Current user's best or current rank will occupy index 6 even if it's higher than others.
Ranking ModeStringThe type of ranking to use: Friends, National, or Global

Output

NameData TypeDescription
PulseExecPulses when leaderboard information is found or when there is no leaderboard information available for that index
Info AvailableBooleanReturns true if the ranking information at the given index is available, false if not
UsernameStringThe TikTok username of the user at the given index
Profile Photo TextureTextureThe TikTok profile photo of the user at the given index
ScoreNumberThe score of the user at the given index
Is Current UserBooleanReturns true if the user at the given index is the same as the current user
RankingNumberThe expected ranking for this index