{{Template:GUI_Object|button| [wiki:GUI_-_Properties#buffer_zone buffer_zone], [wiki:GUI_-_Properties#caption caption], [wiki:GUI_-_Properties#cell_id cell_id], [wiki:GUI_-_Properties#font font], [wiki:GUI_-_Properties#sprite sprite], [wiki:GUI_-_Properties#sprite_over sprite_over], [wiki:GUI_-_Properties#sprite_pressed sprite_pressed], [wiki:GUI_-_Properties#sprite_disabled sprite_disabled], [wiki:GUI_-_Properties#text_align text_align], [wiki:GUI_-_Properties#text_valign text_valign], [wiki:GUI_-_Properties#textcolor textcolor], [wiki:GUI_-_Properties#textcolor_over textcolor_over], [wiki:GUI_-_Properties#textcolor_pressed textcolor_pressed], [wiki:GUI_-_Properties#textcolor_disabled textcolor_disabled], [wiki:GUI_-_Properties#tooltip tooltip], [wiki:GUI_-_Properties#tooltip_style tooltip_style]|[wiki:GUI_-_Actions#Press Press]}}

= Button =

A button consists of a sprite filling all of its size and text that can be placed in any alignment. When hovered, pressed or disabled, both the sprite and the text colour can be changed.

[[Image(gui-object-button.png, nolink)]]

The left button has got both ''text_align'' and ''text_valign'' set to "center", this means ''buffer_zone'' is completely unused.

The press event is called as soon as the left mouse button is pressed down.

== Examples ==
'''''Code of example buttons:'''''

{{{
#!xml
  <object type="button"
          name="The_one_to_the_left" 
          size="20 20 170 80"
          sprite="gd-button"
          sprite_pressed="gd-button-pressed"
          text_align="center"
          text_valign="center"
          font="verdana12"
          textcolor="0 0 0"
          textcolor_pressed="255 255 255">
          Centered
          <action on="Press"><![CDATA[ doSomething(); ]]></action>
  </object>
  
  <object type="button"
          name="The_one_to_the_right" 
          size="210 20 360 80"
          sprite="gd-button"
          sprite_pressed="gd-button-pressed"
          text_align="left"
          text_valign="bottom"
          buffer_zone="20"
          font="verdana12"
          textcolor="0 0 0"
          textcolor_pressed="255 255 255">
          Press
          <action on="Press"><![CDATA[ doSomething(); ]]></action>
  </object>
}}}