Component:UIGrabInstancer: Difference between revisions

From Resonite Wiki
Added infobox for the component picture. Updated description.
Moved a sentence to the related components, it is cleaner this way.
Line 4: Line 4:
}}
}}


The '''UIGrabInstancer''' component allows [[User|users]] to instance items from [[UIX]] elements from a template a user provides. This component is similar to the [[Component:GrabInstancer|GrabInstancer]] component.
The '''UIGrabInstancer''' component allows [[User|users]] to instance items from [[UIX]] elements from a template a user provides.


{{Table ComponentFields
{{Table ComponentFields
Line 25: Line 25:


== Related Components ==
== Related Components ==
* [[Component:GrabInstancer|GrabInstancer]] is similar to this component, but uses the grab feature in [[Resonite]] to make a copy of an item template.
[[Category:Components]]
[[Category:Components]]
[[Category:Components:UIX:Interaction]]
[[Category:Components:UIX:Interaction]]

Revision as of 03:39, 28 July 2024

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.

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.