Skip to main content
Provides the current player’s profile. Syncs automatically after login and after profile updates.

Methods

MethodParametersReturnsNotes
GetUser()User?Null if not logged in
Refresh()voidManual sync
UpdateUsername(username)stringvoidFire-and-forget
UpdateDisplayName(displayName)stringvoidFire-and-forget
UpdatePassword(old, new)string, stringvoidFire-and-forget
AddListener(listener)Actionvoid
RemoveListener(listener)Actionvoid

User

FieldTypeNotes
UidstringPlatform-level user ID
PlayerIdstringGame-specific player ID
Usernamestring
DisplayNamestring
Emailstring
AvatarstringURL
LangstringLocale code (e.g. “en”)
Locationstring
Timezonestring
CreatedAtstringISO timestamp