Class PlayerMoveEvent<RoomType>

Emitted when a player moves.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- PlayerMoveEvent

Implements

PlayerEvent<RoomType>

Index

Constructors

Properties

eventName newPosition oldPosition player room eventName

Constructors

constructor

new PlayerMoveEvent<RoomType extends StatefulRoom<any>>(
    room: RoomType,
    player: Player<RoomType>,
    oldPosition: Vector2,
    newPosition: Vector2,
): PlayerMoveEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- player: Player<RoomType>
- oldPosition: Vector2
  The old position of the player.
- newPosition: Vector2
  The new position of the player.
Returns PlayerMoveEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/player/Move.ts:15

Properties

eventName

eventName: "player.move" = ...

`Readonly`newPosition

newPosition: Vector2

The new position of the player.

`Readonly`oldPosition

oldPosition: Vector2

The old position of the player.

`Readonly`player

player: Player<RoomType>

The player that this event is for.

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "player.move" = ...