From a5324787c80ebc55b123ab19db2b23404b1241ec Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Wed, 13 May 2020 18:27:34 -0400 Subject: Rename some more global enums (Key, Joy, MIDI) --- doc/classes/@GlobalScope.xml | 592 ++++++++++++++++----------------- doc/classes/Input.xml | 8 +- doc/classes/InputEventJoypadButton.xml | 2 +- doc/classes/InputEventJoypadMotion.xml | 2 +- doc/classes/InputEventKey.xml | 4 +- doc/classes/InputEventMouse.xml | 2 +- doc/classes/InputEventMouseButton.xml | 2 +- doc/classes/XRController3D.xml | 2 +- doc/translations/classes.pot | 14 +- doc/translations/fr.po | 14 +- 10 files changed, 321 insertions(+), 321 deletions(-) (limited to 'doc') diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index cc6cd8a662..25f8f22d44 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1308,730 +1308,730 @@ Keycodes with this bit applied are non-printable. - + Escape key. - + Tab key. - + Shift + Tab key. - + Backspace key. - + Return key (on the main keyboard). - + Enter key on the numeric keypad. - + Insert key. - + Delete key. - + Pause key. - + Print Screen key. - + System Request key. - + Clear key. - + Home key. - + End key. - + Left arrow key. - + Up arrow key. - + Right arrow key. - + Down arrow key. - + Page Up key. - + Page Down key. - + Shift key. - + Control key. - + Meta key. - + Alt key. - + Caps Lock key. - + Num Lock key. - + Scroll Lock key. - + F1 key. - + F2 key. - + F3 key. - + F4 key. - + F5 key. - + F6 key. - + F7 key. - + F8 key. - + F9 key. - + F10 key. - + F11 key. - + F12 key. - + F13 key. - + F14 key. - + F15 key. - + F16 key. - + Multiply (*) key on the numeric keypad. - + Divide (/) key on the numeric keypad. - + Subtract (-) key on the numeric keypad. - + Period (.) key on the numeric keypad. - + Add (+) key on the numeric keypad. - + Number 0 on the numeric keypad. - + Number 1 on the numeric keypad. - + Number 2 on the numeric keypad. - + Number 3 on the numeric keypad. - + Number 4 on the numeric keypad. - + Number 5 on the numeric keypad. - + Number 6 on the numeric keypad. - + Number 7 on the numeric keypad. - + Number 8 on the numeric keypad. - + Number 9 on the numeric keypad. - + Left Super key (Windows key). - + Right Super key (Windows key). - + Context menu key. - + Left Hyper key. - + Right Hyper key. - + Help key. - + Left Direction key. - + Right Direction key. - + Media back key. Not to be confused with the Back button on an Android device. - + Media forward key. - + Media stop key. - + Media refresh key. - + Volume down key. - + Mute volume key. - + Volume up key. - + Bass Boost key. - + Bass up key. - + Bass down key. - + Treble up key. - + Treble down key. - + Media play key. - + Media stop key. - + Previous song key. - + Next song key. - + Media record key. - + Home page key. - + Favorites key. - + Search key. - + Standby key. - + Open URL / Launch Browser key. - + Launch Mail key. - + Launch Media key. - + Launch Shortcut 0 key. - + Launch Shortcut 1 key. - + Launch Shortcut 2 key. - + Launch Shortcut 3 key. - + Launch Shortcut 4 key. - + Launch Shortcut 5 key. - + Launch Shortcut 6 key. - + Launch Shortcut 7 key. - + Launch Shortcut 8 key. - + Launch Shortcut 9 key. - + Launch Shortcut A key. - + Launch Shortcut B key. - + Launch Shortcut C key. - + Launch Shortcut D key. - + Launch Shortcut E key. - + Launch Shortcut F key. - + Unknown key. - + Space key. - + ! key. - + " key. - + # key. - + $ key. - + % key. - + & key. - + ' key. - + ( key. - + ) key. - + * key. - + + key. - + , key. - + - key. - + . key. - + / key. - + Number 0. - + Number 1. - + Number 2. - + Number 3. - + Number 4. - + Number 5. - + Number 6. - + Number 7. - + Number 8. - + Number 9. - + : key. - + ; key. - + < key. - + = key. - + > key. - + ? key. - + @ key. - + A key. - + B key. - + C key. - + D key. - + E key. - + F key. - + G key. - + H key. - + I key. - + J key. - + K key. - + L key. - + M key. - + N key. - + O key. - + P key. - + Q key. - + R key. - + S key. - + T key. - + U key. - + V key. - + W key. - + X key. - + Y key. - + Z key. - + [ key. - + \ key. - + ] key. - + ^ key. - + _ key. - + ` key. - + { key. - + | key. - + } key. - + ~ key. - + Non-breakable space key. - + ¡ key. - + ¢ key. - + £ key. - + ¤ key. - + ¥ key. - + ¦ key. - + § key. - + ¨ key. - + © key. - + ª key. - + « key. - + ¬ key. - + Soft hyphen key. - + ® key. - + ¯ key. - + ° key. - + ± key. - + ² key. - + ³ key. - + ´ key. - + µ key. - + ¶ key. - + · key. - + ¸ key. - + ¹ key. - + º key. - + » key. - + ¼ key. - + ½ key. - + ¾ key. - + ¿ key. - + À key. - + Á key. - + Â key. - + Ã key. - + Ä key. - + Å key. - + Æ key. - + Ç key. - + È key. - + É key. - + Ê key. - + Ë key. - + Ì key. - + Í key. - + Î key. - + Ï key. - + Ð key. - + Ñ key. - + Ò key. - + Ó key. - + Ô key. - + Õ key. - + Ö key. - + × key. - + Ø key. - + Ù key. - + Ú key. - + Û key. - + Ü key. - + Ý key. - + Þ key. - + ß key. - + ÷ key. - + ÿ key. @@ -2061,166 +2061,166 @@ Group Switch key mask. - + Left mouse button. - + Right mouse button. - + Middle mouse button. - + Extra mouse button 1 (only present on some mice). - + Extra mouse button 2 (only present on some mice). - + Mouse wheel up. - + Mouse wheel down. - + Mouse wheel left button (only present on some mice). - + Mouse wheel right button (only present on some mice). - + Left mouse button mask. - + Right mouse button mask. - + Middle mouse button mask. - + Extra mouse button 1 mask. - + Extra mouse button 2 mask. - + An invalid game controller button. - + Game controller SDL button A. Corresponds to the bottom action button: Sony Cross, Xbox A, Nintendo B. - + Game controller SDL button B. Corresponds to the right action button: Sony Circle, Xbox B, Nintendo A. - + Game controller SDL button X. Corresponds to the left action button: Sony Square, Xbox X, Nintendo Y. - + Game controller SDL button Y. Corresponds to the top action button: Sony Triangle, Xbox Y, Nintendo X. - + Game controller SDL back button. Corresponds to the Sony Select, Xbox Back, Nintendo - button. - + Game controller SDL guide button. Corresponds to the Sony PS, Xbox Home button. - + Game controller SDL start button. Corresponds to the Nintendo + button. - + Game controller SDL left stick button. Corresponds to the Sony L3, Xbox L/LS button. - + Game controller SDL right stick button. Corresponds to the Sony R3, Xbox R/RS button. - + Game controller SDL left shoulder button. Corresponds to the Sony L1, Xbox LB button. - + Game controller SDL right shoulder button. Corresponds to the Sony R1, Xbox RB button. - + Game controller D-pad up button. - + Game controller D-pad down button. - + Game controller D-pad left button. - + Game controller D-pad right button. - + Game controller SDL miscellaneous button. Corresponds to Xbox share button, PS5 microphone button, Nintendo capture button. - + Game controller SDL paddle 1 button. - + Game controller SDL paddle 2 button. - + Game controller SDL paddle 3 button. - + Game controller SDL paddle 4 button. - + Game controller SDL touchpad button. - + The number of SDL game controller buttons. - + The maximum number of game controller buttons: Android supports up to 36 buttons. - + An invalid game controller axis. - + Game controller left joystick x-axis. - + Game controller left joystick y-axis. - + Game controller right joystick x-axis. - + Game controller right joystick y-axis. - + Game controller left trigger axis. - + Game controller right trigger axis. - + The number of SDL game controller axes. - + The maximum number of game controller axes: OpenVR supports up to 5 Joysticks making a total of 10 axes. - + MIDI note OFF message. - + MIDI note ON message. - + MIDI aftertouch message. - + MIDI control change message. - + MIDI program change message. - + MIDI channel pressure message. - + MIDI pitch bend message. diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 659d791ccf..d7408cd0ff 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -126,7 +126,7 @@ - Returns the current value of the joypad axis at given index (see [enum JoyAxisList]). + Returns the current value of the joypad axis at given index (see [enum JoyAxis]). @@ -255,7 +255,7 @@ - Returns [code]true[/code] if you are pressing the joypad button (see [enum JoyButtonList]). + Returns [code]true[/code] if you are pressing the joypad button (see [enum JoyButton]). @@ -273,7 +273,7 @@ - Returns [code]true[/code] if you are pressing the key in the current keyboard layout. You can pass a [enum KeyList] constant. + Returns [code]true[/code] if you are pressing the key in the current keyboard layout. You can pass a [enum Key] constant. @@ -282,7 +282,7 @@ - Returns [code]true[/code] if you are pressing the mouse button specified with [enum ButtonList]. + Returns [code]true[/code] if you are pressing the mouse button specified with [enum MouseButton]. diff --git a/doc/classes/InputEventJoypadButton.xml b/doc/classes/InputEventJoypadButton.xml index 6ab4942f85..b1f4836f6e 100644 --- a/doc/classes/InputEventJoypadButton.xml +++ b/doc/classes/InputEventJoypadButton.xml @@ -13,7 +13,7 @@ - Button identifier. One of the [enum JoyButtonList] button constants. + Button identifier. One of the [enum JoyButton] button constants. If [code]true[/code], the button's state is pressed. If [code]false[/code], the button's state is released. diff --git a/doc/classes/InputEventJoypadMotion.xml b/doc/classes/InputEventJoypadMotion.xml index 2d7787b568..39fdb14016 100644 --- a/doc/classes/InputEventJoypadMotion.xml +++ b/doc/classes/InputEventJoypadMotion.xml @@ -13,7 +13,7 @@ - Axis identifier. Use one of the [enum JoyAxisList] axis constants. + Axis identifier. Use one of the [enum JoyAxis] axis constants. 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 fe91b9c13e..9f2b829823 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -32,11 +32,11 @@ If [code]true[/code], the key was already pressed before this event. It means the user is holding the key down. - The key keycode, which corresponds to one of the [enum KeyList] constants. Represent key in the current keyboard layout. + The key keycode, which corresponds to one of the [enum Key] constants. Represent key in the current keyboard layout. To get a human-readable representation of the [InputEventKey], use [code]OS.get_keycode_string(event.keycode)[/code] where [code]event[/code] is the [InputEventKey]. - Key physical keycode, which corresponds to one of the [enum KeyList] constants. Represent the physical location of a key on the 101/102-key US QWERTY keyboard. + Key physical keycode, which corresponds to one of the [enum Key] constants. Represent the physical location of a key on the 101/102-key US QWERTY keyboard. To get a human-readable representation of the [InputEventKey], use [code]OS.get_keycode_string(event.keycode)[/code] where [code]event[/code] is the [InputEventKey]. diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index 31e82bbaed..e54c3224da 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -13,7 +13,7 @@ - The mouse button mask identifier, one of or a bitwise combination of the [enum ButtonList] button masks. + The mouse button mask identifier, one of or a bitwise combination of the [enum MouseButton] button masks. The global mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0. diff --git a/doc/classes/InputEventMouseButton.xml b/doc/classes/InputEventMouseButton.xml index d7b64a9a2d..d7e92f8bca 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -13,7 +13,7 @@ - The mouse button identifier, one of the [enum ButtonList] button or button wheel constants. + The mouse button identifier, one of the [enum MouseButton] button or button wheel constants. If [code]true[/code], the mouse button's state is a double-click. diff --git a/doc/classes/XRController3D.xml b/doc/classes/XRController3D.xml index a4a86cc22a..5d8c23bd6f 100644 --- a/doc/classes/XRController3D.xml +++ b/doc/classes/XRController3D.xml @@ -62,7 +62,7 @@ - Returns [code]true[/code] if the button at index [code]button[/code] is pressed. See [enum JoyButtonList]. + Returns [code]true[/code] if the button at index [code]button[/code] is pressed. See [enum JoyButton]. diff --git a/doc/translations/classes.pot b/doc/translations/classes.pot index 4cd89924ee..d14b0d9b1f 100644 --- a/doc/translations/classes.pot +++ b/doc/translations/classes.pot @@ -25583,7 +25583,7 @@ msgstr "" #: doc/classes/Input.xml:99 msgid "" "Returns the current value of the joypad axis at given index (see [enum " -"JoyAxisList])." +"JoyAxis])." msgstr "" #: doc/classes/Input.xml:108 @@ -25592,7 +25592,7 @@ msgstr "" #: doc/classes/Input.xml:117 msgid "" -"Receives a [enum JoyAxisList] axis and returns its equivalent name as a " +"Receives a [enum JoyAxis] axis and returns its equivalent name as a " "string." msgstr "" @@ -25602,7 +25602,7 @@ msgstr "" #: doc/classes/Input.xml:135 msgid "" -"Receives a gamepad button from [enum JoyButtonList] and returns its " +"Receives a gamepad button from [enum JoyButton] and returns its " "equivalent name as a string." msgstr "" @@ -25677,7 +25677,7 @@ msgstr "" #: doc/classes/Input.xml:238 msgid "" "Returns [code]true[/code] if you are pressing the joypad button (see [enum " -"JoyButtonList])." +"JoyButton])." msgstr "" #: doc/classes/Input.xml:247 @@ -26077,7 +26077,7 @@ msgid "" msgstr "" #: doc/classes/InputEventJoypadButton.xml:16 -msgid "Button identifier. One of the [enum JoyButtonList] button constants." +msgid "Button identifier. One of the [enum JoyButton] button constants." msgstr "" #: doc/classes/InputEventJoypadButton.xml:19 @@ -26105,7 +26105,7 @@ msgid "" msgstr "" #: doc/classes/InputEventJoypadMotion.xml:16 -msgid "Axis identifier. Use one of the [enum JoyAxisList] axis constants." +msgid "Axis identifier. Use one of the [enum JoyAxis] axis constants." msgstr "" #: doc/classes/InputEventJoypadMotion.xml:19 @@ -60259,7 +60259,7 @@ msgstr "" #: doc/classes/XRController3D.xml:65 msgid "" "Returns [code]true[/code] if the button at index [code]button[/code] is " -"pressed. See [enum JoyButtonList]." +"pressed. See [enum JoyButton]." msgstr "" #: doc/classes/XRController3D.xml:71 diff --git a/doc/translations/fr.po b/doc/translations/fr.po index c4fe08e67b..f3e26ebc61 100644 --- a/doc/translations/fr.po +++ b/doc/translations/fr.po @@ -25946,7 +25946,7 @@ msgstr "" #: doc/classes/Input.xml:99 msgid "" "Returns the current value of the joypad axis at given index (see [enum " -"JoyAxisList])." +"JoyAxis])." msgstr "" #: doc/classes/Input.xml:108 @@ -25955,7 +25955,7 @@ msgstr "" #: doc/classes/Input.xml:117 msgid "" -"Receives a [enum JoyAxisList] axis and returns its equivalent name as a " +"Receives a [enum JoyAxis] axis and returns its equivalent name as a " "string." msgstr "" @@ -25965,7 +25965,7 @@ msgstr "" #: doc/classes/Input.xml:135 msgid "" -"Receives a gamepad button from [enum JoyButtonList] and returns its " +"Receives a gamepad button from [enum JoyButton] and returns its " "equivalent name as a string." msgstr "" @@ -26041,7 +26041,7 @@ msgstr "" #, fuzzy msgid "" "Returns [code]true[/code] if you are pressing the joypad button (see [enum " -"JoyButtonList])." +"JoyButton])." msgstr "" "Retourne [code]true[/code] (vrai) si la chaîne de caractères finit par la " "chaîne de caractères donnée." @@ -26443,7 +26443,7 @@ msgid "" msgstr "" #: doc/classes/InputEventJoypadButton.xml:16 -msgid "Button identifier. One of the [enum JoyButtonList] button constants." +msgid "Button identifier. One of the [enum JoyButton] button constants." msgstr "" #: doc/classes/InputEventJoypadButton.xml:19 @@ -26471,7 +26471,7 @@ msgid "" msgstr "" #: doc/classes/InputEventJoypadMotion.xml:16 -msgid "Axis identifier. Use one of the [enum JoyAxisList] axis constants." +msgid "Axis identifier. Use one of the [enum JoyAxis] axis constants." msgstr "" #: doc/classes/InputEventJoypadMotion.xml:19 @@ -60738,7 +60738,7 @@ msgstr "" #, fuzzy msgid "" "Returns [code]true[/code] if the button at index [code]button[/code] is " -"pressed. See [enum JoyButtonList]." +"pressed. See [enum JoyButton]." msgstr "" "Renvoie [code]true[/code] (vrai) si [code]s[/code] vaut zéro ou quasiment " "zéro." -- cgit v1.2.3