Component:UIGrabInstancer

From Resonite Wiki
Revision as of 02:29, 29 July 2024 by AmasterAmaster (talk | contribs) (Added warning note.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
UIGrabInstancer component as seen in the Scene Inspector


The UIGrabInstancer component allows users to instance items from UIX elements from a template a user provides.

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 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>]] Persistence of the instance
ExcludedParts [[Type:list of Slot|list of Slot]] Slots will be skipped while duplicating

Usage

Useful for making copies of items you referenced, but specifically from the UIX panels you have.

The way this component instances the template, will spawn the copied item where the template is. So it is usually recommended to place the template where the instancer is so it is not jarring when attempting to grab a copy of the Slot. (the other way is to use ProtoFlux to recenter where the user's hand is to adjust for the distance.)

Examples

History

The UIGrabInstancer was added in Beta 2024.4.15.1407.

Related Components

  • GrabInstancer is similar to this component, but uses the grab feature in Resonite to make a copy of an item template.