Component:DynamicReference: Difference between revisions

From Resonite Wiki
Add info
add field info and clean
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
Dynamic Reference is a component that allows marking of any [[Type:SyncRef`1|SyncRef`1 (Reference holder)]] as part of the [[Dynamic Variables]] System. The value inside of the specified [[Type:SyncRef`1|SyncRef]] can change and will be changed by the [[Dynamic Variables]] System. The variable name and the type of variable will determine how this will link to and be changed by the [[Dynamic Variables]] System. For more info on how Dynamic Variables work please check the [[Dynamic Variables]] page.
{{Infobox Component
{{Infobox Component
|Image=DynamicReference`1Component.png
|Image=DynamicReference`1Component.png
|Name=Dynamic Reference`1
|Name=Dynamic Reference`1
}}
}}
The '''DynamicReference''' component allows marking of any [[Type:SyncRef`1|SyncRef`1 (Reference holder)]] as part of the [[Dynamic Variables]] System. The value inside of the specified [[Type:SyncRef`1|SyncRef]] can change and will be changed by the [[Dynamic Variables]] System. The variable name and the type of variable will determine how this will link to and be changed by the [[Dynamic Variables]] System. For more info on how Dynamic Variables work please check the [[Dynamic Variables]] page.


<!--T:2-->
<!--T:2-->
Line 12: Line 12:
{{Table ComponentFields
{{Table ComponentFields
|VariableName|String| {{Template:Variable Name Component}}
|VariableName|String| {{Template:Variable Name Component}}
|TargetReference|SyncRef`1|TypeString1=SyncRef<IWorldElement>|
|TargetReference|[[Type:SyncRef`1|SyncRef`1]]&lt;T&gt;|TypeAdv1=true| The field to become synced with and be the definition of the reference dynamic variable.
|OverrideOnLink|Bool|{{Template:OverrideOnLink Field}}
|OverrideOnLink|Bool|{{Template:OverrideOnLink Field}}
}}
}}
Line 18: Line 18:
<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{stub}}


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Dynamic Reference`1]]
[[Category:Components{{#translation:}}|Dynamic Reference`1]]
[[Category:Components:Data:Dynamic{{#translation:}}|Dynamic Reference`1]]
[[Category:Components:Data:Dynamic{{#translation:}}|Dynamic Reference`1]]

Revision as of 21:12, 13 February 2025

Component image 
Dynamic Reference`1 component as seen in the Scene Inspector

The DynamicReference component allows marking of any SyncRef`1 (Reference holder) as part of the Dynamic Variables System. The value inside of the specified SyncRef can change and will be changed by the Dynamic Variables System. The variable name and the type of variable will determine how this will link to and be changed by the Dynamic Variables System. For more info on how Dynamic Variables work please check the Dynamic Variables page.

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.
VariableName String The Variable name that will be used to link this component's refrenced value to the Dynamic Variables System.
TargetReference SyncRef`1<T> The field to become synced with and be the definition of the reference dynamic variable.
OverrideOnLink Bool whether this component should write its value to a Dynamic Variable Space Component when it links to the space, updating all child variables with the same name and type.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

See Also