2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
								<?xml version="1.0" encoding="UTF-8" ?>  
						 
					
						
							
								
									
										
										
										
											2022-03-16 23:01:02 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
								<class  name= "MenuButton"  inherits= "Button"  version= "3.5"  xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance"  xsi:noNamespaceSchemaLocation= "../class.xsd" >  
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									<brief_description > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										Special button that brings up a [PopupMenu] when clicked.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</brief_description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-23 11:14:14 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										Special button that brings up a [PopupMenu] when clicked.
							 
						 
					
						
							
								
									
										
										
										
											2021-03-18 12:04:28 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										New items can be created inside this [PopupMenu] using [code]get_popup().add_item("My Item Name")[/code]. You can also create them directly from the editor. To do so, select the [MenuButton] node, then in the toolbar at the top of the 2D editor, click [b]Items[/b] then click [b]Add[/b] in the popup. You will be able to give each item new properties.
							 
						 
					
						
							
								
									
										
										
										
											2020-09-23 23:34:28 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										See also [BaseButton] which contains common properties and methods associated with this node.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<tutorials > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</tutorials> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<methods > 
							 
						 
					
						
							
								
									
										
										
										
											2017-12-25 14:03:53 -02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "get_popup"  qualifiers= "const" > 
							 
						 
					
						
							
								
									
										
										
										
											2021-07-30 15:28:05 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											<return  type= "PopupMenu"  /> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2019-05-23 19:15:43 -07:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												Returns the [PopupMenu] contained in this button.
							 
						 
					
						
							
								
									
										
										
										
											2021-10-10 23:10:07 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-03 13:45:03 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<method  name= "set_disable_shortcuts" > 
							 
						 
					
						
							
								
									
										
										
										
											2021-07-30 15:28:05 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											<return  type= "void"  /> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<argument  index= "0"  name= "disabled"  type= "bool"  /> 
							 
						 
					
						
							
								
									
										
										
										
											2018-01-03 13:45:03 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-23 11:14:14 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
												If [code]true[/code], shortcuts are disabled and cannot be used to trigger the button.
							 
						 
					
						
							
								
									
										
										
										
											2018-01-03 13:45:03 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</method> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									</methods> 
							 
						 
					
						
							
								
									
										
										
										
											2018-07-29 19:26:43 -03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
									<members > 
							 
						 
					
						
							
								
									
										
										
										
											2021-12-02 23:15:17 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "action_mode"  type= "int"  setter= "set_action_mode"  getter= "get_action_mode"  overrides= "BaseButton"  enum= "BaseButton.ActionMode"  default= "0"  /> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<member  name= "flat"  type= "bool"  setter= "set_flat"  getter= "is_flat"  overrides= "Button"  default= "true"  /> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<member  name= "focus_mode"  type= "int"  setter= "set_focus_mode"  getter= "get_focus_mode"  overrides= "Control"  enum= "Control.FocusMode"  default= "0"  /> 
							 
						 
					
						
							
								
									
										
										
										
											2019-06-29 12:38:01 +02:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "switch_on_hover"  type= "bool"  setter= "set_switch_on_hover"  getter= "is_switch_on_hover"  default= "false" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-01-23 11:14:14 +01:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											If [code]true[/code], when the cursor hovers above another [MenuButton] within the same parent which also has [code]switch_on_hover[/code] enabled, it will close the current [MenuButton] and open the other one.
							 
						 
					
						
							
								
									
										
										
										
											2018-07-29 19:26:43 -03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										</member> 
							 
						 
					
						
							
								
									
										
										
										
											2021-12-02 23:15:17 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<member  name= "toggle_mode"  type= "bool"  setter= "set_toggle_mode"  getter= "is_toggle_mode"  overrides= "BaseButton"  default= "true"  /> 
							 
						 
					
						
							
								
									
										
										
										
											2018-07-29 19:26:43 -03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
									</members> 
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
									<signals > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<signal  name= "about_to_show" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											<description > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
												Emitted when [PopupMenu] of this MenuButton is about to show.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											</description> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</signal> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</signals> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<constants > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</constants> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									<theme_items > 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-06 18:07:21 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font_color"  data_type= "color"  type= "Color"  default= "Color( 0.88, 0.88, 0.88, 1 )" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-04 15:46:01 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Default text [Color] of the [MenuButton].
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-06 18:07:21 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font_color_disabled"  data_type= "color"  type= "Color"  default= "Color( 1, 1, 1, 0.3 )" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-04 15:46:01 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Text [Color] used when the [MenuButton] is disabled.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-10-26 16:32:15 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font_color_focus"  data_type= "color"  type= "Color"  default= "Color( 0.94, 0.94, 0.94, 1 )" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											Text [Color] used when the [MenuButton] is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-06 18:07:21 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font_color_hover"  data_type= "color"  type= "Color"  default= "Color( 0.94, 0.94, 0.94, 1 )" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-04 15:46:01 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Text [Color] used when the [MenuButton] is being hovered.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-06 18:07:21 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font_color_pressed"  data_type= "color"  type= "Color"  default= "Color( 1, 1, 1, 1 )" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-04 15:46:01 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Text [Color] used when the [MenuButton] is being pressed.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-06 18:07:21 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "hseparation"  data_type= "constant"  type= "int"  default= "3" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-04 15:46:01 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											The horizontal space between [MenuButton]'s icon and text.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-12-01 22:45:12 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "font"  data_type= "font"  type= "Font" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											[Font] of the [MenuButton]'s text.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "disabled"  data_type= "style"  type= "StyleBox" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											[StyleBox] used when the [MenuButton] is disabled.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "focus"  data_type= "style"  type= "StyleBox" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											[StyleBox] used when the [MenuButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										<theme_item  name= "hover"  data_type= "style"  type= "StyleBox" > 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
											[StyleBox] used when the [MenuButton] is being hovered.
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-06 18:07:21 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "normal"  data_type= "style"  type= "StyleBox" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-04 15:46:01 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											Default [StyleBox] for the [MenuButton].
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
									
										
										
										
											2021-08-06 18:07:21 +03:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
										<theme_item  name= "pressed"  data_type= "style"  type= "StyleBox" > 
							 
						 
					
						
							
								
									
										
										
										
											2020-02-04 15:46:01 +08:00 
										
									 
								 
							 
							
								
									
										 
								
							 
							
								 
							
							
											[StyleBox] used when the [MenuButton] is being pressed.
							 
						 
					
						
							
								
									
										
										
										
											2017-09-12 17:42:36 -03:00 
										
									 
								 
							 
							
								
							 
							
								 
							
							
										</theme_item> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
									</theme_items> 
							 
						 
					
						
							
								
							 
							
								
							 
							
								 
							
							
								</class>