sfs3::event::Login Struct Reference

Dispatched after a successful login in a Zone. More...

#include <SFSEvent.h>

Public Attributes
std::string	zoneName
	The name of the Zone that was logged in.
std::shared_ptr< entities::User >	mySelf
	The User object of the client that logged in.
std::shared_ptr< entities::SFSObject >	params
	The custom parameters returned by a custom login system, or nullptr if none.

Detailed Description

Dispatched after a successful login in a Zone.

Sent in response to a requests::LoginRequest.

mySelf is a convenience for the handler's own scope. To access your User data anywhere else use SmartFox::getMySelf, which always tracks the currently logged in User: logging out of a Zone clears it, whereas this snapshot keeps the previous User alive and detached from the API state.

See also

requests::LoginRequest

entities::User

SFSEvent::LOGIN_ERROR

SFSEvent::LOGOUT

---

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

• event/SFSEvent.h