Packagecom.smartfoxserver.v2.requests
Classpublic class RoomSettings
InheritanceRoomSettings Inheritance Object
Subclasses MMORoomSettings, SFSGameSettings

The RoomSettings class is a container for the settings required to create a Room using the CreateRoomRequest request.

See also

CreateRoomRequest
Room


Public Properties
 PropertyDefined 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
Public Methods
 MethodDefined By
  
RoomSettings(name:String)
Creates a new RoomSettings instance.
RoomSettings
Property Detail
allowOwnerOnlyInvitationproperty
allowOwnerOnlyInvitation:Boolean

Specifies 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).


Implementation
    public function get allowOwnerOnlyInvitation():Boolean
    public function set allowOwnerOnlyInvitation(value:Boolean):void

See also

eventsproperty 
events:RoomEvents

Defines 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.


Implementation
    public function get events():RoomEvents
    public function set events(value:RoomEvents):void
extensionproperty 
extension:RoomExtension

Defines the Extension that must be attached to the Room on the server-side, and its settings.


Implementation
    public function get extension():RoomExtension
    public function set extension(value:RoomExtension):void
groupIdproperty 
groupId:String

Defines 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.


Implementation
    public function get groupId():String
    public function set groupId(value:String):void

See also

isGameproperty 
isGame:Boolean

Indicates whether the Room is a Game Room or not.

The default value is false.


Implementation
    public function get isGame():Boolean
    public function set isGame(value:Boolean):void
maxSpectatorsproperty 
maxSpectators:int

Defines the maximum number of spectators allowed in the Room (only for Game Rooms).

The default value is 0.


Implementation
    public function get maxSpectators():int
    public function set maxSpectators(value:int):void

See also

maxUsersproperty 
maxUsers:int

Defines 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.


Implementation
    public function get maxUsers():int
    public function set maxUsers(value:int):void

See also

maxVariablesproperty 
maxVariables:int

Defines the maximum number of Room Variables allowed for the Room.

The default value is 5.


Implementation
    public function get maxVariables():int
    public function set maxVariables(value:int):void
nameproperty 
name:String

Defines the name of the Room.


Implementation
    public function get name():String
    public function set name(value:String):void
passwordproperty 
password:String

Defines 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.


Implementation
    public function get password():String
    public function set password(value:String):void
permissionsproperty 
permissions:RoomPermissions

Defines 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.


Implementation
    public function get permissions():RoomPermissions
    public function set permissions(value:RoomPermissions):void
variablesproperty 
variables:Array

Defines a list of RooomVariable objects to be attached to the Room.

The default value is null.


Implementation
    public function get variables():Array
    public function set variables(value:Array):void

See also

Constructor Detail
RoomSettings()Constructor
public function RoomSettings(name:String)

Creates a new RoomSettings instance. The instance must be passed to the CreateRoomRequest class constructor.

Parameters
name:String — The name of the Room to be created.

See also