Class PlayerSnapToEvent<RoomType>

constructor

• new PlayerSnapToEvent<RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>>(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | SnapToMessage,
      oldPosition: Vector2,
      newPosition: Vector2,
  ): PlayerSnapToEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | SnapToMessage
  • oldPosition: Vector2

    The old position of the player.

  • newPosition: Vector2

    The new position of the player.

  Returns PlayerSnapToEvent<RoomType>

StaticeventName

eventName

Readonlymessage

ReadonlynewPosition

ReadonlyoldPosition

Readonlyplayer

Readonlyroom

alteredPosition

• get alteredPosition(): Vector2

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

  Returns Vector2

revert

• revert(): void

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

  Returns void

setPosition

• setPosition(position: Vector2): void

  Set the position that the player was snapped to.

  Parameters

  • position: Vector2

    The position to snap to.

  Returns void