Show raw api
{
"functions": [
{
"name": "Setup",
"desc": "Creates connections so that Chickynoid can run on the client. Specifically, it connects to relevant networking and\nRunService events.",
"params": [],
"returns": [],
"function_type": "method",
"source": {
"line": 88,
"path": "src/Client/init.lua"
}
},
{
"name": "ResetConnection",
"desc": "Reset the network connection. Used to recover from death spirals by telling the server to stop sending replication\npackets.",
"params": [],
"returns": [],
"function_type": "method",
"private": true,
"source": {
"line": 223,
"path": "src/Client/init.lua"
}
},
{
"name": "DoFpsCount",
"desc": "Calculates FPS and updates the FPS graph. FPS is also used internally for various things.",
"params": [
{
"name": "deltaTime",
"desc": "",
"lua_type": "number"
}
],
"returns": [],
"function_type": "method",
"private": true,
"source": {
"line": 244,
"path": "src/Client/init.lua"
}
},
{
"name": "LocalTick",
"desc": "Use this instead of raw tick().",
"params": [],
"returns": [
{
"desc": "",
"lua_type": "number"
}
],
"function_type": "method",
"private": true,
"source": {
"line": 280,
"path": "src/Client/init.lua"
}
},
{
"name": "ProcessFrame",
"desc": "Processes one frame forward in time and runs every heartbeat. This is the core part of Chickynoid that moves\neverything along.",
"params": [
{
"name": "deltaTime",
"desc": "Time since last frame",
"lua_type": "number"
}
],
"returns": [],
"function_type": "method",
"private": true,
"source": {
"line": 291,
"path": "src/Client/init.lua"
}
},
{
"name": "SetupTime",
"desc": "This tries to figure out a correct delta for the server time. Better to update this infrequently as it will cause a\n\"pop\" in prediction.\n\nThought: Replace with roblox solution or converging solution?",
"params": [
{
"name": "serverActualTime",
"desc": "",
"lua_type": "number"
}
],
"returns": [],
"function_type": "method",
"private": true,
"source": {
"line": 500,
"path": "src/Client/init.lua"
}
},
{
"name": "DeserializeSnapshot",
"desc": "Deserializes a snapshot from the server.",
"params": [
{
"name": "event",
"desc": "",
"lua_type": "unknown"
},
{
"name": "previousSnapshot",
"desc": "",
"lua_type": "unknown"
}
],
"returns": [
{
"desc": "",
"lua_type": "unknown"
}
],
"function_type": "method",
"private": true,
"source": {
"line": 519,
"path": "src/Client/init.lua"
}
}
],
"properties": [],
"types": [
{
"name": "ClientConfig",
"desc": "Client config for Chickynoid.",
"fields": [
{
"name": "fpsMin",
"lua_type": "number",
"desc": "If you're slower than this, your step will be broken up."
},
{
"name": "fpsMax",
"lua_type": "number",
"desc": "Think carefully about changing this! Every extra frame clients make, puts load on the server."
},
{
"name": "useSubFrameInterpolation",
"lua_type": "bool",
"desc": ""
},
{
"name": "showDebugMovement",
"lua_type": "bool",
"desc": "Show movement debug in FPS graph."
}
],
"source": {
"line": 76,
"path": "src/Client/init.lua"
}
}
],
"name": "ChickynoidClient",
"desc": "Client namespace for the Chickynoid package.",
"realm": [
"Client"
],
"source": {
"line": 7,
"path": "src/Client/init.lua"
}
}