Skip to main content

OverriddenProperty

Sets properties on the client and then replicates them to the server

Functions​

new​

</>
OverriddenProperty.new(
robloxInstance: Instance,
propertyName: string,
replicateRate: number?,--

Optional replication rate and callback

replicateCallback: (T)?
) → OverriddenProperty

Constructs a new OverriddenProperty.

Set​

</>
OverriddenProperty:Set(value: T) → ()

Sets the property

Get​

</>
OverriddenProperty:Get() → T

Gets the property

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new OverriddenProperty.",
            "params": [
                {
                    "name": "robloxInstance",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "propertyName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "replicateRate",
                    "desc": "Optional replication rate and callback",
                    "lua_type": "number?"
                },
                {
                    "name": "replicateCallback",
                    "desc": "",
                    "lua_type": "(T)?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "OverriddenProperty"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/overriddenproperty/src/Shared/OverriddenProperty.lua"
            }
        },
        {
            "name": "Set",
            "desc": "Sets the property",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 52,
                "path": "src/overriddenproperty/src/Shared/OverriddenProperty.lua"
            }
        },
        {
            "name": "Get",
            "desc": "Gets the property",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 64,
                "path": "src/overriddenproperty/src/Shared/OverriddenProperty.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "OverriddenProperty",
    "desc": "Sets properties on the client and then replicates them to the server",
    "source": {
        "line": 5,
        "path": "src/overriddenproperty/src/Shared/OverriddenProperty.lua"
    }
}