SkeldJS
    Preparing search index...

    Class PlayerCheckVanishEvent<RoomType>

    Emitted when a player (e.g. a phantom) is attempting to vanish, and is requesting the host to verify the attempt and actually allow the player to vanish. Only emitted if the client is the host.

    This event is useful if you want to prevent a player from vanishing before it happens. This event doesn't guarantee that the player actually does vanish, see PlayerVanishEvent to listen for that.

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

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

    Whether or not this vanish would normally be considered valid.

    maxDuration: number
    message: undefined | CheckVanishMessage

    The message that this event originated from.

    player: Player<RoomType>
    room: RoomType

    Accessors

    Methods

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

      Parameters

      • isValid: boolean

        Whether or not this vanish should be considered valid.

      Returns void