The User class is used internally by the SmartFoxClient object to store the properties of each user. Also, User objects are returned by different methods and events of the API.
1.0.0
Final
The gotoAndPlay() Team
© 2006-2007 gotoAndPlay()
The User class is used internally by the SmartFoxClient object to store the properties of each user. | |
The default contructor. | |
Get the user id. | |
Get the user name. | |
Retrieve a User Variable. | |
Retrieve the list of all User Variables. | |
A boolean flag indicating if the user is a spectator in the current room. | |
A boolean flag indicating if the user is a Moderator in the current Zone. | |
Retrieve the player id of the user. |
public function isModerator():Boolean
A boolean flag indicating if the user is a Moderator in the current Zone.
You can get more details about Moderators in the “Zone configuration” documentation (http://www.smartfoxserver.com- /docs- /docPages- /config- /basics.htm#zone).
None.
Boolean | true if the user is a Moderator. |
The default contructor.
public function User( id: int, name: String )
Get the user id.
public function getId():int
Get the user name.
public function getName():String
Retrieve a User Variable.
public function getVariables():Array
A boolean flag indicating if the user is a spectator in the current room.
public function isSpectator():Boolean
A boolean flag indicating if the user is a Moderator in the current Zone.
public function isModerator():Boolean
Retrieve the player id of the user.
public function getPlayerId():int
Set on or more User Variables.
public function setUserVariables( varObj: Object, roomId: int = -1 ):void