MMORoom Class |
The MMORoom object represents a specialized type of Room entity on the client.
Inheritance HierarchyNamespace: Sfs2X.Entities
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public class MMORoom : SFSRoom
The MMORoom type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Capacity |
Returns the maximum amount of users, including spectators, that can be contained in this Room.
(Inherited from SFSRoom.) |
| DefaultAOI |
Returns the default Area of Interest (AoI) of this MMORoom.
|
| GroupId |
Returns the Room Group name.
(Inherited from SFSRoom.) |
| HigherMapLimit |
Returns the higher coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes.
|
| Id |
Indicates the id of this Room.
(Inherited from SFSRoom.) |
| IsGame |
Indicates whether this is a Game Room or not.
(Inherited from SFSRoom.) |
| IsHidden |
Indicates whether this Room is hidden or not.
(Inherited from SFSRoom.) |
| IsJoined |
Indicates whether the client joined this Room or not.
(Inherited from SFSRoom.) |
| IsPasswordProtected |
Indicates whether this Room requires a password to be joined or not.
(Inherited from SFSRoom.) |
| LowerMapLimit |
Returns the lower coordinates limit of the virtual environment represented by the MMORoom along the X,Y,Z axes.
|
| MaxSpectators |
Returns the maximum number of spectators allowed in this Room (Game Rooms only).
(Inherited from SFSRoom.) |
| MaxUsers |
Returns the maximum number of users allowed in this Room.
(Inherited from SFSRoom.) |
| Name |
Indicates the name of this Room.
(Inherited from SFSRoom.) |
| PlayerList |
Returns a list of User objects representing the players currently inside this Room (Game Rooms only).
(Inherited from SFSRoom.) |
| Properties |
Defines a generic utility object that can be used to store custom Room data.
(Inherited from SFSRoom.) |
| SpectatorCount |
Returns the current number of spectators in this Room (Game Rooms only).
(Inherited from SFSRoom.) |
| SpectatorList |
Returns a list of User objects representing the spectators currently inside this Room (Game Rooms only).
(Inherited from SFSRoom.) |
| UserCount |
Returns the current number of users in this Room.
(Inherited from SFSRoom.) |
| UserList |
Returns a list of User objects representing all the users currently inside this Room.
(Inherited from SFSRoom.) |
Methods| Name | Description | |
|---|---|---|
 | ContainsUser |
Indicates whether the specified user is currently inside this Room or not.
(Inherited from SFSRoom.) |
| ContainsVariable |
Indicates whether this Room has the specified Room Variable set or not.
(Inherited from SFSRoom.) |
| GetMMOItem |
Retrieves an MMOItem object from its id property.
|
| GetMMOItems |
Retrieves all MMOItem object in the MMORoom that fall within the current user's Area of Interest.
|
| GetUserById |
Retrieves a User object from its id property.
(Inherited from SFSRoom.) |
| GetUserByName |
Retrieves a User object from its name property.
(Inherited from SFSRoom.) |
| GetVariable |
Retrieves a Room Variable from its name.
(Inherited from SFSRoom.) |
| GetVariables |
Retrieves all the Room Variables of this Room.
(Inherited from SFSRoom.) |
| ToString |
Returns a string that contains the Room id, name and id of the Group to which it belongs.
(Inherited from SFSRoom.) |
Remarks
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
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