Skip to main content

RemoteProperty

A wrapper around value instances, called remote as they replicate automatically through Roblox

Functions​

new​

This item only works when running on the server. Server
</>
RemoteProperty.new(
initialValue: string | number | boolean | Instance | table,
parent: Instance,
objTypeOverride: string
) → RemoteProperty

Creates a new RemoteProperty instance, this is used to replicate values across the server and client.

Set​

This item only works when running on the server. Server
</>
RemoteProperty:Set(value: string | number | boolean | Instance | table) → nil

Sets the value of the RemoteProperty instance, this is used to replicate values across the server and client.

Get​

This item only works when running on the client. ClientThis item only works when running on the server. Server
</>
RemoteProperty:Get() → string | number | boolean | Instance | table

Gets the value of the RemoteProperty object.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new RemoteProperty instance, this is used to replicate values across the server and client.\n\t",
            "params": [
                {
                    "name": "initialValue",
                    "desc": "",
                    "lua_type": "string | number | boolean | Instance | table"
                },
                {
                    "name": "parent",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "objTypeOverride",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RemoteProperty"
                }
            ],
            "function_type": "static",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 52,
                "path": "src/Util/RemoteComm/_RemoteProperty.lua"
            }
        },
        {
            "name": "Set",
            "desc": "Sets the value of the RemoteProperty instance, this is used to replicate values across the server and client.\n\t",
            "params": [
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "string | number | boolean | Instance | table"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "nil"
                }
            ],
            "function_type": "method",
            "realm": [
                "Server"
            ],
            "source": {
                "line": 92,
                "path": "src/Util/RemoteComm/_RemoteProperty.lua"
            }
        },
        {
            "name": "new",
            "desc": "Connects to an existing RemoteProperty instance, this is used to replicate values across the server and client.\n\n:::warning\nThis only to be used internally to link to an existing RemoteProperty instance, creating a new RemoteProperty instance on the client is not possible.\n:::\n\t",
            "params": [
                {
                    "name": "objInst",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RemoteProperty"
                }
            ],
            "function_type": "static",
            "realm": [
                "Client"
            ],
            "private": true,
            "source": {
                "line": 114,
                "path": "src/Util/RemoteComm/_RemoteProperty.lua"
            }
        },
        {
            "name": "Set",
            "desc": "Sets the value of the RemoteProperty instance, this is used to replicate values across the server and client.\n\n:::warning\nThis is only available to warn the user that this function is not available on the client.\n:::\n\t",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "nil"
                }
            ],
            "function_type": "method",
            "realm": [
                "Client"
            ],
            "private": true,
            "ignore": true,
            "source": {
                "line": 138,
                "path": "src/Util/RemoteComm/_RemoteProperty.lua"
            }
        },
        {
            "name": "Get",
            "desc": "Gets the value of the RemoteProperty object.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string | number | boolean | Instance | table"
                }
            ],
            "function_type": "method",
            "realm": [
                "Client",
                "Server"
            ],
            "source": {
                "line": 153,
                "path": "src/Util/RemoteComm/_RemoteProperty.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RemoteProperty",
    "desc": "A wrapper around value instances, called remote as they replicate automatically through Roblox",
    "source": {
        "line": 31,
        "path": "src/Util/RemoteComm/_RemoteProperty.lua"
    }
}