Component:ButtonParentUnderUser

From Resonite Wiki
Revision as of 22:44, 11 September 2024 by AmasterAmaster (talk | contribs) (This is no longer a stub. Added a description, added a useage description, added field descriptions, added example description.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
Button Parent Under User component as seen in the Scene Inspector


The ButtonParentUnderUser component takes in a slot and some optional parameters for parenting slots. When a IButton is pressed, this component will parent any slot provided to the user that pressed the button.

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.
Root Slot The slot to parent to the user that pressed the button.
FindObjectRoot Bool Looks upwards in the slot heirarchy to find the slot with the Object Root component, and then parents that slot instead to the user.
UnparentWhenParented Bool Makes this component's parenting effects togglable.
PreserveOriginalSpace Bool Keep track of the original space.
_originalSpace Slot The slot that represents the original space.

Usage

Useful if you want certain slots to be parented to you when a button is pressed.

Examples

This is seen in the Scene Inspector, ProtoFlux Node Browser, and other menus with a button that has a pin icon.

See Also