Skip to main content

EffectHandler

Manages the application of skill effects when nodes are unlocked.

Functions​

new​

</>
EffectHandler.new() → EffectHandler

Creates a new EffectHandler instance.

register​

</>
EffectHandler:register(
nodeId: string,--

The node identifier

callback: function--

Callback(playerId, nodeId, rank, effectData)

) → ()

Registers an effect callback for a specific node.

apply​

</>
EffectHandler:apply(
playerId: string,--

The UserId as a string

nodeId: string,--

The node identifier

rank: number,--

The current rank of the node

effectData: EffectData?--

Effect payload from the node config

) → ()

Applies an effect for a node unlock or upgrade.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new EffectHandler instance.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "EffectHandler"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 22,
                "path": "src/EffectHandler.luau"
            }
        },
        {
            "name": "register",
            "desc": "Registers an effect callback for a specific node.",
            "params": [
                {
                    "name": "nodeId",
                    "desc": "The node identifier",
                    "lua_type": "string"
                },
                {
                    "name": "callback",
                    "desc": "Callback(playerId, nodeId, rank, effectData)",
                    "lua_type": "function"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 31,
                "path": "src/EffectHandler.luau"
            }
        },
        {
            "name": "apply",
            "desc": "Applies an effect for a node unlock or upgrade.",
            "params": [
                {
                    "name": "playerId",
                    "desc": "The UserId as a string",
                    "lua_type": "string"
                },
                {
                    "name": "nodeId",
                    "desc": "The node identifier",
                    "lua_type": "string"
                },
                {
                    "name": "rank",
                    "desc": "The current rank of the node",
                    "lua_type": "number"
                },
                {
                    "name": "effectData",
                    "desc": "Effect payload from the node config",
                    "lua_type": "EffectData?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 40,
                "path": "src/EffectHandler.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "EffectHandler",
    "desc": "Manages the application of skill effects when nodes are unlocked.",
    "source": {
        "line": 9,
        "path": "src/EffectHandler.luau"
    }
}