Skip to main content

Scene

Functions

wait_pos

Scene.wait_pos(
entityEntityRef,
xnumber,--

horizontal coordinate

ynumber--

vertical coordinate

) → ()

Waits until the entity is at the given position

wait_rect

Scene.wait_rect(
entityEntityRef,
x1number,--

horizontal minimum

y1number,--

vertical minimum

x2number,--

horizontal maximum

y2number--

vertical maximum

) → ()

Waits until the entity is in the given rectangle

waitEntityPos

deprecated
Scene.waitEntityPos(
entitynumber,--

entity index

posXnumber,--

horizontal coordinate

posYnumber--

vertical coordinate

) → ()

Waits until the entity is at the given position Uses the old entity API. Avoid.

waitEntityRect

deprecated
Scene.waitEntityRect(
entitynumber,--

entity index

x1number,--

horizontal minimum

y1number,--

vertical minimum

x2number,--

horizontal maximum

y2number--

vertical maximum

) → ()

Waits until the entity is in the given rectangle Uses the old entity API. Avoid.

Show raw api
{
    "functions": [
        {
            "name": "wait_pos",
            "desc": "Waits until the entity is at the given position",
            "params": [
                {
                    "name": "entity",
                    "desc": "",
                    "lua_type": "EntityRef"
                },
                {
                    "name": "x",
                    "desc": "horizontal coordinate",
                    "lua_type": "number"
                },
                {
                    "name": "y",
                    "desc": "vertical coordinate",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 12,
                "path": "../../res/data/script/lib/util/scene.lua"
            }
        },
        {
            "name": "wait_rect",
            "desc": "Waits until the entity is in the given rectangle",
            "params": [
                {
                    "name": "entity",
                    "desc": "",
                    "lua_type": "EntityRef"
                },
                {
                    "name": "x1",
                    "desc": "horizontal minimum",
                    "lua_type": "number"
                },
                {
                    "name": "y1",
                    "desc": "vertical minimum",
                    "lua_type": "number"
                },
                {
                    "name": "x2",
                    "desc": "horizontal maximum",
                    "lua_type": "number"
                },
                {
                    "name": "y2",
                    "desc": "vertical maximum",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 26,
                "path": "../../res/data/script/lib/util/scene.lua"
            }
        },
        {
            "name": "waitEntityPos",
            "desc": "Waits until the entity is at the given position\nUses the old entity API. Avoid.",
            "params": [
                {
                    "name": "entity",
                    "desc": "entity index",
                    "lua_type": "number"
                },
                {
                    "name": "posX",
                    "desc": "horizontal coordinate",
                    "lua_type": "number"
                },
                {
                    "name": "posY",
                    "desc": "vertical coordinate",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "tags": [
                "deprecated"
            ],
            "source": {
                "line": 49,
                "path": "../../res/data/script/lib/util/scene.lua"
            }
        },
        {
            "name": "waitEntityRect",
            "desc": "Waits until the entity is in the given rectangle\nUses the old entity API. Avoid.",
            "params": [
                {
                    "name": "entity",
                    "desc": "entity index",
                    "lua_type": "number"
                },
                {
                    "name": "x1",
                    "desc": "horizontal minimum",
                    "lua_type": "number"
                },
                {
                    "name": "y1",
                    "desc": "vertical minimum",
                    "lua_type": "number"
                },
                {
                    "name": "x2",
                    "desc": "horizontal maximum",
                    "lua_type": "number"
                },
                {
                    "name": "y2",
                    "desc": "vertical maximum",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "tags": [
                "deprecated"
            ],
            "source": {
                "line": 65,
                "path": "../../res/data/script/lib/util/scene.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Scene",
    "desc": "",
    "source": {
        "line": 4,
        "path": "../../res/data/script/lib/util/scene.lua"
    }
}