Automated: update DeDuplicate |
add info |
||
| Line 3: | Line 3: | ||
|Name=User Login Manager | |Name=User Login Manager | ||
}} | }} | ||
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 the dash world. Is the button for logging in or out. | ||
}} | }} | ||
== Sync Delegates == | == Sync Delegates == | ||
{{Table ComponentTriggers | {{Table ComponentTriggers | ||
|DoLoginLogout()|[[Type:ButtonEventHandler|ButtonEventHandler]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| | |DoLoginLogout()|[[Type:ButtonEventHandler|ButtonEventHandler]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| Only works in the dash world. Starts the user logging in or logging out. | ||
}} | }} | ||
== | == Usage == | ||
{{stub}} | |||
== Examples == | == Examples == | ||
Used in the dash for the profile facet. | |||
== 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]] | ||
Revision as of 18:02, 6 February 2025
Component image 
User Login Manager 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 the dash world. Is the button for logging in or out. |
Sync Delegates
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|
Usage
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Examples
Used in the dash for the profile facet.