SFSUser Class |
The SFSUser object represents a client logged in SmartFoxServer.
Inheritance HierarchySystemObject
Sfs2X.EntitiesSFSUser
Sfs2X.EntitiesSFSUser
Namespace: Sfs2X.Entities
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public class SFSUser : User
The SFSUser 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.
|
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.
|
| ToString |
Returns a string that contains the user id, name and a boolean indicating if the this object represents the current client.
(Overrides ObjectToString.) |
Remarks
The SmartFoxServer 2X client API are not aware of all the clients (users) connected to the server, but only of those that are in the same Rooms joined by the current client;
this reduces the traffic between the client and the server considerably. In order to interact with other users the client should join other Rooms
or use the Buddy List system to keep track of and interact with friends.
See Also