Skip to main content

SyncUpdateListener

Client subscribes/readies up and receive updates from the server

Functions​

new​

Constructor
</>
SyncUpdateListener.new(remoteEvent: RemoteEvent) → SyncUpdateListener

Constructor

Destroy​

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

Deconstructor

update​

</>
SyncUpdateListener:update(updateHandler: (state: table) → ()) → ()

Consumes updates

ready​

</>
SyncUpdateListener:ready() → ()

Notifies server this player is ready

unready​

</>
SyncUpdateListener:unready() → ()

Unready from syncs

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor",
            "params": [
                {
                    "name": "remoteEvent",
                    "desc": "",
                    "lua_type": "RemoteEvent"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "SyncUpdateListener"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 11,
                "path": "src/shared/client/SyncUpdateListener.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Deconstructor",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 49,
                "path": "src/shared/client/SyncUpdateListener.lua"
            }
        },
        {
            "name": "update",
            "desc": "Consumes updates",
            "params": [
                {
                    "name": "updateHandler",
                    "desc": "",
                    "lua_type": "(state: table) -> ()"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 60,
                "path": "src/shared/client/SyncUpdateListener.lua"
            }
        },
        {
            "name": "ready",
            "desc": "Notifies server this player is ready",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 74,
                "path": "src/shared/client/SyncUpdateListener.lua"
            }
        },
        {
            "name": "unready",
            "desc": "Unready from syncs",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 82,
                "path": "src/shared/client/SyncUpdateListener.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SyncUpdateListener",
    "desc": "Client subscribes/readies up and receive updates from the server",
    "source": {
        "line": 3,
        "path": "src/shared/client/SyncUpdateListener.lua"
    }
}