MMORoom
A specialized type of Room entity on the client.
Properties
Methods
new MMORoom()
Developers never istantiate the MMORoom class: this is done internally by the SmartFoxServer 2X API.
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 proximityListUpdate 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.
Properties
defaultAOI Vec3D
Returns the default Area of Interest (AoI) of this MMORoom.
- See also
- MMORoomSettings#defaultAOI
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.
- See also
- MMORoomSettings#mapLimits
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.
- See also
- MMORoomSettings#mapLimits
Methods
getMMOItem(id) → MMOItem
Retrieves an MMOItem object from its id property.
The item is available to the current user if it falls within his Area of Interest only.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
id |
number |
|
The id of the item to be retrieved. |
- Returns
-
MMOItemAn MMOItem object, orundefinedif the item with the passed id is not in proximity of the current user.
getMMOItems() → Array of MMOItem
Retrieves all MMOItem object in the MMORoom that fall within the current user's Area of Interest.
- Returns
-
Array of MMOItemA list of MMOItem objects, or an empty list if no item is in proximity of the current user.