diff options
| author | Juan Linietsky <reduzio@gmail.com> | 2018-05-07 18:24:17 -0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-07 18:24:17 -0300 |
| commit | 7811156c4f1632e36143c7dae0f8f27b2916f3f4 (patch) | |
| tree | c2eb453d399f5398559a4c47267e4d4beee8a37a /doc | |
| parent | 7175a7f02532eba6232c3bedb206c77103213b6d (diff) | |
| parent | ed69345a19fc2372f44be8e674b0271728e5f427 (diff) | |
Merge pull request #17451 from Goutte/feat-base-button-mask
Allow configuration of which mouse buttons the BaseButton responds to
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/BaseButton.xml | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 2f44179adb..3ff8634010 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -15,7 +15,7 @@ <return type="void"> </return> <description> - Called when button is pressed. + Called when the button is pressed. </description> </method> <method name="_toggled" qualifiers="virtual"> @@ -24,7 +24,7 @@ <argument index="0" name="button_pressed" type="bool"> </argument> <description> - Called when button is toggled (only if toggle_mode is active). + Called when the button is toggled (only if toggle_mode is active). </description> </method> <method name="get_draw_mode" qualifiers="const"> @@ -38,7 +38,7 @@ <return type="bool"> </return> <description> - Return true if mouse entered the button before it exit. + Return true if the mouse has entered the button and has not left it yet. </description> </method> </methods> @@ -46,6 +46,10 @@ <member name="action_mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="BaseButton.ActionMode"> Determines when the button is considered clicked, one of the ACTION_MODE_* constants. </member> + <member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask"> + Binary mask to choose which mouse buttons this button will respond to. + To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT. + </member> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> If [code]true[/code] the button is in disabled state and can't be clicked or toggled. </member> |