Class PlayerSyncSettingsEvent<RoomType>

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

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- PlayerSyncSettingsEvent

Implements

Index

Properties

Accessors

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

Accessors

alteredSettings

get alteredSettings(): GameSettings

- Defined in core/lib/events/player/SyncSettings.ts:38
The altered settings of the room that will be set, if changeed.

Returns GameSettings

isDirty

get isDirty(): boolean

- Defined in core/lib/events/player/SyncSettings.ts:46
Whether the PlayerSyncSettingsEvent.alteredSettings is different from the PlayerSyncSettingsEvent.settings.

Returns boolean

Constructors

constructor

new PlayerSyncSettingsEvent<RoomType>(room: RoomType, player: PlayerData<RoomType>, message: undefined | SyncSettingsMessage, settings: GameSettings): PlayerSyncSettingsEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/player/SyncSettings.ts:20
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- player: PlayerData<RoomType>
- message: undefined | SyncSettingsMessage
- settings: GameSettings
Returns PlayerSyncSettingsEvent<RoomType>

Methods

setSettings

setSettings(settings: Partial<AllGameSettings>): void

- Defined in core/lib/events/player/SyncSettings.ts:54
Change the settings that were set.

Parameters
- settings: Partial<AllGameSettings>
  
  The settings to set.
Returns void

Generated using TypeDoc