Class PlayerCheckZiplineEvent<RoomType>

constructor

• new PlayerCheckZiplineEvent<
      RoomType extends StatefulRoom<StatefulRoom<any, {}>, {}>,
  >(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | CheckZiplineMessage,
      fromTop: boolean,
      isValid: boolean,
  ): PlayerCheckZiplineEvent<RoomType>

  Type Parameters

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

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | CheckZiplineMessage
  • fromTop: boolean
  • isValid: boolean

    Whether or not this zipline would normally be considered valid.

  Returns PlayerCheckZiplineEvent<RoomType>

StaticeventName

eventName

ReadonlyfromTop

ReadonlyisValid

Readonlymessage

Readonlyplayer

Readonlyroom

alteredFromTop

• get alteredFromTop(): boolean

  Returns boolean

alteredIsValid

• get alteredIsValid(): boolean

  Whether or not this zipline use will be considered valid instead, if altered.

  Returns boolean

alteredPlayer

• get alteredPlayer(): Player<RoomType>

  The player that will use the zipline instead, if altered.

  Returns Player<RoomType>

setFromTop

• setFromTop(fromTop: boolean): void

  Parameters

  • fromTop: boolean

  Returns void

setPlayer

• setPlayer(player: Player<RoomType>): void

  Change the player that will actually use the zipline.

  Parameters

  • player: Player<RoomType>

  Returns void

setValid

• setValid(isValid: boolean): void

  Change whether this zipline use should be consider valid. If valid, this player will use the zipline.

  Parameters

  • isValid: boolean

    Whether or not this zipline use should be considered valid.

  Returns void