Component:DynamicField: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page DynamicField (Component) to Component:DynamicField: Creating component Namespace
Add info, no longer stub
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
Dynamic Field is a component that allows marking of any [[Type:IField`1|IField]] as part of the [[Dynamic Variables]] System. The value inside of the specified [[Type:IField`1|IField]] 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=DynamicField`1Component.png
|Image=DynamicField`1Component.png
Line 11: Line 11:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|VariableName|String|
|VariableName|String| The Variable name that will be used to link <code>TargetField</code> to the [[Dynamic Variables]] System.
|TargetField|IField`1|TypeString1=IField<float>|
|TargetField|IField`1|TypeString1=IField<float>| The Field to link to the [[Dynamic Variables]] System
|OverrideOnLink|Bool|
|OverrideOnLink|Bool| {{Template:OverrideOnLink Field}}
}}
}}


Line 25: Line 25:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Dynamic Field`1]]
[[Category:Components{{#translation:}}|Dynamic Field`1]]
[[Category:Components:Data:Dynamic{{#translation:}}|Dynamic Field`1]]
[[Category:Components:Data:Dynamic{{#translation:}}|Dynamic Field`1]]

Revision as of 15:36, 19 March 2024

Dynamic Field is a component that allows marking of any IField as part of the Dynamic Variables System. The value inside of the specified IField 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.

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


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 Variable name that will be used to link TargetField to the Dynamic Variables System.
TargetField IField<float> The Field to link to the Dynamic Variables System
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

Examples

Related Components