MMORoomSettings Class Reference

#import <MMORoomSettings.h>

Inherits RoomSettings.

Instance Methods
(id)	- initWithName:

Class Methods
(id)	+ settingsWithName:

Properties
Vec3D *	defaultAOI
MapLimits *	mapLimits
NSInteger	userMaxLimboSeconds
NSInteger	proximityListUpdateMillis
BOOL	sendAOIEntryPoint
Properties inherited from RoomSettings
NSString *	name
NSString *	password
NSString *	groupId
BOOL	isGame
NSInteger	maxUsers
NSInteger	maxSpectators
NSInteger	maxVariables
NSArray *	variables
RoomPermissions *	permissions
RoomEvents *	events
RoomExtension *	extension
BOOL	allowOwnerOnlyInvitation

Detailed Description

The MMORoomSettings class is a container for the settings required to create an MMORoom using the CreateRoomRequest request.

See also

MMORoom

CreateRoomRequest

CreateRoomSettings

Method Documentation

initWithName:

- (id) initWithName:

(NSString *)

name

Parameters

name	the name of the MMORoom

Reimplemented from RoomSettings.

settingsWithName:

+ (id) settingsWithName:

(NSString *)

name

Parameters

name	the name of the MMORoom

Reimplemented from RoomSettings.

Property Documentation

defaultAOI

- (Vec3D*) defaultAOI

readwritenonatomicstrong

Defines 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 represented by a Vec3D object providing 2D or 3D coordinates.

NOTE: Setting this value is mandatory.

Example #1: a Vec3D(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.

Example #2: 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.

See also

Vec3D

mapLimits

- (MapLimits*) mapLimits

readwritenonatomicstrong

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

See also

Vec3D

proximityListUpdateMillis

- (NSInteger) proximityListUpdateMillis

readwritenonatomicassign

Configures the speed at which the [ISFSEvents onProximityListUpdate:] 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 (AoI) 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.

Default value is 250 milliseconds.

See also

[ISFSEvents onProximityListUpdate:]

sendAOIEntryPoint

- (BOOL) sendAOIEntryPoint

readwritenonatomicassign

Sets if the users entry points in the current user's Area of Interest should be transmitted in the [ISFSEvents onProximityListUpdate:] event.

If this setting is set to YES, 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.

Default value: YES

See also

[User aoiEntryPoint]

[MMOItem aoiEntryPoint]

[ISFSEvents onProximityListUpdate]

userMaxLimboSeconds

- (NSInteger) userMaxLimboSeconds

readwritenonatomicassign

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

Default value is 50 seconds.