Packagecom.smartfoxserver.v2.requests
Classpublic class RoomEvents
InheritanceRoomEvents Inheritance 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.events
CreateRoomRequest


Public Properties
 PropertyDefined By
  allowUserCountChange : Boolean
Indicates whether or not the userCountChange event should be dispatched whenever the users (or players+spectators) count changes in the Room.
RoomEvents
  allowUserEnter : Boolean
Indicates whether the userEnterRoom event should be dispatched whenever a user joins the Room or not.
RoomEvents
  allowUserExit : Boolean
Indicates whether the userExitRoom event should be dispatched whenever a user leaves the Room or not.
RoomEvents
  allowUserVariablesUpdate : Boolean
Indicates whether or not the userVariablesUpdate event should be dispatched whenever a user in the Room updates his User Variables.
RoomEvents
Public Methods
 MethodDefined By
  
Creates a new RoomEvents instance.
RoomEvents
Property Detail
allowUserCountChangeproperty
allowUserCountChange:Boolean

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

The default value is false.


Implementation
    public function get allowUserCountChange():Boolean
    public function set allowUserCountChange(value:Boolean):void

See also

allowUserEnterproperty 
allowUserEnter:Boolean

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

The default value is false.


Implementation
    public function get allowUserEnter():Boolean
    public function set allowUserEnter(value:Boolean):void

See also

allowUserExitproperty 
allowUserExit:Boolean

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

The default value is false.


Implementation
    public function get allowUserExit():Boolean
    public function set allowUserExit(value:Boolean):void

See also

allowUserVariablesUpdateproperty 
allowUserVariablesUpdate:Boolean

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

The default value is false.


Implementation
    public function get allowUserVariablesUpdate():Boolean
    public function set allowUserVariablesUpdate(value:Boolean):void

See also

Constructor Detail
RoomEvents()Constructor
public function RoomEvents()

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

See also