Skip to main content

RootUpdater

The root node that manages updating for linked objects

Functions​

new​

Constructor
</>
RootUpdater.new(object: {update: function}) → any

Destroy​

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

isLinked​

</>
RootUpdater:isLinked(object: any) → boolean

Returns true if object is linked

add​

</>
RootUpdater:add(object: any) → ()

Links an object to this updater

remove​

</>
RootUpdater:remove(object: any) → ()

Unlinks an object from this updater

update​

</>
RootUpdater:update(...: any) → ()

Updates linked objects

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "object",
                    "desc": "",
                    "lua_type": "{ update: function }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 10,
                "path": "src/shared/updater/RootUpdater.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 23,
                "path": "src/shared/updater/RootUpdater.lua"
            }
        },
        {
            "name": "isLinked",
            "desc": "Returns true if object is linked",
            "params": [
                {
                    "name": "object",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 34,
                "path": "src/shared/updater/RootUpdater.lua"
            }
        },
        {
            "name": "add",
            "desc": "Links an object to this updater",
            "params": [
                {
                    "name": "object",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 46,
                "path": "src/shared/updater/RootUpdater.lua"
            }
        },
        {
            "name": "remove",
            "desc": "Unlinks an object from this updater",
            "params": [
                {
                    "name": "object",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 63,
                "path": "src/shared/updater/RootUpdater.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates linked objects",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 82,
                "path": "src/shared/updater/RootUpdater.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RootUpdater",
    "desc": "The root node that manages updating for linked objects",
    "source": {
        "line": 3,
        "path": "src/shared/updater/RootUpdater.lua"
    }
}