SkeldJS
    Preparing search index...

    Class PlayerCheckAppearEvent<RoomType>

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

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

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    eventName: "player.checkappear" = ...
    doAnimation: boolean
    eventName: "player.checkappear" = ...
    isValid: boolean

    Whether or not this appear would normally be considered valid.

    message: undefined | CheckAppearMessage

    The message that this event originated from.

    player: Player<RoomType>
    room: RoomType

    Accessors

    Methods

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

      Parameters

      • isValid: boolean

        Whether or not this appear should be considered valid.

      Returns void