Skip to main content

SyncUpdateSubscriber

This item only works when running on the server. Server

Allows the Server to sync updates with subscribed/ready clients Server sends updates to subscribed/ready clients Clients can ready up and receive updates from the server Clients CANNOT send updates to the server (other than subscribing)

Functions​

new​

Constructor
</>
SyncUpdateSubscriber.new() → SyncUpdateSubscriber

Constructor

Destroy​

Deconstructor
</>
SyncUpdateSubscriber:Destroy() → ()

Deconstructor

update​

</>
SyncUpdateSubscriber:update(
state: table,
updateAll: boolean?--

if true, updates; default = false

) → ()

Updates subscribed clients

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SyncUpdateSubscriber"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 27,
                "path": "src/server/SyncUpdateSubscriber.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Deconstructor",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 43,
                "path": "src/server/SyncUpdateSubscriber.lua"
            }
        },
        {
            "name": "_onServerEvent",
            "desc": "",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "isReady",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 58,
                "path": "src/server/SyncUpdateSubscriber.lua"
            }
        },
        {
            "name": "_onPlayerReady",
            "desc": "",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 70,
                "path": "src/server/SyncUpdateSubscriber.lua"
            }
        },
        {
            "name": "_onPlayerUnready",
            "desc": "",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 80,
                "path": "src/server/SyncUpdateSubscriber.lua"
            }
        },
        {
            "name": "_onPlayerLeft",
            "desc": "",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 86,
                "path": "src/server/SyncUpdateSubscriber.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates subscribed clients",
            "params": [
                {
                    "name": "state",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "updateAll",
                    "desc": "if true, updates; default = false",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 93,
                "path": "src/server/SyncUpdateSubscriber.lua"
            }
        },
        {
            "name": "_updateClient",
            "desc": "",
            "params": [
                {
                    "name": "player",
                    "desc": "",
                    "lua_type": "Player"
                },
                {
                    "name": "state",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 129,
                "path": "src/server/SyncUpdateSubscriber.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SyncUpdateSubscriber",
    "desc": "Allows the Server to sync updates with subscribed/ready clients\nServer sends updates to subscribed/ready clients\nClients can ready up and receive updates from the server\nClients CANNOT send updates to the server (other than subscribing)",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 20,
        "path": "src/server/SyncUpdateSubscriber.lua"
    }
}