Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Radiant Dash Button | |Name=Radiant Dash Button | ||
}} | }} | ||
See [[Dash menu]]. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Dash|'''[[Component:RadiantDash|RadiantDash]]'''|TypeAdv0=true| | |Dash|'''[[Component:RadiantDash|RadiantDash]]'''|TypeAdv0=true| The dash this is a button to. | ||
|Screen|'''[[Component:RadiantDashScreen|RadiantDashScreen]]'''|TypeAdv1=true| | |Screen|'''[[Component:RadiantDashScreen|RadiantDashScreen]]'''|TypeAdv1=true| The screen this button triggers a switch to for. | ||
|_switchingEnabled|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>}}|TypeAdv2=true| | |_switchingEnabled|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>}}|TypeAdv2=true| The field to drive with whether switching is enabled. | ||
|_screenEnabled|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>}}|TypeAdv3=true| | |_screenEnabled|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>}}|TypeAdv3=true| The field to drive with whether the screen is enabled. | ||
|_currentScreen|{{RootFieldType|RelayRef`1|[[Type:SyncRef`1|SyncRef`1]]<[[Component:RadiantDashScreen|RadiantDashScreen]]>}}|TypeAdv4=true| | |_currentScreen|{{RootFieldType|RelayRef`1|[[Type:SyncRef`1|SyncRef`1]]<[[Component:RadiantDashScreen|RadiantDashScreen]]>}}|TypeAdv4=true| The current screen <code>Dash</code> is on. | ||
|_button|'''[[Component:Button|Button]]'''|TypeAdv5=true| | |_button|'''[[Component:Button|Button]]'''|TypeAdv5=true| The button to trigger switching to the target screen. | ||
|_text|'''[[Component:Text|Text]]'''|TypeAdv6=true| | |_text|'''[[Component:Text|Text]]'''|TypeAdv6=true| The text for the button. | ||
|_textBg|'''[[Component:Image|Image]]'''|TypeAdv7=true| | |_textBg|'''[[Component:Image|Image]]'''|TypeAdv7=true| The text background element. | ||
|_icon|'''[[Component:Image|Image]]'''|TypeAdv8=true| | |_icon|'''[[Component:Image|Image]]'''|TypeAdv8=true| The icon for the button. | ||
|_layout|'''[[Component:LayoutElement|LayoutElement]]'''|TypeAdv9=true| | |_layout|'''[[Component:LayoutElement|LayoutElement]]'''|TypeAdv9=true| The layout UIX element of the button. | ||
|_rootRect|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv10=true| | |_rootRect|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv10=true| The root Rect UIX element for this button. | ||
|_iconRect|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv11=true| | |_iconRect|'''[[Component:RectTransform|RectTransform]]'''|TypeAdv11=true| The root Rect UIX element for the button's icon. | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
| Line 29: | Line 29: | ||
[[Category:Components:Uncategorized{{#translation:}}|Radiant Dash Button]] | [[Category:Components:Uncategorized{{#translation:}}|Radiant Dash Button]] | ||
[[Category:Components{{#translation:}}|Radiant Dash Button]] | [[Category:Components{{#translation:}}|Radiant Dash Button]] | ||
Latest revision as of 02:47, 1 August 2025
Component image 
Radiant Dash Button component as seen in the Scene Inspector
See Dash menu.
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. |
Dash
|
RadiantDash | The dash this is a button to. |
Screen
|
RadiantDashScreen | The screen this button triggers a switch to for. |
_switchingEnabled
|
direct RelayRef`1<IField`1<Bool>> | The field to drive with whether switching is enabled. |
_screenEnabled
|
direct RelayRef`1<IField`1<Bool>> | The field to drive with whether the screen is enabled. |
_currentScreen
|
direct RelayRef`1<SyncRef`1<RadiantDashScreen>> | The current screen Dash is on.
|
_button
|
Button | The button to trigger switching to the target screen. |
_text
|
Text | The text for the button. |
_textBg
|
Image | The text background element. |
_icon
|
Image | The icon for the button. |
_layout
|
LayoutElement | The layout UIX element of the button. |
_rootRect
|
RectTransform | The root Rect UIX element for this button. |
_iconRect
|
RectTransform | The root Rect UIX element for the button's icon. |