Skip to main content

Updater

A node that updates linked objects Extends RootUpdater

Functions​

new​

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

Destroy​

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

setRoot​

</>
Updater:setRoot(updater: object) → ()

Sets the root update

setParent​

</>
Updater:setParent(newParent: object) → ()

Sets the parent

update​

</>
Updater: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": 14,
                "path": "src/shared/updater/Updater.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 24,
                "path": "src/shared/updater/Updater.lua"
            }
        },
        {
            "name": "setRoot",
            "desc": "Sets the root update",
            "params": [
                {
                    "name": "updater",
                    "desc": "",
                    "lua_type": "object"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 38,
                "path": "src/shared/updater/Updater.lua"
            }
        },
        {
            "name": "setParent",
            "desc": "Sets the parent",
            "params": [
                {
                    "name": "newParent",
                    "desc": "",
                    "lua_type": "object"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 48,
                "path": "src/shared/updater/Updater.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates linked objects",
            "params": [
                {
                    "name": "...",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 70,
                "path": "src/shared/updater/Updater.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Updater",
    "desc": "A node that updates linked objects\nExtends RootUpdater",
    "source": {
        "line": 6,
        "path": "src/shared/updater/Updater.lua"
    }
}