| Package | com.smartfoxserver.v2.requests |
| Class | public class RoomSettings |
| Inheritance | RoomSettings  Object |
| Subclasses | MMORoomSettings, SFSGameSettings |
See also
| Property | Defined By | ||
|---|---|---|---|
| allowOwnerOnlyInvitation : Boolean
Specifies if the Room allows "Join Room" invitations to be sent by any user or just by its owner. | RoomSettings | ||
| events : RoomEvents
Defines the flags indicating which events related to the Room are dispatched by the SmartFox client. | RoomSettings | ||
| extension : RoomExtension
Defines the Extension that must be attached to the Room on the server-side, and its settings. | RoomSettings | ||
| groupId : String
Defines the id of the Group to which the Room should belong. | RoomSettings | ||
| isGame : Boolean
Indicates whether the Room is a Game Room or not. | RoomSettings | ||
| maxSpectators : int
Defines the maximum number of spectators allowed in the Room (only for Game Rooms). | RoomSettings | ||
| maxUsers : int
Defines the maximum number of users allowed in the Room. | RoomSettings | ||
| maxVariables : int
Defines the maximum number of Room Variables allowed for the Room. | RoomSettings | ||
| name : String
Defines the name of the Room. | RoomSettings | ||
| password : String
Defines the password of the Room. | RoomSettings | ||
| permissions : RoomPermissions
Defines the flags indicating which operations are permitted on the Room. | RoomSettings | ||
| variables : Array
Defines a list of RooomVariable objects to be attached to the Room. | RoomSettings | ||
| Method | Defined By | ||
|---|---|---|---|
RoomSettings(name:String)
Creates a new RoomSettings instance. | RoomSettings | ||
| allowOwnerOnlyInvitation | property |
allowOwnerOnlyInvitation:BooleanSpecifies if the Room allows "Join Room" invitations to be sent by any user or just by its owner.
The default value is true (only the creator is allowed to send invitations).
public function get allowOwnerOnlyInvitation():Boolean public function set allowOwnerOnlyInvitation(value:Boolean):voidSee also
| events | property |
events:RoomEventsDefines the flags indicating which events related to the Room are dispatched by the SmartFox client.
Room events include: users entering or leaving the room, user count change and user variables update.
If set to null, the events configured on the server-side are used (see the SmartFoxServer 2X Administration Tool documentation).
The default value is null.
public function get events():RoomEvents public function set events(value:RoomEvents):void| extension | property |
extension:RoomExtensionDefines the Extension that must be attached to the Room on the server-side, and its settings.
public function get extension():RoomExtension public function set extension(value:RoomExtension):void| groupId | property |
groupId:StringDefines the id of the Group to which the Room should belong. If the Group doesn't exist yet, a new one is created before assigning the Room to it.
The default value is default.
public function get groupId():String public function set groupId(value:String):voidSee also
| isGame | property |
isGame:BooleanIndicates whether the Room is a Game Room or not.
The default value is false.
public function get isGame():Boolean public function set isGame(value:Boolean):void| maxSpectators | property |
maxSpectators:intDefines the maximum number of spectators allowed in the Room (only for Game Rooms).
The default value is 0.
public function get maxSpectators():int public function set maxSpectators(value:int):voidSee also
| maxUsers | property |
maxUsers:intDefines the maximum number of users allowed in the Room. In case of Game Rooms, this is the maximum number of players.
The default value is 10.
public function get maxUsers():int public function set maxUsers(value:int):voidSee also
| maxVariables | property |
maxVariables:intDefines the maximum number of Room Variables allowed for the Room.
The default value is 5.
public function get maxVariables():int public function set maxVariables(value:int):void| name | property |
name:StringDefines the name of the Room.
public function get name():String public function set name(value:String):void| password | property |
password:StringDefines the password of the Room. If the password is set to an empty string, the Room won't be password protected.
The default value is an empty string.
public function get password():String public function set password(value:String):void| permissions | property |
permissions:RoomPermissionsDefines the flags indicating which operations are permitted on the Room.
Permissions include: name and password change, maximum users change and public messaging.
If set to null, the permissions configured on the server-side are used (see the SmartFoxServer 2X Administration Tool documentation).
The default value is null.
public function get permissions():RoomPermissions public function set permissions(value:RoomPermissions):void| variables | property |
variables:ArrayDefines a list of RooomVariable objects to be attached to the Room.
The default value is null.
public function get variables():Array public function set variables(value:Array):voidSee also
| RoomSettings | () | Constructor |
public function RoomSettings(name:String)Creates a new RoomSettings instance. The instance must be passed to the CreateRoomRequest class constructor.
Parametersname:String — The name of the Room to be created.
|
See also