diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 392ee25ad6d..c6abf2fee51 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -4,8 +4,10 @@ Generic input event + Base class of all sort of input event. See [method Node._input]. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html @@ -16,7 +18,7 @@ - Returns true if this input event matches the event passed. + Returns [code]true[/code] if this event matches [code]event[event]. @@ -30,14 +32,14 @@ - Returns the id of the device that generated the event. + Returns the device's id that generated the event. - Returns the id of the event. + Returns the event's ID. @@ -46,7 +48,7 @@ - Returns true if this input event matches a pre-defined action, no matter the type. + Returns [code]true[/code] if this input event matches a pre-defined action of any type. @@ -55,7 +57,7 @@ - Returns true if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns [code]true[/code] if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. @@ -64,27 +66,28 @@ - Returns true if the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. + Returns [code]true[/code] if this input event's type is one of the [code]InputEvent[/code] constants. - Returns true if this input event is an echo event (only for events of type KEY, it will return false for other types). + Returns [code]true[/code] if this input event is an echo event (only for events of type KEY). - Returns true if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns [code]true[/code] if this input event is pressed. Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. @@ -124,6 +127,7 @@ + The event's device ID. diff --git a/doc/classes/InputEventAction.xml b/doc/classes/InputEventAction.xml index 2617ea4dfa8..a2f4c9b9d37 100644 --- a/doc/classes/InputEventAction.xml +++ b/doc/classes/InputEventAction.xml @@ -4,8 +4,10 @@ Input event type for actions. + Contains a generic action which can be targeted from several type of inputs. Actions can be created from the project settings menu [code]Project > Project Settings > Input Map[/Code]. See [method Node._input]. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#actions @@ -35,8 +37,10 @@ + The action's name. Actions are accessed via this [String]. + If [code]true[/code] the action's state is pressed. If [code]false[/code] the action's state is released. diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index 2784b064421..f13a1102b75 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -1,11 +1,13 @@ - Input event type for joypad button events. + Input event for gamepad buttons. + Input event type for gamepad buttons. For joysticks see [InputEventJoypadMotion]. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html @@ -49,13 +51,13 @@ - Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope]. + Button identifier. One of the [code]JOY_BUTTON_*[/code] constants from [@global Scope]. - Pressed state of the joypad button. + If [code]true[/code] the button's state is pressed. If [code]false[/code] the button's state is released. - Intensity of the button pressure, ranges from 0 to 1.0. + Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from [code]0[/code] to [code]1[/code]. diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index 8a26007fc1e..9e7edfb822f 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -1,11 +1,13 @@ - Input event type for joypad motion/axis events. + Input event type for gamepad joysticks and other motions. For buttons see [InputEventJoypadMotion]. + Stores information about joystick motions. One [code]InputEventJoypadMotion[/code] represents one axis at a time. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html @@ -41,10 +43,10 @@ - Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope]. + Axis identifier. Use one of the [code]JOY_AXIS_*[/code] constants in [@global Scope]. - Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position. + Current position of the joystick on the given axis. The value ranges from [code]-1.0[/code] to [code]1.0[/code]. A value of [code]0[/code] means the axis is in its resting position. diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 151e19d25db..9565584a4f6 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -4,8 +4,10 @@ Input event type for keyboard events. + Stores key presses on the keyboard. Supports key presses, key releases and [member echo] events. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html @@ -63,16 +65,16 @@ - Echo state of the key, i.e. whether it's a repeat event or not. + If [code]true[/code] the key was already pressed before this event. It means the user is holding the key down. - Pressed state of the key. + If [code]true[/code] the key's state is pressed. If [code]false[/code] the key's state is released. - Scancode of the key, one of the KEY_* constants in [@Global Scope]. + Key scancode, one of the [code]KEY_*[/code] constants in [@global Scope]. - Unicode identifier of the key (when relevant). + Key unicode identifier when relevant. diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 57f0acbf301..38eec74ffae 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -4,8 +4,10 @@ Base input event type for mouse events. + Stores general mouse events informations. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html @@ -58,10 +60,10 @@ Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. - Global position of the mouse click. + Mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0. - Local position of the mouse click. + Mouse local position relative to the [Viewport]. If used in [method Control._gui_input] the position is relative to the current [Control] wich is under the mouse. diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index 63e31eb61cb..afc0c331c83 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -4,8 +4,10 @@ Input event type for mouse button events. + Contains mouse click informations. See [method Node._input]. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html @@ -66,12 +68,13 @@ Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope]. - Whether the event is a double-click. + If [code]true[/code] the mouse button's state is a double-click. If [code]false[/code] the mouse button's state is released. + TO TALK in PR, reduz said : i think it's used for apple touch but i don't remember what it does - Pressed state of the mouse button. + If [code]true[/code] the mouse button's state is pressed. If [code]false[/code] the mouse button's state is released. diff --git a/doc/classes/InputEventMouseMotion.xml b/doc/classes/InputEventMouseMotion.xml index 59fe8d2e580..5be82e1ffa4 100644 --- a/doc/classes/InputEventMouseMotion.xml +++ b/doc/classes/InputEventMouseMotion.xml @@ -4,8 +4,10 @@ Input event type for mouse motion events. + Contains mouse motion informations. Supports relative, absolute positions and speed. See [method Node._input]. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html @@ -41,10 +43,10 @@ - Position of the mouse pointer relative to the previous mouse position. + Mouse position relative to the previous position (position at the last frame). - Speed of the mouse pointer. + Mouse speed. diff --git a/doc/classes/InputEventScreenDrag.xml b/doc/classes/InputEventScreenDrag.xml index 0b0ecc17bc1..0c92ad5f708 100644 --- a/doc/classes/InputEventScreenDrag.xml +++ b/doc/classes/InputEventScreenDrag.xml @@ -2,10 +2,13 @@ Input event type for screen drag events. + (only available on mobile devices) + Contains screen drag informations. See [method Node._input]. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html @@ -72,13 +75,13 @@ Drag event index in the case of a multi-drag event. - Position of the drag event. + Drag position. - Position of the drag event relative to its start position. + Drag position relative to its start position. - Speed of the drag event. + Drag speed. diff --git a/doc/classes/InputEventScreenTouch.xml b/doc/classes/InputEventScreenTouch.xml index 48c5626f143..01ba9f12854 100644 --- a/doc/classes/InputEventScreenTouch.xml +++ b/doc/classes/InputEventScreenTouch.xml @@ -2,10 +2,13 @@ Input event type for screen touch events. + (only available on mobile devices) + Stores multi-touch press/release information. Supports touch press, touch release and [member index] for multi-touch count and order. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html @@ -49,13 +52,13 @@ - Touch event index in the case of a multi-touch event. + Touch index in the case of a multi-touch event. One index = one finger. - Position of the touch event. + Touch position. - Pressed state of the touch event. + If [code]true[/code] the touch's state is pressed. If [code]false[/code] the touch's state is released. diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml index 7bbdf0a441c..46107a4ab89 100644 --- a/doc/classes/InputEventWithModifiers.xml +++ b/doc/classes/InputEventWithModifiers.xml @@ -1,11 +1,13 @@ - Base class for input events with modifiers. + Base class for keys events with modifiers. + Contains keys events informations with modifiers support like [code]SHIFT[/code] or [code]ALT[/code]. See [method Node._input]. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index bf72ba05e74..333edf02b57 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -1,11 +1,13 @@ - Singleton that manages actions. + Singleton that manages [InputEventAction]. + Manages all [InputEventAction] which can be created/modified from the project settings menu [code]Project > Project Settings > Input Map[/Code] or in code with [method add_action] and [method action_add_event]. See [method Node._input]. + http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html#inputmap @@ -18,7 +20,7 @@ - Add an [InputEvent] to an action. This [InputEvent] will trigger the action. + Adds an [InputEvent] to an action. This [InputEvent] will trigger the action. @@ -29,7 +31,7 @@ - Remove an [InputEvent] from an action. + Removes an [InputEvent] from an action. @@ -40,7 +42,7 @@ - Whether an action has an [InputEvent] associated with it. + Returns [true] if an action has an [InputEvent] associated with it. @@ -49,7 +51,7 @@ - Add an (empty) action to the [InputMap]. An [InputEvent] can then be added to this action with [method action_add_event]. + Adds an (empty) action to the [InputMap]. An [InputEvent] can then be added to this action with [method action_add_event]. @@ -58,7 +60,7 @@ - Remove an action from the [InputMap]. + Removes an action from the [code]InputMap[/code]. @@ -69,7 +71,7 @@ - Return whether the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. + Returns [true] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. @@ -78,14 +80,14 @@ - Return an array of InputEvents associated with a given action. + Returns an array of [InputEvent]s associated with a given action. - Return an array of all actions in the [InputMap]. + Returns an array of all actions in the [code]InputMap[/code]. @@ -94,14 +96,14 @@ - Whether this InputMap has a registered action with the given name. + Returns [code]true[/code] if the [code]InputMap[/code] has a registered action with the given name. - Clear the [InputMap] and load it anew from [ProjectSettings]. + Clears all [InputEventAction] in the [code]InputMap[/code] and load it anew from [ProjectSettings].