Skip to main content

TemplateRef

Object representing an template instance

Properties​

id​

</>
TemplateRef.id: string

Get/Set the template identifier

variant​

</>
TemplateRef.variant: string

Get/Set the template variant

mirror​

</>
TemplateRef.mirror: string

Get/Set the template mirror mode

file​

</>
TemplateRef.file: string

Get/Set the template file path

group​

</>
TemplateRef.group: string

Get/Set the template map group

origin​

</>
TemplateRef.origin: boolean

Get/Set the template origin flag

The origin is set e.g. when a door leads out of a room. On return, the origin position can be used.

origin_pos​

</>
TemplateRef.origin_pos: table

Get/Set the template origin position coordinates (x, y, z).

This is the regional coordinate of the origin.

origin_player​

</>
TemplateRef.origin_player: table

Get/Set the template origin player coordinates (x, y).

This is where the player can be returned to.

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "id",
            "desc": "Get/Set the template identifier",
            "lua_type": "string",
            "source": {
                "line": 13,
                "path": "../../res/data/script/lib/system/template_ref.lua"
            }
        },
        {
            "name": "variant",
            "desc": "Get/Set the template variant",
            "lua_type": "string",
            "source": {
                "line": 20,
                "path": "../../res/data/script/lib/system/template_ref.lua"
            }
        },
        {
            "name": "mirror",
            "desc": "Get/Set the template mirror mode",
            "lua_type": "string",
            "source": {
                "line": 27,
                "path": "../../res/data/script/lib/system/template_ref.lua"
            }
        },
        {
            "name": "file",
            "desc": "Get/Set the template file path",
            "lua_type": "string",
            "source": {
                "line": 34,
                "path": "../../res/data/script/lib/system/template_ref.lua"
            }
        },
        {
            "name": "group",
            "desc": "Get/Set the template map group",
            "lua_type": "string",
            "source": {
                "line": 41,
                "path": "../../res/data/script/lib/system/template_ref.lua"
            }
        },
        {
            "name": "origin",
            "desc": "Get/Set the template origin flag\n\nThe origin is set e.g. when a door leads out of a room.\nOn return, the origin position can be used.",
            "lua_type": "boolean",
            "source": {
                "line": 51,
                "path": "../../res/data/script/lib/system/template_ref.lua"
            }
        },
        {
            "name": "origin_pos",
            "desc": "Get/Set the template origin position coordinates (x, y, z).\n\nThis is the regional coordinate of the origin.",
            "lua_type": "table",
            "source": {
                "line": 60,
                "path": "../../res/data/script/lib/system/template_ref.lua"
            }
        },
        {
            "name": "origin_player",
            "desc": "Get/Set the template origin player coordinates (x, y).\n\nThis is where the player can be returned to.",
            "lua_type": "table",
            "source": {
                "line": 69,
                "path": "../../res/data/script/lib/system/template_ref.lua"
            }
        }
    ],
    "types": [],
    "name": "TemplateRef",
    "desc": "Object representing an template instance",
    "source": {
        "line": 5,
        "path": "../../res/data/script/lib/system/template_ref.lua"
    }
}