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

Remove redundant info on the enum types used

Browse Source
This commit is contained in:
Haoyu Qiu
2025-05-08 11:56:10 +08:00
parent 1b37dacc18
commit 1e82bafa3a
144 changed files with 359 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/classes/Input.xml
View File

@@ -90,7 +90,7 @@
<method name="get_current_cursor_shape" qualifiers="const">
<return type="int" enum="Input.CursorShape" />
<description>
Returns the currently assigned cursor shape (see [enum CursorShape]).
Returns the currently assigned cursor shape.
</description>
</method>
<method name="get_gravity" qualifiers="const">
@@ -114,7 +114,7 @@
<param index="0" name="device" type="int" />
<param index="1" name="axis" type="int" enum="JoyAxis" />
<description>
Returns the current value of the joypad axis at given index (see [enum JoyAxis]).
Returns the current value of the joypad axis at index [param axis].
</description>
</method>
<method name="get_joy_guid" qualifiers="const">
@@ -247,7 +247,7 @@
<param index="0" name="device" type="int" />
<param index="1" name="button" type="int" enum="JoyButton" />
<description>
Returns [code]true[/code] if you are pressing the joypad button (see [enum JoyButton]).
Returns [code]true[/code] if you are pressing the joypad button at index [param button].
</description>
</method>
<method name="is_joy_known" keywords="is_gamepad_known, is_controller_known">
@@ -333,7 +333,7 @@
<param index="1" name="shape" type="int" enum="Input.CursorShape" default="0" />
<param index="2" name="hotspot" type="Vector2" default="Vector2(0, 0)" />
<description>
Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See [enum CursorShape] for the list of shapes.
Sets a custom mouse cursor image, which is only visible inside the game window, for the given mouse [param shape]. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor.
[param image] can be either [Texture2D] or [Image] and its size must be lower than or equal to 256×256. To avoid rendering issues, sizes lower than or equal to 128×128 are recommended.
[param hotspot] must be within [param image]'s size.
[b]Note:[/b] [AnimatedTexture]s aren't supported as custom mouse cursors. If using an [AnimatedTexture], only the first frame will be displayed.
@@ -434,7 +434,7 @@
If [code]true[/code], sends touch input events when clicking or dragging the mouse. See also [member ProjectSettings.input_devices/pointing/emulate_touch_from_mouse].
</member>
<member name="mouse_mode" type="int" setter="set_mouse_mode" getter="get_mouse_mode" enum="Input.MouseMode">
Controls the mouse mode. See [enum MouseMode] for more information.
Controls the mouse mode.
</member>
<member name="use_accumulated_input" type="bool" setter="set_use_accumulated_input" getter="is_using_accumulated_input">
If [code]true[/code], similar input events sent by the operating system are accumulated. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS.