Component:DynamicField`1: Difference between revisions

From Resonite Wiki
not a styb
cleanup, unstub, add info
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=DynamicField`1Component.png
|Image=DynamicField`1Component.png
|Name=DynamicField`1
|Name=DynamicField<T>
}}
}}
 
The '''DynamicField<T>''' binds the [[field]] pointed to by <code>TargetField</code> to the [[dynamic variable]] referred to by <code>VariableName</code>. The field must be a [[value type]].
<!--T:2-->
== Intoduction ==
The '''DynamicField`1''' component points at a field containing a value type. The value of the its variable is whatever the field contains, and the field will be updated if the variable is written to.
 
For demonstration purposes, this component is shown with a [[Type:Float|float]] type.


<!--T:3-->
<!--T:3-->
== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|VariableName|String|The name of the dynamic variable to be used
|VariableName|String|The name of the dynamic variable to be used
|TargetField|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;T&gt;}}|TypeAdv1=true|The field that will be used as the dynamic variable's value
|TargetField|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;T&gt;}}|TypeAdv1=true|The field that will be used as the dynamic variable's value.
|OverrideOnLink|Bool|If true, the value of the field will be written when this component is moved into a new space
|OverrideOnLink|Bool|If true, the value of the field will be written when this component is moved into a new space
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
This component works almost exactly like the [[Component:DynamicValueVariable|DynamicValueVariable]] component, except that the value used for the dynamic variable is sourced from a separate field. This field will be automatically updated with the value of the dynamic variable, and writing to the field will write to the dynamic variable. This can be used to directly bind fields of separate components as a dynamic variable without having to use a [[Component:DynamicValueVariableDriver|DynamicValueVariableDriver]] or similar setup.


<!--T:5-->
<!--T:5-->
Line 29: Line 24:


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
* [[Dynamic Variables]]
* [[Component:DynamicReference]], for the same functionality but with [[reference types]].
* [[Component:DynamicValueVariable]]
</translate>
</translate>
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]

Revision as of 19:57, 13 November 2024

Component image 
DynamicField<T> component as seen in the Scene Inspector

The DynamicField<T> binds the field pointed to by TargetField to the dynamic variable referred to by VariableName. The field must be a value type.

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.
VariableName String The name of the dynamic variable to be used
TargetField direct RelayRef`1<IField`1<T>> The field that will be used as the dynamic variable's value.
OverrideOnLink Bool If true, the value of the field will be written when this component is moved into a new space

Usage

This component works almost exactly like the DynamicValueVariable component, except that the value used for the dynamic variable is sourced from a separate field. This field will be automatically updated with the value of the dynamic variable, and writing to the field will write to the dynamic variable. This can be used to directly bind fields of separate components as a dynamic variable without having to use a DynamicValueVariableDriver or similar setup.

Examples

See Also