Made the youtube link actually embedded. Added a reference link about the UIGrabInstancer. |
Ads missing field |
||
Line 16: | Line 16: | ||
|ActivateRoot|Bool| Whether or not the GrabInstancer should activate the newly duplicated 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. | |EnableGrabbable|Bool| Whether or not the GrabInstancer should activate any Grabbable component on the newly duplicated slot. | ||
|SetInstancePersistent|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Bool|Bool]]>'''|TypeAdv3=true| | |SetInstancePersistent|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Bool|Bool]]>'''|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 | |ExcludedParts|{{RootFieldType|SyncRefList`1|[[Type:Slot|Slot]]}}| slots will be skipped while duplicating | ||
|Physical|Bool| If true, the GrabInstancer only reacts to physical grab. | |Physical|Bool| If true, the GrabInstancer only reacts to physical grab. |
Revision as of 16:46, 30 October 2024
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Component image
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
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 | Helps let you compose the duplicate |
ContainerTemplateInstanceRoot
|
Slot | Helps let you compose the duplicate |
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.