User Interface |
The User interface defines all the methods and properties that an object representing a SmartFoxServer User entity exposes.
Namespace: Sfs2X.Entities
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public interface User
The User type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AOIEntryPoint |
Returns the entry point of this user in the current user's AoI.
|
| Id |
Indicates the id of this user.
|
| IsItMe |
Indicates if this User object represents the current client.
|
| IsPlayer |
Indicates whether this user is a player (playerId greater than 0) in the last joined Room or not.
|
| IsSpectator |
Indicates whether this user is a spectator (playerId lower than 0) in the last joined Room or not.
|
| Name |
Indicates the name of this user.
|
| PlayerId |
Returns the id of this user as a player in a Game Room.
|
| PrivilegeId |
Returns the id which identifies the privilege level of this user.
|
| Properties |
Defines a generic utility object that can be used to store custom user data.
|
| UserManager |
Returns a reference to the User Manager which manages this user.
|
Methods| Name | Description | |
|---|---|---|
 | ContainsVariable |
Indicates whether this user has the specified User Variable set or not.
|
| GetPlayerId |
Returns the playerId value of this user in the passed Room.
|
| GetVariable |
Retrieves a User Variable from its name.
|
| GetVariables |
Retrieves all the User Variables of this user.
|
| IsAdmin |
Indicates whether this user logged in as an administrator or not.
|
| IsGuest |
Indicates whether this user logged in as a guest or not.
|
| IsJoinedInRoom |
Indicates whether this user joined the passed Room or not.
|
| IsModerator |
Indicates whether this user logged in as a moderator or not.
|
| IsPlayerInRoom |
Indicates whether this user is a player (playerId greater than 0) in the passed Room or not.
|
| IsSpectatorInRoom |
Indicates whether this user is a spectator (playerId lower than 0) in the passed Room or not.
|
| IsStandardUser |
Indicates whether this user logged in as a standard user or not.
|
Remarks
In the SmartFoxServer 2X client API this interface is implemented by the SFSUser class. Read the class description for additional informations.
See Also