Skip to main content

SkillReplication

Handles the replication of a skill from server to client.

Properties​

ID​

This item is read only and cannot be modified. Read Only
</>
SkillReplication.ID: number

The unique ID of the skill effect. Synced between the server and the client's SkillFX.ID.

Functions​

FireExcept​

</>
SkillReplication:FireExcept(
MethodName: string,
Player: Player,
MethodData: MethodData?,
RangeData: RangeData?
) → ()

Fires the method to all clients except the specified player.

FireTo​

</>
SkillReplication:FireTo(
MethodName: string,
Player: Player,
MethodData: MethodData?,
RangeData: RangeData?
) → ()

Fires the method to the specified player.

FireAll​

</>
SkillReplication:FireAll(
MethodName: string,
MethodData: MethodData?,
RangeData: RangeData?
) → ()

Fires the method to all clients.

FireReplicated​

</>
SkillReplication:FireReplicated(
MethodName: string,
MethodData: MethodData?,
RangeData: RangeData?
) → ()

Fires the method to all clients that have replicated the quest.

Fire​

</>
SkillReplication:Fire(
MethodName: string,
MethodData: MethodData?,
FlagData: FlagData?,
RangeData: RangeData?
) → ()

A more advanced version of FireAll that allows you to specify flags & replication range.

Show raw api
{
    "functions": [
        {
            "name": "FireExcept",
            "desc": "Fires the method to all clients except the specified player.",
            "params": [
                {
                    "name": "MethodName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "Player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "MethodData",
                    "desc": "",
                    "lua_type": "MethodData?"
                },
                {
                    "name": "RangeData",
                    "desc": "",
                    "lua_type": "RangeData?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 130,
                "path": "src/ServerStorage/Modules/Replication/SkillReplicationModule.lua"
            }
        },
        {
            "name": "FireTo",
            "desc": "Fires the method to the specified player.",
            "params": [
                {
                    "name": "MethodName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "Player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "MethodData",
                    "desc": "",
                    "lua_type": "MethodData?"
                },
                {
                    "name": "RangeData",
                    "desc": "",
                    "lua_type": "RangeData?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 143,
                "path": "src/ServerStorage/Modules/Replication/SkillReplicationModule.lua"
            }
        },
        {
            "name": "FireAll",
            "desc": "Fires the method to all clients.",
            "params": [
                {
                    "name": "MethodName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "MethodData",
                    "desc": "",
                    "lua_type": "MethodData?"
                },
                {
                    "name": "RangeData",
                    "desc": "",
                    "lua_type": "RangeData?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 153,
                "path": "src/ServerStorage/Modules/Replication/SkillReplicationModule.lua"
            }
        },
        {
            "name": "FireReplicated",
            "desc": "Fires the method to all clients that have replicated the quest.",
            "params": [
                {
                    "name": "MethodName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "MethodData",
                    "desc": "",
                    "lua_type": "MethodData?"
                },
                {
                    "name": "RangeData",
                    "desc": "",
                    "lua_type": "RangeData?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 166,
                "path": "src/ServerStorage/Modules/Replication/SkillReplicationModule.lua"
            }
        },
        {
            "name": "Fire",
            "desc": "A more advanced version of `FireAll` that allows you to specify flags & replication range.",
            "params": [
                {
                    "name": "MethodName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "MethodData",
                    "desc": "",
                    "lua_type": "MethodData?"
                },
                {
                    "name": "FlagData",
                    "desc": "",
                    "lua_type": "FlagData?"
                },
                {
                    "name": "RangeData",
                    "desc": "",
                    "lua_type": "RangeData?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 179,
                "path": "src/ServerStorage/Modules/Replication/SkillReplicationModule.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "ID",
            "desc": "The unique ID of the skill effect. Synced between the server and the client's `SkillFX.ID`.",
            "lua_type": "number",
            "readonly": true,
            "source": {
                "line": 24,
                "path": "src/ServerStorage/Modules/Replication/SkillReplicationModule.lua"
            }
        }
    ],
    "types": [],
    "name": "SkillReplication",
    "desc": "Handles the replication of a skill from server to client.",
    "source": {
        "line": 17,
        "path": "src/ServerStorage/Modules/Replication/SkillReplicationModule.lua"
    }
}