hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Use self-closing tags for return and argument

Browse source 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
This commit is contained in:
Rémi Verschelde 2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
No known key found for this signature in database
GPG key ID: C3336907360768E1
408 changed files with 14025 additions and 28050 deletions
Download patch file Download diff file Expand all files Collapse all files

75
doc/classes/InputEvent.xml
View file

@ -14,112 +14,87 @@
</tutorials>
<methods>
<method name="accumulate">
<return type="bool">
</return>
<argument index="0" name="with_event" type="InputEvent">
</argument>
<return type="bool" />
<argument index="0" name="with_event" type="InputEvent" />
<description>
Returns [code]true[/code] if the given input event and this input event can be added together (only for events of type [InputEventMouseMotion]).
The given input event's position, global position and speed will be copied. The resulting [code]relative[/code] is a sum of both events. Both events' modifiers have to be identical.
</description>
</method>
<method name="as_text" qualifiers="const">
<return type="String">
</return>
<return type="String" />
<description>
Returns a [String] representation of the event.
</description>
</method>
<method name="get_action_strength" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="exact_match" type="bool" default="false">
</argument>
<return type="float" />
<argument index="0" name="action" type="StringName" />
<argument index="1" name="exact_match" type="bool" default="false" />
<description>
Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion].
If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
</description>
</method>
<method name="is_action" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="exact_match" type="bool" default="false">
</argument>
<return type="bool" />
<argument index="0" name="action" type="StringName" />
<argument index="1" name="exact_match" type="bool" default="false" />
<description>
Returns [code]true[/code] if this input event matches a pre-defined action of any type.
If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
</description>
</method>
<method name="is_action_pressed" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="allow_echo" type="bool" default="false">
</argument>
<argument index="2" name="exact_match" type="bool" default="false">
</argument>
<return type="bool" />
<argument index="0" name="action" type="StringName" />
<argument index="1" name="allow_echo" type="bool" default="false" />
<argument index="2" name="exact_match" type="bool" default="false" />
<description>
Returns [code]true[/code] if the given action is being pressed (and is not an echo event for [InputEventKey] events, unless [code]allow_echo[/code] is [code]true[/code]). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
</description>
</method>
<method name="is_action_released" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="StringName">
</argument>
<argument index="1" name="exact_match" type="bool" default="false">
</argument>
<return type="bool" />
<argument index="0" name="action" type="StringName" />
<argument index="1" name="exact_match" type="bool" default="false" />
<description>
Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
</description>
</method>
<method name="is_action_type" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if this input event's type is one that can be assigned to an input action.
</description>
</method>
<method name="is_echo" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if this input event is an echo event (only for events of type [InputEventKey]).
</description>
</method>
<method name="is_match" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="event" type="InputEvent">
</argument>
<argument index="1" name="exact_match" type="bool" default="true">
</argument>
<return type="bool" />
<argument index="0" name="event" type="InputEvent" />
<argument index="1" name="exact_match" type="bool" default="true" />
<description>
Returns [code]true[/code] if the specified [code]event[/code] matches this event. Only valid for action events i.e key ([InputEventKey]), button ([InputEventMouseButton] or [InputEventJoypadButton]), axis [InputEventJoypadMotion] or action ([InputEventAction]) events.
If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
</description>
</method>
<method name="is_pressed" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if this input event is pressed. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
</description>
</method>
<method name="xformed_by" qualifiers="const">
<return type="InputEvent">
</return>
<argument index="0" name="xform" type="Transform2D">
</argument>
<argument index="1" name="local_ofs" type="Vector2" default="Vector2(0, 0)">
</argument>
<return type="InputEvent" />
<argument index="0" name="xform" type="Transform2D" />
<argument index="1" name="local_ofs" type="Vector2" default="Vector2(0, 0)" />
<description>
Returns a copy of the given input event which has been offset by [code]local_ofs[/code] and transformed by [code]xform[/code]. Relevant for events of type [InputEventMouseButton], [InputEventMouseMotion], [InputEventScreenTouch], [InputEventScreenDrag], [InputEventMagnifyGesture] and [InputEventPanGesture].
</description>