Class PlayerMoveEvent<RoomType>

Emitted when a player moves.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

BasicEvent
- PlayerMoveEvent

Implements

Index

Properties

eventName eventName player position room velocity

Constructors

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

The new position of the player.

`Readonly` room

room: RoomType

The room or client that the event came from.

`Readonly` velocity

velocity: Vector2

The velocity of the player.

Constructors

constructor

new PlayerMoveEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, position: Vector2, velocity: Vector2): PlayerMoveEvent<RoomType>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- position: Vector2
  
  The new position of the player.
- velocity: Vector2
  
  The velocity of the player.
Returns PlayerMoveEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/events/player/Move.d.ts:23

Generated using TypeDoc