Component:RadiantDashStateSync: Difference between revisions

Latest revision as of 15:23, 14 April 2025

Component image

**RadiantDashStateSync** component as seen in the Scene Inspector

The RadiantDashStateSync component is a userspace component that grabs the current dash component in the userspace world and cross synchronizes its values with the dash.

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.
`IsFreeform`	Bool	Whether the userspace dash is set to freeform movement.
`IsOpen`	Bool	Whether the userspace dash is currently open.
`Curvature`	Float	What the curvature of the dash is currently.

Usage

Best used when attached to an item that will exist on the dash, like a facet.

Examples

Can be used to get user settings for a dash within a facet.

@@ Line 1: / Line 1: @@
 {{Infobox Component
 |Image=RadiantDashStateSyncComponent.png
-|Name=Radiant Dash State Sync
+|Name=RadiantDashStateSync
 }}
-The '''RadiantDashStateSync''' component only functions in user space. This component grabs the current dash component in the userspace world, and cross synchronizes its values with the userspace world dash.
+The '''RadiantDashStateSync''' component is a [[userspace]] component that grabs the current [[Component:RadiantDash|dash component]] in the userspace world and cross synchronizes its values with the dash.
 == Fields ==
@@ Line 13: / Line 14: @@
 == Usage ==
 Best used when attached to an item that will exist on the dash, like a facet.
 == Examples ==
 Can be used to get user settings for a dash within a facet.
 == See Also ==
 * [[Dash]]
 [[Category:Components:Radiant UI{{#translation:}}|Radiant Dash State Sync]]
 [[Category:Components{{#translation:}}|Radiant Dash State Sync]]