Component:UserOnlineStatusSync: Difference between revisions

From Resonite Wiki
userspace, add example, cleanup
formatting & reword
 
Line 4: Line 4:
}}
}}


The '''UserOnlineStatusSync''' component only works in [[userspace]]. It informs of what [[status]] the user has.
The '''UserOnlineStatusSync''' component only works in [[userspace]]. It provides the [[online status]] that your account currently has.


== Fields ==
== Fields ==
Line 16: Line 16:


== Examples ==
== Examples ==
The OnlineStatus and OnlineStatusV2 facet in [[Resonite Essentials]] use UserOnlineStatusSync for setting the status and keeping the status synced.


resrec:///G-Resonite/R-49769871-ecfc-4d4d-a13c-0c72d4cd4ed6
The OnlineStatus and OnlineStatusV2 facet in [[Resonite Essentials]] use UserOnlineStatusSync for setting the status and keeping the status synced:


resrec:///G-Resonite/R-c605cdd7-305a-4446-87ca-3d537d9c2176
* <code>resrec:///G-Resonite/R-49769871-ecfc-4d4d-a13c-0c72d4cd4ed6</code>
* <code>resrec:///G-Resonite/R-c605cdd7-305a-4446-87ca-3d537d9c2176</code>


== See Also ==
== See Also ==

Latest revision as of 19:37, 14 April 2025

Component image 
UserOnlineStatusSync component as seen in the Scene Inspector


The UserOnlineStatusSync component only works in userspace. It provides the online status that your account currently has.

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.
OnlineStatus OnlineStatus The online status of the local user.

Usage

Attach to a slot that will be in userspace (like a facet) and bring it into userspace in order for it to begin working.

Examples

The OnlineStatus and OnlineStatusV2 facet in Resonite Essentials use UserOnlineStatusSync for setting the status and keeping the status synced:

  • resrec:///G-Resonite/R-49769871-ecfc-4d4d-a13c-0c72d4cd4ed6
  • resrec:///G-Resonite/R-c605cdd7-305a-4446-87ca-3d537d9c2176

See Also