Component:GenericUIContainer: Difference between revisions

From Resonite Wiki
Added description, added links, added field descriptions, added usage description. Style.
remove stub
 
Line 6: Line 6:
The '''Generic UI Container''' is a component that is seen on [[UIX]] panels and canvases. It does two primary things, match the title for the panel of a provided text, and flag when it closes and then destroys the provided hierarchy root [[Slot|slot]].
The '''Generic UI Container''' is a component that is seen on [[UIX]] panels and canvases. It does two primary things, match the title for the panel of a provided text, and flag when it closes and then destroys the provided hierarchy root [[Slot|slot]].


 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Title|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true|Changes the title for this panel.
|Title|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true|Changes the title for this panel.
Line 21: Line 21:
[[Category:Components:Common UI{{#translation:}}|Generic UIContainer]]
[[Category:Components:Common UI{{#translation:}}|Generic UIContainer]]
[[Category:Components{{#translation:}}|Generic UIContainer]]
[[Category:Components{{#translation:}}|Generic UIContainer]]
[[Category:ComponentStubs]]

Latest revision as of 07:02, 19 January 2025

Component image 
Generic UIContainer component as seen in the Scene Inspector


The Generic UI Container is a component that is seen on UIX panels and canvases. It does two primary things, match the title for the panel of a provided text, and flag when it closes and then destroys the provided hierarchy root slot.

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.
Title IField`1<String> Changes the title for this panel.
CloseRequest Bool Becomes true when this container (UIX panel/canvas) is closing.
CloseDestroyRoot Slot The target slot to destroy.

Usage

There is no known usage for this component to be used in projects, but only seen on certain panels and canvases.

Examples

The GenericUIContainer can be found on many default interfaces including the Scene Inspector, Node Browser, and Component Inspector.