godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/TouchScreenButton.xml

70 lines
2.6 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Update docs to version 4.0
2020-02-01 01:03:48 +00:00
<class name="TouchScreenButton" inherits="Node2D" version="4.0">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
Button for touch screen devices.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
Button for touch screen devices. You can set it to be visible on all screens, or only on touch devices.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="is_pressed" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
Returns [code]true[/code] if this button is currently pressed.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="action" type="String" setter="set_action" getter="get_action" default="&quot;&quot;">
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
The button's action. Actions can be handled with [InputEventAction].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="bitmask" type="BitMap" setter="set_bitmask" getter="get_bitmask">
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
The button's bitmask.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<member name="normal" type="Texture2D" setter="set_texture" getter="get_texture">
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
The button's texture for the normal state.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="passby_press" type="bool" setter="set_passby_press" getter="is_passby_press_enabled" default="false">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
If [code]true[/code], pass-by presses are enabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 08:59:06 +00:00
<member name="pressed" type="Texture2D" setter="set_texture_pressed" getter="get_texture_pressed">
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
The button's texture for the pressed state.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="shape" type="Shape2D" setter="set_shape" getter="get_shape">
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
The button's shape.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="shape_centered" type="bool" setter="set_shape_centered" getter="is_shape_centered" default="true">
Clarify shape_centered property
2019-11-08 10:02:22 +00:00
If [code]true[/code], the button's shape is centered in the provided texture. If no texture is used, this property has no effect.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="shape_visible" type="bool" setter="set_shape_visible" getter="is_shape_visible" default="true">
doc: Add missing commas after "If true/false"
2018-12-20 12:46:54 +00:00
If [code]true[/code], the button's shape is visible.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="visibility_mode" type="int" setter="set_visibility_mode" getter="get_visibility_mode" enum="TouchScreenButton.VisibilityMode" default="0">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
The button's visibility mode. See [enum VisibilityMode] for possible values.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals>
<signal name="pressed">
<description>
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
Emitted when the button is pressed (down).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
<signal name="released">
<description>
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
Emitted when the button is released (up).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="VISIBILITY_ALWAYS" value="0" enum="VisibilityMode">
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
Always visible.
doc: Sync classref with current source [ci skip]
2017-09-15 23:46:14 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="VISIBILITY_TOUCHSCREEN_ONLY" value="1" enum="VisibilityMode">
[DOCS] TouchScreenButton
2017-10-10 21:31:04 +00:00
Visible on touch screens only.
doc: Sync classref with current source [ci skip]
2017-09-15 23:46:14 +00:00
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>