Automated: create new component page |
update |
||
| (9 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Infobox Component | {{Infobox Component | ||
|Image=UserLoginManagerComponent.png | |Image=UserLoginManagerComponent.png | ||
|Name= | |Name=UserLoginManager | ||
}} | }} | ||
The '''UserLoginManager''' component is used to handle the user's login status. | |||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|IsLoggedIn|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv0=true| | |IsLoggedIn|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv0=true| Whether the current user is logged in or not. | ||
|IsLoggingOut|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv1=true| | |IsLoggingOut|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv1=true| Whether the local user is currently logging out or not. | ||
|CurrentUsername|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv2=true| | |CurrentUsername|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv2=true| The username of the local user. | ||
|CurrentUserId|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv3=true| | |CurrentUserId|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv3=true| The user ID of the local user. | ||
|CurrentAccountType|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv4=true| | |CurrentAccountType|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv4=true| The account type of the local user (patreon status or team member likewise) | ||
|CurrentAccountColorOverride|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]<[[Type:ColorX|ColorX]]>}}|TypeAdv5=true| | |CurrentAccountColorOverride|{{RootFieldType|RawOutput`1|[[Type:Nullable`1|Nullable`1]]<[[Type:ColorX|ColorX]]>}}|TypeAdv5=true| The current user color override of the local user. Like nametag colors. | ||
|CurrentProfileIcon|Uri| | |CurrentProfileIcon|Uri| The user icon of the local user. | ||
|LoginLogoutButton|'''[[Component:Button|Button]]'''|TypeAdv7=true| | |LoginLogoutButton|'''[[Component:Button|Button]]'''|TypeAdv7=true| Only works in [[userspace]]. Is the button for logging in or out. | ||
}} | }} | ||
== | == Sync Delegates == | ||
{{Table ComponentTriggers | |||
|DoLoginLogout:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|false| Triggers the login/logout process. | |||
}} | |||
== Usage == | |||
{{stub}} | |||
== Examples == | == Examples == | ||
The UserProfile facet in [[Resonite Essentials]] uses UserLoginManager for getting profile information and logging out the user: | |||
* <code>resrec:///G-Resonite/R-c01a8b5b-be64-4b35-aa16-a20ff5f8a030</code> | |||
== See Also == | == See Also == | ||
* [[Dash Menu]] | |||
[[Category:Components:Cloud{{#translation:}}|User Login Manager]] | [[Category:Components:Cloud{{#translation:}}|User Login Manager]] | ||
[[Category:Components{{#translation:}}|User Login Manager]] | [[Category:Components{{#translation:}}|User Login Manager]] | ||
Latest revision as of 17:50, 3 May 2025
Component image 
UserLoginManager component as seen in the Scene Inspector
The UserLoginManager component is used to handle the user's login status.
Usage
| 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
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|---|---|---|
DoLoginLogout:ButtonEventHandler
|
ButtonEventHandler | X | Triggers the login/logout process. |
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