Class RoomSetPrivacyEvent<RoomType>

Emitted when the privacy of the room is updated.

Type Parameters

RoomType extends Hostable = Hostable

Hierarchy

BasicEvent
- RoomSetPrivacyEvent

Implements

Index

Properties

eventName eventName message newPrivacy oldPrivacy room

Accessors

Constructors

Methods

revert setPrivacy

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

The new privacy of the room.

`Readonly` oldPrivacy

oldPrivacy: PrivacyType

The old privacy of the room.

`Readonly` room

room: RoomType

The room or client that the event came from.

Accessors

alteredPrivacy

get alteredPrivacy(): PrivacyType
The altered privacy to set the room to, if changed.

Returns PrivacyType
- Defined in node_modules/@skeldjs/core/dist/lib/events/room/SetPrivacy.d.ts:35

Constructors

constructor

new RoomSetPrivacyEvent<RoomType>(room: RoomType, message: undefined | AlterGameMessage, oldPrivacy: PrivacyType, newPrivacy: PrivacyType): RoomSetPrivacyEvent<RoomType>
Type Parameters
- RoomType extends Hostable<any, RoomType> = Hostable<any>
Parameters
- room: RoomType
- message: undefined | AlterGameMessage
- oldPrivacy: PrivacyType
  
  The old privacy of the room.
- newPrivacy: PrivacyType
  
  The new privacy of the room.
Returns RoomSetPrivacyEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in node_modules/@skeldjs/core/dist/lib/events/room/SetPrivacy.d.ts:23

Methods

revert

revert(): void
Revert the room's privacy to its old privacy.

Returns void
- Defined in node_modules/@skeldjs/core/dist/lib/events/room/SetPrivacy.d.ts:39

setPrivacy

setPrivacy(privacy: PrivacyType): void
Change the privacy that the room was set to.
Parameters
- privacy: PrivacyType
  
  The privacy to set.
Returns void
- Defined in node_modules/@skeldjs/core/dist/lib/events/room/SetPrivacy.d.ts:44

Generated using TypeDoc