Class PlayerSyncSettingsEvent<RoomType>

Emitted when a player (i.e. the host of the room) sets the settings of the room.

Type Parameters

Hierarchy

  • BasicEvent
    • PlayerSyncSettingsEvent

Implements

Properties

eventName eventName message player room settings

Accessors

alteredSettings isDirty

Constructors

constructor

Methods

setSettings

Properties

Static eventName

eventName: "player.syncsettings"

eventName

eventName: "player.syncsettings"

Readonly message

message: undefined | SyncSettingsMessage

The message that this event originated from.

Readonly player

player: PlayerData<RoomType>

The player that this event is for.

Readonly room

room: RoomType

The room or client that the event came from.

Readonly settings

settings: GameSettings

The settings that were set.

Accessors

alteredSettings

  • get alteredSettings(): GameSettings

  • The altered settings of the room that will be set, if changeed.

    Returns GameSettings

isDirty

  • get isDirty(): boolean

  • Whether the alteredSettings is different from the settings.

    Returns boolean

Constructors

constructor

Methods

setSettings

  • Change the settings that were set.

    Parameters

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc