Component:ParentValueLink: Difference between revisions

From Resonite Wiki
unstub
add link
Line 10: Line 10:
|MatchTag|String|The tag to search for on the slot's immediate parent. Compatible [[Component:ParentValue|ParentValue]] components must have the same <code>Tag</code>.
|MatchTag|String|The tag to search for on the slot's immediate parent. Compatible [[Component:ParentValue|ParentValue]] components must have the same <code>Tag</code>.
|Target|{{RootFieldType|RefDrive`1|T}}|TypeAdv1=true|The field to drive using the value of the linked parent.
|Target|{{RootFieldType|RefDrive`1|T}}|TypeAdv1=true|The field to drive using the value of the linked parent.
|WriteBack|Bool|If <code>True</code>, any writes to the driven field will be propagated back to the <code>Value</code> provided by the ParentValue.
|WriteBack|Bool|If <code>True</code>, any writes to the driven field will be propagated back to the <code>Value</code> provided by the ParentValue. See [[Drives#Write Backs|write backs]].
|DefaultValue|'''T'''|TypeAdv3=true|Default value to use if the component can not find a compatible ParentValue.
|DefaultValue|'''T'''|TypeAdv3=true|Default value to use if the component can not find a compatible ParentValue.
}}
}}

Revision as of 18:25, 17 February 2025

Component image 
ParentValueLink<float> component as seen in the Scene Inspector

The ParentValueLink<T> component drives a field depending on the value of a compatible ParentValue as part of a parent value system.

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.
MatchTag String The tag to search for on the slot's immediate parent. Compatible ParentValue components must have the same Tag.
Target direct RefDrive`1<T> The field to drive using the value of the linked parent.
WriteBack Bool If True, any writes to the driven field will be propagated back to the Value provided by the ParentValue. See write backs.
DefaultValue T Default value to use if the component can not find a compatible ParentValue.

Usage

Upon a change of parent, this component will search for ParentValue components on the slot's immediate parent that have a matching type and tag. If it can find such a component and link to it, it will drive the Target field based on the Value of the ParentValue. If it can not find such a component, it will use the DefaultValue value.

Examples

See Also