godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-06 10:11:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Rename the argument tag to param in XML documentation

Browse Source
This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/classes/XRController3D.xml
View File

@@ -15,7 +15,7 @@
<methods>
<method name="get_axis" qualifiers="const">
<return type="Vector2" />
<argument index="0" name="name" type="StringName" />
<param index="0" name="name" type="StringName" />
<description>
Returns a [Vector2] for the input with the given [code]name[/code]. This is used for thumbsticks and thumbpads found on many controllers.
</description>
@@ -28,14 +28,14 @@
</method>
<method name="get_value" qualifiers="const">
<return type="float" />
<argument index="0" name="name" type="StringName" />
<param index="0" name="name" type="StringName" />
<description>
Returns a numeric value for the input with the given [code]name[/code]. This is used for triggers and grip sensors.
</description>
</method>
<method name="is_button_pressed" qualifiers="const">
<return type="bool" />
<argument index="0" name="name" type="StringName" />
<param index="0" name="name" type="StringName" />
<description>
Returns [code]true[/code] if the button with the given [code]name[/code] is pressed.
</description>
@@ -43,27 +43,27 @@
</methods>
<signals>
<signal name="button_pressed">
<argument index="0" name="name" type="String" />
<param index="0" name="name" type="String" />
<description>
Emitted when a button on this controller is pressed.
</description>
</signal>
<signal name="button_released">
<argument index="0" name="name" type="String" />
<param index="0" name="name" type="String" />
<description>
Emitted when a button on this controller is released.
</description>
</signal>
<signal name="input_axis_changed">
<argument index="0" name="name" type="String" />
<argument index="1" name="value" type="Vector2" />
<param index="0" name="name" type="String" />
<param index="1" name="value" type="Vector2" />
<description>
Emitted when a thumbstick or thumbpad on this controller is moved.
</description>
</signal>
<signal name="input_value_changed">
<argument index="0" name="name" type="String" />
<argument index="1" name="value" type="float" />
<param index="0" name="name" type="String" />
<param index="1" name="value" type="float" />
<description>
Emitted when a trigger or similar input on this controller changes value.
</description>