Show raw api
{
"functions": [
{
"name": "GetPlayerScore",
"desc": "Fetches a players position on a specified leaderboard. If that player has no data present in\nthe leaderboard, nil will be returned!",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string"
},
{
"name": "player",
"desc": "",
"lua_type": "Player"
},
{
"name": "skipCache",
"desc": "",
"lua_type": "boolean?"
}
],
"returns": [
{
"desc": "",
"lua_type": "Types.PlayerEntry\n"
}
],
"function_type": "method",
"source": {
"line": 91,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "GetRankings",
"desc": "Returns rankings on a specified leaderboard, starting at a specified rank, and fetching a specified number of players.",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string"
},
{
"name": "startingRank",
"desc": "",
"lua_type": "number"
},
{
"name": "playerCount",
"desc": "",
"lua_type": "number"
},
{
"name": "skipCache",
"desc": "",
"lua_type": "boolean?"
}
],
"returns": [
{
"desc": "",
"lua_type": "{Types.LeaderboardRanking}\n"
}
],
"function_type": "method",
"source": {
"line": 98,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "GetPlayerScoreForUserId",
"desc": "Fetches a UserId's position on a specified leaderboard. If that player has no data present in\nthe leaderboard, nil will be returned!",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string"
},
{
"name": "userId",
"desc": "",
"lua_type": "number"
},
{
"name": "skipCache",
"desc": "",
"lua_type": "boolean?"
}
],
"returns": [
{
"desc": "",
"lua_type": "Types.PlayerEntry\n"
}
],
"function_type": "method",
"source": {
"line": 106,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "GetRankingOfPlayers",
"desc": "Fetches a sorted list of specific players from a leaderboard. This group is bound to a groupId, and cached accordingly",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string"
},
{
"name": "groupId",
"desc": "",
"lua_type": "string"
},
{
"name": "userIds",
"desc": "",
"lua_type": "{number}"
},
{
"name": "skipCache",
"desc": "",
"lua_type": "boolean?"
}
],
"returns": [
{
"desc": "",
"lua_type": "Types.LeaderboardRanking\n"
}
],
"function_type": "method",
"source": {
"line": 113,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "GetManyPlayerScores",
"desc": "Fetches a sort list of many players positions on a specified leaderboard. Results are cached individually by UserId, not as a group. For\ngrouped-cache behavior, see `GetRankingOfPlayers`. You can fetch up to 200 players at once.",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string"
},
{
"name": "userIds",
"desc": "",
"lua_type": "{number}"
}
],
"returns": [
{
"desc": "",
"lua_type": "Types.LeaderboardRanking\n"
}
],
"function_type": "method",
"source": {
"line": 130,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "SetPlayerScore",
"desc": "Sets a players score on a specified leaderboard.",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string"
},
{
"name": "player",
"desc": "",
"lua_type": "Player"
},
{
"name": "score",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "Types.Success\n"
}
],
"function_type": "method",
"source": {
"line": 158,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "_makeRequest",
"desc": "Makes a request to the leaderboard API. This is used as a sink for all other \"GET\" requests to reduce the amount of code duplication.",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string"
},
{
"name": "path",
"desc": "",
"lua_type": "string"
},
{
"name": "token",
"desc": "",
"lua_type": "string"
},
{
"name": "method",
"desc": "",
"lua_type": "string"
},
{
"name": "body",
"desc": "",
"lua_type": "{[string]: any}"
},
{
"name": "skipCache",
"desc": "",
"lua_type": "boolean?"
}
],
"returns": [
{
"desc": "",
"lua_type": "Types.HttpResponse\n"
}
],
"function_type": "method",
"private": true,
"source": {
"line": 191,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "_writePlayerScore",
"desc": "Sets a players score on a specified leaderboard.",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string | number"
},
{
"name": "player",
"desc": "",
"lua_type": "Player"
},
{
"name": "score",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "Types.Success\n"
}
],
"function_type": "method",
"source": {
"line": 265,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "_cacheData",
"desc": "Caches a data with respect to TTL",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string | number"
},
{
"name": "identifier",
"desc": "",
"lua_type": "string | number"
},
{
"name": "data",
"desc": "",
"lua_type": "any"
}
],
"returns": [],
"function_type": "method",
"private": true,
"source": {
"line": 328,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "_getCachedData",
"desc": "Fetches cached data. Busts the cache if the data is expired",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string | number"
},
{
"name": "identifier",
"desc": "",
"lua_type": "string | number"
}
],
"returns": [],
"function_type": "method",
"private": true,
"source": {
"line": 345,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "_addPendingWrite",
"desc": "Adds a pending write to the queue",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string | number"
},
{
"name": "player",
"desc": "",
"lua_type": "Player"
},
{
"name": "score",
"desc": "",
"lua_type": "number"
},
{
"name": "timeAdded",
"desc": "",
"lua_type": "number?"
}
],
"returns": [],
"function_type": "method",
"private": true,
"source": {
"line": 361,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "_clearPendingWrite",
"desc": "Clears a pending write from the queue",
"params": [
{
"name": "leaderboardId",
"desc": "",
"lua_type": "string | number"
},
{
"name": "player",
"desc": "",
"lua_type": "Player"
}
],
"returns": [],
"function_type": "method",
"private": true,
"source": {
"line": 385,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
},
{
"name": "_getAuthToken",
"desc": "Fetches the auth token from the HttpService or config",
"params": [],
"returns": [],
"function_type": "method",
"private": true,
"source": {
"line": 401,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
}
],
"properties": [],
"types": [],
"name": "Leaderboard",
"desc": "A class that handles fetching and setting player scores on a leaderboard. See docs for more info",
"source": {
"line": 6,
"path": "src/leaderboards/src/Server/OrionLeaderboard.lua"
}
}