sfs2x.client.requests
Class RoomEvents

java.lang.Object
  sfs2x.client.requests.RoomEvents

public class RoomEvents
extends java.lang.Object

The RoomEvents class contains a specific subset of the RoomSettings required to create a Room. It defines which events related to the Room will be fired by the SmartFox client.

See Also:

RoomSettings.getEvents(), CreateRoomRequest

Constructor Summary

RoomEvents()
Creates a new RoomEvents instance.

Method Summary

boolean	getAllowUserCountChange() Indicates whether or not the userCountChange event should be dispatched whenever the users (or players+spectators) count changes in the Room.
boolean	getAllowUserEnter() Indicates whether the userEnterRoom event should be dispatched whenever a user joins the Room or not.
boolean	getAllowUserExit() Indicates whether the userExitRoom event should be dispatched whenever a user leaves the Room or not.
boolean	getAllowUserVariablesUpdate() Indicates whether or not the userVariablesUpdate event should be dispatched whenever a user in the Room updates his User Variables.
void	setAllowUserCountChange(boolean allowUserCountChange) *Private*
void	setAllowUserEnter(boolean allowUserEnter) *Private*
void	setAllowUserExit(boolean allowUserExit) *Private*
void	setAllowUserVariablesUpdate(boolean allowUserVariablesUpdate) *Private*

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoomEvents

public RoomEvents()

Creates a new RoomEvents instance. The RoomSettings.events property must be set to this instance during Room creation.

See Also:

RoomSettings.getEvents()

Method Detail

getAllowUserEnter

public boolean getAllowUserEnter()

Indicates whether the userEnterRoom event should be dispatched whenever a user joins the Room or not.

Default: false

See Also:

SFSEvent.USER_ENTER_ROOM

setAllowUserEnter

public void setAllowUserEnter(boolean allowUserEnter)

*Private*

getAllowUserExit

public boolean getAllowUserExit()

Indicates whether the userExitRoom event should be dispatched whenever a user leaves the Room or not.

Default: false

See Also:

SFSEvent.USER_EXIT_ROOM

setAllowUserExit

public void setAllowUserExit(boolean allowUserExit)

*Private*

getAllowUserCountChange

public boolean getAllowUserCountChange()

Indicates whether or not the userCountChange event should be dispatched whenever the users (or players+spectators) count changes in the Room.

Default: false

See Also:

SFSEvent.USER_COUNT_CHANGE

setAllowUserCountChange

public void setAllowUserCountChange(boolean allowUserCountChange)

*Private*

getAllowUserVariablesUpdate

public boolean getAllowUserVariablesUpdate()

Indicates whether or not the userVariablesUpdate event should be dispatched whenever a user in the Room updates his User Variables.

Default: false

See Also:

SFSEvent.USER_VARIABLES_UPDATE

setAllowUserVariablesUpdate

public void setAllowUserVariablesUpdate(boolean allowUserVariablesUpdate)

*Private*