Skip to content

← Previous | Next →


teleport

Description

Allows a point for teleportation for entering or exiting the zone. It also manages bucket assignment and may place a map blip at the entry location.

Parameters

Name Type Mandatory Description
entry.x Number Yes The X coordinate for the entry point.
entry.y Number Yes The Y coordinate for the entry point.
entry.z Number Yes The Z coordinate for the entry point.
entry.heading Number Yes The heading (rotation) for the player at entry.
exit.x Number Yes The X coordinate for the exit point.
exit.y Number Yes The Y coordinate for the exit point.
exit.z Number Yes The Z coordinate for the exit point.
exit.heading Number Yes The heading (rotation) for the player at exit.
blip.name String No Name of the blip shown on the map.
blip.sprite Number No Sprite ID used for the blip.
blip.color Number No Color ID for the blip.
delay Number No Delay in milliseconds during teleportation.
bucket Number No Routing bucket the player will be placed into while inside the zone.
requirements Object No Requirement object like in zones that must be fulfilled to activate teleportation.

Example

{
    "teleport": {
        "entry": {
            "x": 100.0,
            "y": 200.0,
            "z": 300.0,
            "heading": 180.0
        },
        "exit": {
            "x": 10.0,
            "y": 20.0,
            "z": 30.0,
            "heading": 0.0
        },
        "blip": {
            "name": "Secret Cave",
            "sprite": 68,
            "color": 4
        },
        "delay": 2000,
        "bucket": 1,
        "requirements": {}
    }
}