Show raw api
{
"functions": [
{
"name": "createConfig",
"desc": "Creates a new elo config.",
"params": [
{
"name": "config",
"desc": "Optional table with defaults",
"lua_type": "table?"
}
],
"returns": [
{
"desc": "",
"lua_type": "EloConfig"
}
],
"function_type": "static",
"source": {
"line": 47,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "isEloConfig",
"desc": "Returns whether an object is an elo config",
"params": [
{
"name": "config",
"desc": "",
"lua_type": "any"
}
],
"returns": [
{
"desc": "",
"lua_type": "boolean"
}
],
"function_type": "static",
"source": {
"line": 65,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "getNewElo",
"desc": "Gets the new score for the player and opponent after a series of matches.",
"params": [
{
"name": "config",
"desc": "",
"lua_type": "EloConfig"
},
{
"name": "playerOneRating",
"desc": "",
"lua_type": "number"
},
{
"name": "playerTwoRating",
"desc": "",
"lua_type": "number"
},
{
"name": "eloMatchResultList",
"desc": "",
"lua_type": "{ EloMatchResult }"
}
],
"returns": [
{
"desc": "playerOneRating",
"lua_type": "number"
},
{
"desc": "playerTwoRating",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 79,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "getEloChange",
"desc": "Gets the change in elo for the given players and the results",
"params": [
{
"name": "config",
"desc": "",
"lua_type": "EloConfig"
},
{
"name": "playerOneRating",
"desc": "",
"lua_type": "number"
},
{
"name": "playerTwoRating",
"desc": "",
"lua_type": "number"
},
{
"name": "eloMatchResultList",
"desc": "",
"lua_type": "{ EloMatchResult }"
}
],
"returns": [
{
"desc": "playerOneRating",
"lua_type": "number"
},
{
"desc": "playerTwoRating",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 100,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "getNewPlayerOneScore",
"desc": "Gets the new score for the player after a series of matches.",
"params": [
{
"name": "config",
"desc": "",
"lua_type": "EloConfig"
},
{
"name": "playerOneRating",
"desc": "",
"lua_type": "number"
},
{
"name": "playerTwoRating",
"desc": "",
"lua_type": "number"
},
{
"name": "eloMatchResultList",
"desc": "",
"lua_type": "{ EloMatchResult }"
}
],
"returns": [],
"function_type": "static",
"source": {
"line": 120,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "getPlayerOneExpected",
"desc": "Compute expected score for a player vs. player given the rating.\n\n:::info\nA player's expected score is their probability of winning plus half their probability of drawing. Thus, an expected score of 0.75 could represent a 75% chance of winning, 25% chance of losing, and 0% chance of drawing\n:::",
"params": [
{
"name": "config",
"desc": "",
"lua_type": "EloConfig"
},
{
"name": "playerOneRating",
"desc": "",
"lua_type": "number"
},
{
"name": "playerTwoRating",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 141,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "getPlayerOneScoreAdjustment",
"desc": "Gets the score adjustment for a given player's base.",
"params": [
{
"name": "config",
"desc": "",
"lua_type": "EloConfig"
},
{
"name": "playerOneRating",
"desc": "",
"lua_type": "number"
},
{
"name": "playerTwoRating",
"desc": "",
"lua_type": "number"
},
{
"name": "eloMatchResultList",
"desc": "",
"lua_type": "{ EloMatchResult }"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 159,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "fromOpponentPerspective",
"desc": "Flips the scores for the opponent",
"params": [
{
"name": "eloMatchResultList",
"desc": "",
"lua_type": "{ EloMatchResult }"
}
],
"returns": [
{
"desc": "",
"lua_type": "{ number }"
}
],
"function_type": "static",
"source": {
"line": 197,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "countPlayerOneWins",
"desc": "Counts the number of wins for player one",
"params": [
{
"name": "eloMatchResultList",
"desc": "",
"lua_type": "{ EloMatchResult }"
}
],
"returns": [
{
"desc": "",
"lua_type": "{ number }"
}
],
"function_type": "static",
"source": {
"line": 215,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "countPlayerTwoWins",
"desc": "Counts the number of wins for player two",
"params": [
{
"name": "eloMatchResultList",
"desc": "",
"lua_type": "{ EloMatchResult }"
}
],
"returns": [
{
"desc": "",
"lua_type": "{ number }"
}
],
"function_type": "static",
"source": {
"line": 233,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "standardKFactorFormula",
"desc": "Standard kfactor formula for use in the elo config.",
"params": [
{
"name": "rating",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 251,
"path": "src/elo/src/Shared/EloUtils.lua"
}
},
{
"name": "extractKFactor",
"desc": "Computes the kfactor for the given player from the rating",
"params": [
{
"name": "config",
"desc": "",
"lua_type": "EloConfig"
},
{
"name": "rating",
"desc": "",
"lua_type": "number"
}
],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "static",
"source": {
"line": 268,
"path": "src/elo/src/Shared/EloUtils.lua"
}
}
],
"properties": [],
"types": [
{
"name": "EloConfig",
"desc": "",
"fields": [
{
"name": "factor",
"lua_type": "number",
"desc": ""
},
{
"name": "kfactor",
"lua_type": "number | function",
"desc": ""
},
{
"name": "initial",
"lua_type": "number",
"desc": ""
},
{
"name": "ratingFloor",
"lua_type": "number",
"desc": ""
},
{
"name": "groupMultipleResultAsOne",
"lua_type": "boolean",
"desc": ""
}
],
"source": {
"line": 41,
"path": "src/elo/src/Shared/EloUtils.lua"
}
}
],
"name": "EloUtils",
"desc": "Utilities to compute elo scores for players\n\n```lua\nlocal config = EloUtils.createConfig()\n\nlocal playerOneRating = 1400\nlocal playerTwoRating = 1800\n\n-- Update rating!\nplayerOneRating, playerTwoRating = EloUtils.getNewElo(\n\tconfig,\n\tplayerOneRating,\n\tplayerTwoRating,\n\t{\n\t\tEloMatchResult.PLAYER_ONE_WIN;\n\t})\n\n-- New rankings!\nprint(playerOneRating, playerTwoRating)\n```",
"source": {
"line": 24,
"path": "src/elo/src/Shared/EloUtils.lua"
}
}