Skip to main content

DialogMarker

A box that can be activated by stepping inside.

Functions​

new​

</>
DialogMarker:new(
id: string,--

user supplied instance string

x: number,--

horizontal coordinate

y: number,--

vertical coordinate

event_trigger: () → ()
) → ()

Creates a new dialog marker and spawns it

Use a different id string for different markers.

spawn​

</>
DialogMarker:spawn() → ()

Spawns the marker

remove​

</>
DialogMarker:remove() → ()

Removes the marker

update​

</>
DialogMarker:update() → ()

Updates the marker

Call this periodically.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new dialog marker and spawns it\n\nUse a different id string for different markers.",
            "params": [
                {
                    "name": "id",
                    "desc": "user supplied instance string",
                    "lua_type": "string"
                },
                {
                    "name": "x",
                    "desc": "horizontal coordinate",
                    "lua_type": "number"
                },
                {
                    "name": "y",
                    "desc": "vertical coordinate",
                    "lua_type": "number"
                },
                {
                    "name": "event_trigger",
                    "desc": "",
                    "lua_type": "() -> ()"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 29,
                "path": "../../res/data/script/lib/util/marker.lua"
            }
        },
        {
            "name": "spawn",
            "desc": "Spawns the marker",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 60,
                "path": "../../res/data/script/lib/util/marker.lua"
            }
        },
        {
            "name": "remove",
            "desc": "Removes the marker",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 103,
                "path": "../../res/data/script/lib/util/marker.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates the marker\n\nCall this periodically.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 119,
                "path": "../../res/data/script/lib/util/marker.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "DialogMarker",
    "desc": "A box that can be activated by stepping inside.",
    "source": {
        "line": 5,
        "path": "../../res/data/script/lib/util/marker.lua"
    }
}