Merge pull request #31445 from KoBeWi/how_to_input

Clarify usage of action_press
This commit is contained in:
Rémi Verschelde 2019-08-18 11:04:59 +02:00 committed by GitHub
commit 80c2f303ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -20,6 +20,7 @@
<description>
This will simulate pressing the specified action.
The strength can be used for non-boolean actions, it's ranged between 0 and 1 representing the intensity of the given action.
[b]Note:[/b] This method will not cause any [method Node._input] calls. It is intended to be used with [method is_action_pressed] and [method is_action_just_pressed]. If you want to simulate [code]_input[/code], use [method parse_input_event] instead.
</description>
</method>
<method name="action_release">
@ -283,7 +284,14 @@
<argument index="0" name="event" type="InputEvent">
</argument>
<description>
Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code.
Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code. Also generates [method Node._input] calls.
Example:
[codeblock]
var a = InputEventAction.new()
a.action = "ui_cancel"
a.pressed = true
Input.parse_input_event(a)
[/codeblock]
</description>
</method>
<method name="remove_joy_mapping">