| Package | com.smartfoxserver.v2.entities |
| Class | public class MMORoom |
| Inheritance | MMORoom  SFSRoom Object |
The MMORoom is ideal for huge virtual worlds and MMO games because it works with proximity lists instead of "regular" users lists. This allows thousands of users to interact with each other based on their Area of Interest (AoI). The AoI represents a range around the user that is affected by server and user events, outside which no other events are received.
The size of the AoI is set at Room creation time and it is the same for all users who joined it. Supposing that the MMORoom hosts a 3D virtual world, setting an AoI of (x=100, y=100, z=40) for the Room tells the server to transmit updates and broadcast events to and from those users that fall within the AoI range around the current user; this means the area within +/- 100 units on the X axis, +/- 100 units on the Y axis and +/- 40 units on the Z axis.
As the user moves around in the virtual environment, he can update his position in the corresponding MMORoom and thus continuously receive events about other users (and items - see below) entering and leaving his AoI. The player will be able to update his position via the SetUserPositionRequest request and receive updates on his current proximity list by means of the SFSEvent.PROXIMITY_LIST_UPDATE event.
Finally, MMORooms can also host any number of "MMOItems" which represent dynamic non-player objects that users can interact with. They are handled by the MMORoom using the same rules of visibility described before.
See also
| Property | Defined By | ||
|---|---|---|---|
 | capacity : int [read-only]
Returns the maximum amount of users, including spectators, that can be contained in this Room. | SFSRoom | |
| defaultAOI : Vec3D
Returns the default Area of Interest (AoI) of this MMORoom. | MMORoom | ||
| groupId : String [read-only]
Returns the Room Group name. | SFSRoom | |
| higherMapLimit : Vec3D
Returns the higher coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes. | MMORoom | ||
| id : int [read-only]
Indicates the id of this Room. | SFSRoom | |
| isGame : Boolean
Indicates whether this is a Game Room or not. | SFSRoom | |
| isHidden : Boolean
Indicates whether this Room is hidden or not. | SFSRoom | |
| isJoined : Boolean
Indicates whether the client joined this Room or not. | SFSRoom | |
| isPasswordProtected : Boolean
Indicates whether this Room requires a password to be joined or not. | SFSRoom | |
| lowerMapLimit : Vec3D
Returns the lower coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes. | MMORoom | ||
| maxSpectators : int
Returns the maximum number of spectators allowed in this Room (Game Rooms only). | SFSRoom | |
| maxUsers : int
Returns the maximum number of users allowed in this Room. | SFSRoom | |
| name : String
Indicates the name of this Room. | SFSRoom | |
| playerList : Array [read-only]
Returns a list of User objects representing the players currently inside this Room (Game Rooms only). | SFSRoom | |
| properties : Object
Defines a generic utility object that can be used to store custom Room data. | SFSRoom | |
| roomManager : IRoomManager
Returns a reference to the Room Manager which manages this Room. | SFSRoom | |
| spectatorCount : int
Returns the current number of spectators in this Room (Game Rooms only). | SFSRoom | |
| spectatorList : Array [read-only]
Returns a list of User objects representing the spectators currently inside this Room (Game Rooms only). | SFSRoom | |
| userCount : int
Returns the current number of users in this Room. | SFSRoom | |
| userList : Array [read-only]
Returns a list of User objects representing all the users currently inside this Room. | SFSRoom | |
| Method | Defined By | ||
|---|---|---|---|
MMORoom(id:int, name:String, groupId:String = default) | MMORoom | ||
| containsUser(user:User):Boolean
Indicates whether the specified user is currently inside this Room or not. | SFSRoom | |
| containsVariable(name:String):Boolean
Indicates whether this Room has the specified Room Variable set or not. | SFSRoom | |
getMMOItem(id:int):IMMOItem
Retrieves an MMOItem object from its id property. | MMORoom | ||
getMMOItems():Array
Retrieves all MMOItem object in the MMORoom that fall within the current user's Area of Interest. | MMORoom | ||
| getUserById(id:int):User
Retrieves a User object from its id property. | SFSRoom | |
| getUserByName(name:String):User
Retrieves a User object from its name property. | SFSRoom | |
| getVariable(name:String):RoomVariable
Retrieves a Room Variable from its name. | SFSRoom | |
| getVariables():Array
Retrieves all the Room Variables of this Room. | SFSRoom | |
| toString():String
Returns a string that contains the Room id, name and id of the Group to which it belongs. | SFSRoom | |
| defaultAOI | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesdefaultAOI:Vec3DReturns the default Area of Interest (AoI) of this MMORoom.
public function get defaultAOI():Vec3D public function set defaultAOI(value:Vec3D):voidSee also
| higherMapLimit | property |
higherMapLimit:Vec3D
Returns the higher coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes.
If null is returned, no limits were set at Room creation time.
public function get higherMapLimit():Vec3D public function set higherMapLimit(value:Vec3D):voidSee also
| lowerMapLimit | property |
lowerMapLimit:Vec3D
Returns the lower coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes.
If null is returned, no limits were set at Room creation time.
public function get lowerMapLimit():Vec3D public function set lowerMapLimit(value:Vec3D):voidSee also
| MMORoom | () | Constructor |
public function MMORoom(id:int, name:String, groupId:String = default)Parameters
id:int | |
name:String | |
groupId:String (default = default) |
| addMMOItem | () | method |
| getMMOItem | () | method |
public function getMMOItem(id:int):IMMOItemRetrieves an MMOItem object from its id property. The item is available to the current user if it falls within his Area of Interest only.
Parameters
id:int — The id of the item to be retrieved.
|
IMMOItem — An MMOItem object, or null if the item with the passed id is not in proximity of the current user.
|
| getMMOItems | () | method |
public function getMMOItems():ArrayRetrieves all MMOItem object in the MMORoom that fall within the current user's Area of Interest.
ReturnsArray — A list of MMOItem objects, or an empty list if no item is in proximity of the current user.
|
See also
| removeItem | () | method |
kernel function removeItem(id:int):voidParameters
id:int |