Component:DynamicReferenceVariable: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page DynamicReferenceVariable (Component) to Component:DynamicReferenceVariable: Creating component Namespace
Add template
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
A dynamic reference variable is a component that allows storing any reference [[:Category:Type|Type]] inside the component. The reference is then accessible and changeable via the [[Dynamic Variables]] system.
{{Infobox Component
{{Infobox Component
|Image=DynamicReferenceVariable`1Component.png
|Image=DynamicReferenceVariable`1Component.png
Line 11: Line 11:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|VariableName|String|
|VariableName|String| {{Template:Variable Name Component}}
|Reference|IWorldElement|
|Reference|IWorldElement| The reference this variable holds. Can set and be changed by the [[Dynamic Variables]] system.
|OverrideOnLink|Bool|
|OverrideOnLink|Bool| {{Template:OverrideOnLink Field}}
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
This component can be used as an accessory and setter of the [[Dynamic Variables]] system. For more info check the [[Dynamic Variables]] page.


<!--T:4-->
<!--T:4-->
Line 25: Line 26:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Dynamic Reference Variable`1]]
[[Category:Components{{#translation:}}|Dynamic Reference Variable`1]]
[[Category:Components:Data:Dynamic{{#translation:}}|Dynamic Reference Variable`1]]
[[Category:Components:Data:Dynamic{{#translation:}}|Dynamic Reference Variable`1]]

Latest revision as of 16:11, 19 March 2024

A dynamic reference variable is a component that allows storing any reference Type inside the component. The reference is then accessible and changeable via the Dynamic Variables system.

Component image 
Dynamic Reference Variable`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 this component's refrenced value to the Dynamic Variables System.
Reference IWorldElement The reference this variable holds. Can set and be changed by 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

This component can be used as an accessory and setter of the Dynamic Variables system. For more info check the Dynamic Variables page.

Examples

Related Components