Component:OnlineStatusSettings: Difference between revisions

From Resonite Wiki
Automated: update Fields
add info
 
Line 3: Line 3:
|Name=Online Status Settings
|Name=Online Status Settings
}}
}}
{{stub}}
The '''OnlineStatusSettings''' component is used to define how online status for the user should be handled.


== Usage ==
See [[Settings]].
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|DefaultStatus|OnlineStatus|
|DefaultStatus|OnlineStatus| The default status for the user when they log in.
|RememberMode|'''[[#StatusRememberMode|OnlineStatusSettings.StatusRememberMode]]'''|TypeAdv1=true|
|RememberMode|'''[[#StatusRememberMode|OnlineStatusSettings.StatusRememberMode]]'''|TypeAdv1=true| Whether the status the user had when they were last on should be remembered.
|RememberTimespan|Double|
|RememberTimespan|Double| How long to remember the last status from the previous login before setting back to default again.
|InvisibleRememberMode|'''[[#StatusRememberMode|OnlineStatusSettings.StatusRememberMode]]'''|TypeAdv3=true|
|InvisibleRememberMode|'''[[#StatusRememberMode|OnlineStatusSettings.StatusRememberMode]]'''|TypeAdv3=true| How to remember the previous status from the last login.
|InvisibleRememberTimespan|Double|
|InvisibleRememberTimespan|Double| How long to remember a status if it's set to invisible.
|AutoAwayTimespan|Double|
|AutoAwayTimespan|Double| How long to wait when the user is AFK before enabling Away.
|EnableDefaultStatus|Bool|
|EnableDefaultStatus|Bool| Whether to enable the default status behavior.
|ShowRememberTimespan|Bool|
|ShowRememberTimespan|Bool| Whether to show the remember timespan control UI.
|ShowInvisibleRememberTimespan|Bool|
|ShowInvisibleRememberTimespan|Bool| Whether to show the remember invisible timespan control UI.
}}
}}


== Behavior ==
== Usage ==
See [[Settings]].


== Examples ==
== Examples ==
See [[Settings]].


== See Also ==
== See Also ==
See [[Settings]].


[[Category:Components:Uncategorized{{#translation:}}|Online Status Settings]]
[[Category:Components:Uncategorized{{#translation:}}|Online Status Settings]]
[[Category:Components{{#translation:}}|Online Status Settings]]
[[Category:Components{{#translation:}}|Online Status Settings]]
[[Category:Components With Nested Enums{{#translation:}}|Online Status Settings]]
[[Category:Components With Nested Enums{{#translation:}}|Online Status Settings]]
[[Category:ComponentStubs]]

Latest revision as of 19:25, 26 June 2025

Component image 
File:OnlineStatusSettingsComponent.png
Online Status Settings component as seen in the Scene Inspector

The OnlineStatusSettings component is used to define how online status for the user should be handled.

See Settings.

Fields

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.
DefaultStatus OnlineStatus The default status for the user when they log in.
RememberMode OnlineStatusSettings.StatusRememberMode Whether the status the user had when they were last on should be remembered.
RememberTimespan Double How long to remember the last status from the previous login before setting back to default again.
InvisibleRememberMode OnlineStatusSettings.StatusRememberMode How to remember the previous status from the last login.
InvisibleRememberTimespan Double How long to remember a status if it's set to invisible.
AutoAwayTimespan Double How long to wait when the user is AFK before enabling Away.
EnableDefaultStatus Bool Whether to enable the default status behavior.
ShowRememberTimespan Bool Whether to show the remember timespan control UI.
ShowInvisibleRememberTimespan Bool Whether to show the remember invisible timespan control UI.

Usage

See Settings.

Examples

See Settings.

See Also

See Settings.