Class PlayerSnapToEvent<RoomType>

Emitted when a player snaps to a position, without lerping. Typically emitted when the player is moves between vents.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSnapToEvent

Implements

Properties

eventName eventName message newPosition oldPosition player room

Accessors

alteredPosition

Constructors

constructor

Methods

revert setPosition

Properties

Static eventName

eventName: "player.snapto"

eventName

eventName: "player.snapto"

Readonly message

message: undefined | SnapToMessage

The message that this event originated from.

Readonly newPosition

newPosition: Vector2

The new position of the player.

Readonly oldPosition

oldPosition: Vector2

The old position of the player.

Readonly player

player: PlayerData<RoomType>

The player that this event is for.

Readonly room

room: RoomType

The room or client that the event came from.

Accessors

alteredPosition

  • get alteredPosition(): Vector2

  • The altered position that the player will snap to instead, if changed.

    Returns Vector2

Constructors

constructor

Methods

revert

  • Revert the player's position back to their old position.

    Returns void

setPosition

  • Set the position that the player was snapped to.

    Parameters

    • position: Vector2

      The position to snap to.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc