Public Member Functions | |
| (void) | - clearVariables |
| (int) | - getId |
| (NSString *) | - getName |
| (NSInteger) | - getPlayerId |
| (id) | - getVariable: |
| (NSMutableDictionary *) | - getVariables |
| (id) | - initWithParams:name: |
| (BOOL) | - isModerator |
| (BOOL) | - isSpectator |
| (void) | - setIsSpectator: |
| (void) | - setModerator: |
| (void) | - setPlayerId: |
| (void) | - setVariables: |
Static Public Member Functions | |
| (id) | + user:name: |
NOTE: in the provided examples, user always indicates a User instance.
| - (void) clearVariables |
Reset User Variabless.
| - (int) getId |
| - (NSString *) getName |
Get the name of the user.
| - (NSInteger) getPlayerId |
Retrieve the player id of the user. The user must be a player inside a game room for this method to work properly. This id is 1-based (player 1, player 2, etc.), but if the user is a spectator its value is -1.
| - (id) getVariable: | (NSString *) | varName |
Retrieve a User Variable.
| varName | : the name of the variable to retrieve. |
| - (NSMutableDictionary *) getVariables |
Retrieve the list of all User Variables.
| - (id) initWithParams: | (NSInteger) | id | ||
| name: | (NSString *) | name | ||
| - (BOOL) isModerator |
A boolean flag indicating if the user is a Moderator in the current zone.
| - (BOOL) isSpectator |
A boolean flag indicating if the user is a spectator in the current room.
| - (void) setIsSpectator: | (BOOL) | b |
| - (void) setModerator: | (BOOL) | b |
| - (void) setPlayerId: | (NSInteger) | pid |
Set the playerId property.
| pid | : the playerId value. |
| - (void) setVariables: | (NSDictionary *) | o |
Set the User Variabless.
| o | : an object containing variables' key-value pairs. |
| + (id) user: | (NSInteger) | id | ||
| name: | (NSString *) | name | ||
User contructor.
| id | : the user id. | |
| name | : the user name. |
1.5.8