sfs3::entities::User Class Reference

A client logged in SmartFoxServer that is "known" by the current client, that is, one who is inside one of the joined Rooms. More...

#include <User.h>

Inheritance diagram for sfs3::entities::User:

Public Member Functions
virtual int32_t	getId () const =0
virtual std::string	getName () const =0
virtual int32_t	getPlayerId () const =0
	Returns the id of this user as a player in a Game Room.
virtual int32_t	getPlayerId (const Room *room) const =0
	Returns the player id of this user in the given Room.
virtual bool	isPlayer () const =0
	Tells if this user is a player in the last joined Room, that is, his player id is greater than 0.
virtual bool	isSpectator () const =0
	Tells if this user is a spectator in the last joined Room, that is, his player id is lower than 0.
virtual bool	isPlayerInRoom (const Room *room) const =0
	Tells if this user is a player in the given Room.
virtual bool	isSpectatorInRoom (const Room *room) const =0
	Tells if this user is a spectator in the given Room.
virtual bool	isJoinedInRoom (const Room *room) const =0
	Tells if this user joined the given Room.
virtual int32_t	getPrivilegeId () const =0
	Returns the id of the privilege level of this user.
virtual core::UserManager *	getUserManager () const =0
virtual bool	isGuest () const =0
	Tells if this user logged in as a guest or not.
virtual bool	isStandardUser () const =0
	Tells if this user logged in as a standard user or not.
virtual bool	isModerator () const =0
	Tells if this user logged in as a moderator or not.
virtual bool	isAdmin () const =0
	Tells if this user logged in as an administrator or not.
virtual bool	isItMe () const =0
	Tells if this User object represents the current client.
virtual std::vector< std::shared_ptr< UserVariable > >	getVariables () const =0
virtual std::shared_ptr< UserVariable >	getVariable (const std::string &varName) const =0
	Retrieves a User Variable from its name.
virtual bool	containsVariable (const std::string &name) const =0
	Tells if this user has the given User Variable set or not.
virtual std::optional< Vec3D >	getAOIEntryPoint () const =0
	Returns the point inside the current user's Area of Interest where this user "appeared" with the last proximity list update, in an MMORoom.

Detailed Description

A client logged in SmartFoxServer that is "known" by the current client, that is, one who is inside one of the joined Rooms.

SFSUser is the standard implementation of this interface.

The setters are for the API itself: a value set by hand has no effect on the server and can disrupt the working of the API.

See also

SFSUser

Member Function Documentation

getId()

virtual int32_t sfs3::entities::User::getId ( ) const

pure virtual

Returns

the id of this user, unique and generated by the server when the user is created

Implemented in sfs3::entities::SFSUser.

getName()

virtual std::string sfs3::entities::User::getName ( ) const

pure virtual

Returns

the name of this user. Two users in the same Zone cannot have the same name. The comparison is case sensitive.

Implemented in sfs3::entities::SFSUser.

getPlayerId() [1/2]

virtual int32_t sfs3::entities::User::getPlayerId ( ) const

pure virtual

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

This is not the same as the id: it says which player number the user got inside a Game Room. For example, in a Game Room for 5 players the first client that joins gets player id 1, the second gets 2, and so on. When a user leaves the Room his slot is freed, and the next user who joins takes it.

The player id applies to Game Rooms only: in a standard Room it is always 0. In a Game Room a value lower than 0 means the user is a spectator.

A user inside more than one Game Room at the same time has a different player id in each of them. This method returns the value for the last joined Room; to read the value in a specific Room, use User::getPlayerId(const Room*) const.

Returns

the player id in the last joined Game Room

Implemented in sfs3::entities::SFSUser.

getPlayerId() [2/2]

virtual int32_t sfs3::entities::User::getPlayerId ( const Room * room ) const

pure virtual

Returns the player id of this user in the given Room.

Parameters

room	The Room to read the player id from.

Returns

The player id of this user in that Room.

See also

User::getPlayerId() const

Implemented in sfs3::entities::SFSUser.

isPlayer()

virtual bool sfs3::entities::User::isPlayer ( ) const

pure virtual

Tells if this user is a player in the last joined Room, that is, his player id is greater than 0.

A non-Game Room always gives false. For a user inside more than one Game Room at the same time, use User::isPlayerInRoom instead.

Returns

true if this user is a player

See also

User::getPlayerId() const

User::isSpectator

Implemented in sfs3::entities::SFSUser.

isSpectator()

virtual bool sfs3::entities::User::isSpectator ( ) const

pure virtual

Tells if this user is a spectator in the last joined Room, that is, his player id is lower than 0.

A non-Game Room always gives false. For a user inside more than one Game Room at the same time, use User::isSpectatorInRoom instead.

Returns

true if this user is a spectator

See also

User::getPlayerId() const

User::isPlayer

Implemented in sfs3::entities::SFSUser.

isPlayerInRoom()

virtual bool sfs3::entities::User::isPlayerInRoom ( const Room * room ) const

pure virtual

Tells if this user is a player in the given Room.

A non-Game Room always gives false.

Parameters

room	The Room where to check if this user is a player.

Returns

true if this user is a player in that Room.

See also

User::isPlayer

User::isSpectatorInRoom

Implemented in sfs3::entities::SFSUser.

isSpectatorInRoom()

virtual bool sfs3::entities::User::isSpectatorInRoom ( const Room * room ) const

pure virtual

Tells if this user is a spectator in the given Room.

A non-Game Room always gives false.

Parameters

room	The Room where to check if this user is a spectator.

Returns

true if this user is a spectator in that Room.

See also

User::isSpectator

User::isPlayerInRoom

Implemented in sfs3::entities::SFSUser.

isJoinedInRoom()

virtual bool sfs3::entities::User::isJoinedInRoom ( const Room * room ) const

pure virtual

Tells if this user joined the given Room.

Parameters

room	The Room where to check the presence of the user.

Returns

true if this user is inside that Room.

Implemented in sfs3::entities::SFSUser.

getPrivilegeId()

virtual int32_t sfs3::entities::User::getPrivilegeId ( ) const

pure virtual

Returns the id of the privilege level of this user.

The server assigns the privileges to the user when he logs in.

Returns

the privilege id

See also

entities::UserPrivileges

Implemented in sfs3::entities::SFSUser.

getUserManager()

virtual core::UserManager * sfs3::entities::User::getUserManager ( ) const

pure virtual

Returns

the User Manager that manages this user

Implemented in sfs3::entities::SFSUser.

isGuest()

virtual bool sfs3::entities::User::isGuest ( ) const

pure virtual

Tells if this user logged in as a guest or not.

A guest user has his privilege id set to UserPrivileges::GUEST.

Returns

true if this user is a guest

See also

User::getPrivilegeId

UserPrivileges

Implemented in sfs3::entities::SFSUser.

isStandardUser()

virtual bool sfs3::entities::User::isStandardUser ( ) const

pure virtual

Tells if this user logged in as a standard user or not.

A standard user has his privilege id set to UserPrivileges::STANDARD.

Returns

true if this user is a standard user

See also

User::getPrivilegeId

UserPrivileges

Implemented in sfs3::entities::SFSUser.

isModerator()

virtual bool sfs3::entities::User::isModerator ( ) const

pure virtual

Tells if this user logged in as a moderator or not.

A moderator has his privilege id set to UserPrivileges::MODERATOR.

Returns

true if this user is a moderator

See also

User::getPrivilegeId

UserPrivileges

Implemented in sfs3::entities::SFSUser.

isAdmin()

virtual bool sfs3::entities::User::isAdmin ( ) const

pure virtual

Tells if this user logged in as an administrator or not.

An administrator has his privilege id set to UserPrivileges::ADMINISTRATOR.

Returns

true if this user is an administrator

See also

User::getPrivilegeId

UserPrivileges

Implemented in sfs3::entities::SFSUser.

isItMe()

virtual bool sfs3::entities::User::isItMe ( ) const

pure virtual

Tells if this User object represents the current client.

Returns

true if this is the current client

See also

SmartFox::getMySelf

Implemented in sfs3::entities::SFSUser.

getVariables()

virtual std::vector< std::shared_ptr< UserVariable > > sfs3::entities::User::getVariables ( ) const

pure virtual

Returns

all the User Variables of this user

See also

UserVariable

User::getVariable

Implemented in sfs3::entities::SFSUser.

getVariable()

virtual std::shared_ptr< UserVariable > sfs3::entities::User::getVariable ( const std::string & varName ) const

pure virtual

Retrieves a User Variable from its name.

Parameters

varName

The name of the User Variable to find.

Returns

The User Variable, or nullptr if this user has no variable with that name.

See also

User::getVariables

requests::SetUserVariablesRequest

Implemented in sfs3::entities::SFSUser.

containsVariable()

virtual bool sfs3::entities::User::containsVariable ( const std::string & name ) const

pure virtual

Tells if this user has the given User Variable set or not.

Parameters

name	The name of the User Variable to look for.

Returns

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

Implemented in sfs3::entities::SFSUser.

getAOIEntryPoint()

virtual std::optional< Vec3D > sfs3::entities::User::getAOIEntryPoint ( ) const

pure virtual

Returns the point inside the current user's Area of Interest where this user "appeared" with the last proximity list update, in an MMORoom.

It is set only when the MMORoom is configured to send the entry points; otherwise the optional stays empty.

Returns

the entry point, or an empty optional

See also

requests::MMOSettings::sendAOIEntryPoint

SFSEvent::PROXIMITY_LIST_UPDATE

Implemented in sfs3::entities::SFSUser.

---

The documentation for this class was generated from the following file:

• entities/User.h