Script API - v26.50.24
    Preparing search index...

    Class LocationWaypoint

    Waypoint that points to a fixed location in the world. Unlike entity waypoints, location waypoints always remain valid and their position can be updated.

    export class LocationWaypoint extends Waypoint {
        constructor(dimensionLocation: DimensionLocation, textureSelector: WaypointTextureSelector, color?: RGB);
        setDimensionLocation(dimensionLocation: DimensionLocation): void;
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    color? isEnabled isValid textureSelector

    Methods

    getDimensionLocation remove setDimensionLocation

    Constructors

    Properties

    color?: RGB

    Optional RGB color tint applied to the waypoint icon. If not specified, the waypoint uses its default color.

    restricted-execution-read-only - This property can't be edited in restricted-execution mode.

    This property can't be read in early-execution mode.

    isEnabled: boolean

    Controls whether the waypoint is currently displayed on the player's screen. When disabled, the waypoint is hidden but remains valid.

    restricted-execution-read-only - This property can't be edited in restricted-execution mode.

    This property can't be read in early-execution mode.

    isValid: boolean

    Returns whether the waypoint is currently valid. A waypoint becomes invalid when its tracked entity is no longer valid.

    This property can't be read in early-execution mode.

    textureSelector: WaypointTextureSelector

    The WaypointTextureSelector that determines which icon texture is displayed for the waypoint based on distance or other criteria.

    restricted-execution-read-only - This property can't be edited in restricted-execution mode.

    This property can't be read in early-execution mode.

    Methods

    • Returns void

      Removes the waypoint from all locator bars it has been added to. This affects all players who have this waypoint in their locator bar.

      no-restricted-execution - This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    • Parameters

      Returns void

      Updates the dimension and location that this waypoint points to.

      no-restricted-execution - This function can't be called in restricted-execution mode.

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods