Script API - v1.26.10.25
    Preparing search index...

    Class EntityWaypointBeta

    Waypoint that tracks an entity's position. The waypoint automatically updates as the entity moves and becomes invalid when the entity is removed.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    color?: RGB

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

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

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

    entity: Entity

    The entity being tracked by this waypoint.

    This property can throw when used.

    InvalidWaypointError

    InvalidWaypointTextureSelectorError

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

    The visibility rules that control when the waypoint is shown based on the entity's state (e.g., sneaking, invisible, dead).

    This property can throw when used.

    InvalidWaypointError

    InvalidWaypointTextureSelectorError

    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.

    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.

    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.

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

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