Component:DynamicValueVariableDriver: Difference between revisions

From Resonite Wiki
add info
add missing field
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
Dynamic Value Variable Driver is a component that can drive a [[Type:IField`1|IField`1 (Value Holder)]] to the value assigned to a dynamic variable with the name <code>VariableName</code>. if the specified variable cannot be found, the value will revert to <code>DefaultTarget</code> how this works is explained on [[Dynamic Variables]] page.
{{Infobox Component
{{Infobox Component
|Image=DynamicValueVariableDriver`1Component.png
|Image=DynamicValueVariableDriver`1Component.png
|Name=Dynamic Value Variable Driver`1
|Name=Dynamic Value Variable Driver`1
}}
}}
Dynamic Value Variable Driver is a component that can drive a [[Type:IField`1|IField`1 (Value Holder)]] to the value assigned to a dynamic variable with the name <code>VariableName</code>. if the specified variable cannot be found, the value will revert to <code>DefaultTarget</code> how this works is explained on [[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}}
|Target|IField`1| {{Template:DefaultTarget Field}}
|Target|{{RootFieldType|FieldDrive`1|T}}|TypeAdv1=true| {{Template:DefaultTarget Field}}
|DefaultValue|'''T'''|TypeAdv2=true| The value to revert to when one doesn't exist.
}}
}}


Line 26: Line 27:
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Dynamic Value Variable Driver`1]]
[[Category:Components{{#translation:}}|Dynamic Value Variable Driver`1]]
[[Category:Generic Components{{#translation:}}|Dynamic Value Variable Driver`1]]
[[Category:Components:Data:Dynamic{{#translation:}}|Dynamic Value Variable Driver`1]]
[[Category:Components:Data:Dynamic{{#translation:}}|Dynamic Value Variable Driver`1]]

Latest revision as of 21:48, 19 March 2025

Component image 
Dynamic Value Variable Driver`1 component as seen in the Scene Inspector

Dynamic Value Variable Driver is a component that can drive a IField`1 (Value Holder) to the value assigned to a dynamic variable with the name VariableName. if the specified variable cannot be found, the value will revert to DefaultTarget how this works is explained on 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.
Target field drive of T The value/reference to revert to when this component cannot find the specified VariableName dynamic variable.
DefaultValue T The value to revert to when one doesn't exist.

Usage

Examples

Related Components