Class PlayerShapeshiftEvent<RoomType>

constructor

• new PlayerShapeshiftEvent<RoomType extends StatefulRoom<any>>(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | ProtectPlayerMessage,
      target: Player<RoomType>,
      duration: number,
      doAnimation: boolean,
  ): PlayerShapeshiftEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<any>

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | ProtectPlayerMessage
  • target: Player<RoomType>

    The target that the player shapeshifted into.

  • duration: number

    The duration, in seconds, for how long the player is shapeshifted for.

  • doAnimation: boolean

    Whether or not to show an animation of the player shapeshifting.

  Returns PlayerShapeshiftEvent<RoomType>

ReadonlydoAnimation

Readonlyduration

eventName

Readonlymessage

Readonlyplayer

Readonlyroom

Readonlytarget

StaticeventName

alteredDoAnimation

• get alteredDoAnimation(): boolean

  Whether or not to show an animation of the player shapeshifting instead, if altered.

  Returns boolean

alteredTarget

• get alteredTarget(): Player<RoomType>

  The player that the player will shapeshift into instead, if altered.

  Returns Player<RoomType>

setDoAnimation

• setDoAnimation(doAnimation: boolean): void

  Change whether or not an animation will show the player shapeshifting.

  Parameters

  • doAnimation: boolean

    Whether or not to do show an animation of the player shape shifting.

  Returns void

setTarget

• setTarget(target: Player<RoomType>): void

  Change the player that the player will shapeshift into.

  Parameters

  • target: Player<RoomType>

    The player to shapeshift into instead.

  Returns void