@minecraft/server
    Preparing search index...

    Class PlayerWaypoint

    Waypoint that tracks a player's position. Extends EntityWaypoint with additional player-specific visibility rules such as hidden state and spectator mode.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    color? entity entityRules isEnabled isValid playerRules textureSelector

    Methods

    getDimensionLocation remove

    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.

    entity: Entity

    The entity being tracked by this waypoint.

    This property can throw when used.

    InvalidWaypointError

    InvalidWaypointTextureSelectorError

    entityRules: EntityVisibilityRules

    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

    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.

    isValid: boolean

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

    playerRules: PlayerVisibilityRules

    The PlayerVisibilityRules that control when the waypoint is shown based on the player's state (e.g., hidden, spectator mode, spectator viewing another spectator).

    This property can throw when used.

    InvalidWaypointError

    InvalidWaypointTextureSelectorError

    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.

    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.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods