godot-docs/classes/class_linkbutton.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the LinkButton.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_LinkButton:

LinkButton
==========

**Inherits:** :ref:`BaseButton<class_basebutton>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Simple button used to represent a link to some resource.

Member Variables
----------------

  .. _class_LinkButton_text:

- :ref:`String<class_string>` **text**

  .. _class_LinkButton_underline:

- :ref:`UnderlineMode<enum_linkbutton_underlinemode>` **underline**


Enums
-----

  .. _enum_LinkButton_UnderlineMode:

enum **UnderlineMode**

- **UNDERLINE_MODE_ALWAYS** = **0** --- The LinkButton will always show an underline at the bottom of its text
- **UNDERLINE_MODE_ON_HOVER** = **1** --- The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it.
- **UNDERLINE_MODE_NEVER** = **2** --- The LinkButton will never show an underline at the bottom of its text.


Description
-----------

This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page).