Component:ParentReference: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
unstub
 
Line 1: Line 1:
{{Infobox Component
{{Infobox Component
|Image=ParentReference`1Component.png
|Image=ParentReference`1Component.png
|Name=Parent Reference`1
|Name=ParentReference<T>
}}
}}
{{stub}}


== Usage ==
The '''ParentReference<T>''' component provides a [[reference type]] for the [[parent value]] system.
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Tag|String|
|Tag|String|Tag of the parent value. Compatible [[Component:ParentReferenceLink|ParentReferenceLink]] components on the slot's immediate children must have the same tag.
|Reference|'''T'''|TypeAdv1=true|
|Reference|'''T'''|TypeAdv1=true|The value of the parent value associated with the <code>Tag</code> and type.
}}
}}


== Behavior ==
== Usage ==
 
When this component is on a slot, all immediate children are part of its parent value system. Any immediate children of the slot with a [[Component:ParentReferenceLink|ParentReferenceLink]] component that matches the type and <code>Tag</code> of this component will be linked to the <code>Reference</code> provided by this component.
 
This can be especially useful for [[Component:Snapper|Snapper]]/[[Component:SnapTarget|SnapTarget]] systems.


== Examples ==
== Examples ==
Line 17: Line 22:
== See Also ==
== See Also ==


[[Category:Components:Data:Parent{{#translation:}}|Parent Reference`1]]
* [[Component:ParentValue]], for [[value types]].
[[Category:Components{{#translation:}}|Parent Reference`1]]
 
[[Category:Generic Components{{#translation:}}|Parent Reference`1]]
[[Category:Components:Data:Parent{{#translation:}}]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}]]
[[Category:Generic Components{{#translation:}}]]

Latest revision as of 19:51, 18 December 2024

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


The ParentReference<T> component provides a reference type for the 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.
Tag String Tag of the parent value. Compatible ParentReferenceLink components on the slot's immediate children must have the same tag.
Reference T The value of the parent value associated with the Tag and type.

Usage

When this component is on a slot, all immediate children are part of its parent value system. Any immediate children of the slot with a ParentReferenceLink component that matches the type and Tag of this component will be linked to the Reference provided by this component.

This can be especially useful for Snapper/SnapTarget systems.

Examples

See Also