Component:GrabInstancer

From Resonite Wiki
This page contains changes which are not marked for translation.


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.

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.
Template Slot The slot that gets duplicated and grabbed when the GrabInstancer is grabbed. (Like a figurine)
ContainerTemplate Slot The slot to duplicate and act as a container for the grabbed object (Like a box for a figurine)
ContainerTemplateInstanceRoot Slot The override on where to place the duplicated grabbed object (Where to put the figurine in the box hiearchy).
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 Nullable`1<Bool> Whether to set the duplicated object's persistence field, and what to set it to.
ExcludedParts 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.

Usage

Attach to a slot and provide a value for Template at minimum.

Examples

A video tutorial about the GrabInstancer by ProbablePrime:

See Also