Class MovingPlatformPlayerUpdateEvent<RoomType>

Emitted when the player on a moving platform is updated. This is also when the moving platform moves left or right.

Type Parameters

Hierarchy

  • RevertableEvent
    • MovingPlatformPlayerUpdateEvent

Implements

Properties

eventName eventName message movingplatform player reverted room side

Accessors

alteredPlayer alteredSide

Constructors

constructor

Methods

revert setPlayer setSide

Properties

Static eventName

eventName: "movingplatform.updateplayer"

eventName

eventName: "movingplatform.updateplayer"

Readonly message

message: undefined | RepairSystemMessage

The message that this event originated from.

Readonly movingplatform

movingplatform: MovingPlatformSystem<RoomType>

The moving platform system that this event is for.

Readonly player

player: undefined | PlayerData<RoomType>

The player on the moving platform, if any.

reverted

reverted: boolean

Readonly room

room: RoomType

The room or client that the event came from.

Readonly side

side: MovingPlatformSide

The direction that the moving platform is moving in.

Accessors

alteredPlayer

  • get alteredPlayer(): undefined | PlayerData<RoomType>

  • The altered player that will be on the moving platform, if changed.

    Returns undefined | PlayerData<RoomType>

alteredSide

  • get alteredSide(): MovingPlatformSide

  • The altered direction that the moving platfomr will move in, if changed.

    Returns MovingPlatformSide

Constructors

constructor

Methods

revert

  • Returns void

setPlayer

  • Change the player that is on the moving platform.

    Parameters

    • player: undefined | PlayerData<RoomType>

      The player to get onto the moving platform.

    Returns void

setSide

  • Change the direction that the moving platform is moving in.

    Parameters

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc