Component:GrabInstancer: Difference between revisions

Latest revision as of 16:56, 30 October 2024

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Component image

**GrabInstancer** component as seen in the Scene Inspector

The GrabInstancer component spawns a new copy of Template and attaches it to the user's hand whenever the slot it is attached to is grabbed.

Usage

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.
`Template`	Slot	The slot that gets duplicated and grabbed when the GrabInstancer is grabbed.
`ContainerTemplate`	Slot
`ContainerTemplateInstanceRoot`	Slot
`ActivateRoot`	Bool	Whether or not the GrabInstancer should activate the newly duplicated slot.
`EnableGrabbable`	Bool	Whether or not the GrabInstancer should activate any Grabbable component on the newly duplicated slot.
`SetInstancePersistent`	[[Type:Nullable`1<Bool>\|Nullable`1<Bool>]]	Whether to set the duplicated object's persistence field, and what to set it to.
`ExcludedParts`	*[[Type:list* of** Slot\|list of Slot]]	slots will be skipped while duplicating
`Physical`	Bool	If true, the GrabInstancer only reacts to physical grab.
`GrabPriority`	Int	Determines what gets grabbed if several grabbable objects are touching someone's grab sphere. The IGrabbable with the highest priority will be grabbed first. If the highest priority ties with another IGrabbable, it will grab both of those and ignore any lower priority IGrabbables.

Behavior

Examples

A video tutorial about the GrabInstancer by ProbablePrime:

Related Components

UIGrabInstancer is similar to this component but uses UIX elements to do this.

@@ Line 6: / Line 6: @@
 |Name=GrabInstancer
 }}
-== Intoduction ==
 The '''GrabInstancer''' component spawns a new copy of <code>Template</code> and attaches it to the user's hand whenever the slot it is attached to is grabbed.
 == Usage ==
 {{Table ComponentFields
 |Template|Slot| The slot that gets duplicated and grabbed when the GrabInstancer is grabbed.
+|ContainerTemplate|Slot|
+|ContainerTemplateInstanceRoot|Slot|
 |ActivateRoot|Bool| Whether or not the GrabInstancer should activate the newly duplicated slot.
 |EnableGrabbable|Bool| Whether or not the GrabInstancer should activate any Grabbable component on the newly duplicated slot.
+|SetInstancePersistent|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv3=true| Whether to set the duplicated object's persistence field, and what to set it to.
+|ExcludedParts|{{RootFieldType|SyncRefList`1|[[Type:Slot|Slot]]}}| slots will be skipped while duplicating
 |Physical|Bool| If true, the GrabInstancer only reacts to physical grab.
-|GrabPriority|Int| When attempting to grab multiple objects at once, only those with the highest grab priority are grabbed.
+|GrabPriority|Int| {{Template:Grab Priority}}
 }}
 == Behavior ==
 == Examples ==
-* [https://www.youtube.com/watch?v=QFWU2dZTDvw GrabInstancer] by [[User:ProbablePrime|ProbablePrime]]
+A video tutorial about the GrabInstancer by [[User:ProbablePrime|ProbablePrime]]:
+<youtube>QFWU2dZTDvw</youtube>
 == Related Components ==
+* [[Component:UIGrabInstancer|UIGrabInstancer]] is similar to this component but uses [[UIX]] elements to do this.
 </translate>
-[[Category:Components{{#translation:}}|GrabInstancer (Component){{#translation:}}]]
+[[Category:Components{{#translation:}}|Grab Instancer]]
-[[Category:Components:Transform:Interaction{{#translation:}}|GrabInstancer (Component){{#translation:}}]]
+[[Category:ComponentStubs]]
+[[Category:Components:Transform:Interaction{{#translation:}}|Grab Instancer]]