SkeldJS
    Preparing search index...

    Class PlayerCheckShapeshiftEvent<RoomType>

    Emitted when a player (i.e. a shapeshifter) is attempting to shapeshift into another player, and is requesting the host to verify the attempt and actually shapeshift into that player. Only emitted if the client is the host.

    This event is useful if you want to prevent a shapeshift from actually happening, before it happens. Therefore this event doesn't guarantee that the shapeshift actually takes place, see PlayerShapeshiftEvent to listen for that.

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    eventName: "player.checkshapeshift" = ...
    eventName: "player.checkshapeshift" = ...
    isValid: boolean

    Whether or not this shapeshift would normally be considered valid and thus the player be shapeshifted.

    message: undefined | CheckShapeshiftMessage

    The message that this event originated from.

    player: Player<RoomType>
    room: RoomType
    target: Player<RoomType>

    The other player that the player is attempting to shapeshift.

    Accessors

    Methods

    • Change whether this shapeshift should be consider valid. If valid, this player will shapeshift.

      Parameters

      • isValid: boolean

        Whether or not this shapeshift should be considered valid.

      Returns void