sfs2x.client.entities
Interface User

All Known Implementing Classes:

SFSUser

public interface User

The User interface defines all the methods and properties that an object representing a SmartFoxServer User entity exposes.

In the SmartFoxServer 2X client API this interface is implemented by the SFSUser class. Read the class description for additional informations.

See Also:

SFSUser

Method Summary

boolean	containsVariable(java.lang.String name) Indicates whether this user has the specified User Variable set or not.
int	getId() Indicates the id of this user.
java.lang.String	getName() Indicates the name of this user.
int	getPlayerId() Returns the id of this user as a player in a Game Room.
int	getPlayerId(Room room) Returns the playerId value of this user in the passed Room.
int	getPrivilegeId() Returns the id which identifies the privilege level of this user.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Defines a generic utility object that can be used to store custom user data.
IUserManager	getUserManager() *Private*
UserVariable	getVariable(java.lang.String varName) Retrieves a User Variable from its name.
java.util.List<UserVariable>	getVariables() Retrieves all the User Variables of this user.
boolean	isAdmin() Indicates whether this user logged in as an administrator or not.
boolean	isGuest() Indicates whether this user logged in as a guest or not.
boolean	isItMe() Indicates if this User object represents the current client.
boolean	isJoinedInRoom(Room room) Indicates whether this user joined the passed Room or not.
boolean	isModerator() Indicates whether this user logged in as a moderator or not.
boolean	isPlayer() Indicates whether this user is a player (playerId greater than 0) in the last joined Room or not.
boolean	isPlayerInRoom(Room room) Indicates whether this user is a player (playerId greater than 0) in the passed Room or not.
boolean	isSpectator() Indicates whether this user is a spectator (playerId lower than 0) in the last joined Room or not.
boolean	isSpectatorInRoom(Room room) Indicates whether this user is a spectator (playerId lower than 0) in the passed Room or not.
boolean	isStandardUser() Indicates whether this user logged in as a standard user or not.
void	removePlayerId(Room room) *Private*
void	setPlayerId(int id, Room room) *Private*
void	setPrivilegeId(int privilegeId) Returns a reference to the User Manager which manages this user.
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> properties) *Private*
void	setUserManager(IUserManager userManager)
void	setVariable(UserVariable userVariable) *Private*
void	setVariables(java.util.List<? extends UserVariable> userVariables) *Private*

Method Detail

getId

int getId()

Indicates the id of this user. It is unique and it is generated by the server when the user is created.

getName

java.lang.String getName()

Indicates the name of this user. Two users in the same Zone can't have the same name.

getPlayerId

int getPlayerId()

Returns the id of this user as a player in a Game Room.

This property differs from id property and it used to indicate which player number is assigned to a user inside a Game Room. For example, in a Game Room for 5 players the first client joining it will have playerId equal to 1, the second will have it equal to 2 and so forth. When a user leaves the Room the player slot is freed up and the next user joining the Room will take it.

The playerId property applies to Game Rooms only; in standard Rooms it is always 0. Also, in Game Rooms a playerId value lower than 0 indicates that the user is a spectator.

If the user is inside multiple Game Rooms at the same time, a different playerId value will be assigned to him in each Room. In this case this property returns the value corresponding to the last joined Room; in order to obtain the playerId value in a specific Room, use the getPlayerId() method.

See Also:

getPlayerId(Room)

isPlayer

boolean isPlayer()

Indicates whether this user is a player (playerId greater than 0) in the last joined Room or not. Non-Game Rooms always return false.

If the user is inside multiple Game Rooms at the same time, use the isPlayerInRoom() method.

See Also:

isPlayerInRoom(sfs2x.client.entities.Room), getPlayerId(), isSpectator()

isSpectator

boolean isSpectator()

Indicates whether this user is a spectator (playerId lower than 0) in the last joined Room or not. Non-Game Rooms always return false.

If the user is inside multiple Game Rooms at the same time, use the isSpectatorInRoom() method.

See Also:

isSpectatorInRoom(sfs2x.client.entities.Room), getPlayerId(), isPlayer()

getPlayerId

int getPlayerId(Room room)

Returns the playerId value of this user in the passed Room. See the playerId property description for more informations.

Parameters:

room - The Room object representing the Room to retrieve the player id from.

Returns:

The playerId of this user in the passed Room.

See Also:

getPlayerId()

setPlayerId

void setPlayerId(int id,
                 Room room)

*Private*

removePlayerId

void removePlayerId(Room room)

*Private*

getPrivilegeId

int getPrivilegeId()

Returns the id which identifies the privilege level of this user.

NOTE: setting the privilegeId property manually has no effect on the server and can disrupt the API functioning. Privileges are assigned to the user by the server when the user logs in.

See Also:

UserPrivileges

setPrivilegeId

void setPrivilegeId(int privilegeId)

Returns a reference to the User Manager which manages this user.

NOTE: setting the userManager property manually has no effect on the server and can disrupt the API functioning.

getUserManager

IUserManager getUserManager()

*Private*

setUserManager

void setUserManager(IUserManager userManager)

isGuest

boolean isGuest()

Indicates whether this user logged in as a guest or not. Guest users have the privilegeId property se to UserPrivileges.GUEST.

Returns:

true if this user is a guest.

See Also:

isStandardUser(), isModerator(), isAdmin(), getPrivilegeId(), UserPrivileges.GUEST

isStandardUser

boolean isStandardUser()

Indicates whether this user logged in as a standard user or not. Standard users have the privilegeId property se to UserPrivileges.STANDARD.

Returns:

true if this user is a standard user.

See Also:

isGuest(), isModerator(), isAdmin(), getPrivilegeId(), UserPrivileges.STANDARD

isModerator

boolean isModerator()

Indicates whether this user logged in as a moderator or not. Moderator users have the privilegeId property se to UserPrivileges.MODERATOR.

Returns:

true if this user is a moderator.

See Also:

isGuest(), isStandardUser(), isAdmin(), getPrivilegeId(), UserPrivileges.MODERATOR

isAdmin

boolean isAdmin()

Indicates whether this user logged in as an administrator or not. Administrator users have the privilegeId property se to UserPrivileges.ADMINISTRATOR.

Returns:

true if this user is an administrator.

See Also:

isGuest(), isStandardUser(), isModerator(), getPrivilegeId(), UserPrivileges.ADMINISTRATOR

isPlayerInRoom

boolean isPlayerInRoom(Room room)

Indicates whether this user is a player (playerId greater than 0) in the passed Room or not. Non-Game Rooms always return false.

If a user can join one Game Rooms at a time only, use the isPlayer property.

Parameters:

room - The Room object representing the Room where to check if this user is a player.

Returns:

true if this user is a player in the passed Room.

See Also:

isPlayer(), isSpectatorInRoom(Room), getPlayerId()

isSpectatorInRoom

boolean isSpectatorInRoom(Room room)

Indicates whether this user is a spectator (playerId lower than 0) in the passed Room or not. Non-Game Rooms always return false.

If a user can join one Game Rooms at a time only, use the isSpectator property.

Parameters:

room - The Room object representing the Room where to check if this user is a spectator.

Returns:

true if this user is a spectator in the passed Room.

See Also:

isSpectator(), isPlayerInRoom(Room), getPlayerId()

isJoinedInRoom

boolean isJoinedInRoom(Room room)

Indicates whether this user joined the passed Room or not.

Parameters:

room - The Room object representing the Room where to check the user presence.

Returns:

true if this user is inside the passed Room.

isItMe

boolean isItMe()

Indicates if this User object represents the current client.

See Also:

SmartFox.getMySelf()

getVariables

java.util.List<UserVariable> getVariables()

Retrieves all the User Variables of this user.

Returns:

The list of UserVariable objects associated with the user.

See Also:

UserVariable, getVariable(String)

getVariable

UserVariable getVariable(java.lang.String varName)

Retrieves a User Variable from its name.

Parameters:

varName - The name of the User Variable to be retrieved.

Returns:

The UserVariable object representing the User Variable, or null if no User Variable with the passed name is associated with this user.

See Also:

getVariables(), SetUserVariablesRequest

setVariable

void setVariable(UserVariable userVariable)

*Private*

setVariables

void setVariables(java.util.List<? extends UserVariable> userVariables)

*Private*

containsVariable

boolean containsVariable(java.lang.String name)

Indicates whether this user has the specified User Variable set or not.

Parameters:

name - The name of the User Variable whose existance must be checked.

Returns:

true if a User Variable with the passed name is set for this user.

getProperties

java.util.Map<java.lang.String,java.lang.Object> getProperties()

Defines a generic utility object that can be used to store custom user data. The values added to this object are for client-side use only and are never transmitted to the server or to the other clients.

setProperties

void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

*Private*