SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
RoomEvents.h
1 //
2 // RoomEvents.h
3 // SFS2X
4 //
5 // Original development by Infosfer Game Technologies Ltd. | http://www.infosfer.com.
6 //
7 // Maintained and developed by A51 Integrated.
8 // Copyright 2012 A51 Integrated | http://a51integrated.com. All rights reserved.
9 //
10 
11 
12 #import <Foundation/Foundation.h>
13 
14 /** This class provides Room event settings that can be specified when creating a new Room via the CreateRoomRequest
15 
16  You can configure which events the Room will fire in the Zone:
17 
18  - <b>allowUserEnter<b>: fire an event each time a User enters/joins the Room
19  - <b>allowUserExit<b>: fire an event each time a User exits/leaves the Room
20  - <b>allowUserCountChange<b>: fire an event each time the user count/spectator count changes in the Room
21  - <b>allowUserVariablesUpdate<b>: fire an event each time a user in the Room has updated his/her UserVariables
22 
23  Each of these events can be turned ON (true) or OFF (false)
24 
25  @see CreateRoomSettings
26  @see CreateRoomRequest
27  */
28 @interface RoomEvents : NSObject {
29  BOOL _allowUserEnter;
30  BOOL _allowUserExit;
31  BOOL _allowUserCountChange;
32  BOOL _allowUserVariablesUpdate;
33 }
34 
35 /** fire an event each time a User enters/joins the Room */
36 @property (readwrite) BOOL allowUserEnter;
37 /** fire an event each time a User exits/leaves the Room */
38 @property (readwrite) BOOL allowUserExit;
39 /** fire an event each time the user count/spectator count changes in the Room */
40 @property (readwrite) BOOL allowUserCountChange;
41 /** fire an event each time a user in the Room has updated his/her UserVariables */
42 @property (readwrite) BOOL allowUserVariablesUpdate;
43 
44 @end
RoomEvents
Definition: RoomEvents.h:28