Component:RadiantDashStateSync: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Radiant Dash State Sync
|Name=Radiant Dash State Sync
}}
}}
{{stub}}
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.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|IsFreeform|Bool|
|IsFreeform|Bool| Whether the userspace dash is set to freeform movement.
|IsOpen|Bool|
|IsOpen|Bool| Whether the userspace dash is currently open.
|Curvature|Float|
|Curvature|Float| What the curvature of the dash is currently.
}}
}}


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


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


== See Also ==
== See Also ==
* [[Dash]]


[[Category:Components:Radiant UI{{#translation:}}|Radiant Dash State Sync]]
[[Category:Components:Radiant UI{{#translation:}}|Radiant Dash State Sync]]
[[Category:Components{{#translation:}}|Radiant Dash State Sync]]
[[Category:Components{{#translation:}}|Radiant Dash State Sync]]
[[Category:ComponentStubs]]

Latest revision as of 20:47, 31 January 2025

Component image 
Radiant Dash State Sync component as seen in the Scene Inspector

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.

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.

See Also