Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=World Close Screen | |Name=World Close Screen | ||
}} | }} | ||
The '''World Close Screen''' component is used in the dash and appears when the user asks to close a world. This acts as a conformation. This is also an internally used component. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Icon|Uri| | |Icon|Uri| The icon for this dialogue screen. | ||
|ActiveColor|'''[[Type:Nullable`1|Nullable`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv1=true| | |ActiveColor|'''[[Type:Nullable`1|Nullable`1]]<[[Type:ColorX|ColorX]]>'''|TypeAdv1=true| The color when this screen is selected and active. | ||
|Label|String| | |Label|String| The label of this dash screen. | ||
|ScreenEnabled|Bool| | |ScreenEnabled|Bool| Whether this dash screen is enabled or not. | ||
|BaseResolution|Float2| | |BaseResolution|Float2| The resolution this screen renders at. | ||
|_screenRoot|Slot| | |_screenRoot|Slot| The root slot of this screen's visual elements. | ||
|_screenCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv6=true| | |_screenCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv6=true| The canvas Component used to render this dash screen. | ||
|_modalOverlayManager|'''[[Component:ModalOverlayManager|ModalOverlayManager]]'''|TypeAdv7=true| | |_modalOverlayManager|'''[[Component:ModalOverlayManager|ModalOverlayManager]]'''|TypeAdv7=true| This is the Overlay manager that handles editing mode on this screen. | ||
|_button|'''[[Component:RadiantDashButton|RadiantDashButton]]'''|TypeAdv8=true| | |_button|'''[[Component:RadiantDashButton|RadiantDashButton]]'''|TypeAdv8=true| This is the button to switch to viewing this screen. | ||
|_iconTexture|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv9=true| | |_iconTexture|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv9=true| This is the texture Component showing the icon for the tab of this screen. | ||
|_closeDialog|'''[[Component:WorldCloseDialog|WorldCloseDialog]]'''|TypeAdv10=true| | |_closeDialog|'''[[Component:WorldCloseDialog|WorldCloseDialog]]'''|TypeAdv10=true| The close dialog this is controlling. | ||
}} | }} | ||
== | == Usage == | ||
Not used by the user, is an internally used component. | |||
== Examples == | == Examples == | ||
Used for the world close dialog in the dash when closing a world. | |||
== See Also == | == See Also == | ||
[[Category:Components:Uncategorized{{#translation:}}|World Close Screen]] | [[Category:Components:Uncategorized{{#translation:}}|World Close Screen]] | ||
[[Category:Components{{#translation:}}|World Close Screen]] | [[Category:Components{{#translation:}}|World Close Screen]] | ||
Latest revision as of 18:30, 22 May 2025
Component image 
World Close Screen component as seen in the Scene Inspector
The World Close Screen component is used in the dash and appears when the user asks to close a world. This acts as a conformation. This is also an internally used component.
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. |
Icon
|
Uri | The icon for this dialogue screen. |
ActiveColor
|
Nullable`1<ColorX> | The color when this screen is selected and active. |
Label
|
String | The label of this dash screen. |
ScreenEnabled
|
Bool | Whether this dash screen is enabled or not. |
BaseResolution
|
Float2 | The resolution this screen renders at. |
_screenRoot
|
Slot | The root slot of this screen's visual elements. |
_screenCanvas
|
Canvas | The canvas Component used to render this dash screen. |
_modalOverlayManager
|
ModalOverlayManager | This is the Overlay manager that handles editing mode on this screen. |
_button
|
RadiantDashButton | This is the button to switch to viewing this screen. |
_iconTexture
|
Texture2D | This is the texture Component showing the icon for the tab of this screen. |
_closeDialog
|
WorldCloseDialog | The close dialog this is controlling. |
Usage
Not used by the user, is an internally used component.
Examples
Used for the world close dialog in the dash when closing a world.