godot/doc/classes/InputEventAction.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventAction" inherits="InputEvent" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Input event type for actions.
	</brief_description>
	<description>
		Contains a generic action which can be targeted from several types of inputs. Actions can be created from the [b]Input Map[/b] tab in the [b]Project &gt; Project Settings[/b] menu. See [method Node._input].
	</description>
	<tutorials>
		<link title="InputEvent: Actions">$DOCS_URL/tutorials/inputs/inputevent.html#actions</link>
		<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>
		<link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>
	</tutorials>
	<members>
		<member name="action" type="StringName" setter="set_action" getter="get_action" default="&amp;&quot;&quot;">
			The action's name. Actions are accessed via this [String].
		</member>
		<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">
			If [code]true[/code], the action's state is pressed. If [code]false[/code], the action's state is released.
		</member>
		<member name="strength" type="float" setter="set_strength" getter="get_strength" default="1.0">
			The action's strength between 0 and 1. This value is considered as equal to 0 if pressed is [code]false[/code]. The event strength allows faking analog joypad motion events, by specifying how strongly the joypad axis is bent or pressed.
		</member>
	</members>
</class>
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-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 21:18:53 +08:00			`<class name="InputEventAction" inherits="InputEvent" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
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-13 04:42:36 +08:00			`<brief_description>`
			`Input event type for actions.`
			`</brief_description>`
			`<description>`
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-22 07:04:47 +08:00			`Contains a generic action which can be targeted from several types of inputs. Actions can be created from the [b]Input Map[/b] tab in the [b]Project > Project Settings[/b] menu. See [method Node._input].`
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-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 17:43:07 +08:00			`<link title="InputEvent: Actions">$DOCS_URL/tutorials/inputs/inputevent.html#actions</link>`
Link to demos from within the class reference 2020-10-01 16:34:47 +08:00			`<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>`
			`<link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>`
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-13 04:42:36 +08:00			`</tutorials>`
			`<members>`
Let var2str display StringName with correct sigil 2021-06-06 03:24:24 +08:00			`<member name="action" type="StringName" setter="set_action" getter="get_action" default="&""">`
[DOCS] InputEvent* 2017-10-16 06:07:13 +08:00			`The action's name. Actions are accessed via this [String].`
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-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed" default="false">`
doc: Add missing commas after "If true/false" 2018-12-20 20:46:54 +08:00			`If [code]true[/code], the action's state is pressed. If [code]false[/code], the action's state is released.`
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-13 04:42:36 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="strength" type="float" setter="set_strength" getter="get_strength" default="1.0">`
class reference proofreading 2021-03-18 19:04:28 +08:00			`The action's strength between 0 and 1. This value is considered as equal to 0 if pressed is [code]false[/code]. The event strength allows faking analog joypad motion events, by specifying how strongly the joypad axis is bent or pressed.`
Add configurable strength value to InputEventAction 2019-06-01 21:31:47 +08:00			`</member>`
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-13 04:42:36 +08:00			`</members>`
			`</class>`