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

    Class WaypointBeta

    Base class for waypoints displayed on the player's locator bar. Waypoints can track locations or entities and are rendered with customizable textures and colors.

    Waypoints act as shared handles that can be added to multiple players' locator bars. When you modify a waypoint's properties (such as color, texture, or enabled state), the changes are reflected for all players who have that waypoint in their locator bar. This allows you to efficiently manage waypoints across multiple players without creating separate instances for each player.

    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.

    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.