From 0cccb6b4fae6f77e4cda7240128106927f63ede2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sun, 30 Jun 2019 17:17:46 +0200 Subject: [PATCH] doc: Complete GlobalScope documentation (cherry picked from commit 5aafc62a9bf8e8bb098a2cc3a22f1dedda622374) --- doc/classes/@GlobalScope.xml | 170 ++++++++++++++++++++++++----------- 1 file changed, 117 insertions(+), 53 deletions(-) diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 8d3c0bf6e30..a868116a801 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -638,7 +638,7 @@ _ key - Left Quote Key + ` key. { key @@ -662,9 +662,10 @@ + ¤ key. - Yen Key + ¥ key. ¦ key @@ -679,21 +680,22 @@ © key + ª key. « key - » key + ¬ key. - ‐ key + Soft hyphen key. ® key - Macron Key + ¯ key. ° key @@ -714,19 +716,19 @@ µ key - Paragraph Key + ¶ key. · key - ¬ key + ¸ key. ¹ key - ♂ key + º key. » key @@ -744,97 +746,97 @@ ¿ 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 + Ú key. - û key + Û key. - ü key + Ü key. - ý key + Ý key. - þ key + Þ key. ß key @@ -1050,8 +1052,10 @@ Joypad Right Stick Vertical Axis + Generic gamepad axis 4. + Generic gamepad axis 5. Joypad Left Trigger Analog Axis @@ -1060,8 +1064,10 @@ Joypad Right Trigger Analog Axis + Generic gamepad axis 8. + Generic gamepad axis 9. Represents the maximum number of joystick axes supported. @@ -1085,18 +1091,25 @@ Joypad Right Analog Trigger + 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. Methods that return [enum Error] return [constant OK] when no error occurred. Note that many functions don't return an error code but will print error messages to stdout. @@ -1258,88 +1271,112 @@ 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 an integer or float property should be within a range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"allow_greater"[/code] and/or [code]"allow_lesser"[/code] to allow manual input going respectively above the max or below the min values. Example: [code]"-360,360,1,allow_greater,allow_lesser"[/code]. - Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats. + Hints that an integer or float property should be within an exponential range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"allow_greater"[/code] and/or [code]"allow_lesser"[/code] to allow manual input going respectively above the max or below the min values. Example: [code]"0.01,100,0.01,allow_greater"[/code]. - Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties. + Hints that an integer, float or string property is an enumerated value to pick in a list specified via a hint string such as [code]"Hello,Something,Else"[/code]. + Hints that a float property should be edited via an exponential easing function. The hint string can include [code]"attenuation"[/code] to flip the curve horizontally and/or [code]"inout"[/code] to also include in/out easing. + Deprecated hint, unused. + Deprecated hint, unused. - 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. + Hints that an integer property is a bitmask with named bit flags. For example, to allow toggling bits 0, 1, 2 and 4, the hint could be something like [code]"Bit0,Bit1,Bit2,,Bit4"[/code]. + Hints that an integer property is a bitmask using the optionally named 2D render layers. + Hints that an integer property is a bitmask using the optionally named 2D physics layers. + Hints that an integer property is a bitmask using the optionally named 3D render layers. + Hints that an integer property is a bitmask using the optionally named 3D physics layers. - String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc". + Hints that a string property is a path to a file. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like [code]"*.png,*.jpg"[/code]. - String property is a directory (so pop up a file dialog when edited). + Hints that a string property is a path to a directory. Editing it will show a file dialog for picking the path. + Hints that a string property is an absolute path to a file outside the project folder. Editing it will show a file dialog for picking the path. The hint string can be a set of filters with wildcards like [code]"*.png,*.jpg"[/code]. + Hints that a string property is an absolute path to a directory outside the project folder. Editing it will show a file dialog for picking the path. - String property is a resource, so open the resource popup menu when edited. + Hints that a property is an instance of a [Resource]-derived type, optionally specified via the hint string (e.g. [code]"Texture"[/code]). Editing it will show a popup menu of valid resource types to instantiate. + Hints that a string property is text with line breaks. Editing it will show a text input field where line breaks can be typed. + Hints that a string property should have a placeholder text visible on its input field, whenever the property is empty. The hint string is the placeholder text to use. + Hints that a color property should be edited without changing its alpha component, i.e. only R, G and B channels are edited. - Hints that the image is compressed using lossy compression. + Hints that an image is compressed using lossy compression. - Hints that the image is compressed using lossless compression. + Hints that an image is compressed using lossless compression. - Property will be used as storage (default). + The property is serialized and saved in the scene file (default). - Property will be visible in editor (default). + The property is shown in the editor inspector (default). + Deprecated usage flag, unused. + Deprecated usage flag, unused. + The property can be checked in the editor inspector. + The property is checked in the editor inspector. + The property is a translatable string. + Used to group properties together in the editor. + Used to categorize properties together in the editor. + The property does not save its state in [PackedScene]. + Editing the property prompts the user for restarting the editor. + The property is a script variable which should be serialized and saved in the scene file. - Default usage (storage and editor). + Default usage (storage, editor and network). + Default usage for translatable strings (storage, editor, network and internationalized). + Default usage but without showing the property in the editor (storage, network). Flag for normal method @@ -1348,23 +1385,25 @@ Flag for editor method + Deprecated method flag, unused. Flag for constant method + Deprecated method flag, unused. Flag for virtual method - Flag for method from script + Deprecated method flag, unused. Default method flags - Variable is of type nil (only applied for null). + Variable is of type [Nil] (only applied for [code]null[/code]). Variable is of type [bool]. @@ -1373,7 +1412,7 @@ Variable is of type [int]. - Variable is of type [float]/real. + Variable is of type [float] (real). Variable is of type [String]. @@ -1448,54 +1487,79 @@ Represents the size of the [enum Variant.Type] enum. + Equality operator ([code]==[/code]). + Inequality operator ([code]!=[/code]). + Less than operator ([code]<[/code]). + Less than or equal operator ([code]<=[/code]). + Greater than operator ([code]>[/code]). + Greater than or equal operator ([code]>=[/code]). + Addition operator ([code]+[/code]). + Subtraction operator ([code]-[/code]). + Multiplication operator ([code]*[/code]). + Division operator ([code]/[/code]). + Unary negation operator ([code]-[/code]). + Unary plus operator ([code]+[/code]). + Remainder/modulo operator ([code]%[/code]). + String concatenation operator ([code]+[/code]). + Left shift operator ([code]<<[/code]). + Right shift operator ([code]>>[/code]). + Bitwise AND operator ([code]&[/code]). + Bitwise OR operator ([code]|[/code]). + Bitwise XOR operator ([code]^[/code]). + Bitwise NOT operator ([code]~[/code]). + Logical AND operator ([code]and[/code] or [code]&&[/code]). + Logical OR operator ([code]or[/code] or [code]||[/code]). + Logical XOR operator (not implemented in GDScript). + Logical NOT operator ([code]not[/code] or [code]![/code]). + Logical IN operator ([code]in[/code]). Represents the size of the [enum Variant.Operator] enum.