From e7701bb2de30c554f52dc9d3f0110b4001ae18ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 15 Nov 2017 18:45:34 +0100 Subject: doc: Rename "@Global Scope" to "@GlobalScope" Spaces in filenames are evil. --- doc/classes/@GDScript.xml | 4 +- doc/classes/@Global Scope.xml | 1387 ---------------------------- doc/classes/@GlobalScope.xml | 1387 ++++++++++++++++++++++++++++ doc/classes/ConfigFile.xml | 4 +- doc/classes/Directory.xml | 14 +- doc/classes/EditorInterface.xml | 2 +- doc/classes/EditorSettings.xml | 2 +- doc/classes/File.xml | 2 +- doc/classes/Input.xml | 10 +- doc/classes/InputEventMouse.xml | 2 +- doc/classes/InputEventMouseButton.xml | 2 +- doc/classes/JSONParseResult.xml | 4 +- doc/classes/Object.xml | 6 +- doc/classes/ProjectSettings.xml | 2 +- editor/doc/doc_data.cpp | 2 +- editor/editor_help.cpp | 2 +- modules/gdscript/gd_editor.cpp | 2 +- modules/mono/editor/bindings_generator.cpp | 4 +- 18 files changed, 1419 insertions(+), 1419 deletions(-) delete mode 100644 doc/classes/@Global Scope.xml create mode 100644 doc/classes/@GlobalScope.xml diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index fa5c89ccf2..3f2d0c71e7 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -196,7 +196,7 @@ - Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the enum TYPE_* in [@Global Scope]. + Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the enum TYPE_* in [@GlobalScope]. [codeblock] a = Vector2(1, 0) # prints 1 @@ -984,7 +984,7 @@ - Returns the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope]. + Returns the internal type of the given Variant object, using the TYPE_* enum in [@GlobalScope]. [codeblock] p = parse_json('["a", "b", "c"]') if typeof(p) == TYPE_ARRAY: diff --git a/doc/classes/@Global Scope.xml b/doc/classes/@Global Scope.xml deleted file mode 100644 index 5ba50fa862..0000000000 --- a/doc/classes/@Global Scope.xml +++ /dev/null @@ -1,1387 +0,0 @@ - - - - Global scope constants and variables. - - - Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, scancodes, property hints, etc. It's not much. - Singletons are also documented here, since they can be accessed from anywhere. - - - - - - - - - - [ARVRServer] singleton - - - [AudioServer] singleton - - - [ClassDB] singleton - - - [Engine] singleton - - - [Geometry] singleton - - - [GodotSharp] singleton - - - [IP] singleton - - - [Input] singleton - - - [InputMap] singleton - - - [JSON] singleton - - - [Marshalls] singleton - - - [OS] singleton - - - [Performance] singleton - - - [Physics2DServer] singleton - - - [PhysicsServer] singleton - - - [ProjectSettings] singleton - - - [ResourceLoader] singleton - - - [ResourceSaver] singleton - - - [TranslationServer] singleton - - - [VisualServer] singleton - - - - - Left margin, used usually for [Control] or [StyleBox] derived classes. - - - Top margin, used usually for [Control] or [StyleBox] derived classes. - - - Right margin, used usually for [Control] or [StyleBox] derived classes. - - - Bottom margin, used usually for [Control] or [StyleBox] derived classes. - - - General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc. - - - General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc. - - - Horizontal left alignment, usually for text-derived classes. - - - Horizontal center alignment, usually for text-derived classes. - - - Horizontal right alignment, usually for text-derived classes. - - - Vertical top alignment, usually for text-derived classes. - - - Vertical center alignment, usually for text-derived classes. - - - Vertical bottom alignment, usually for text-derived classes. - - - Scancodes with this bit applied are non printable. - - - Escape Key - - - Tab Key - - - Shift-Tab Key - - - Backspace Key - - - Return Key (On Main Keyboard) - - - Enter Key (On Numpad) - - - Insert Key - - - Delete Key - - - Pause Key - - - Printscreen Key - - - System Request Key - - - Clear Key - - - Home Key - - - End Key - - - Left Arrow Key - - - Up Arrow Key - - - Right Arrow Key - - - Down Arrow Key - - - Pageup Key - - - Pagedown Key - - - Shift Key - - - Control Key - - - Meta Key - - - Alt Key - - - Capslock Key - - - Numlock Key - - - Scrolllock 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 Numpad - - - Divide Key on Numpad - - - Subtract Key on Numpad - - - Period Key on Numpad - - - Add Key on Numpad - - - Number 0 on Numpad - - - Number 1 on Numpad - - - Number 2 on Numpad - - - Number 3 on Numpad - - - Number 4 on Numpad - - - Number 5 on Numpad - - - Number 6 on Numpad - - - Number 7 on Numpad - - - Number 8 on Numpad - - - Number 9 on Numpad - - - 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 - - - Back key - - - Forward key - - - Stop key - - - 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 - - - Lower than key - - - = key - - - Greater than 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 - - - Left Quote Key - - - { key - - - | key - - - } key - - - ~ key - - - - - - - ¢ key - - - - - - - Yen Key - - - ¦ key - - - § key - - - ¨ key - - - © key - - - - - « key - - - » key - - - ‐ key - - - ® key - - - Macron Key - - - ° key - - - ± key - - - ² key - - - ³ key - - - ´ key - - - µ key - - - Paragraph 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 Code Mask - - - Modifier Key Mask - - - Shift Key Mask - - - Alt Key Mask - - - Meta Key Mask - - - CTRL Key Mask - - - CMD Key Mask - - - Keypad Key Mask - - - Group Switch Key Mask - - - Left Mouse Button - - - Right Mouse Button - - - Middle Mouse Button - - - Mouse wheel up - - - Mouse wheel down - - - Mouse wheel left button - - - Mouse wheel right button - - - Left Mouse Button Mask - - - Right Mouse Button Mask - - - Middle Mouse Button Mask - - - Joypad Button 0 - - - Joypad Button 1 - - - Joypad Button 2 - - - Joypad Button 3 - - - Joypad Button 4 - - - Joypad Button 5 - - - Joypad Button 6 - - - Joypad Button 7 - - - Joypad Button 8 - - - Joypad Button 9 - - - Joypad Button 10 - - - Joypad Button 11 - - - Joypad Button 12 - - - Joypad Button 13 - - - Joypad Button 14 - - - Joypad Button 15 - - - Joypad Button 16 - - - DUALSHOCK circle button - - - DUALSHOCK X button - - - DUALSHOCK square button - - - DUALSHOCK triangle button - - - XBOX controller B button - - - XBOX controller A button - - - XBOX controller X button - - - XBOX controller Y button - - - DualShock controller A button - - - DualShock controller B button - - - DualShock controller X button - - - DualShock controller Y button - - - Joypad Button Select - - - Joypad Button Start - - - Joypad DPad Up - - - Joypad DPad Down - - - Joypad DPad Left - - - Joypad DPad Right - - - Joypad Left Shoulder Button - - - Joypad Left Trigger - - - Joypad Left Stick Click - - - Joypad Right Shoulder Button - - - Joypad Right Trigger - - - Joypad Right Stick Click - - - Joypad Left Stick Horizontal Axis - - - Joypad Left Stick Vertical Axis - - - Joypad Right Stick Horizontal Axis - - - Joypad Right Stick Vertical Axis - - - - - - - Joypad Left Trigger Analog Axis - - - Joypad Right Trigger Analog Axis - - - - - - - - - Joypad Left Stick Horizontal Axis - - - Joypad Left Stick Vertical Axis - - - Joypad Right Stick Horizontal Axis - - - Joypad Right Stick Vertical Axis - - - Joypad Left Analog Trigger - - - Joypad Right Analog Trigger - - - Functions that return Error return OK when no error occured. Most functions don't return errors and/or just print errors to STDOUT. - - - Generic error. - - - Unavailable error - - - Unconfigured error - - - Unauthorized error - - - Parameter range error - - - Out of memory (OOM) error - - - File: Not found error - - - File: Bad drive error - - - File: Bad path error - - - File: No permission error - - - File: Already in use error - - - File: Can't open error - - - File: Can't write error - - - File: Can't read error - - - File: Unrecognized error - - - File: Corrupt error - - - File: Missing dependencies error - - - File: End of file (EOF) error - - - Can't open error - - - Can't create error - - - Parse error - - - Query failed error - - - Already in use error - - - Locked error - - - Timeout error - - - Can't acquire resource error - - - Invalid data error - - - Invalid parameter error - - - Already exists error - - - Does not exist error - - - Database: Read error - - - Database: Write error - - - Compilation failed error - - - Method not found error - - - Linking failed error - - - Script failed error - - - Cycling link (import cycle) error - - - Busy error - - - Help error - - - Bug error - - - WTF error (something probably went really wrong) - - - No hint for edited property. - - - Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats. - - - Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. - - - Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties. - - - - - - - - - Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. - - - - - - - - - - - String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc". - - - String property is a directory (so pop up a file dialog when edited). - - - - - - - String property is a resource, so open the resource popup menu when edited. - - - - - - - Hints that the image is compressed using lossy compression. - - - Hints that the image is compressed using lossless compression. - - - Property will be used as storage (default). - - - Property will be visible in editor (default). - - - - - - - - - - - - - - - - - - - - - - - - - - - Default usage (storage and editor). - - - - - - - Flag for normal method - - - Flag for editor method - - - - - Flag for constant method - - - - - Flag for virtual method - - - Flag for method from script - - - Default method flags - - - Variable is of type nil (only applied for null). - - - Variable is of type [bool]. - - - Variable is of type [int]. - - - Variable is of type [float]/real. - - - Variable is of type [String]. - - - Variable is of type [Vector2]. - - - Variable is of type [Rect2]. - - - Variable is of type [Vector3]. - - - Variable is of type [Transform2D]. - - - Variable is of type [Plane]. - - - Variable is of type [Quat]. - - - Variable is of type [Rect3]. - - - Variable is of type [Basis]. - - - Variable is of type [Transform]. - - - Variable is of type [Color]. - - - Variable is of type [NodePath]. - - - Variable is of type [RID]. - - - Variable is of type [Object]. - - - Variable is of type [Dictionary]. - - - Variable is of type [Array]. - - - Variable is of type [PoolByteArray]. - - - Variable is of type [PoolIntArray]. - - - Variable is of type [PoolRealArray]. - - - Variable is of type [PoolStringArray]. - - - Variable is of type [PoolVector2Array]. - - - Variable is of type [PoolVector3Array]. - - - Variable is of type [PoolColorArray]. - - - Marker for end of type constants. - - - diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml new file mode 100644 index 0000000000..258b06f320 --- /dev/null +++ b/doc/classes/@GlobalScope.xml @@ -0,0 +1,1387 @@ + + + + Global scope constants and variables. + + + Global scope constants and variables. This is all that resides in the globals, constants regarding error codes, scancodes, property hints, etc. It's not much. + Singletons are also documented here, since they can be accessed from anywhere. + + + + + + + + + + [ARVRServer] singleton + + + [AudioServer] singleton + + + [ClassDB] singleton + + + [Engine] singleton + + + [Geometry] singleton + + + [GodotSharp] singleton + + + [IP] singleton + + + [Input] singleton + + + [InputMap] singleton + + + [JSON] singleton + + + [Marshalls] singleton + + + [OS] singleton + + + [Performance] singleton + + + [Physics2DServer] singleton + + + [PhysicsServer] singleton + + + [ProjectSettings] singleton + + + [ResourceLoader] singleton + + + [ResourceSaver] singleton + + + [TranslationServer] singleton + + + [VisualServer] singleton + + + + + Left margin, used usually for [Control] or [StyleBox] derived classes. + + + Top margin, used usually for [Control] or [StyleBox] derived classes. + + + Right margin, used usually for [Control] or [StyleBox] derived classes. + + + Bottom margin, used usually for [Control] or [StyleBox] derived classes. + + + General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc. + + + General horizontal alignment, used usually for [Separator], [ScrollBar], [Slider], etc. + + + Horizontal left alignment, usually for text-derived classes. + + + Horizontal center alignment, usually for text-derived classes. + + + Horizontal right alignment, usually for text-derived classes. + + + Vertical top alignment, usually for text-derived classes. + + + Vertical center alignment, usually for text-derived classes. + + + Vertical bottom alignment, usually for text-derived classes. + + + Scancodes with this bit applied are non printable. + + + Escape Key + + + Tab Key + + + Shift-Tab Key + + + Backspace Key + + + Return Key (On Main Keyboard) + + + Enter Key (On Numpad) + + + Insert Key + + + Delete Key + + + Pause Key + + + Printscreen Key + + + System Request Key + + + Clear Key + + + Home Key + + + End Key + + + Left Arrow Key + + + Up Arrow Key + + + Right Arrow Key + + + Down Arrow Key + + + Pageup Key + + + Pagedown Key + + + Shift Key + + + Control Key + + + Meta Key + + + Alt Key + + + Capslock Key + + + Numlock Key + + + Scrolllock 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 Numpad + + + Divide Key on Numpad + + + Subtract Key on Numpad + + + Period Key on Numpad + + + Add Key on Numpad + + + Number 0 on Numpad + + + Number 1 on Numpad + + + Number 2 on Numpad + + + Number 3 on Numpad + + + Number 4 on Numpad + + + Number 5 on Numpad + + + Number 6 on Numpad + + + Number 7 on Numpad + + + Number 8 on Numpad + + + Number 9 on Numpad + + + 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 + + + Back key + + + Forward key + + + Stop key + + + 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 + + + Lower than key + + + = key + + + Greater than 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 + + + Left Quote Key + + + { key + + + | key + + + } key + + + ~ key + + + + + + + ¢ key + + + + + + + Yen Key + + + ¦ key + + + § key + + + ¨ key + + + © key + + + + + « key + + + » key + + + ‐ key + + + ® key + + + Macron Key + + + ° key + + + ± key + + + ² key + + + ³ key + + + ´ key + + + µ key + + + Paragraph 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 Code Mask + + + Modifier Key Mask + + + Shift Key Mask + + + Alt Key Mask + + + Meta Key Mask + + + CTRL Key Mask + + + CMD Key Mask + + + Keypad Key Mask + + + Group Switch Key Mask + + + Left Mouse Button + + + Right Mouse Button + + + Middle Mouse Button + + + Mouse wheel up + + + Mouse wheel down + + + Mouse wheel left button + + + Mouse wheel right button + + + Left Mouse Button Mask + + + Right Mouse Button Mask + + + Middle Mouse Button Mask + + + Joypad Button 0 + + + Joypad Button 1 + + + Joypad Button 2 + + + Joypad Button 3 + + + Joypad Button 4 + + + Joypad Button 5 + + + Joypad Button 6 + + + Joypad Button 7 + + + Joypad Button 8 + + + Joypad Button 9 + + + Joypad Button 10 + + + Joypad Button 11 + + + Joypad Button 12 + + + Joypad Button 13 + + + Joypad Button 14 + + + Joypad Button 15 + + + Joypad Button 16 + + + DUALSHOCK circle button + + + DUALSHOCK X button + + + DUALSHOCK square button + + + DUALSHOCK triangle button + + + XBOX controller B button + + + XBOX controller A button + + + XBOX controller X button + + + XBOX controller Y button + + + DualShock controller A button + + + DualShock controller B button + + + DualShock controller X button + + + DualShock controller Y button + + + Joypad Button Select + + + Joypad Button Start + + + Joypad DPad Up + + + Joypad DPad Down + + + Joypad DPad Left + + + Joypad DPad Right + + + Joypad Left Shoulder Button + + + Joypad Left Trigger + + + Joypad Left Stick Click + + + Joypad Right Shoulder Button + + + Joypad Right Trigger + + + Joypad Right Stick Click + + + Joypad Left Stick Horizontal Axis + + + Joypad Left Stick Vertical Axis + + + Joypad Right Stick Horizontal Axis + + + Joypad Right Stick Vertical Axis + + + + + + + Joypad Left Trigger Analog Axis + + + Joypad Right Trigger Analog Axis + + + + + + + + + Joypad Left Stick Horizontal Axis + + + Joypad Left Stick Vertical Axis + + + Joypad Right Stick Horizontal Axis + + + Joypad Right Stick Vertical Axis + + + Joypad Left Analog Trigger + + + Joypad Right Analog Trigger + + + Functions that return Error return OK when no error occured. Most functions don't return errors and/or just print errors to STDOUT. + + + Generic error. + + + Unavailable error + + + Unconfigured error + + + Unauthorized error + + + Parameter range error + + + Out of memory (OOM) error + + + File: Not found error + + + File: Bad drive error + + + File: Bad path error + + + File: No permission error + + + File: Already in use error + + + File: Can't open error + + + File: Can't write error + + + File: Can't read error + + + File: Unrecognized error + + + File: Corrupt error + + + File: Missing dependencies error + + + File: End of file (EOF) error + + + Can't open error + + + Can't create error + + + Parse error + + + Query failed error + + + Already in use error + + + Locked error + + + Timeout error + + + Can't acquire resource error + + + Invalid data error + + + Invalid parameter error + + + Already exists error + + + Does not exist error + + + Database: Read error + + + Database: Write error + + + Compilation failed error + + + Method not found error + + + Linking failed error + + + Script failed error + + + Cycling link (import cycle) error + + + Busy error + + + Help error + + + Bug error + + + WTF error (something probably went really wrong) + + + No hint for edited property. + + + Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats. + + + Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. + + + Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties. + + + + + + + + + Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. + + + + + + + + + + + String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc". + + + String property is a directory (so pop up a file dialog when edited). + + + + + + + String property is a resource, so open the resource popup menu when edited. + + + + + + + Hints that the image is compressed using lossy compression. + + + Hints that the image is compressed using lossless compression. + + + Property will be used as storage (default). + + + Property will be visible in editor (default). + + + + + + + + + + + + + + + + + + + + + + + + + + + Default usage (storage and editor). + + + + + + + Flag for normal method + + + Flag for editor method + + + + + Flag for constant method + + + + + Flag for virtual method + + + Flag for method from script + + + Default method flags + + + Variable is of type nil (only applied for null). + + + Variable is of type [bool]. + + + Variable is of type [int]. + + + Variable is of type [float]/real. + + + Variable is of type [String]. + + + Variable is of type [Vector2]. + + + Variable is of type [Rect2]. + + + Variable is of type [Vector3]. + + + Variable is of type [Transform2D]. + + + Variable is of type [Plane]. + + + Variable is of type [Quat]. + + + Variable is of type [Rect3]. + + + Variable is of type [Basis]. + + + Variable is of type [Transform]. + + + Variable is of type [Color]. + + + Variable is of type [NodePath]. + + + Variable is of type [RID]. + + + Variable is of type [Object]. + + + Variable is of type [Dictionary]. + + + Variable is of type [Array]. + + + Variable is of type [PoolByteArray]. + + + Variable is of type [PoolIntArray]. + + + Variable is of type [PoolRealArray]. + + + Variable is of type [PoolStringArray]. + + + Variable is of type [PoolVector2Array]. + + + Variable is of type [PoolVector3Array]. + + + Variable is of type [PoolColorArray]. + + + Marker for end of type constants. + + + diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index c3b628298d..ef668ca994 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -95,7 +95,7 @@ - Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@Global Scope]. If the load was successful, the return value is [code]OK[/code]. + Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [code]OK[/code]. @@ -104,7 +104,7 @@ - Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@Global Scope]. If the load was successful, the return value is [code]OK[/code]. + Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [code]OK[/code]. diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index a0146dfae2..b11e0629cd 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -34,7 +34,7 @@ Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]). - The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*). + The method returns one of the error code constants defined in [@GlobalScope] (OK or ERR_*). @@ -46,7 +46,7 @@ Copy the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. - Returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*). + Returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*). @@ -146,7 +146,7 @@ Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]). - The method returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*). + The method returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*). @@ -156,7 +156,7 @@ Create a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. - Return one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*). + Return one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*). @@ -166,7 +166,7 @@ Open an existing directory of the filesystem. The [i]path[/i] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]). - The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*). + The method returns one of the error code constants defined in [@GlobalScope] (OK or ERR_*). @@ -176,7 +176,7 @@ Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. - Return one of the error code constants defined in [@Global Scope] (OK or FAILED). + Return one of the error code constants defined in [@GlobalScope] (OK or FAILED). @@ -188,7 +188,7 @@ Rename (move) the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. - Return one of the error code constants defined in [@Global Scope] (OK or FAILED). + Return one of the error code constants defined in [@GlobalScope] (OK or FAILED). diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 93de000952..0059804c00 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -127,7 +127,7 @@ - Saves the scene. Returns either OK or ERR_CANT_CREATE. See [@Global Scope] constants. + Saves the scene. Returns either OK or ERR_CANT_CREATE. See [@GlobalScope] constants. diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 753fc4f959..a0e4fdb8e0 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -23,7 +23,7 @@ - Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@Global Scope]), and optionally hint:[int](see PROPERTY_HINT_* in [@Global Scope]), hint_string:[String]. + Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String]. Example: [codeblock] editor_settings.set("category/property_name", 0) diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 15d37ebbc4..8ec56e9c48 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -120,7 +120,7 @@ - Returns the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope]. + Returns the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@GlobalScope]. diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index f9e8ad534a..114c8d2c59 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -75,7 +75,7 @@ - Returns the current value of the joypad axis at given index (see [code]JOY_*[/code] constants in [@Global Scope]) + Returns the current value of the joypad axis at given index (see [code]JOY_*[/code] constants in [@GlobalScope]) @@ -209,7 +209,7 @@ - Returns [code]true[/code] if you are pressing the joypad button. (see [code]JOY_*[/code] constants in [@Global Scope]) + Returns [code]true[/code] if you are pressing the joypad button. (see [code]JOY_*[/code] constants in [@GlobalScope]) @@ -218,7 +218,7 @@ - Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the [code]JOY_*[/code] constants (see [@Global Scope]). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. + Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the [code]JOY_*[/code] constants (see [@GlobalScope]). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. @@ -227,7 +227,7 @@ - Returns [code]true[/code] if you are pressing the key. You can pass [code]KEY_*[/code], which are pre-defined constants listed in [@Global Scope]. + Returns [code]true[/code] if you are pressing the key. You can pass [code]KEY_*[/code], which are pre-defined constants listed in [@GlobalScope]. @@ -236,7 +236,7 @@ - Returns [code]true[/code] if you are pressing the mouse button. You can pass [code]BUTTON_*[/code], which are pre-defined constants listed in [@Global Scope]. + Returns [code]true[/code] if you are pressing the mouse button. You can pass [code]BUTTON_*[/code], which are pre-defined constants listed in [@GlobalScope]. diff --git a/doc/classes/InputEventMouse.xml b/doc/classes/InputEventMouse.xml index d9489eeaed..24a771cef3 100644 --- a/doc/classes/InputEventMouse.xml +++ b/doc/classes/InputEventMouse.xml @@ -57,7 +57,7 @@ - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. + Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@GlobalScope]. 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 f7fd42a8a5..ff7c1da34e 100644 --- a/doc/classes/InputEventMouseButton.xml +++ b/doc/classes/InputEventMouseButton.xml @@ -65,7 +65,7 @@ - Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope]. + Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@GlobalScope]. If [code]true[/code] the mouse button's state is a double-click. If [code]false[/code] the mouse button's state is released. diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index 390aaa802c..5bf9298f7a 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -70,13 +70,13 @@ - The error type if JSON source was not successfully parsed. See [@Global Scope]ERR_* constants. + The error type if JSON source was not successfully parsed. See [@GlobalScope]ERR_* constants. The line number where the error occurred if JSON source was not successfully parsed. - The error message if JSON source was not successfully parsed. See [@Global Scope]ERR_* constants. + The error message if JSON source was not successfully parsed. See [@GlobalScope]ERR_* constants. A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index e36a90cd23..bea4c14a3c 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -28,7 +28,7 @@ - Returns the object's property list as an [Array] of dictionaries. Dictionaries must contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]). + Returns the object's property list as an [Array] of dictionaries. Dictionaries must contain: name:String, type:int (see TYPE_* enum in [@GlobalScope]) and optionally: hint:int (see PROPERTY_HINT_* in [@GlobalScope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@GlobalScope]). @@ -66,7 +66,7 @@ - Adds a user-defined [code]signal[/code]. Arguments are optional, but can be added as an [Array] of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*). + Adds a user-defined [code]signal[/code]. Arguments are optional, but can be added as an [Array] of dictionaries, each containing "name" and "type" (from [@GlobalScope] TYPE_*). @@ -212,7 +212,7 @@ - Returns the list of properties as an [Array] of dictionaries. Dictionaries contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]). + Returns the list of properties as an [Array] of dictionaries. Dictionaries contain: name:String, type:int (see TYPE_* enum in [@GlobalScope]) and optionally: hint:int (see PROPERTY_HINT_* in [@GlobalScope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@GlobalScope]). diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index c62127ec4d..523c45a92a 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -17,7 +17,7 @@ - Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@Global Scope]), and optionally hint:[int](see PROPERTY_HINT_* in [@Global Scope]), hint_string:[String]. + Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String]. Example: [codeblock] ProjectSettings.set("category/property_name", 0) diff --git a/editor/doc/doc_data.cpp b/editor/doc/doc_data.cpp index 2a0cd00c27..f7f823c945 100644 --- a/editor/doc/doc_data.cpp +++ b/editor/doc/doc_data.cpp @@ -530,7 +530,7 @@ void DocData::generate(bool p_basic_types) { { - String cname = "@Global Scope"; + String cname = "@GlobalScope"; class_list[cname] = ClassDoc(); ClassDoc &c = class_list[cname]; c.name = cname; diff --git a/editor/editor_help.cpp b/editor/editor_help.cpp index bdb621a258..cc7f1cac43 100644 --- a/editor/editor_help.cpp +++ b/editor/editor_help.cpp @@ -555,7 +555,7 @@ void EditorHelp::_class_desc_select(const String &p_select) { if (select.find(".") != -1) { class_name = select.get_slice(".", 0); } else { - class_name = "@Global Scope"; + class_name = "@GlobalScope"; } emit_signal("go_to_help", "class_enum:" + class_name + ":" + select); return; diff --git a/modules/gdscript/gd_editor.cpp b/modules/gdscript/gd_editor.cpp index 655e785174..9b7201f5f7 100644 --- a/modules/gdscript/gd_editor.cpp +++ b/modules/gdscript/gd_editor.cpp @@ -2798,7 +2798,7 @@ Error GDScriptLanguage::lookup_code(const String &p_code, const String &p_symbol } } else { r_result.type = ScriptLanguage::LookupResult::RESULT_CLASS_CONSTANT; - r_result.class_name = "@Global Scope"; + r_result.class_name = "@GlobalScope"; r_result.class_member = p_symbol; return OK; } diff --git a/modules/mono/editor/bindings_generator.cpp b/modules/mono/editor/bindings_generator.cpp index e6099c7cdf..a293cc2c50 100644 --- a/modules/mono/editor/bindings_generator.cpp +++ b/modules/mono/editor/bindings_generator.cpp @@ -320,9 +320,9 @@ Error BindingsGenerator::generate_cs_core_project(const String &p_output_dir, bo int global_constants_count = GlobalConstants::get_global_constant_count(); if (global_constants_count > 0) { - Map::Element *match = EditorHelp::get_doc_data()->class_list.find("@Global Scope"); + Map::Element *match = EditorHelp::get_doc_data()->class_list.find("@GlobalScope"); - ERR_EXPLAIN("Could not find `@Global Scope` in DocData"); + ERR_EXPLAIN("Could not find `@GlobalScope` in DocData"); ERR_FAIL_COND_V(!match, ERR_BUG); const DocData::ClassDoc &global_scope_doc = match->value(); -- cgit v1.2.3