Class RoomSetPrivacyEvent<RoomType>

Emitted when the privacy of the room is updated.

Type parameters

RoomType: Hostable

Hierarchy

BasicEvent
- RoomSetPrivacyEvent

Implements

Index

Properties

Accessors

alteredPrivacy

Constructors

constructor

Methods

Properties

Static eventName

eventName: "room.setprivacy" = ...

eventName

eventName: "room.setprivacy" = ...

Readonly message

message: undefined | AlterGameMessage

The message that this event originated from.

Readonly newPrivacy

newPrivacy: PrivacyType

Readonly oldPrivacy

oldPrivacy: PrivacyType

Readonly room

room: RoomType

The room or client that the event came from.

Accessors

alteredPrivacy

get alteredPrivacy(): PrivacyType

- Defined in core/lib/events/room/SetPrivacy.ts:37
The altered privacy to set the room to, if changed.

Returns PrivacyType

Constructors

constructor

new RoomSetPrivacyEvent<RoomType>(room: RoomType, message: undefined | AlterGameMessage, oldPrivacy: PrivacyType, newPrivacy: PrivacyType): RoomSetPrivacyEvent<RoomType>

Overrides BasicEvent.constructor
- Defined in core/lib/events/room/SetPrivacy.ts:17
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- message: undefined | AlterGameMessage
- oldPrivacy: PrivacyType
- newPrivacy: PrivacyType
Returns RoomSetPrivacyEvent<RoomType>

Methods

revert

revert(): void

- Defined in core/lib/events/room/SetPrivacy.ts:44
Revert the room's privacy to its old privacy.

Returns void

setPrivacy

setPrivacy(privacy: PrivacyType): void

- Defined in core/lib/events/room/SetPrivacy.ts:52
Change the privacy that the room was set to.

Parameters
- privacy: PrivacyType
  
  The privacy to set.
Returns void

Generated using TypeDoc