Class PlayerMoveEvent<RoomType>

Emitted when a player moves.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerMoveEvent

Implements

Index

Properties

Constructors

constructor

Properties

Static eventName

eventName: "player.move" = ...

eventName

eventName: "player.move" = ...

Readonly player

player: PlayerData<RoomType>

The player that this event is for.

Readonly position

position: Vector2

Readonly room

room: RoomType

The room or client that the event came from.

Readonly velocity

velocity: Vector2

Constructors

constructor

new PlayerMoveEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, position: Vector2, velocity: Vector2): PlayerMoveEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/Move.ts:16
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- position: Vector2
- velocity: Vector2
Returns PlayerMoveEvent<RoomType>

Generated using TypeDoc