Component:UserLoginManager: Difference between revisions

Revision as of 06:05, 17 March 2025

Component image

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

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 the dash world. Is the button for logging in or out.

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`DoLoginLogoutButtonEventHandler`	ButtonEventHandler	X

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

Used in the dash for the profile facet.

@@ Line 8: / Line 8: @@
 {{Table ComponentFields
 |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| Whether the local user is currently logging out or not.
 |CurrentUsername|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv2=true| The username of the local user.
 |CurrentUserId|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv3=true| The user ID of the local user.
@@ Line 19: / Line 19: @@
 == Sync Delegates ==
 {{Table ComponentTriggers
-|DoLoginLogout()|[[Type:ButtonEventHandler|ButtonEventHandler]]&lt;[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData&gt;| Only works in the dash world. Starts the user logging in or logging out.
+|DoLoginLogout[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|false|
 }}