| Package | com.smartfoxserver.v2.requests.mmo |
| Class | public class MMORoomSettings |
| Inheritance | MMORoomSettings  RoomSettings Object |
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 | |
| defaultAOI : Vec3D
Defines the Area of Interest (AoI) for the MMORoom. | MMORoomSettings | ||
| 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 | |
| mapLimits : MapLimits
Defines the limits of the virtual environment represented by the MMORoom. | MMORoomSettings | ||
| 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 | |
| proximityListUpdateMillis : int
Configures the speed at which the SFSEvent.PROXIMITY_LIST_UPDATE event is sent by the server. | MMORoomSettings | ||
| sendAOIEntryPoint : Boolean
Sets if the users entry points in the current user's Area of Interest should be transmitted in the SFSEvent.PROXIMITY_LIST_UPDATE event. | MMORoomSettings | ||
| userMaxLimboSeconds : int
Defines the time limit before a user without a physical position set inside the MMORoom is kicked from the Room. | MMORoomSettings | ||
| variables : Array
Defines a list of RooomVariable objects to be attached to the Room. | RoomSettings | |
| Method | Defined By | ||
|---|---|---|---|
MMORoomSettings(name:String)
Creates a new MMORoomSettings instance. | MMORoomSettings | ||
| defaultAOI | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesdefaultAOI:Vec3DDefines the Area of Interest (AoI) for the MMORoom.
This value represents the area/range around the user that will be affected by server events and other users events. It is a Vec3D object providing 2D or 3D coordinates.
Setting this value is mandatory.
public function get defaultAOI():Vec3D public function set defaultAOI(value:Vec3D):voidVec3D(50,50) describes a range of 50 units (e.g. pixels) in all four directions (top, bottom, left, right) with respect to the user position in a 2D coordinates system.A
Vec3D(120,120,60) describes a range of 120 units in all four directions (top, bottom, left, right) and 60 units along the two Z-axis directions (backward, forward) with respect to the user position in a 3D coordinates system.
| mapLimits | property |
mapLimits:MapLimitsDefines the limits of the virtual environment represented by the MMORoom.
When specified, this property must contain two non-null Vec3D objects representing the minimum and maximum limits of the 2D/3D coordinates systems. Any positional value that falls outside the provided limit will be refused by the server.
This setting is optional but its usage is highly recommended.
public function get mapLimits():MapLimits public function set mapLimits(value:MapLimits):void| proximityListUpdateMillis | property |
proximityListUpdateMillis:intConfigures the speed at which the SFSEvent.PROXIMITY_LIST_UPDATE event is sent by the server.
In an MMORoom, the regular users list is replaced by a proximity list, which keeps an updated view of the users currently within the Area of Interest of the current user. The speed at which these updates are fired by the server is regulated by this parameter, which sets the minimum time between two subsequent updates.
NOTE: values below the default might be unnecessary for most applications unless they are in realtime.
The default value is 250 milliseconds.
public function get proximityListUpdateMillis():int public function set proximityListUpdateMillis(value:int):voidSee also
| sendAOIEntryPoint | property |
sendAOIEntryPoint:BooleanSets if the users entry points in the current user's Area of Interest should be transmitted in the SFSEvent.PROXIMITY_LIST_UPDATE event.
If this setting is set to true, when a user enters the AoI of another user, the server will also send the coordinates
at which the former "appeared" within the AoI. This option should be turned off in case these coordinates are not needed, in order to save bandwidth.
The default value is true.
public function get sendAOIEntryPoint():Boolean public function set sendAOIEntryPoint(value:Boolean):voidSee also
| userMaxLimboSeconds | property |
userMaxLimboSeconds:intDefines the time limit before a user without a physical position set inside the MMORoom is kicked from the Room.
As soon as the MMORoom is joined, the user still doesn't have a physical position set in the coordinates system, therefore it is considered in a "limbo" state. At this point the user is expected to set his position (via the SetUserPositionRequest request) within the amount of seconds expressed by this value.
The default value is 50 seconds.
public function get userMaxLimboSeconds():int public function set userMaxLimboSeconds(value:int):void| MMORoomSettings | () | Constructor |
public function MMORoomSettings(name:String)Creates a new MMORoomSettings instance. The instance must be passed to the CreateRoomRequest class constructor.
Parametersname:String — The name of the MMORoom to be created.
|
See also