Skip to main content

SkillTreeClient

Client-side skill tree instance. Manages state and communicates with server.

Properties​

StateUpdated​

</>
SkillTreeClient.StateUpdated: Signal<PlayerSkillState>

Fired when server sends a state update. Argument: state

Functions​

new​

</>
SkillTreeClient.new(
remotes: RemoteConfig--

Remote events from server

) → SkillTreeClient

Creates a new SkillTreeClient instance.

requestUnlock​

</>
SkillTreeClient:requestUnlock(
nodeId: string--

The node identifier

) → ()

Requests to unlock a node on the server.

requestUpgrade​

</>
SkillTreeClient:requestUpgrade(
nodeId: string--

The node identifier

) → ()

Requests to upgrade a multi-rank node on the server.

getState​

</>
SkillTreeClient:getState() → PlayerSkillState--

The current state

Returns the current client state.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new SkillTreeClient instance.",
            "params": [
                {
                    "name": "remotes",
                    "desc": "Remote events from server",
                    "lua_type": "RemoteConfig"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SkillTreeClient"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 32,
                "path": "src/SkillTreeClient.luau"
            }
        },
        {
            "name": "requestUnlock",
            "desc": "Requests to unlock a node on the server.",
            "params": [
                {
                    "name": "nodeId",
                    "desc": "The node identifier",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 53,
                "path": "src/SkillTreeClient.luau"
            }
        },
        {
            "name": "requestUpgrade",
            "desc": "Requests to upgrade a multi-rank node on the server.",
            "params": [
                {
                    "name": "nodeId",
                    "desc": "The node identifier",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 59,
                "path": "src/SkillTreeClient.luau"
            }
        },
        {
            "name": "getState",
            "desc": "Returns the current client state.",
            "params": [],
            "returns": [
                {
                    "desc": "The current state",
                    "lua_type": "PlayerSkillState"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 65,
                "path": "src/SkillTreeClient.luau"
            }
        },
        {
            "name": "_onStateUpdated",
            "desc": "",
            "params": [
                {
                    "name": "state",
                    "desc": "",
                    "lua_type": "PlayerSkillState"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 70,
                "path": "src/SkillTreeClient.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "StateUpdated",
            "desc": "Fired when server sends a state update. Argument: state",
            "lua_type": "Signal<PlayerSkillState>",
            "source": {
                "line": 28,
                "path": "src/SkillTreeClient.luau"
            }
        }
    ],
    "types": [],
    "name": "SkillTreeClient",
    "desc": "Client-side skill tree instance. Manages state and communicates with server.",
    "source": {
        "line": 11,
        "path": "src/SkillTreeClient.luau"
    }
}