diff options
| author | Tomasz Chabora <kobewi4e@gmail.com> | 2020-10-12 19:37:50 +0200 |
|---|---|---|
| committer | kobewi <kobewi4e@gmail.com> | 2021-07-13 23:43:46 +0200 |
| commit | 105495646191f2758779256589cac1aa5c583cdc (patch) | |
| tree | 3a249f38af5f29ee40eb5d73b82d1dcdfb80da59 /modules/visual_script/doc_classes/VisualScriptInputAction.xml | |
| parent | 7bc52e56c093342255c389fcc652eda2ced40b39 (diff) | |
| download | redot-engine-105495646191f2758779256589cac1aa5c583cdc.tar.gz | |
Document remaining Visual Script classes
Diffstat (limited to 'modules/visual_script/doc_classes/VisualScriptInputAction.xml')
| -rw-r--r-- | modules/visual_script/doc_classes/VisualScriptInputAction.xml | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptInputAction.xml b/modules/visual_script/doc_classes/VisualScriptInputAction.xml index 9ca67feacb..d6fa111500 100644 --- a/modules/visual_script/doc_classes/VisualScriptInputAction.xml +++ b/modules/visual_script/doc_classes/VisualScriptInputAction.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptInputAction" inherits="VisualScriptNode" version="4.0"> <brief_description> + A Visual Script node returning a state of an action. </brief_description> <description> + [VisualScriptInputAction] can be used to check if an action is pressed or released. </description> <tutorials> </tutorials> @@ -10,18 +12,24 @@ </methods> <members> <member name="action" type="StringName" setter="set_action_name" getter="get_action_name" default="&"""> + Name of the action. </member> <member name="mode" type="int" setter="set_action_mode" getter="get_action_mode" enum="VisualScriptInputAction.Mode" default="0"> + State of the action to check. See [enum Mode] for options. </member> </members> <constants> <constant name="MODE_PRESSED" value="0" enum="Mode"> + [code]True[/code] if action is pressed. </constant> <constant name="MODE_RELEASED" value="1" enum="Mode"> + [code]True[/code] if action is released (i.e. not pressed). </constant> <constant name="MODE_JUST_PRESSED" value="2" enum="Mode"> + [code]True[/code] on the frame the action was pressed. </constant> <constant name="MODE_JUST_RELEASED" value="3" enum="Mode"> + [code]True[/code] on the frame the action was released. </constant> </constants> </class> |