Class SFS2X.Requests.RoomPermissions
A subset of the RoomSettings defining which operations users will be able to execute on the Room after its creation.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Creates a new RoomPermissions instance.
|
Field Summary
Class Detail
SFS2X.Requests.RoomPermissions()
Creates a new RoomPermissions instance.
The RoomSettings.permissions property must be set to this instance during Room creation.
Field Detail
{Boolean}
allowNameChange
Sets whether changing the Room name after its creation is allowed or not.
The Room name can be changed by means of the ChangeRoomNameRequest request.
- Default Value:
- false
- See also:
- SFS2X.Requests.System.ChangeRoomNameRequest
{Boolean}
allowPasswordStateChange
Sets whether changing (or removing) the Room password after its creation is allowed or not.
The Room password can be changed by means of the ChangeRoomPasswordStateRequest request.
- Default Value:
- false
- See also:
- SFS2X.Requests.System.ChangeRoomPasswordStateRequest
{Boolean}
allowPublicMessages
Sets whether users inside the Room are allowed to send public messages or not.
Public messages can be sent by means of the PublicMessageRequest request.
- Default Value:
- true
- See also:
- SFS2X.Requests.System.PublicMessageRequest
{Boolean}
allowResizing
Sets whether the Room capacity can be changed after its creation or not.
The capacity is the maximum number of users and spectators (in Game Rooms) allowed to enter the Room. It can be changed by means of the ChangeRoomCapacityRequest request.
- Default Value:
- false
- See also:
- SFS2X.Requests.System.ChangeRoomCapacityRequest