Automated: create new component page |
add info |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{Legacy}} | |||
{{Infobox Component | {{Infobox Component | ||
|Image=LegacyRadiantScreenWrapper`1Component.png | |Image=LegacyRadiantScreenWrapper`1Component.png | ||
|Name=Legacy Radiant Screen Wrapper`1 | |Name=Legacy Radiant Screen Wrapper`1 | ||
}} | }} | ||
The '''LegacyRadiantScreenWrapper''' component was used to handle the old ui when the bottom buttons used to be physical. this should never be used in new content ever. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Icon|Uri| | |Icon|Uri| The icon of the current 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 of the current screen. | ||
|Label|String| | |Label|String| The label text of the current screen. | ||
|ScreenEnabled|Bool| | |ScreenEnabled|Bool| The enabled status of the current screen. | ||
|BaseResolution|Float2| | |BaseResolution|Float2| The base resolution of the current screen. | ||
|_screenRoot|Slot| | |_screenRoot|Slot| The root slot of the current screen. | ||
|_screenCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv6=true| | |_screenCanvas|'''[[Component:Canvas|Canvas]]'''|TypeAdv6=true| The canvas component of the current screen. | ||
|_modalOverlayManager|'''[[Component:ModalOverlayManager|ModalOverlayManager]]'''|TypeAdv7=true| | |_modalOverlayManager|'''[[Component:ModalOverlayManager|ModalOverlayManager]]'''|TypeAdv7=true| The modal overlay manager of the dash this component controls. | ||
|_button|'''[[Component:RadiantDashButton|RadiantDashButton]]'''|TypeAdv8=true| | |_button|'''[[Component:RadiantDashButton|RadiantDashButton]]'''|TypeAdv8=true| The button for the current screen. | ||
|_iconTexture|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv9=true| | |_iconTexture|{{RootFieldType|AssetRef`1|[[Type:Texture2D|Texture2D]]}}|TypeAdv9=true| The icon for the current screen. | ||
|ExtraSidePadding|Float| | |ExtraSidePadding|Float| How much to pad the current screen | ||
|Background|ColorX| | |Background|ColorX| The background color of the current screen. | ||
|_initialized|Bool| | |_initialized|Bool| Whether this component is finished setup. | ||
|InitializeComponent|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]<T>}}|TypeAdv13=true| | |InitializeComponent|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]<T>}}|TypeAdv13=true| A sync delegate to call with an argument of '''T''' when this initalizes. | ||
|ButtonGenerated|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]<[[Component:RadiantDashButton|RadiantDashButton]]>}}|TypeAdv14=true| | |ButtonGenerated|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]<[[Component:RadiantDashButton|RadiantDashButton]]>}}|TypeAdv14=true| A sync delegate to call with an argument of [[Component:RadiantDashButton|RadiantDashButton]] to call when this component's button is generated. | ||
}} | }} | ||
== See Also == | == See Also == | ||
Line 33: | Line 30: | ||
[[Category:Components{{#translation:}}|Legacy Radiant Screen Wrapper`1]] | [[Category:Components{{#translation:}}|Legacy Radiant Screen Wrapper`1]] | ||
[[Category:Generic Components{{#translation:}}|Legacy Radiant Screen Wrapper`1]] | [[Category:Generic Components{{#translation:}}|Legacy Radiant Screen Wrapper`1]] | ||
Latest revision as of 18:53, 7 April 2025
Component image File:LegacyRadiantScreenWrapper`1Component.pngLegacy Radiant Screen Wrapper`1 component as seen in the Scene Inspector
The LegacyRadiantScreenWrapper component was used to handle the old ui when the bottom buttons used to be physical. this should never be used in new content ever.
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 of the current screen. |
ActiveColor
|
Nullable`1<ColorX> | The color of the current screen. |
Label
|
String | The label text of the current screen. |
ScreenEnabled
|
Bool | The enabled status of the current screen. |
BaseResolution
|
Float2 | The base resolution of the current screen. |
_screenRoot
|
Slot | The root slot of the current screen. |
_screenCanvas
|
Canvas | The canvas component of the current screen. |
_modalOverlayManager
|
ModalOverlayManager | The modal overlay manager of the dash this component controls. |
_button
|
RadiantDashButton | The button for the current screen. |
_iconTexture
|
Texture2D | The icon for the current screen. |
ExtraSidePadding
|
Float | How much to pad the current screen |
Background
|
ColorX | The background color of the current screen. |
_initialized
|
Bool | Whether this component is finished setup. |
InitializeComponent
|
delegate of identity Action`1<T> | A sync delegate to call with an argument of T when this initalizes. |
ButtonGenerated
|
delegate of identity Action`1<RadiantDashButton> | A sync delegate to call with an argument of RadiantDashButton to call when this component's button is generated. |