Component:UserLoginManager

From Resonite Wiki
Revision as of 19:02, 14 April 2025 by Bree (talk | contribs) (add example)
Component image 
UserLoginManager component as seen in the Scene Inspector


The UserLoginManager component is used to handle the user's login status.

Usage

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
IsLoggedIn raw output of Bool Whether the current user is logged in or not.
IsLoggingOut raw output of Bool Whether the local user is currently logging out or not.
CurrentUsername raw output of String The username of the local user.
CurrentUserId raw output of String The user ID of the local user.
CurrentAccountType raw output of String The account type of the local user (patreon status or team member likewise)
CurrentAccountColorOverride raw output of Nullable`1<ColorX> The current user color override of the local user. Like nametag colors.
CurrentProfileIcon Uri The user icon of the local user.
LoginLogoutButton Button Only works in userspace. Is the button for logging in or out.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
DoLoginLogout:ButtonEventHandler ButtonEventHandler X

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Examples

The UserProfile facet in Resonite Essentials uses UserLoginManager for getting profile information and logging out the user.

resrec:///G-Resonite/R-c01a8b5b-be64-4b35-aa16-a20ff5f8a030

See Also