Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=User Login Status | |Name=User Login Status | ||
}} | }} | ||
The '''UserLoginStatus''' component gets the current login status of the local user. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|IsLoggedIn|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv0=true| | |IsLoggedIn|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv0=true| Whether the local user is logged in. | ||
|LoggedUserId|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv1=true| | |LoggedUserId|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv1=true| The userID of the local user if they are logged in. | ||
|LoggedUsername|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv2=true| | |LoggedUsername|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv2=true| The username of the local user if they are logged in. | ||
}} | }} | ||
== | == Usage == | ||
Attach to a Component to instantly get info on the local user's login status. | |||
== Examples == | == Examples == | ||
{{stub}} | |||
== See Also == | == See Also == | ||
* [[Component:UserLoginManager]] | |||
[[Category:Components:Cloud:Indicators{{#translation:}}|User Login Status]] | [[Category:Components:Cloud:Indicators{{#translation:}}|User Login Status]] | ||
[[Category:Components{{#translation:}}|User Login Status]] | [[Category:Components{{#translation:}}|User Login Status]] | ||
Latest revision as of 18:10, 6 February 2025
Component image 
User Login Status component as seen in the Scene Inspector
The UserLoginStatus component gets the current login status of the local user.
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 local user is logged in. |
LoggedUserId
|
raw output of String | The userID of the local user if they are logged in. |
LoggedUsername
|
raw output of String | The username of the local user if they are logged in. |
Usage
Attach to a Component to instantly get info on the local user's login status.
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.