Class PlayerSyncSettingsEvent<RoomType>

constructor

• new PlayerSyncSettingsEvent<RoomType extends StatefulRoom<any>>(
      room: RoomType,
      player: Player<RoomType>,
      message: undefined | SyncSettingsMessage,
      settings: GameSettings,
  ): PlayerSyncSettingsEvent<RoomType>

  Type Parameters

  • RoomType extends StatefulRoom<any>

  Parameters

  • room: RoomType
  • player: Player<RoomType>
  • message: undefined | SyncSettingsMessage
  • settings: GameSettings

    The settings that were set.

  Returns PlayerSyncSettingsEvent<RoomType>

eventName

Readonlymessage

Readonlyplayer

Readonlyroom

Readonlysettings

StaticeventName

alteredSettings

• get alteredSettings(): GameSettings

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

  Returns GameSettings

isDirty

• get isDirty(): boolean

  Whether the PlayerSyncSettingsEvent.alteredSettings is different from the PlayerSyncSettingsEvent.settings.

  Returns boolean

setSettings

• setSettings(settings: Partial<AllGameSettings>): void

  Change the settings that were set.

  Parameters

  • settings: Partial<AllGameSettings>

    The settings to set.

  Returns void