diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/base/classes.xml | 6404 |
1 files changed, 3202 insertions, 3202 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index b04d4cfe16..c56f0084ac 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -2,10 +2,10 @@ <doc version="2.1.alpha.custom_build" name="Engine Types"> <class name="@GDScript" category="Core"> <brief_description> - Built-in GDScript functions. + Built-in GDScript functions. </brief_description> <description> - This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects. + This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects. </description> <methods> <method name="Color8"> @@ -20,7 +20,7 @@ <argument index="3" name="a8" type="int"> </argument> <description> - Make a color from red, green, blue and alpha. Arguments can range from 0 to 255. + Make a color from red, green, blue and alpha. Arguments can range from 0 to 255. </description> </method> <method name="abs"> @@ -29,7 +29,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Remove sign (works for integer and float). + Remove sign (works for integer and float). </description> </method> <method name="acos"> @@ -38,7 +38,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Arc-cosine. + Arc-cosine. </description> </method> <method name="asin"> @@ -47,7 +47,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Arc-sine. + Arc-sine. </description> </method> <method name="assert"> @@ -56,7 +56,7 @@ <argument index="0" name="condition" type="bool"> </argument> <description> - Assert that the condition is true. If the condition is false, generates an error. + Assert that the condition is true. If the condition is false, generates an error. </description> </method> <method name="atan"> @@ -65,7 +65,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Arc-tangent. + Arc-tangent. </description> </method> <method name="atan2"> @@ -76,7 +76,7 @@ <argument index="1" name="y" type="float"> </argument> <description> - Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range. + Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range. </description> </method> <method name="bytes2var"> @@ -85,7 +85,7 @@ <argument index="0" name="bytes" type="RawArray"> </argument> <description> - Decode a byte array back to a value. + Decode a byte array back to a value. </description> </method> <method name="ceil"> @@ -94,7 +94,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Ceiling (rounds up to nearest integer). + Ceiling (rounds up to nearest integer). </description> </method> <method name="clamp"> @@ -107,7 +107,7 @@ <argument index="2" name="max" type="float"> </argument> <description> - Clamp both values to a range. + Clamp both values to a range. </description> </method> <method name="convert"> @@ -118,7 +118,7 @@ <argument index="1" name="type" type="int"> </argument> <description> - Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in [@Global Scope]. + Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in [@Global Scope]. </description> </method> <method name="cos"> @@ -127,7 +127,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Standard cosine function. + Standard cosine function. </description> </method> <method name="cosh"> @@ -136,7 +136,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Hyperbolic cosine. + Hyperbolic cosine. </description> </method> <method name="db2linear"> @@ -145,7 +145,7 @@ <argument index="0" name="db" type="float"> </argument> <description> - Convert from decibels to linear energy (audio). + Convert from decibels to linear energy (audio). </description> </method> <method name="decimals"> @@ -154,7 +154,7 @@ <argument index="0" name="step" type="float"> </argument> <description> - Return the amount of decimals in the floating point value. + Return the amount of decimals in the floating point value. </description> </method> <method name="dectime"> @@ -167,7 +167,7 @@ <argument index="2" name="step" type="float"> </argument> <description> - Decreases time by a specified amount. + Decreases time by a specified amount. </description> </method> <method name="deg2rad"> @@ -176,7 +176,7 @@ <argument index="0" name="deg" type="float"> </argument> <description> - Convert from degrees to radians. + Convert from degrees to radians. </description> </method> <method name="dict2inst"> @@ -185,7 +185,7 @@ <argument index="0" name="dict" type="Dictionary"> </argument> <description> - Convert a previously converted instances to dictionary back into an instance. Useful for deserializing. + Convert a previously converted instances to dictionary back into an instance. Useful for deserializing. </description> </method> <method name="ease"> @@ -196,7 +196,7 @@ <argument index="1" name="curve" type="float"> </argument> <description> - Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. + Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. </description> </method> <method name="exp"> @@ -205,7 +205,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Exponential logarithm. + Exponential logarithm. </description> </method> <method name="floor"> @@ -214,7 +214,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Floor (rounds down to nearest integer). + Floor (rounds down to nearest integer). </description> </method> <method name="fmod"> @@ -225,7 +225,7 @@ <argument index="1" name="y" type="float"> </argument> <description> - Module (remainder of x/y). + Module (remainder of x/y). </description> </method> <method name="fposmod"> @@ -236,7 +236,7 @@ <argument index="1" name="y" type="float"> </argument> <description> - Module (remainder of x/y) that wraps equally in positive and negative. + Module (remainder of x/y) that wraps equally in positive and negative. </description> </method> <method name="funcref"> @@ -247,7 +247,7 @@ <argument index="1" name="funcname" type="String"> </argument> <description> - Return a reference to the specified function. + Return a reference to the specified function. </description> </method> <method name="hash"> @@ -256,7 +256,7 @@ <argument index="0" name="var:Variant" type="Variant"> </argument> <description> - Hash the variable passed and return an integer. + Hash the variable passed and return an integer. </description> </method> <method name="inst2dict"> @@ -265,7 +265,7 @@ <argument index="0" name="inst" type="Object"> </argument> <description> - Convert a script class instance to a dictionary (useful for serializing). + Convert a script class instance to a dictionary (useful for serializing). </description> </method> <method name="instance_from_id"> @@ -274,7 +274,7 @@ <argument index="0" name="instance_id" type="int"> </argument> <description> - Get an object by its ID. + Get an object by its ID. </description> </method> <method name="is_inf"> @@ -303,7 +303,7 @@ <argument index="2" name="weight" type="float"> </argument> <description> - Linear interpolates between two values by a normalized value. + Linear interpolates between two values by a normalized value. </description> </method> <method name="linear2db"> @@ -312,7 +312,7 @@ <argument index="0" name="nrg" type="float"> </argument> <description> - Convert from linear energy to decibels (audio). + Convert from linear energy to decibels (audio). </description> </method> <method name="load"> @@ -321,7 +321,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Load a resource from the filesystem, pass a valid path as argument. + Load a resource from the filesystem, pass a valid path as argument. </description> </method> <method name="log"> @@ -330,7 +330,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Natural logarithm. + Natural logarithm. </description> </method> <method name="max"> @@ -341,7 +341,7 @@ <argument index="1" name="b" type="float"> </argument> <description> - Return the maximum of two values. + Return the maximum of two values. </description> </method> <method name="min"> @@ -352,7 +352,7 @@ <argument index="1" name="b" type="float"> </argument> <description> - Return the minimum of two values. + Return the minimum of two values. </description> </method> <method name="nearest_po2"> @@ -361,7 +361,7 @@ <argument index="0" name="val" type="int"> </argument> <description> - Return the nearest larger power of 2 for an integer. + Return the nearest larger power of 2 for an integer. </description> </method> <method name="pow"> @@ -372,7 +372,7 @@ <argument index="1" name="y" type="float"> </argument> <description> - Power function, x elevate to y. + Power function, x elevate to y. </description> </method> <method name="preload"> @@ -381,7 +381,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Preload a resource from the filesystem. The resource is loaded during script parsing. + Preload a resource from the filesystem. The resource is loaded during script parsing. </description> </method> <method name="print"> @@ -392,14 +392,14 @@ <argument index="1" name="..." type="Variant"> </argument> <description> - Print one or more arguments to strings in the best way possible to a console line. + Print one or more arguments to strings in the best way possible to a console line. </description> </method> <method name="print_stack"> <return type="Nil"> </return> <description> - Print a stack track at code location, only works when running with debugger turned on. + Print a stack track at code location, only works when running with debugger turned on. </description> </method> <method name="printerr"> @@ -410,7 +410,7 @@ <argument index="1" name="..." type="Variant"> </argument> <description> - Print one or more arguments to strings in the best way possible to standard error line. + Print one or more arguments to strings in the best way possible to standard error line. </description> </method> <method name="printraw"> @@ -421,7 +421,7 @@ <argument index="1" name="..." type="Variant"> </argument> <description> - Print one or more arguments to strings in the best way possible to console. No newline is added at the end. + Print one or more arguments to strings in the best way possible to console. No newline is added at the end. </description> </method> <method name="prints"> @@ -432,7 +432,7 @@ <argument index="1" name="..." type="Variant"> </argument> <description> - Print one or more arguments to the console with a space between each argument. + Print one or more arguments to the console with a space between each argument. </description> </method> <method name="printt"> @@ -443,7 +443,7 @@ <argument index="1" name="..." type="Variant"> </argument> <description> - Print one or more arguments to the console with a tab between each argument. + Print one or more arguments to the console with a tab between each argument. </description> </method> <method name="rad2deg"> @@ -452,7 +452,7 @@ <argument index="0" name="rad" type="float"> </argument> <description> - Convert from radians to degrees. + Convert from radians to degrees. </description> </method> <method name="rand_range"> @@ -463,7 +463,7 @@ <argument index="1" name="to" type="float"> </argument> <description> - Random range, any floating point value between 'from' and 'to' + Random range, any floating point value between 'from' and 'to' </description> </method> <method name="rand_seed"> @@ -472,28 +472,28 @@ <argument index="0" name="seed" type="int"> </argument> <description> - Random from seed, pass a seed and an array with both number and new seed is returned. + Random from seed, pass a seed and an array with both number and new seed is returned. </description> </method> <method name="randf"> <return type="float"> </return> <description> - Random value (0 to 1 float). + Random value (0 to 1 float). </description> </method> <method name="randi"> <return type="int"> </return> <description> - Random 32 bits value (integer). To obtain a value from 0 to N, you can use remainder, like (for random from 0 to 19): randi() % 20. + Random 32 bits value (integer). To obtain a value from 0 to N, you can use remainder, like (for random from 0 to 19): randi() % 20. </description> </method> <method name="randomize"> <return type="Nil"> </return> <description> - Reset the seed of the random number generator with a new, different one. + Reset the seed of the random number generator with a new, different one. </description> </method> <method name="range"> @@ -502,7 +502,7 @@ <argument index="0" name="..." type="Variant"> </argument> <description> - Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). + Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). </description> </method> <method name="round"> @@ -511,7 +511,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Round to nearest integer. + Round to nearest integer. </description> </method> <method name="seed"> @@ -520,7 +520,7 @@ <argument index="0" name="seed" type="int"> </argument> <description> - Set seed for the random number generator. + Set seed for the random number generator. </description> </method> <method name="sign"> @@ -529,7 +529,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Return sign (-1 or +1). + Return sign (-1 or +1). </description> </method> <method name="sin"> @@ -538,7 +538,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Standard sine function. + Standard sine function. </description> </method> <method name="sinh"> @@ -547,7 +547,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Hyperbolic sine. + Hyperbolic sine. </description> </method> <method name="sqrt"> @@ -556,7 +556,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Square root. + Square root. </description> </method> <method name="stepify"> @@ -567,7 +567,7 @@ <argument index="1" name="step" type="float"> </argument> <description> - Snap float value to a given step. + Snap float value to a given step. </description> </method> <method name="str"> @@ -578,7 +578,7 @@ <argument index="1" name="..." type="Variant"> </argument> <description> - Convert one or more arguments to strings in the best way possible. + Convert one or more arguments to strings in the best way possible. </description> </method> <method name="str2var"> @@ -587,7 +587,7 @@ <argument index="0" name="string" type="String"> </argument> <description> - Convert a formatted string that was returned by [method var2str] to the original value. + Convert a formatted string that was returned by [method var2str] to the original value. </description> </method> <method name="tan"> @@ -596,7 +596,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Standard tangent function. + Standard tangent function. </description> </method> <method name="tanh"> @@ -605,7 +605,7 @@ <argument index="0" name="s" type="float"> </argument> <description> - Hyperbolic tangent. + Hyperbolic tangent. </description> </method> <method name="type_exists"> @@ -622,7 +622,7 @@ <argument index="0" name="what" type="Variant"> </argument> <description> - Return the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope]. + Return the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope]. </description> </method> <method name="var2bytes"> @@ -631,7 +631,7 @@ <argument index="0" name="var" type="Variant"> </argument> <description> - Encode a variable value to a byte array. + Encode a variable value to a byte array. </description> </method> <method name="var2str"> @@ -640,7 +640,7 @@ <argument index="0" name="var" type="Variant"> </argument> <description> - Convert a value to a formatted string that can later be parsed using [method str2var]. + Convert a value to a formatted string that can later be parsed using [method str2var]. </description> </method> <method name="weakref"> @@ -649,7 +649,7 @@ <argument index="0" name="obj" type="Object"> </argument> <description> - Return a weak reference to an object. + Return a weak reference to an object. </description> </method> <method name="yield"> @@ -660,7 +660,7 @@ <argument index="1" name="signal" type="String"> </argument> <description> - Stop the function execution and return the current state. Call resume on the state to resume execution. This makes the state invalid. + Stop the function execution and return the current state. Call resume on the state to resume execution. This makes the state invalid. Returns anything that was passed to the resume function call. If passed an object and a signal, the execution is resumed when the object's signal is emmited. </description> @@ -674,10 +674,10 @@ </class> <class name="@Global Scope" category="Core"> <brief_description> - Global scope constants and variables. + Global scope constants and variables. </brief_description> <description> - 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. + 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. </description> <methods> @@ -1948,10 +1948,10 @@ </class> <class name="AABB" category="Built-In Types"> <brief_description> - Axis-Aligned Bounding Box. + Axis-Aligned Bounding Box. </brief_description> <description> - AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests. + AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests. </description> <methods> <method name="AABB"> @@ -1962,7 +1962,7 @@ <argument index="1" name="size" type="Vector3"> </argument> <description> - Optional constructor, accepts position and size. + Optional constructor, accepts position and size. </description> </method> <method name="encloses"> @@ -1971,7 +1971,7 @@ <argument index="0" name="with" type="AABB"> </argument> <description> - Return true if this [AABB] completely encloses another one. + Return true if this [AABB] completely encloses another one. </description> </method> <method name="expand"> @@ -1980,14 +1980,14 @@ <argument index="0" name="to_point" type="Vector3"> </argument> <description> - Return this [AABB] expanded to include a given point. + Return this [AABB] expanded to include a given point. </description> </method> <method name="get_area"> <return type="float"> </return> <description> - Get the area of the [AABB]. + Get the area of the [AABB]. </description> </method> <method name="get_endpoint"> @@ -1996,49 +1996,49 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the position of the 8 endpoints of the [AABB] in space. + Get the position of the 8 endpoints of the [AABB] in space. </description> </method> <method name="get_longest_axis"> <return type="Vector3"> </return> <description> - Return the normalized longest axis of the [AABB]. + Return the normalized longest axis of the [AABB]. </description> </method> <method name="get_longest_axis_index"> <return type="int"> </return> <description> - Return the index of the longest axis of the [AABB] (according to [Vector3]::AXIS* enum). + Return the index of the longest axis of the [AABB] (according to [Vector3]::AXIS* enum). </description> </method> <method name="get_longest_axis_size"> <return type="float"> </return> <description> - Return the scalar length of the longest axis of the [AABB]. + Return the scalar length of the longest axis of the [AABB]. </description> </method> <method name="get_shortest_axis"> <return type="Vector3"> </return> <description> - Return the normalized shortest axis of the [AABB]. + Return the normalized shortest axis of the [AABB]. </description> </method> <method name="get_shortest_axis_index"> <return type="int"> </return> <description> - Return the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum). + Return the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum). </description> </method> <method name="get_shortest_axis_size"> <return type="float"> </return> <description> - Return the scalar length of the shortest axis of the [AABB]. + Return the scalar length of the shortest axis of the [AABB]. </description> </method> <method name="get_support"> @@ -2047,7 +2047,7 @@ <argument index="0" name="dir" type="Vector3"> </argument> <description> - Return the support point in a given direction. This is useful for collision detection algorithms. + Return the support point in a given direction. This is useful for collision detection algorithms. </description> </method> <method name="grow"> @@ -2056,21 +2056,21 @@ <argument index="0" name="by" type="float"> </argument> <description> - Return a copy of the [AABB] grown a given amount of units towards all the sides. + Return a copy of the [AABB] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> <return type="bool"> </return> <description> - Return true if the [AABB] is flat or empty. + Return true if the [AABB] is flat or empty. </description> </method> <method name="has_no_surface"> <return type="bool"> </return> <description> - Return true if the [AABB] is empty. + Return true if the [AABB] is empty. </description> </method> <method name="has_point"> @@ -2079,7 +2079,7 @@ <argument index="0" name="point" type="Vector3"> </argument> <description> - Return true if the [AABB] contains a point. + Return true if the [AABB] contains a point. </description> </method> <method name="intersection"> @@ -2088,7 +2088,7 @@ <argument index="0" name="with" type="AABB"> </argument> <description> - Return the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure. + Return the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure. </description> </method> <method name="intersects"> @@ -2097,7 +2097,7 @@ <argument index="0" name="with" type="AABB"> </argument> <description> - Return true if the [AABB] overlaps with another. + Return true if the [AABB] overlaps with another. </description> </method> <method name="intersects_plane"> @@ -2106,7 +2106,7 @@ <argument index="0" name="plane" type="Plane"> </argument> <description> - Return true if the [AABB] is at both sides of a plane. + Return true if the [AABB] is at both sides of a plane. </description> </method> <method name="intersects_segment"> @@ -2117,7 +2117,7 @@ <argument index="1" name="to" type="Vector3"> </argument> <description> - Return true if the [AABB] intersects the line segment between from and to + Return true if the [AABB] intersects the line segment between from and to </description> </method> <method name="merge"> @@ -2126,7 +2126,7 @@ <argument index="0" name="with" type="AABB"> </argument> <description> - Combine this [AABB] with another, a larger one is returned that contains both. + Combine this [AABB] with another, a larger one is returned that contains both. </description> </method> </methods> @@ -2146,10 +2146,10 @@ </class> <class name="AcceptDialog" inherits="WindowDialog" category="Core"> <brief_description> - Base dialog for user notification. + Base dialog for user notification. </brief_description> <description> - This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result. + This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result. </description> <methods> <method name="add_button"> @@ -2162,7 +2162,7 @@ <argument index="2" name="action" type="String" default=""""> </argument> <description> - Add custom button to the dialog and return the created button. + Add custom button to the dialog and return the created button. The button titled with [i]text[/i] and the [i]action[/i] will be passed to [custom_action] signal when it is pressed. </description> </method> @@ -2172,35 +2172,35 @@ <argument index="0" name="name" type="String"> </argument> <description> - Add custom cancel button to the dialog and return the created button. + Add custom cancel button to the dialog and return the created button. </description> </method> <method name="get_hide_on_ok" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the dialog will be hidden when accepted (default true). + Return true if the dialog will be hidden when accepted (default true). </description> </method> <method name="get_label"> <return type="Object"> </return> <description> - Return the label used for built-in text. + Return the label used for built-in text. </description> </method> <method name="get_ok"> <return type="Object"> </return> <description> - Return the OK Button. + Return the OK Button. </description> </method> <method name="get_text" qualifiers="const"> <return type="String"> </return> <description> - Return the built-in label text. + Return the built-in label text. </description> </method> <method name="register_text_enter"> @@ -2209,35 +2209,35 @@ <argument index="0" name="line_edit" type="Object"> </argument> <description> - Register a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. + Register a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. </description> </method> <method name="set_hide_on_ok"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether the dialog is hidden when accepted (default true). + Set whether the dialog is hidden when accepted (default true). </description> </method> <method name="set_text"> <argument index="0" name="text" type="String"> </argument> <description> - Set the built-in label text. + Set the built-in label text. </description> </method> </methods> <signals> <signal name="confirmed"> <description> - Emitted when accepted. + Emitted when accepted. </description> </signal> <signal name="custom_action"> <argument index="0" name="action" type="String"> </argument> <description> - Emitted with a custom button is added. + Emitted with a custom button is added. </description> </signal> </signals> @@ -2246,10 +2246,10 @@ </class> <class name="AnimatedSprite" inherits="Node2D" category="Core"> <brief_description> - Sprite node that can use multiple textures for animation. + Sprite node that can use multiple textures for animation. </brief_description> <description> - Sprite node that can use multiple textures for animation. + Sprite node that can use multiple textures for animation. </description> <methods> <method name="get_animation" qualifiers="const"> @@ -2262,49 +2262,49 @@ <return type="int"> </return> <description> - Return the visible frame index. + Return the visible frame index. </description> </method> <method name="get_modulate" qualifiers="const"> <return type="Color"> </return> <description> - Return the color modulation for this sprite. + Return the color modulation for this sprite. </description> </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the offset of the sprite in the node origin. + Return the offset of the sprite in the node origin. </description> </method> <method name="get_sprite_frames" qualifiers="const"> <return type="SpriteFrames"> </return> <description> - Get the [SpriteFrames] resource, which contains all frames. + Get the [SpriteFrames] resource, which contains all frames. </description> </method> <method name="is_centered" qualifiers="const"> <return type="bool"> </return> <description> - Return true when centered. See [method set_centered]. + Return true when centered. See [method set_centered]. </description> </method> <method name="is_flipped_h" qualifiers="const"> <return type="bool"> </return> <description> - Return true if sprite is flipped horizontally. + Return true if sprite is flipped horizontally. </description> </method> <method name="is_flipped_v" qualifiers="const"> <return type="bool"> </return> <description> - Return true if sprite is flipped vertically. + Return true if sprite is flipped vertically. </description> </method> <method name="is_playing" qualifiers="const"> @@ -2329,49 +2329,49 @@ <argument index="0" name="centered" type="bool"> </argument> <description> - When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is. + When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is. </description> </method> <method name="set_flip_h"> <argument index="0" name="flip_h" type="bool"> </argument> <description> - If true, sprite is flipped horizontally. + If true, sprite is flipped horizontally. </description> </method> <method name="set_flip_v"> <argument index="0" name="flip_v" type="bool"> </argument> <description> - If true, sprite is flipped vertically. + If true, sprite is flipped vertically. </description> </method> <method name="set_frame"> <argument index="0" name="frame" type="int"> </argument> <description> - Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource). + Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource). </description> </method> <method name="set_modulate"> <argument index="0" name="modulate" type="Color"> </argument> <description> - Change the color modulation (multiplication) for this sprite. + Change the color modulation (multiplication) for this sprite. </description> </method> <method name="set_offset"> <argument index="0" name="offset" type="Vector2"> </argument> <description> - Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not. + Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not. </description> </method> <method name="set_sprite_frames"> <argument index="0" name="sprite_frames" type="SpriteFrames"> </argument> <description> - Set the [SpriteFrames] resource, which contains all frames. + Set the [SpriteFrames] resource, which contains all frames. </description> </method> <method name="stop"> @@ -2382,7 +2382,7 @@ <signals> <signal name="frame_changed"> <description> - Emmited when frame is changed. + Emmited when frame is changed. </description> </signal> </signals> @@ -2459,10 +2459,10 @@ </class> <class name="Animation" inherits="Resource" category="Core"> <brief_description> - Contains data used to animate everything in the engine. + Contains data used to animate everything in the engine. </brief_description> <description> - An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. + An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. Animations are just data containers, and must be added to odes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back. </description> <methods> @@ -2474,12 +2474,12 @@ <argument index="1" name="at_pos" type="int" default="-1"> </argument> <description> - Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. + Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. </description> </method> <method name="clear"> <description> - Clear the animation (clear all tracks and reset all). + Clear the animation (clear all tracks and reset all). </description> </method> <method name="find_track" qualifiers="const"> @@ -2494,7 +2494,7 @@ <return type="float"> </return> <description> - Return the total length of the animation (in seconds). + Return the total length of the animation (in seconds). </description> </method> <method name="get_step" qualifiers="const"> @@ -2507,14 +2507,14 @@ <return type="int"> </return> <description> - Return the amount of tracks in the animation. + Return the amount of tracks in the animation. </description> </method> <method name="has_loop" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the animation has the loop flag set. + Return whether the animation has the loop flag set. </description> </method> <method name="method_track_get_key_indices" qualifiers="const"> @@ -2527,7 +2527,7 @@ <argument index="2" name="delta" type="float"> </argument> <description> - Return all the key indices of a method track, given a position and delta time. + Return all the key indices of a method track, given a position and delta time. </description> </method> <method name="method_track_get_name" qualifiers="const"> @@ -2538,7 +2538,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the method name of a method track. + Return the method name of a method track. </description> </method> <method name="method_track_get_params" qualifiers="const"> @@ -2549,28 +2549,28 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the arguments values to be called on a method track for a given key in a given track. + Return the arguments values to be called on a method track for a given key in a given track. </description> </method> <method name="remove_track"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove a track by specifying the track index. + Remove a track by specifying the track index. </description> </method> <method name="set_length"> <argument index="0" name="time_sec" type="float"> </argument> <description> - Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. + Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping. </description> </method> <method name="set_loop"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. + Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation. </description> </method> <method name="set_step"> @@ -2589,7 +2589,7 @@ <argument index="2" name="exact" type="bool" default="false"> </argument> <description> - Find the key index by time in a given track. Optionally, only find it if the exact time is given. + Find the key index by time in a given track. Optionally, only find it if the exact time is given. </description> </method> <method name="track_get_interpolation_type" qualifiers="const"> @@ -2598,7 +2598,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the interpolation type of a given track, from the INTERPOLATION_* enum. + Return the interpolation type of a given track, from the INTERPOLATION_* enum. </description> </method> <method name="track_get_key_count" qualifiers="const"> @@ -2607,7 +2607,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the amount of keys in a given track. + Return the amount of keys in a given track. </description> </method> <method name="track_get_key_time" qualifiers="const"> @@ -2618,7 +2618,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the time at which the key is located. + Return the time at which the key is located. </description> </method> <method name="track_get_key_transition" qualifiers="const"> @@ -2629,7 +2629,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the transition curve (easing) for a specific key (see built-in math function "ease"). + Return the transition curve (easing) for a specific key (see built-in math function "ease"). </description> </method> <method name="track_get_key_value" qualifiers="const"> @@ -2638,7 +2638,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Return the value of a given key in a given track. + Return the value of a given key in a given track. </description> </method> <method name="track_get_path" qualifiers="const"> @@ -2647,7 +2647,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the path of a track. for more information on the path format, see [method track_set_path] + Get the path of a track. for more information on the path format, see [method track_set_path] </description> </method> <method name="track_get_type" qualifiers="const"> @@ -2656,7 +2656,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Get the type of a track. + Get the type of a track. </description> </method> <method name="track_insert_key"> @@ -2669,7 +2669,7 @@ <argument index="3" name="transition" type="float" default="1"> </argument> <description> - Insert a generic key in a given track. + Insert a generic key in a given track. </description> </method> <method name="track_is_imported" qualifiers="const"> @@ -2684,14 +2684,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Move a track down. + Move a track down. </description> </method> <method name="track_move_up"> <argument index="0" name="idx" type="int"> </argument> <description> - Move a track up. + Move a track up. </description> </method> <method name="track_remove_key"> @@ -2700,7 +2700,7 @@ <argument index="1" name="key_idx" type="int"> </argument> <description> - Remove a key by index in a given track. + Remove a key by index in a given track. </description> </method> <method name="track_remove_key_at_pos"> @@ -2709,7 +2709,7 @@ <argument index="1" name="pos" type="float"> </argument> <description> - Remove a key by position (seconds) in a given track. + Remove a key by position (seconds) in a given track. </description> </method> <method name="track_set_imported"> @@ -2726,7 +2726,7 @@ <argument index="1" name="interpolation" type="int"> </argument> <description> - Set the interpolation type of a given track, from the INTERPOLATION_* enum. + Set the interpolation type of a given track, from the INTERPOLATION_* enum. </description> </method> <method name="track_set_key_transition"> @@ -2737,7 +2737,7 @@ <argument index="2" name="transition" type="float"> </argument> <description> - Set the transition curve (easing) for a specific key (see built-in math function "ease"). + Set the transition curve (easing) for a specific key (see built-in math function "ease"). </description> </method> <method name="track_set_key_value"> @@ -2748,7 +2748,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Set the value of an existing key. + Set the value of an existing key. </description> </method> <method name="track_set_path"> @@ -2757,7 +2757,7 @@ <argument index="1" name="path" type="NodePath"> </argument> <description> - Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local" + Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local" </description> </method> <method name="transform_track_insert_key"> @@ -2774,7 +2774,7 @@ <argument index="4" name="scale" type="Vector3"> </argument> <description> - Insert a transform key for a transform track. + Insert a transform key for a transform track. </description> </method> <method name="transform_track_interpolate" qualifiers="const"> @@ -2785,7 +2785,7 @@ <argument index="1" name="time_sec" type="float"> </argument> <description> - Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]). + Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]). </description> </method> <method name="value_track_get_key_indices" qualifiers="const"> @@ -2798,7 +2798,7 @@ <argument index="2" name="delta" type="float"> </argument> <description> - Return all the key indices of a value track, given a position and delta time. + Return all the key indices of a value track, given a position and delta time. </description> </method> <method name="value_track_get_update_mode" qualifiers="const"> @@ -2847,10 +2847,10 @@ </class> <class name="AnimationPlayer" inherits="Node" category="Core"> <brief_description> - Container and player of [Animation] resources. + Container and player of [Animation] resources. </brief_description> <description> - An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. + An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. </description> <methods> <method name="add_animation"> @@ -2861,14 +2861,14 @@ <argument index="1" name="animation" type="Animation"> </argument> <description> - Add an animation resource to the player, which will be later referenced by the "name" argument. + Add an animation resource to the player, which will be later referenced by the "name" argument. </description> </method> <method name="advance"> <argument index="0" name="delta" type="float"> </argument> <description> - Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip. + Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip. </description> </method> <method name="animation_get_next" qualifiers="const"> @@ -2889,12 +2889,12 @@ </method> <method name="clear_caches"> <description> - The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again. + The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again. </description> </method> <method name="clear_queue"> <description> - If animations are queued to play, clear them. + If animations are queued to play, clear them. </description> </method> <method name="find_animation" qualifiers="const"> @@ -2903,7 +2903,7 @@ <argument index="0" name="animation" type="Animation"> </argument> <description> - Find an animation name by resource. + Find an animation name by resource. </description> </method> <method name="get_animation" qualifiers="const"> @@ -2912,28 +2912,28 @@ <argument index="0" name="name" type="String"> </argument> <description> - Get an [Animation] resource by requesting a name. + Get an [Animation] resource by requesting a name. </description> </method> <method name="get_animation_list" qualifiers="const"> <return type="StringArray"> </return> <description> - Get the list of names of the animations stored in the player. + Get the list of names of the animations stored in the player. </description> </method> <method name="get_animation_process_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the mode in which the animation player processes. See [method set_animation_process_mode]. + Return the mode in which the animation player processes. See [method set_animation_process_mode]. </description> </method> <method name="get_autoplay" qualifiers="const"> <return type="String"> </return> <description> - Return the name of the animation that will be automatically played when the scene is loaded. + Return the name of the animation that will be automatically played when the scene is loaded. </description> </method> <method name="get_blend_time" qualifiers="const"> @@ -2944,56 +2944,56 @@ <argument index="1" name="anim_to" type="String"> </argument> <description> - Get the blend time between two animations, referenced by their names. + Get the blend time between two animations, referenced by their names. </description> </method> <method name="get_current_animation" qualifiers="const"> <return type="String"> </return> <description> - Return the name of the animation being played. + Return the name of the animation being played. </description> </method> <method name="get_current_animation_length" qualifiers="const"> <return type="float"> </return> <description> - Get the length (in seconds) of the currently being played animation. + Get the length (in seconds) of the currently being played animation. </description> </method> <method name="get_current_animation_pos" qualifiers="const"> <return type="float"> </return> <description> - Get the position (in seconds) of the currently being played animation. + Get the position (in seconds) of the currently being played animation. </description> </method> <method name="get_default_blend_time" qualifiers="const"> <return type="float"> </return> <description> - Return the default blend time between animations. + Return the default blend time between animations. </description> </method> <method name="get_pos" qualifiers="const"> <return type="float"> </return> <description> - Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). + Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided). </description> </method> <method name="get_root" qualifiers="const"> <return type="NodePath"> </return> <description> - Return path to root node (see [method set_root]). + Return path to root node (see [method set_root]). </description> </method> <method name="get_speed" qualifiers="const"> <return type="float"> </return> <description> - Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling). + Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling). </description> </method> <method name="has_animation" qualifiers="const"> @@ -3002,21 +3002,21 @@ <argument index="0" name="name" type="String"> </argument> <description> - Request whether an [Animation] name exist within the player. + Request whether an [Animation] name exist within the player. </description> </method> <method name="is_active" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the player is active. + Return true if the player is active. </description> </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> <description> - Return whether an animation is playing. + Return whether an animation is playing. </description> </method> <method name="play"> @@ -3029,7 +3029,7 @@ <argument index="3" name="from_end" type="bool" default="false"> </argument> <description> - Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. + Play a given animation by the animation name. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. </description> </method> <method name="play_backwards"> @@ -3038,21 +3038,21 @@ <argument index="1" name="custom_blend" type="float" default="-1"> </argument> <description> - Play a given animation by the animation name in reverse. + Play a given animation by the animation name in reverse. </description> </method> <method name="queue"> <argument index="0" name="name" type="String"> </argument> <description> - Queue an animation for playback once the current one is done. + Queue an animation for playback once the current one is done. </description> </method> <method name="remove_animation"> <argument index="0" name="name" type="String"> </argument> <description> - Remove an animation from the player (by supplying the same name used to add it). + Remove an animation from the player (by supplying the same name used to add it). </description> </method> <method name="rename_animation"> @@ -3061,7 +3061,7 @@ <argument index="1" name="newname" type="String"> </argument> <description> - Rename an existing animation. + Rename an existing animation. </description> </method> <method name="seek"> @@ -3070,14 +3070,14 @@ <argument index="1" name="update" type="bool" default="false"> </argument> <description> - Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time. + Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time. </description> </method> <method name="set_active"> <argument index="0" name="active" type="bool"> </argument> <description> - Set the player as active (playing). If false, it + Set the player as active (playing). If false, it will do nothing. </description> </method> @@ -3085,14 +3085,14 @@ <argument index="0" name="mode" type="int"> </argument> <description> - Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*. + Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS_*. </description> </method> <method name="set_autoplay"> <argument index="0" name="name" type="String"> </argument> <description> - Set the name of the animation that will be automatically played when the scene is loaded. + Set the name of the animation that will be automatically played when the scene is loaded. </description> </method> <method name="set_blend_time"> @@ -3103,47 +3103,47 @@ <argument index="2" name="sec" type="float"> </argument> <description> - Specify a blend time (in seconds) between two animations, referenced by their names. + Specify a blend time (in seconds) between two animations, referenced by their names. </description> </method> <method name="set_current_animation"> <argument index="0" name="anim" type="String"> </argument> <description> - Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). + Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). </description> </method> <method name="set_default_blend_time"> <argument index="0" name="sec" type="float"> </argument> <description> - Set the default blend time between animations. + Set the default blend time between animations. </description> </method> <method name="set_root"> <argument index="0" name="path" type="NodePath"> </argument> <description> - AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed. + AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed. </description> </method> <method name="set_speed"> <argument index="0" name="speed" type="float"> </argument> <description> - Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling). + Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is [i]1[/i] (no scaling). </description> </method> <method name="stop"> <argument index="0" name="reset" type="bool" default="true"> </argument> <description> - Stop the currently playing animation. + Stop the currently playing animation. </description> </method> <method name="stop_all"> <description> - Stop playback of animations (deprecated). + Stop playback of animations (deprecated). </description> </method> </methods> @@ -3154,19 +3154,19 @@ <argument index="1" name="new_name" type="String"> </argument> <description> - If the currently being played animation changes, this signal will notify of such change. + If the currently being played animation changes, this signal will notify of such change. </description> </signal> <signal name="animation_started"> <argument index="0" name="name" type="String"> </argument> <description> - Notifies when an animation starts playing. + Notifies when an animation starts playing. </description> </signal> <signal name="finished"> <description> - Notifies when an animation finished playing. + Notifies when an animation finished playing. </description> </signal> </signals> @@ -3181,10 +3181,10 @@ </class> <class name="AnimationTreePlayer" inherits="Node" category="Core"> <brief_description> - Animation Player that uses a node graph for the blending. + Animation Player that uses a node graph for the blending. </brief_description> <description> - Animation Player that uses a node graph for the blending. This kind of player is very useful when animating character or other skeleton based rigs, because it can combine several animations to form a desired pose. + Animation Player that uses a node graph for the blending. This kind of player is very useful when animating character or other skeleton based rigs, because it can combine several animations to form a desired pose. </description> <methods> <method name="add_node"> @@ -3193,7 +3193,7 @@ <argument index="1" name="id" type="String"> </argument> <description> - Add a node of a given type in the graph with given id. + Add a node of a given type in the graph with given id. </description> </method> <method name="advance"> @@ -3224,7 +3224,7 @@ <argument index="1" name="animation" type="Animation"> </argument> <description> - Set the animation for an animation node. + Set the animation for an animation node. </description> </method> <method name="animation_node_set_filter_path"> @@ -3387,7 +3387,7 @@ <argument index="0" name="node" type="String"> </argument> <description> - Check if a node exists (by name). + Check if a node exists (by name). </description> </method> <method name="node_get_input_count" qualifiers="const"> @@ -3396,7 +3396,7 @@ <argument index="0" name="id" type="String"> </argument> <description> - Return the input count for a given node. Different types of nodes have different amount of inputs. + Return the input count for a given node. Different types of nodes have different amount of inputs. </description> </method> <method name="node_get_input_source" qualifiers="const"> @@ -3407,7 +3407,7 @@ <argument index="1" name="idx" type="int"> </argument> <description> - Return the input source for a given node input. + Return the input source for a given node input. </description> </method> <method name="node_get_pos" qualifiers="const"> @@ -3424,7 +3424,7 @@ <argument index="0" name="id" type="String"> </argument> <description> - Get the node type, will return from NODE_* enum. + Get the node type, will return from NODE_* enum. </description> </method> <method name="node_rename"> @@ -3435,7 +3435,7 @@ <argument index="1" name="new_name" type="String"> </argument> <description> - Rename a node in the graph. + Rename a node in the graph. </description> </method> <method name="node_set_pos"> @@ -3720,24 +3720,24 @@ </class> <class name="Area" inherits="CollisionObject" category="Core"> <brief_description> - General purpose area detection and influence for 3D physics. + General purpose area detection and influence for 3D physics. </brief_description> <description> - General purpose area detection for 3D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass. + General purpose area detection for 3D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass. </description> <methods> <method name="get_angular_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the angular damp rate. + Return the angular damp rate. </description> </method> <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the physics layers this area can scan for collisions. + Return the physics layers this area can scan for collisions. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -3746,35 +3746,35 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the collision mask. + Return an individual bit on the collision mask. </description> </method> <method name="get_gravity" qualifiers="const"> <return type="float"> </return> <description> - Return the gravity intensity. + Return the gravity intensity. </description> </method> <method name="get_gravity_distance_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the falloff factor for point gravity. + Return the falloff factor for point gravity. </description> </method> <method name="get_gravity_vector" qualifiers="const"> <return type="Vector3"> </return> <description> - Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. + Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> <method name="get_layer_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the physics layer this area is in. + Return the physics layer this area is in. </description> </method> <method name="get_layer_mask_bit" qualifiers="const"> @@ -3783,63 +3783,63 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the layer mask. + Return an individual bit on the layer mask. </description> </method> <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the linear damp rate. + Return the linear damp rate. </description> </method> <method name="get_overlapping_areas" qualifiers="const"> <return type="Array"> </return> <description> - Return a list of the areas that are totally or partially inside this area. + Return a list of the areas that are totally or partially inside this area. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Return a list of the bodies ([PhysicsBody]) that are totally or partially inside this area. + Return a list of the bodies ([PhysicsBody]) that are totally or partially inside this area. </description> </method> <method name="get_priority" qualifiers="const"> <return type="float"> </return> <description> - Return the processing order of this area. + Return the processing order of this area. </description> </method> <method name="get_space_override_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the space override mode. + Return the space override mode. </description> </method> <method name="is_gravity_a_point" qualifiers="const"> <return type="bool"> </return> <description> - Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. + Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. </description> </method> <method name="is_monitorable" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this area can be detected by other, monitoring, areas. + Return whether this area can be detected by other, monitoring, areas. </description> </method> <method name="is_monitoring_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this area detects bodies/areas entering/exiting it. + Return whether this area detects bodies/areas entering/exiting it. </description> </method> <method name="overlaps_area" qualifiers="const"> @@ -3848,7 +3848,7 @@ <argument index="0" name="area" type="Object"> </argument> <description> - Return whether the area passed is totally or partially inside this area. + Return whether the area passed is totally or partially inside this area. </description> </method> <method name="overlaps_body" qualifiers="const"> @@ -3857,14 +3857,14 @@ <argument index="0" name="body" type="Object"> </argument> <description> - Return whether the body passed is totally or partially inside this area. + Return whether the body passed is totally or partially inside this area. </description> </method> <method name="set_angular_damp"> <argument index="0" name="angular_damp" type="float"> </argument> <description> - Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. </description> </method> @@ -3872,7 +3872,7 @@ <argument index="0" name="collision_mask" type="int"> </argument> <description> - Set the physics layers this area can scan for collisions. + Set the physics layers this area can scan for collisions. </description> </method> <method name="set_collision_mask_bit"> @@ -3881,21 +3881,21 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> <method name="set_enable_monitoring"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether this area can detect bodies/areas entering/exiting it. + Set whether this area can detect bodies/areas entering/exiting it. </description> </method> <method name="set_gravity"> <argument index="0" name="gravity" type="float"> </argument> <description> - Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. + Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity). </description> </method> @@ -3903,21 +3903,21 @@ <argument index="0" name="distance_scale" type="float"> </argument> <description> - Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. + Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. </description> </method> <method name="set_gravity_is_point"> <argument index="0" name="enable" type="bool"> </argument> <description> - When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector]. + When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector]. </description> </method> <method name="set_gravity_vector"> <argument index="0" name="vector" type="Vector3"> </argument> <description> - Set the gravity vector. This vector does not have to be normalized. + Set the gravity vector. This vector does not have to be normalized. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> @@ -3925,7 +3925,7 @@ <argument index="0" name="layer_mask" type="int"> </argument> <description> - Set the physics layers this area is in. + Set the physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. </description> @@ -3936,14 +3936,14 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. </description> </method> <method name="set_linear_damp"> <argument index="0" name="linear_damp" type="float"> </argument> <description> - Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. </description> </method> @@ -3951,14 +3951,14 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. + Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. </description> </method> <method name="set_priority"> <argument index="0" name="priority" type="float"> </argument> <description> - Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. + Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. </description> </method> @@ -3966,7 +3966,7 @@ <argument index="0" name="enable" type="int"> </argument> <description> - Set the space override mode. This mode controls how an area affects gravity and damp. + Set the space override mode. This mode controls how an area affects gravity and damp. AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. @@ -3980,7 +3980,7 @@ <argument index="0" name="area" type="Object"> </argument> <description> - This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. + This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. </description> </signal> <signal name="area_enter_shape"> @@ -3993,14 +3993,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. + This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> <signal name="area_exit"> <argument index="0" name="area" type="Object"> </argument> <description> - This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. </description> </signal> <signal name="area_exit_shape"> @@ -4013,14 +4013,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. + This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> <signal name="body_enter"> <argument index="0" name="body" type="Object"> </argument> <description> - This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. + This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. </description> </signal> <signal name="body_enter_shape"> @@ -4033,14 +4033,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. + This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> <signal name="body_exit"> <argument index="0" name="body" type="Object"> </argument> <description> - This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. </description> </signal> <signal name="body_exit_shape"> @@ -4053,7 +4053,7 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit. + This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit. </description> </signal> </signals> @@ -4062,24 +4062,24 @@ </class> <class name="Area2D" inherits="CollisionObject2D" category="Core"> <brief_description> - General purpose area detection and influence for 2D physics. + General purpose area detection and influence for 2D physics. </brief_description> <description> - General purpose area detection for 2D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass. + General purpose area detection for 2D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass. </description> <methods> <method name="get_angular_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the angular damp rate. + Return the angular damp rate. </description> </method> <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the physics layers this area can scan for collisions. + Return the physics layers this area can scan for collisions. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -4088,35 +4088,35 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the collision mask. + Return an individual bit on the collision mask. </description> </method> <method name="get_gravity" qualifiers="const"> <return type="float"> </return> <description> - Return the gravity intensity. + Return the gravity intensity. </description> </method> <method name="get_gravity_distance_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the falloff factor for point gravity. + Return the falloff factor for point gravity. </description> </method> <method name="get_gravity_vector" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. + Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> <method name="get_layer_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the physics layer this area is in. + Return the physics layer this area is in. </description> </method> <method name="get_layer_mask_bit" qualifiers="const"> @@ -4125,63 +4125,63 @@ <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the layer mask. + Return an individual bit on the layer mask. </description> </method> <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the linear damp rate. + Return the linear damp rate. </description> </method> <method name="get_overlapping_areas" qualifiers="const"> <return type="Array"> </return> <description> - Return a list of the areas that are totally or partially inside this area. + Return a list of the areas that are totally or partially inside this area. </description> </method> <method name="get_overlapping_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Return a list of the bodies ([PhysicsBody2D]) that are totally or partially inside this area. + Return a list of the bodies ([PhysicsBody2D]) that are totally or partially inside this area. </description> </method> <method name="get_priority" qualifiers="const"> <return type="float"> </return> <description> - Return the processing order of this area. + Return the processing order of this area. </description> </method> <method name="get_space_override_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the space override mode. + Return the space override mode. </description> </method> <method name="is_gravity_a_point" qualifiers="const"> <return type="bool"> </return> <description> - Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. + Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. </description> </method> <method name="is_monitorable" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this area can be detected by other, monitoring, areas. + Return whether this area can be detected by other, monitoring, areas. </description> </method> <method name="is_monitoring_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this area detects bodies/areas entering/exiting it. + Return whether this area detects bodies/areas entering/exiting it. </description> </method> <method name="overlaps_area" qualifiers="const"> @@ -4190,7 +4190,7 @@ <argument index="0" name="area" type="Object"> </argument> <description> - Return whether the area passed is totally or partially inside this area. + Return whether the area passed is totally or partially inside this area. </description> </method> <method name="overlaps_body" qualifiers="const"> @@ -4199,14 +4199,14 @@ <argument index="0" name="body" type="Object"> </argument> <description> - Return whether the body passed is totally or partially inside this area. + Return whether the body passed is totally or partially inside this area. </description> </method> <method name="set_angular_damp"> <argument index="0" name="angular_damp" type="float"> </argument> <description> - Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. </description> </method> @@ -4214,7 +4214,7 @@ <argument index="0" name="collision_mask" type="int"> </argument> <description> - Set the physics layers this area can scan for collisions. + Set the physics layers this area can scan for collisions. </description> </method> <method name="set_collision_mask_bit"> @@ -4223,21 +4223,21 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> <method name="set_enable_monitoring"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether this area can detect bodies/areas entering/exiting it. + Set whether this area can detect bodies/areas entering/exiting it. </description> </method> <method name="set_gravity"> <argument index="0" name="gravity" type="float"> </argument> <description> - Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. + Set the gravity intensity. This is useful to alter the force of gravity without altering its direction. This value multiplies the gravity vector, whether it is the given vector ([method set_gravity_vector]), or a calculated one (when using a center of gravity). </description> </method> @@ -4245,21 +4245,21 @@ <argument index="0" name="distance_scale" type="float"> </argument> <description> - Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. + Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. </description> </method> <method name="set_gravity_is_point"> <argument index="0" name="enable" type="bool"> </argument> <description> - When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector]. + When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector]. </description> </method> <method name="set_gravity_vector"> <argument index="0" name="vector" type="Vector2"> </argument> <description> - Set the gravity vector. This vector does not have to be normalized. + Set the gravity vector. This vector does not have to be normalized. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. </description> </method> @@ -4267,7 +4267,7 @@ <argument index="0" name="layer_mask" type="int"> </argument> <description> - Set the physics layers this area is in. + Set the physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. </description> @@ -4278,14 +4278,14 @@ <argument index="1" name="value" type="bool"> </argument> <description> - Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. </description> </method> <method name="set_linear_damp"> <argument index="0" name="linear_damp" type="float"> </argument> <description> - Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. </description> </method> @@ -4293,14 +4293,14 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. + Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. </description> </method> <method name="set_priority"> <argument index="0" name="priority" type="float"> </argument> <description> - Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. + Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. </description> </method> @@ -4308,7 +4308,7 @@ <argument index="0" name="enable" type="int"> </argument> <description> - Set the space override mode. This mode controls how an area affects gravity and damp. + Set the space override mode. This mode controls how an area affects gravity and damp. AREA_SPACE_OVERRIDE_DISABLED: This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. AREA_SPACE_OVERRIDE_COMBINE: This area adds its gravity/damp values to whatever has been calculated so far. This way, many overlapping areas can combine their physics to make interesting effects. AREA_SPACE_OVERRIDE_COMBINE_REPLACE: This area adds its gravity/damp values to whatever has been calculated so far. Then stops taking into account the rest of the areas, even the default one. @@ -4322,7 +4322,7 @@ <argument index="0" name="area" type="Object"> </argument> <description> - This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. + This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. </description> </signal> <signal name="area_enter_shape"> @@ -4335,14 +4335,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. + This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> <signal name="area_exit"> <argument index="0" name="area" type="Object"> </argument> <description> - This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. </description> </signal> <signal name="area_exit_shape"> @@ -4355,14 +4355,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. + This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> <signal name="body_enter"> <argument index="0" name="body" type="Object"> </argument> <description> - This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. + This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. </description> </signal> <signal name="body_enter_shape"> @@ -4375,14 +4375,14 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. + This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> <signal name="body_exit"> <argument index="0" name="body" type="Object"> </argument> <description> - This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. </description> </signal> <signal name="body_exit_shape"> @@ -4395,7 +4395,7 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit. + This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit. </description> </signal> </signals> @@ -4404,10 +4404,10 @@ </class> <class name="Array" category="Built-In Types"> <brief_description> - Generic array datatype. + Generic array datatype. </brief_description> <description> - Generic array, contains several elements of any type, accessible by numerical index starting at 0. Negative indices can be used to count from the right, like in Python. Arrays are always passed by reference. + Generic array, contains several elements of any type, accessible by numerical index starting at 0. Negative indices can be used to count from the right, like in Python. Arrays are always passed by reference. </description> <methods> <method name="Array"> @@ -4416,7 +4416,7 @@ <argument index="0" name="from" type="ColorArray"> </argument> <description> - Construct an array from a [RawArray]. + Construct an array from a [RawArray]. </description> </method> <method name="Array"> @@ -4425,7 +4425,7 @@ <argument index="0" name="from" type="Vector3Array"> </argument> <description> - Construct an array from a [RawArray]. + Construct an array from a [RawArray]. </description> </method> <method name="Array"> @@ -4434,7 +4434,7 @@ <argument index="0" name="from" type="Vector2Array"> </argument> <description> - Construct an array from a [RawArray]. + Construct an array from a [RawArray]. </description> </method> <method name="Array"> @@ -4443,7 +4443,7 @@ <argument index="0" name="from" type="StringArray"> </argument> <description> - Construct an array from a [RawArray]. + Construct an array from a [RawArray]. </description> </method> <method name="Array"> @@ -4452,7 +4452,7 @@ <argument index="0" name="from" type="RealArray"> </argument> <description> - Construct an array from a [RawArray]. + Construct an array from a [RawArray]. </description> </method> <method name="Array"> @@ -4461,7 +4461,7 @@ <argument index="0" name="from" type="IntArray"> </argument> <description> - Construct an array from a [RawArray]. + Construct an array from a [RawArray]. </description> </method> <method name="Array"> @@ -4470,19 +4470,19 @@ <argument index="0" name="from" type="RawArray"> </argument> <description> - Construct an array from a [RawArray]. + Construct an array from a [RawArray]. </description> </method> <method name="append"> <argument index="0" name="value" type="var"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Append an element at the end of the array (alias of [method push_back]). </description> </method> <method name="clear"> <description> - Clear the array (resize to 0). + Clear the array (resize to 0). </description> </method> <method name="count"> @@ -4491,21 +4491,21 @@ <argument index="0" name="value" type="var"> </argument> <description> - Return the amount of times an element is in the array. + Return the amount of times an element is in the array. </description> </method> <method name="empty"> <return type="bool"> </return> <description> - Return true if the array is empty (size==0). + Return true if the array is empty (size==0). </description> </method> <method name="erase"> <argument index="0" name="value" type="var"> </argument> <description> - Remove the first occurrence of a value from the array. + Remove the first occurrence of a value from the array. </description> </method> <method name="find"> @@ -4516,7 +4516,7 @@ <argument index="1" name="from" type="int" default="0"> </argument> <description> - Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed. + Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed. </description> </method> <method name="find_last"> @@ -4525,14 +4525,14 @@ <argument index="0" name="value" type="var"> </argument> <description> - Searches the array in reverse order for a value and returns its index or -1 if not found. + Searches the array in reverse order for a value and returns its index or -1 if not found. </description> </method> <method name="hash"> <return type="int"> </return> <description> - Return a hashed integer value representing the array contents. + Return a hashed integer value representing the array contents. </description> </method> <method name="insert"> @@ -4541,57 +4541,57 @@ <argument index="1" name="value" type="var"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array (so first element will now be the last). </description> </method> <method name="is_shared"> <return type="bool"> </return> <description> - Get whether this is a shared array instance. + Get whether this is a shared array instance. </description> </method> <method name="pop_back"> <description> - Remove the last element of the array. + Remove the last element of the array. </description> </method> <method name="pop_front"> <description> - Remove the first element of the array. + Remove the first element of the array. </description> </method> <method name="push_back"> <argument index="0" name="value" type="var"> </argument> <description> - Append an element at the end of the array. + Append an element at the end of the array. </description> </method> <method name="push_front"> <argument index="0" name="value" type="var"> </argument> <description> - Add an element at the beginning of the array. + Add an element at the beginning of the array. </description> </method> <method name="remove"> <argument index="0" name="pos" type="int"> </argument> <description> - Remove an element from the array by index. + Remove an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="pos" type="int"> </argument> <description> - Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null. + Resize the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are Null. </description> </method> <method name="rfind"> @@ -4602,19 +4602,19 @@ <argument index="1" name="from" type="int" default="-1"> </argument> <description> - Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the amount of elements in the array. + Return the amount of elements in the array. </description> </method> <method name="sort"> <description> - Sort the array using natural order. + Sort the array using natural order. </description> </method> <method name="sort_custom"> @@ -4623,7 +4623,7 @@ <argument index="1" name="func" type="String"> </argument> <description> - Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. + Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. </description> </method> </methods> @@ -4684,38 +4684,38 @@ </class> <class name="AudioServer" inherits="Object" category="Core"> <brief_description> - Server interface for low level audio access. + Server interface for low level audio access. </brief_description> <description> - AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. + AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. </description> <methods> <method name="free_rid"> <argument index="0" name="rid" type="RID"> </argument> <description> - Free a [RID] resource. + Free a [RID] resource. </description> </method> <method name="get_event_voice_global_volume_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the global scale for event-based stream playback. + Return the global scale for event-based stream playback. </description> </method> <method name="get_fx_global_volume_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the global scale for all voices. + Return the global scale for all voices. </description> </method> <method name="get_stream_global_volume_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the global scale for stream playback. + Return the global scale for stream playback. </description> </method> <method name="sample_create"> @@ -4728,7 +4728,7 @@ <argument index="2" name="length" type="int"> </argument> <description> - Create an audio sample, return a [RID] referencing it. The sample will be created with a given format (from the SAMPLE_FORMAT_* enum), a total length (in samples, not bytes), in either stereo or mono. + Create an audio sample, return a [RID] referencing it. The sample will be created with a given format (from the SAMPLE_FORMAT_* enum), a total length (in samples, not bytes), in either stereo or mono. Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes. </description> </method> @@ -4738,7 +4738,7 @@ <argument index="0" name="sample" type="RID"> </argument> <description> - Return the sample data as an array of bytes. The length will be the expected length in bytes. + Return the sample data as an array of bytes. The length will be the expected length in bytes. </description> </method> <method name="sample_get_description" qualifiers="const"> @@ -4747,7 +4747,7 @@ <argument index="0" name="sample" type="RID"> </argument> <description> - Return the description of an audio sample. Mainly used for organization. + Return the description of an audio sample. Mainly used for organization. </description> </method> <method name="sample_get_format" qualifiers="const"> @@ -4756,7 +4756,7 @@ <argument index="0" name="sample" type="RID"> </argument> <description> - Return the format of the audio sample, in the form of the SAMPLE_FORMAT_* enum. + Return the format of the audio sample, in the form of the SAMPLE_FORMAT_* enum. </description> </method> <method name="sample_get_length" qualifiers="const"> @@ -4765,7 +4765,7 @@ <argument index="0" name="sample" type="RID"> </argument> <description> - Return the length in samples (not bytes) of the audio sample. Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes. + Return the length in samples (not bytes) of the audio sample. Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes. </description> </method> <method name="sample_get_loop_begin" qualifiers="const"> @@ -4774,7 +4774,7 @@ <argument index="0" name="sample" type="RID"> </argument> <description> - Return the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. + Return the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. </description> </method> <method name="sample_get_loop_end" qualifiers="const"> @@ -4783,7 +4783,7 @@ <argument index="0" name="sample" type="RID"> </argument> <description> - Return the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. + Return the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. </description> </method> <method name="sample_get_loop_format" qualifiers="const"> @@ -4792,7 +4792,7 @@ <argument index="0" name="sample" type="RID"> </argument> <description> - Return the loop format for a sample, as a value from the SAMPLE_LOOP_* enum. + Return the loop format for a sample, as a value from the SAMPLE_LOOP_* enum. </description> </method> <method name="sample_get_mix_rate" qualifiers="const"> @@ -4801,7 +4801,7 @@ <argument index="0" name="sample" type="RID"> </argument> <description> - Return the mix rate of the given sample. + Return the mix rate of the given sample. </description> </method> <method name="sample_is_stereo" qualifiers="const"> @@ -4810,7 +4810,7 @@ <argument index="0" name="sample" type="RID"> </argument> <description> - Return whether the sample is stereo (2 channels). + Return whether the sample is stereo (2 channels). </description> </method> <method name="sample_set_data"> @@ -4819,7 +4819,7 @@ <argument index="1" name="data" type="RawArray"> </argument> <description> - Set the sample data for a given sample as an array of bytes. The length must be equal to the sample length expected in bytes or an error will be produced. The byte length can be calculated as follows: + Set the sample data for a given sample as an array of bytes. The length must be equal to the sample length expected in bytes or an error will be produced. The byte length can be calculated as follows: Get the sample length ([method sample_get_length]). If the sample format is SAMPLE_FORMAT_PCM16, multiply it by 2. If the sample format is SAMPLE_FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. @@ -4832,7 +4832,7 @@ <argument index="1" name="description" type="String"> </argument> <description> - Set the description of an audio sample. Mainly used for organization. + Set the description of an audio sample. Mainly used for organization. </description> </method> <method name="sample_set_loop_begin"> @@ -4841,7 +4841,7 @@ <argument index="1" name="pos" type="int"> </argument> <description> - Set the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. + Set the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. </description> </method> <method name="sample_set_loop_end"> @@ -4850,7 +4850,7 @@ <argument index="1" name="pos" type="int"> </argument> <description> - Set the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. + Set the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. </description> </method> <method name="sample_set_loop_format"> @@ -4859,7 +4859,7 @@ <argument index="1" name="loop_format" type="int"> </argument> <description> - Set the loop format for a sample from the SAMPLE_LOOP_* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms. + Set the loop format for a sample from the SAMPLE_LOOP_* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms. </description> </method> <method name="sample_set_mix_rate"> @@ -4868,7 +4868,7 @@ <argument index="1" name="mix_rate" type="int"> </argument> <description> - Change the default mix rate of a given sample. + Change the default mix rate of a given sample. </description> </method> <method name="sample_set_signed_data"> @@ -4877,7 +4877,7 @@ <argument index="1" name="data" type="RealArray"> </argument> <description> - Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced. + Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced. For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by [method sample_get_length]. Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data. </description> @@ -4886,28 +4886,28 @@ <argument index="0" name="scale" type="float"> </argument> <description> - Set global scale for event-based stream ([EventStream]) playback. Default is 1.0. + Set global scale for event-based stream ([EventStream]) playback. Default is 1.0. </description> </method> <method name="set_fx_global_volume_scale"> <argument index="0" name="scale" type="float"> </argument> <description> - Set global scale for all voices (not including streams). Default is 1.0. + Set global scale for all voices (not including streams). Default is 1.0. </description> </method> <method name="set_stream_global_volume_scale"> <argument index="0" name="scale" type="float"> </argument> <description> - Set global scale for stream playback. Default is 1.0. + Set global scale for stream playback. Default is 1.0. </description> </method> <method name="voice_create"> <return type="RID"> </return> <description> - Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See [method sample_create]. + Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See [method sample_create]. </description> </method> <method name="voice_get_chorus" qualifiers="const"> @@ -4916,7 +4916,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current chorus send for a given voice (0 to 1). + Return the current chorus send for a given voice (0 to 1). </description> </method> <method name="voice_get_filter_cutoff" qualifiers="const"> @@ -4925,7 +4925,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current filter cutoff (in hz) for a given voice. + Return the current filter cutoff (in hz) for a given voice. </description> </method> <method name="voice_get_filter_resonance" qualifiers="const"> @@ -4934,7 +4934,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current filter resonance for a given voice. + Return the current filter resonance for a given voice. </description> </method> <method name="voice_get_filter_type" qualifiers="const"> @@ -4943,7 +4943,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current selected filter type for a given voice, from the FILTER_* enum. + Return the current selected filter type for a given voice, from the FILTER_* enum. </description> </method> <method name="voice_get_mix_rate" qualifiers="const"> @@ -4952,7 +4952,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current mix rate for a given voice. + Return the current mix rate for a given voice. </description> </method> <method name="voice_get_pan" qualifiers="const"> @@ -4961,7 +4961,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current pan for a given voice (-1 to +1 range). + Return the current pan for a given voice (-1 to +1 range). </description> </method> <method name="voice_get_pan_depth" qualifiers="const"> @@ -4970,7 +4970,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current pan depth for a given voice (-1 to +1 range). + Return the current pan depth for a given voice (-1 to +1 range). </description> </method> <method name="voice_get_pan_height" qualifiers="const"> @@ -4979,7 +4979,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current pan height for a given voice (-1 to +1 range). + Return the current pan height for a given voice (-1 to +1 range). </description> </method> <method name="voice_get_reverb" qualifiers="const"> @@ -4988,7 +4988,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current reverb send for a given voice (0 to 1). + Return the current reverb send for a given voice (0 to 1). </description> </method> <method name="voice_get_reverb_type" qualifiers="const"> @@ -4997,7 +4997,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current reverb type for a given voice from the REVERB_* enum. + Return the current reverb type for a given voice from the REVERB_* enum. </description> </method> <method name="voice_get_volume" qualifiers="const"> @@ -5006,7 +5006,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return the current volume for a given voice. + Return the current volume for a given voice. </description> </method> <method name="voice_is_positional" qualifiers="const"> @@ -5015,7 +5015,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return whether the current voice is positional. See [method voice_set_positional]. + Return whether the current voice is positional. See [method voice_set_positional]. </description> </method> <method name="voice_play"> @@ -5024,7 +5024,7 @@ <argument index="1" name="sample" type="RID"> </argument> <description> - Start playback of a given voice using a given sample. If the voice was already playing it will be restarted. + Start playback of a given voice using a given sample. If the voice was already playing it will be restarted. </description> </method> <method name="voice_set_chorus"> @@ -5033,7 +5033,7 @@ <argument index="1" name="chorus" type="float"> </argument> <description> - Set chorus send post processing for the voice (from 0 to 1). + Set chorus send post processing for the voice (from 0 to 1). </description> </method> <method name="voice_set_filter"> @@ -5048,7 +5048,7 @@ <argument index="4" name="gain" type="float" default="0"> </argument> <description> - Set a resonant filter post processing for the voice. Filter type is a value from the FILTER_* enum. + Set a resonant filter post processing for the voice. Filter type is a value from the FILTER_* enum. </description> </method> <method name="voice_set_mix_rate"> @@ -5057,7 +5057,7 @@ <argument index="1" name="rate" type="int"> </argument> <description> - Set a different playback mix rate for the given voice. + Set a different playback mix rate for the given voice. </description> </method> <method name="voice_set_pan"> @@ -5070,7 +5070,7 @@ <argument index="3" name="height" type="float" default="0"> </argument> <description> - Change the pan of a currently playing voice and, optionally, the depth and height for a positional/3D sound. Panning values are expressed within the -1 to +1 range. + Change the pan of a currently playing voice and, optionally, the depth and height for a positional/3D sound. Panning values are expressed within the -1 to +1 range. </description> </method> <method name="voice_set_positional"> @@ -5079,7 +5079,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> - Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding. + Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding. </description> </method> <method name="voice_set_reverb"> @@ -5090,7 +5090,7 @@ <argument index="2" name="reverb" type="float"> </argument> <description> - Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB_* enum. + Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB_* enum. </description> </method> <method name="voice_set_volume"> @@ -5099,14 +5099,14 @@ <argument index="1" name="volume" type="float"> </argument> <description> - Change the volume of a currently playing voice. Volume is expressed as linear gain where 0.0 is mute and 1.0 is default. + Change the volume of a currently playing voice. Volume is expressed as linear gain where 0.0 is mute and 1.0 is default. </description> </method> <method name="voice_stop"> <argument index="0" name="voice" type="RID"> </argument> <description> - Stop a given voice. + Stop a given voice. </description> </method> </methods> @@ -5163,10 +5163,10 @@ </class> <class name="AudioServerSW" inherits="AudioServer" category="Core"> <brief_description> - Software implementation of [AudioServer]. + Software implementation of [AudioServer]. </brief_description> <description> - This is a software audio server. It does not use any kind of hardware acceleration. + This is a software audio server. It does not use any kind of hardware acceleration. This class does not expose any new method. </description> <methods> @@ -5176,10 +5176,10 @@ </class> <class name="AudioStream" inherits="Resource" category="Core"> <brief_description> - Base class for audio streams. + Base class for audio streams. </brief_description> <description> - Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a [Sample]. + Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a [Sample]. </description> <methods> </methods> @@ -5188,10 +5188,10 @@ </class> <class name="AudioStreamMPC" inherits="AudioStream" category="Core"> <brief_description> - MusePack audio stream driver. + MusePack audio stream driver. </brief_description> <description> - MusePack audio stream driver. + MusePack audio stream driver. </description> <methods> </methods> @@ -5200,10 +5200,10 @@ </class> <class name="AudioStreamOGGVorbis" inherits="AudioStream" category="Core"> <brief_description> - OGG Vorbis audio stream driver. + OGG Vorbis audio stream driver. </brief_description> <description> - OGG Vorbis audio stream driver. + OGG Vorbis audio stream driver. </description> <methods> </methods> @@ -5212,10 +5212,10 @@ </class> <class name="AudioStreamOpus" inherits="AudioStream" category="Core"> <brief_description> - Opus Codec audio stream driver. + Opus Codec audio stream driver. </brief_description> <description> - Opus Codec audio stream driver. + Opus Codec audio stream driver. </description> <methods> </methods> @@ -5304,10 +5304,10 @@ </class> <class name="AudioStreamSpeex" inherits="AudioStream" category="Core"> <brief_description> - Speex audio stream driver. + Speex audio stream driver. </brief_description> <description> - Speex audio stream driver. Speex is very useful for compressed speech. It allows loading a very large amount of speech in memory at little IO/latency cost. + Speex audio stream driver. Speex is very useful for compressed speech. It allows loading a very large amount of speech in memory at little IO/latency cost. </description> <methods> </methods> @@ -5316,38 +5316,38 @@ </class> <class name="BackBufferCopy" inherits="Node2D" category="Core"> <brief_description> - Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction. + Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction. </brief_description> <description> - Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction. + Node for back-buffering the currently displayed screen. The region defined in the BackBufferCopy node is bufferized with the content of the screen it covers, or the entire screen according to the copy mode set. Accessing this buffer is done with the texscreen() shader instruction. </description> <methods> <method name="get_copy_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the copy mode currently applied to the BackBufferCopy (refer to constants section). + Return the copy mode currently applied to the BackBufferCopy (refer to constants section). </description> </method> <method name="get_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return the area covered by the BackBufferCopy. + Return the area covered by the BackBufferCopy. </description> </method> <method name="set_copy_mode"> <argument index="0" name="copy_mode" type="int"> </argument> <description> - Set the copy mode of the BackBufferCopy (refer to constants section). + Set the copy mode of the BackBufferCopy (refer to constants section). </description> </method> <method name="set_rect"> <argument index="0" name="rect" type="Rect2"> </argument> <description> - Defines the area covered by the BackBufferCopy. + Defines the area covered by the BackBufferCopy. </description> </method> </methods> @@ -5769,43 +5769,43 @@ </class> <class name="BaseButton" inherits="Control" category="Core"> <brief_description> - Provides a base class for different kinds of buttons. + Provides a base class for different kinds of buttons. </brief_description> <description> - BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesn't display anything). Other types of buttons inherit from it. + BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesn't display anything). Other types of buttons inherit from it. </description> <methods> <method name="_pressed" qualifiers="virtual"> <description> - Called when button is pressed. + Called when button is pressed. </description> </method> <method name="_toggled" qualifiers="virtual"> <argument index="0" name="pressed" type="bool"> </argument> <description> - Called when button is toggled (only if toggle_mode is active). + Called when button is toggled (only if toggle_mode is active). </description> </method> <method name="get_click_on_press" qualifiers="const"> <return type="bool"> </return> <description> - Return the state of the click_on_press property (see [method set_click_on_press]). + Return the state of the click_on_press property (see [method set_click_on_press]). </description> </method> <method name="get_draw_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. + Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. </description> </method> <method name="get_enabled_focus_mode" qualifiers="const"> <return type="int"> </return> <description> - Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). + Returns focus access mode used when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). </description> </method> <method name="get_shortcut" qualifiers="const"> @@ -5818,56 +5818,56 @@ <return type="bool"> </return> <description> - Return whether the button is in disabled state (see [method set_disabled]). + Return whether the button is in disabled state (see [method set_disabled]). </description> </method> <method name="is_hovered" qualifiers="const"> <return type="bool"> </return> <description> - Return true if mouse entered the button before it exit. + Return true if mouse entered the button before it exit. </description> </method> <method name="is_pressed" qualifiers="const"> <return type="bool"> </return> <description> - If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down. + If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down. </description> </method> <method name="is_toggle_mode" qualifiers="const"> <return type="bool"> </return> <description> - Return the toggle_mode property (see [method set_toggle_mode]). + Return the toggle_mode property (see [method set_toggle_mode]). </description> </method> <method name="set_click_on_press"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button). + Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button). </description> </method> <method name="set_disabled"> <argument index="0" name="disabled" type="bool"> </argument> <description> - Set the button into disabled state. When a button is disabled, it can't be clicked or toggled. + Set the button into disabled state. When a button is disabled, it can't be clicked or toggled. </description> </method> <method name="set_enabled_focus_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). + Sets the focus access mode to use when switching between enabled/disabled (see [method Control.set_focus_mode] and [method set_disabled]). </description> </method> <method name="set_pressed"> <argument index="0" name="pressed" type="bool"> </argument> <description> - Set the button to pressed state (only if toggle_mode is active). + Set the button to pressed state (only if toggle_mode is active). </description> </method> <method name="set_shortcut"> @@ -5880,26 +5880,26 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. + Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked. </description> </method> </methods> <signals> <signal name="pressed"> <description> - This signal is emitted every time the button is pressed or toggled. + This signal is emitted every time the button is pressed or toggled. </description> </signal> <signal name="released"> <description> - This signal is emitted when the button was released. + This signal is emitted when the button was released. </description> </signal> <signal name="toggled"> <argument index="0" name="pressed" type="bool"> </argument> <description> - This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the [i]pressed[/i] argument. + This signal is emitted when the button was just toggled between pressed and normal states (only if toggle_mode is active). The new state is contained in the [i]pressed[/i] argument. </description> </signal> </signals> @@ -5994,7 +5994,7 @@ <argument index="4" name="advance" type="float" default="-1"> </argument> <description> - Add a character to the font, where [i]character[/i] is the unicode value, [i]texture[/i] is the texture index, [i]rect[/i] is the region in the texture (in pixels!), [i]align[/i] is the (optional) alignment for the character and [i]advance[/i] is the (optional) advance. + Add a character to the font, where [i]character[/i] is the unicode value, [i]texture[/i] is the texture index, [i]rect[/i] is the region in the texture (in pixels!), [i]align[/i] is the (optional) alignment for the character and [i]advance[/i] is the (optional) advance. </description> </method> <method name="add_kerning_pair"> @@ -6005,19 +6005,19 @@ <argument index="2" name="kerning" type="int"> </argument> <description> - Add a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. + Add a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. </description> </method> <method name="add_texture"> <argument index="0" name="texture" type="Texture"> </argument> <description> - Add a texture to the [BitmapFont]. + Add a texture to the [BitmapFont]. </description> </method> <method name="clear"> <description> - Clear all the font data. + Clear all the font data. </description> </method> <method name="create_from_fnt"> @@ -6036,7 +6036,7 @@ <argument index="1" name="next" type="int" default="0"> </argument> <description> - Return the size of a character, optionally taking kerning into account if the next character is provided. + Return the size of a character, optionally taking kerning into account if the next character is provided. </description> </method> <method name="get_fallback" qualifiers="const"> @@ -6053,7 +6053,7 @@ <argument index="1" name="char_b" type="int"> </argument> <description> - Return a kerning pair as a difference. + Return a kerning pair as a difference. </description> </method> <method name="get_texture" qualifiers="const"> @@ -6074,7 +6074,7 @@ <argument index="0" name="px" type="float"> </argument> <description> - Set the font ascent (number of pixels above the baseline). + Set the font ascent (number of pixels above the baseline). </description> </method> <method name="set_distance_field_hint"> @@ -6093,7 +6093,7 @@ <argument index="0" name="px" type="float"> </argument> <description> - Set the total font height (ascent plus descent) in pixels. + Set the total font height (ascent plus descent) in pixels. </description> </method> </methods> @@ -6102,10 +6102,10 @@ </class> <class name="BoneAttachment" inherits="Spatial" category="Core"> <brief_description> - A node that will attach to a bone. + A node that will attach to a bone. </brief_description> <description> - This node must be the child of a [Skeleton] node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone. + This node must be the child of a [Skeleton] node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone. </description> <methods> </methods> @@ -6114,17 +6114,17 @@ </class> <class name="BoxContainer" inherits="Container" category="Core"> <brief_description> - Base class for Box containers. + Base class for Box containers. </brief_description> <description> - Base class for Box containers. It arranges children controls vertically or horizontally, and rearranges them automatically when their minimum size changes. + Base class for Box containers. It arranges children controls vertically or horizontally, and rearranges them automatically when their minimum size changes. </description> <methods> <method name="add_spacer"> <argument index="0" name="begin" type="bool"> </argument> <description> - Add a control to the box as a spacer. + Add a control to the box as a spacer. If [i]begin[/i] is true the spacer control will be inserted in front of other children. </description> </method> @@ -6132,14 +6132,14 @@ <return type="int"> </return> <description> - Return the alignment of children in the container. + Return the alignment of children in the container. </description> </method> <method name="set_alignment"> <argument index="0" name="alignment" type="int"> </argument> <description> - Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END). + Set the alignment of children in the container(Must be one of ALIGN_BEGIN, ALIGN_CENTER or ALIGN_END). </description> </method> </methods> @@ -6157,24 +6157,24 @@ </class> <class name="BoxShape" inherits="Shape" category="Core"> <brief_description> - Box shape resource. + Box shape resource. </brief_description> <description> - Box shape resource, which can be set into a [PhysicsBody] or area. + Box shape resource, which can be set into a [PhysicsBody] or area. </description> <methods> <method name="get_extents" qualifiers="const"> <return type="Vector3"> </return> <description> - Return the half extents of the shape. + Return the half extents of the shape. </description> </method> <method name="set_extents"> <argument index="0" name="extents" type="Vector3"> </argument> <description> - Set the half extents for the shape. + Set the half extents for the shape. </description> </method> </methods> @@ -6183,80 +6183,80 @@ </class> <class name="Button" inherits="BaseButton" category="Core"> <brief_description> - Standard themed Button. + Standard themed Button. </brief_description> <description> - Button is the standard themed button. It can contain text and an icon, and will display them according to the current [Theme]. + Button is the standard themed button. It can contain text and an icon, and will display them according to the current [Theme]. </description> <methods> <method name="get_button_icon" qualifiers="const"> <return type="Texture"> </return> <description> - Return the button icon. + Return the button icon. </description> </method> <method name="get_clip_text" qualifiers="const"> <return type="bool"> </return> <description> - Return the state of the [i]clip_text[/i] property (see [method set_clip_text]) + Return the state of the [i]clip_text[/i] property (see [method set_clip_text]) </description> </method> <method name="get_text" qualifiers="const"> <return type="String"> </return> <description> - Return the button text. + Return the button text. </description> </method> <method name="get_text_align" qualifiers="const"> <return type="int"> </return> <description> - Return the text alignment policy. + Return the text alignment policy. </description> </method> <method name="is_flat" qualifiers="const"> <return type="bool"> </return> <description> - Return the state of the [i]flat[/i] property (see [method set_flat]). + Return the state of the [i]flat[/i] property (see [method set_flat]). </description> </method> <method name="set_button_icon"> <argument index="0" name="texture" type="Texture"> </argument> <description> - Set the icon that will be displayed next to the text inside the button area. + Set the icon that will be displayed next to the text inside the button area. </description> </method> <method name="set_clip_text"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]clip_text[/i] property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text. + Set the [i]clip_text[/i] property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text. </description> </method> <method name="set_flat"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed. + Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed. </description> </method> <method name="set_text"> <argument index="0" name="text" type="String"> </argument> <description> - Set the button text, which will be displayed inside the button area. + Set the button text, which will be displayed inside the button area. </description> </method> <method name="set_text_align"> <argument index="0" name="align" type="int"> </argument> <description> - Set the text alignment policy, using one of the ALIGN_* constants. + Set the text alignment policy, using one of the ALIGN_* constants. </description> </method> </methods> @@ -6298,10 +6298,10 @@ </class> <class name="ButtonArray" inherits="Control" category="Core"> <brief_description> - Array of Buttons. + Array of Buttons. </brief_description> <description> - Array of Buttons. A ButtonArray is useful to have an array of buttons laid out vertically or horizontally. Only one button can be selected, and is referenced by its index in the array (first button is 0, second button is 1, etc.). + Array of Buttons. A ButtonArray is useful to have an array of buttons laid out vertically or horizontally. Only one button can be selected, and is referenced by its index in the array (first button is 0, second button is 1, etc.). This is useful [i]e.g.[/i] for joypad-friendly interfaces and option menus. </description> <methods> @@ -6309,7 +6309,7 @@ <argument index="0" name="text" type="String"> </argument> <description> - Append a new button to the array, with the specified text. + Append a new button to the array, with the specified text. </description> </method> <method name="add_icon_button"> @@ -6318,26 +6318,26 @@ <argument index="1" name="text" type="String" default=""""> </argument> <description> - Append a new button to the array, with the specified icon and text. + Append a new button to the array, with the specified icon and text. </description> </method> <method name="clear"> <description> - Remove all buttons from the array. + Remove all buttons from the array. </description> </method> <method name="erase_button"> <argument index="0" name="button_idx" type="int"> </argument> <description> - Remove the specified button in the array. + Remove the specified button in the array. </description> </method> <method name="get_button_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of buttons in the array. + Return the amount of buttons in the array. </description> </method> <method name="get_button_icon" qualifiers="const"> @@ -6346,7 +6346,7 @@ <argument index="0" name="button_idx" type="int"> </argument> <description> - Return the icon of the specified button. + Return the icon of the specified button. </description> </method> <method name="get_button_text" qualifiers="const"> @@ -6355,21 +6355,21 @@ <argument index="0" name="button_idx" type="int"> </argument> <description> - Return the text of the specified button. + Return the text of the specified button. </description> </method> <method name="get_hovered" qualifiers="const"> <return type="int"> </return> <description> - Return the index of the currently hovered button in the array. + Return the index of the currently hovered button in the array. </description> </method> <method name="get_selected" qualifiers="const"> <return type="int"> </return> <description> - Return the index of the currently selected button in the array. + Return the index of the currently selected button in the array. </description> </method> <method name="set_button_icon"> @@ -6378,7 +6378,7 @@ <argument index="1" name="icon" type="Texture"> </argument> <description> - Set the icon of the specified button. + Set the icon of the specified button. </description> </method> <method name="set_button_text"> @@ -6387,14 +6387,14 @@ <argument index="1" name="text" type="String"> </argument> <description> - Define the text of the specified button. + Define the text of the specified button. </description> </method> <method name="set_selected"> <argument index="0" name="button_idx" type="int"> </argument> <description> - Select a button in the array based on the given index. + Select a button in the array based on the given index. </description> </method> </methods> @@ -6403,7 +6403,7 @@ <argument index="0" name="button_idx" type="int"> </argument> <description> - A button has been selected, its index is given as the argument. + A button has been selected, its index is given as the argument. </description> </signal> </signals> @@ -6427,45 +6427,45 @@ </class> <class name="ButtonGroup" inherits="BoxContainer" category="Core"> <brief_description> - Group of Buttons. + Group of Buttons. </brief_description> <description> - Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed. + Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed. </description> <methods> <method name="get_button_list" qualifiers="const"> <return type="Array"> </return> <description> - Return the list of all the buttons in the group. + Return the list of all the buttons in the group. </description> </method> <method name="get_focused_button" qualifiers="const"> <return type="BaseButton"> </return> <description> - Return the focused button. + Return the focused button. </description> </method> <method name="get_pressed_button" qualifiers="const"> <return type="BaseButton"> </return> <description> - Return the pressed button. + Return the pressed button. </description> </method> <method name="get_pressed_button_index" qualifiers="const"> <return type="int"> </return> <description> - Return the index of the pressed button (by tree order). + Return the index of the pressed button (by tree order). </description> </method> <method name="set_pressed_button"> <argument index="0" name="button" type="BaseButton"> </argument> <description> - Set the button to be pressed. + Set the button to be pressed. </description> </method> </methods> @@ -6478,10 +6478,10 @@ </class> <class name="Camera" inherits="Spatial" category="Core"> <brief_description> - Camera node, displays from a point of view. + Camera node, displays from a point of view. </brief_description> <description> - Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [Viewport] node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides [i]3D[/i] display capabilities to a [Viewport], and, without one, a scene registered in that [Viewport] (or higher viewports) can't be displayed. + Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest [Viewport] node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides [i]3D[/i] display capabilities to a [Viewport], and, without one, a scene registered in that [Viewport] (or higher viewports) can't be displayed. </description> <methods> <method name="clear_current"> @@ -6492,7 +6492,7 @@ <return type="Transform"> </return> <description> - Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. + Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. </description> </method> <method name="get_environment" qualifiers="const"> @@ -6547,7 +6547,7 @@ <return type="bool"> </return> <description> - Return whether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree). + Return whether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree). </description> </method> <method name="is_position_behind" qualifiers="const"> @@ -6560,7 +6560,7 @@ </method> <method name="make_current"> <description> - Make this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. + Make this camera the current Camera for the [Viewport] (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added. </description> </method> <method name="project_local_ray_normal" qualifiers="const"> @@ -6585,7 +6585,7 @@ <argument index="0" name="screen_point" type="Vector2"> </argument> <description> - Return a normal vector in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. + Return a normal vector in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. </description> </method> <method name="project_ray_origin" qualifiers="const"> @@ -6594,7 +6594,7 @@ <argument index="0" name="screen_point" type="Vector2"> </argument> <description> - Return a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. + Return a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. </description> </method> <method name="set_environment"> @@ -6617,7 +6617,7 @@ <argument index="2" name="z_far" type="float"> </argument> <description> - Set the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) + Set the camera projection to orthogonal mode, by specifying a width and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels) </description> </method> <method name="set_perspective"> @@ -6628,7 +6628,7 @@ <argument index="2" name="z_far" type="float"> </argument> <description> - Set the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. + Set the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. </description> </method> <method name="set_visible_layers"> @@ -6643,7 +6643,7 @@ <argument index="0" name="world_point" type="Vector3"> </argument> <description> - Return how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle. + Return how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle. </description> </method> </methods> @@ -6662,10 +6662,10 @@ </class> <class name="Camera2D" inherits="Node2D" category="Core"> <brief_description> - Camera node for 2D scenes. + Camera node for 2D scenes. </brief_description> <description> - Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [CanvasItem] based nodes. + Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of [CanvasItem] based nodes. This node is intended to be a simple helper get get things going quickly and it may happen often that more functionality is desired to change how the camera works. To make your own custom camera node, simply inherit from [Node2D] and change the transform of the canvas by calling get_viewport().set_canvas_transform(m) in [Viewport]. </description> <methods> @@ -6675,7 +6675,7 @@ </method> <method name="force_update_scroll"> <description> - Force the camera to update scroll immediately. + Force the camera to update scroll immediately. </description> </method> <method name="get_anchor_mode" qualifiers="const"> @@ -6688,7 +6688,7 @@ <return type="Vector2"> </return> <description> - Return the camera position. + Return the camera position. </description> </method> <method name="get_camera_screen_center" qualifiers="const"> @@ -6703,7 +6703,7 @@ <argument index="0" name="margin" type="int"> </argument> <description> - Return the margins needed to drag the camera (see [method set_drag_margin]). + Return the margins needed to drag the camera (see [method set_drag_margin]). </description> </method> <method name="get_follow_smoothing" qualifiers="const"> @@ -6724,14 +6724,14 @@ <argument index="0" name="margin" type="int"> </argument> <description> - Return the scrolling limit in pixels. + Return the scrolling limit in pixels. </description> </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the scroll offset. + Return the scroll offset. </description> </method> <method name="get_v_offset" qualifiers="const"> @@ -6750,7 +6750,7 @@ <return type="bool"> </return> <description> - Return true of this is the current camera (see [method make_current]). + Return true of this is the current camera (see [method make_current]). </description> </method> <method name="is_follow_smoothing_enabled" qualifiers="const"> @@ -6779,7 +6779,7 @@ </method> <method name="make_current"> <description> - Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. + Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene. </description> </method> <method name="set_anchor_mode"> @@ -6794,7 +6794,7 @@ <argument index="1" name="drag_margin" type="float"> </argument> <description> - Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges. + Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN_* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges. </description> </method> <method name="set_enable_follow_smoothing"> @@ -6827,14 +6827,14 @@ <argument index="1" name="limit" type="int"> </argument> <description> - Set the scrolling limit in pixels. + Set the scrolling limit in pixels. </description> </method> <method name="set_offset"> <argument index="0" name="offset" type="Vector2"> </argument> <description> - Set the scroll offset. Useful for looking around or camera shake animations. + Set the scroll offset. Useful for looking around or camera shake animations. </description> </method> <method name="set_rotating"> @@ -6871,10 +6871,10 @@ </class> <class name="CanvasItem" inherits="Node" category="Core"> <brief_description> - Base class of anything 2D. + Base class of anything 2D. </brief_description> <description> - Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [Control], for anything GUI related, and by [Node2D] for anything 2D engine related. + Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [Control], for anything GUI related, and by [Node2D] for anything 2D engine related. Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significantly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrides function, though. Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though). Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode. @@ -6883,7 +6883,7 @@ <methods> <method name="_draw" qualifiers="virtual"> <description> - Called (if exists) to draw the canvas item. + Called (if exists) to draw the canvas item. </description> </method> <method name="draw_char"> @@ -6900,7 +6900,7 @@ <argument index="4" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> <description> - Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. + Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char. </description> </method> <method name="draw_circle"> @@ -6911,7 +6911,7 @@ <argument index="2" name="color" type="Color"> </argument> <description> - Draw a colored circle. + Draw a colored circle. </description> </method> <method name="draw_colored_polygon"> @@ -6924,7 +6924,7 @@ <argument index="3" name="texture" type="Texture" default="NULL"> </argument> <description> - Draw a colored polygon of any amount of points, convex or concave. + Draw a colored polygon of any amount of points, convex or concave. </description> </method> <method name="draw_line"> @@ -6937,7 +6937,7 @@ <argument index="3" name="width" type="float" default="1"> </argument> <description> - Draw a line from a 2D point to another, with a given color and width. + Draw a line from a 2D point to another, with a given color and width. </description> </method> <method name="draw_polygon"> @@ -6950,7 +6950,7 @@ <argument index="3" name="texture" type="Texture" default="NULL"> </argument> <description> - Draw a polygon of any amount of points, convex or concave. + Draw a polygon of any amount of points, convex or concave. </description> </method> <method name="draw_primitive"> @@ -6965,7 +6965,7 @@ <argument index="4" name="width" type="float" default="1"> </argument> <description> - Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. + Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. </description> </method> <method name="draw_rect"> @@ -6974,7 +6974,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Draw a colored rectangle. + Draw a colored rectangle. </description> </method> <method name="draw_set_transform"> @@ -6985,7 +6985,7 @@ <argument index="2" name="scale" type="Vector2"> </argument> <description> - Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. + Set a custom transform for drawing. Anything drawn afterwards will be transformed by this. </description> </method> <method name="draw_set_transform_matrix"> @@ -7006,7 +7006,7 @@ <argument index="4" name="clip_w" type="int" default="-1"> </argument> <description> - Draw a string using a custom font. + Draw a string using a custom font. </description> </method> <method name="draw_style_box"> @@ -7015,7 +7015,7 @@ <argument index="1" name="rect" type="Rect2"> </argument> <description> - Draw a styled rectangle. + Draw a styled rectangle. </description> </method> <method name="draw_texture"> @@ -7026,7 +7026,7 @@ <argument index="2" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> <description> - Draw a texture at a given position. + Draw a texture at a given position. </description> </method> <method name="draw_texture_rect"> @@ -7041,7 +7041,7 @@ <argument index="4" name="transpose" type="bool" default="false"> </argument> <description> - Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. + Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. </description> </method> <method name="draw_texture_rect_region"> @@ -7056,21 +7056,21 @@ <argument index="4" name="transpose" type="bool" default="false"> </argument> <description> - Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. + Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. </description> </method> <method name="edit_get_state" qualifiers="const"> <return type="Variant"> </return> <description> - Used for editing, returns an opaque value representing the transform state. + Used for editing, returns an opaque value representing the transform state. </description> </method> <method name="edit_rotate"> <argument index="0" name="degrees" type="float"> </argument> <description> - Used for editing, handle rotation. + Used for editing, handle rotation. </description> </method> <method name="edit_set_rect"> @@ -7083,173 +7083,173 @@ <argument index="0" name="state" type="Variant"> </argument> <description> - Set the transform state of this CanvasItem. For [Node2D], this is an [Array] with (in order) a [Vector2] for position, a float for rotation and another [Vector2] for scale. For [Control] this is a [Rect2] with the position and size. + Set the transform state of this CanvasItem. For [Node2D], this is an [Array] with (in order) a [Vector2] for position, a float for rotation and another [Vector2] for scale. For [Control] this is a [Rect2] with the position and size. </description> </method> <method name="get_blend_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the current blending mode from enum BLEND_MODE_*. + Return the current blending mode from enum BLEND_MODE_*. </description> </method> <method name="get_canvas" qualifiers="const"> <return type="RID"> </return> <description> - Return the [RID] of the [World2D] canvas where this item is in. + Return the [RID] of the [World2D] canvas where this item is in. </description> </method> <method name="get_canvas_item" qualifiers="const"> <return type="RID"> </return> <description> - Return the canvas item RID used by [VisualServer] for this item. + Return the canvas item RID used by [VisualServer] for this item. </description> </method> <method name="get_canvas_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Get the transform matrix of this item's canvas. + Get the transform matrix of this item's canvas. </description> </method> <method name="get_global_mouse_pos" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the global position of the mouse. + Get the global position of the mouse. </description> </method> <method name="get_global_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Get the global transform matrix of this item. + Get the global transform matrix of this item. </description> </method> <method name="get_global_transform_with_canvas" qualifiers="const"> <return type="Matrix32"> </return> <description> - Get the global transform matrix of this item in relation to the canvas. + Get the global transform matrix of this item in relation to the canvas. </description> </method> <method name="get_item_and_children_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Get a [Rect2] with the boundaries of this item and its children. + Get a [Rect2] with the boundaries of this item and its children. </description> </method> <method name="get_item_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return a rect containing the editable boundaries of the item. + Return a rect containing the editable boundaries of the item. </description> </method> <method name="get_light_mask" qualifiers="const"> <return type="int"> </return> <description> - Get this item's light mask number. + Get this item's light mask number. </description> </method> <method name="get_local_mouse_pos" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the mouse position relative to this item's position. + Get the mouse position relative to this item's position. </description> </method> <method name="get_material" qualifiers="const"> <return type="CanvasItemMaterial"> </return> <description> - Get the material of this item. + Get the material of this item. </description> </method> <method name="get_opacity" qualifiers="const"> <return type="float"> </return> <description> - Return the canvas item opacity. This affects the canvas item and all the children. + Return the canvas item opacity. This affects the canvas item and all the children. </description> </method> <method name="get_self_opacity" qualifiers="const"> <return type="float"> </return> <description> - Return the canvas item self-opacity. + Return the canvas item self-opacity. </description> </method> <method name="get_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Get the transform matrix of this item. + Get the transform matrix of this item. </description> </method> <method name="get_use_parent_material" qualifiers="const"> <return type="bool"> </return> <description> - Get whether this item uses its parent's material. + Get whether this item uses its parent's material. </description> </method> <method name="get_viewport_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Get the viewport's boundaries as a [Rect2]. + Get the viewport's boundaries as a [Rect2]. </description> </method> <method name="get_viewport_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Get this item's transform in relation to the viewport. + Get this item's transform in relation to the viewport. </description> </method> <method name="get_world_2d" qualifiers="const"> <return type="Object"> </return> <description> - Get the [World2D] where this item is in. + Get the [World2D] where this item is in. </description> </method> <method name="hide"> <description> - Hide the CanvasItem currently visible. + Hide the CanvasItem currently visible. </description> </method> <method name="is_draw_behind_parent_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the item is drawn behind its parent. + Return whether the item is drawn behind its parent. </description> </method> <method name="is_hidden" qualifiers="const"> <return type="bool"> </return> <description> - Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden ([method hide] called) the function will return false. + Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden ([method hide] called) the function will return false. </description> </method> <method name="is_set_as_toplevel" qualifiers="const"> <return type="bool"> </return> <description> - Return if set as toplevel. See [method set_as_toplevel]. + Return if set as toplevel. See [method set_as_toplevel]. </description> </method> <method name="is_visible" qualifiers="const"> <return type="bool"> </return> <description> - Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. + Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. </description> </method> <method name="make_input_local" qualifiers="const"> @@ -7258,102 +7258,102 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Takes a global input event and convert to this item's coordinate system. + Takes a global input event and convert to this item's coordinate system. </description> </method> <method name="set_as_toplevel"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set as top level. This means that it will not inherit transform from parent canvas items. + Set as top level. This means that it will not inherit transform from parent canvas items. </description> </method> <method name="set_blend_mode"> <argument index="0" name="blend_mode" type="int"> </argument> <description> - Set the blending mode from enum BLEND_MODE_*. + Set the blending mode from enum BLEND_MODE_*. </description> </method> <method name="set_draw_behind_parent"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether the canvas item is drawn behind its parent. + Set whether the canvas item is drawn behind its parent. </description> </method> <method name="set_hidden"> <argument index="0" name="hidden" type="bool"> </argument> <description> - Set whether this item should be hidden or not. Note that no matter what is set here this item won't be shown if its parent or grandparents nodes are also hidden. A hidden CanvasItem make all children hidden too. + Set whether this item should be hidden or not. Note that no matter what is set here this item won't be shown if its parent or grandparents nodes are also hidden. A hidden CanvasItem make all children hidden too. </description> </method> <method name="set_light_mask"> <argument index="0" name="light_mask" type="int"> </argument> <description> - Set the ligtht mask number of this item. + Set the ligtht mask number of this item. </description> </method> <method name="set_material"> <argument index="0" name="material" type="CanvasItemMaterial"> </argument> <description> - Set the material of this item. + Set the material of this item. </description> </method> <method name="set_opacity"> <argument index="0" name="opacity" type="float"> </argument> <description> - Set canvas item opacity. This will affect the canvas item and all the children. + Set canvas item opacity. This will affect the canvas item and all the children. </description> </method> <method name="set_self_opacity"> <argument index="0" name="self_opacity" type="float"> </argument> <description> - Set canvas item self-opacity. This does not affect the opacity of children items. + Set canvas item self-opacity. This does not affect the opacity of children items. </description> </method> <method name="set_use_parent_material"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether or not this item should use its parent's material. + Set whether or not this item should use its parent's material. </description> </method> <method name="show"> <description> - Show the CanvasItem currently hidden. + Show the CanvasItem currently hidden. </description> </method> <method name="update"> <description> - Queue the CanvasItem for update. [code]NOTIFICATION_DRAW[/code] will be called on idle time to request redraw. + Queue the CanvasItem for update. [code]NOTIFICATION_DRAW[/code] will be called on idle time to request redraw. </description> </method> </methods> <signals> <signal name="draw"> <description> - Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. + Emitted when the CanvasItem must redraw. This can only be connected realtime, as deferred will not allow drawing. </description> </signal> <signal name="hide"> <description> - Emitted when becoming hidden. + Emitted when becoming hidden. </description> </signal> <signal name="item_rect_changed"> <description> - Emitted when the item rect has changed. + Emitted when the item rect has changed. </description> </signal> <signal name="visibility_changed"> <description> - Emitted when the visibility (hidden/visible) changes. + Emitted when the visibility (hidden/visible) changes. </description> </signal> </signals> @@ -7466,108 +7466,108 @@ </class> <class name="CanvasLayer" inherits="Node" category="Core"> <brief_description> - Canvas Item layer. + Canvas Item layer. </brief_description> <description> - Canvas Item layer. [CanvasItem] nodes that are direct or indirect children of a [CanvasLayer] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [CanvasLayer] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). + Canvas Item layer. [CanvasItem] nodes that are direct or indirect children of a [CanvasLayer] will be drawn in that layer. The layer is a numeric index that defines the draw order. The default 2D scene renders with index 0, so a [CanvasLayer] with index -1 will be drawn below, and one with index 1 will be drawn above. This is very useful for HUDs (in layer 1+ or above), or backgrounds (in layer -1 or below). </description> <methods> <method name="get_layer" qualifiers="const"> <return type="int"> </return> <description> - Return the layer index, determines the draw order, a lower value will be below a higher one. + Return the layer index, determines the draw order, a lower value will be below a higher one. </description> </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the base offset for this layer (helper). + Return the base offset for this layer (helper). </description> </method> <method name="get_rotation" qualifiers="const"> <return type="float"> </return> <description> - Return the base rotation for this layer (helper). + Return the base rotation for this layer (helper). </description> </method> <method name="get_rotationd" qualifiers="const"> <return type="float"> </return> <description> - Get rotation of the layer in degree. + Get rotation of the layer in degree. </description> </method> <method name="get_scale" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the base scale for this layer (helper). + Return the base scale for this layer (helper). </description> </method> <method name="get_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Return the base transform for this layer. + Return the base transform for this layer. </description> </method> <method name="get_viewport" qualifiers="const"> <return type="RID"> </return> <description> - Return the viewport RID for this layer. + Return the viewport RID for this layer. </description> </method> <method name="get_world_2d" qualifiers="const"> <return type="World2D"> </return> <description> - Return the [World2D] used by this layer. + Return the [World2D] used by this layer. </description> </method> <method name="set_layer"> <argument index="0" name="layer" type="int"> </argument> <description> - Set the layer index, determines the draw order, a lower value will be below a higher one. + Set the layer index, determines the draw order, a lower value will be below a higher one. </description> </method> <method name="set_offset"> <argument index="0" name="offset" type="Vector2"> </argument> <description> - Set the base offset for this layer (helper). + Set the base offset for this layer (helper). </description> </method> <method name="set_rotation"> <argument index="0" name="radians" type="float"> </argument> <description> - Set the base rotation for this layer (helper). + Set the base rotation for this layer (helper). </description> </method> <method name="set_rotationd"> <argument index="0" name="degrees" type="float"> </argument> <description> - Set rotation of the layer in degree. + Set rotation of the layer in degree. </description> </method> <method name="set_scale"> <argument index="0" name="scale" type="Vector2"> </argument> <description> - Set the base scale for this layer (helper). + Set the base scale for this layer (helper). </description> </method> <method name="set_transform"> <argument index="0" name="transform" type="Matrix32"> </argument> <description> - Set the base transform for this layer. + Set the base transform for this layer. </description> </method> </methods> @@ -7576,24 +7576,24 @@ </class> <class name="CanvasModulate" inherits="Node2D" category="Core"> <brief_description> - Tint the entire canvas + Tint the entire canvas </brief_description> <description> - CanvasModulate tints the canvas elements using its asigned color + CanvasModulate tints the canvas elements using its asigned color </description> <methods> <method name="get_color" qualifiers="const"> <return type="Color"> </return> <description> - Gets the canvas tint color + Gets the canvas tint color </description> </method> <method name="set_color"> <argument index="0" name="color" type="Color"> </argument> <description> - Sets the canvas tint color + Sets the canvas tint color </description> </method> </methods> @@ -7602,38 +7602,38 @@ </class> <class name="CapsuleShape" inherits="Shape" category="Core"> <brief_description> - Capsule shape resource. + Capsule shape resource. </brief_description> <description> - Capsule shape resource, which can be set into a [PhysicsBody] or area. + Capsule shape resource, which can be set into a [PhysicsBody] or area. </description> <methods> <method name="get_height" qualifiers="const"> <return type="float"> </return> <description> - Return the capsule height. + Return the capsule height. </description> </method> <method name="get_radius" qualifiers="const"> <return type="float"> </return> <description> - Return the capsule radius. + Return the capsule radius. </description> </method> <method name="set_height"> <argument index="0" name="height" type="float"> </argument> <description> - Set the capsule height. + Set the capsule height. </description> </method> <method name="set_radius"> <argument index="0" name="radius" type="float"> </argument> <description> - Set the capsule radius. + Set the capsule radius. </description> </method> </methods> @@ -7642,38 +7642,38 @@ </class> <class name="CapsuleShape2D" inherits="Shape2D" category="Core"> <brief_description> - Capsule 2D shape resource for physics. + Capsule 2D shape resource for physics. </brief_description> <description> - Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modeling biped characters. + Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modeling biped characters. </description> <methods> <method name="get_height" qualifiers="const"> <return type="float"> </return> <description> - Return the height of the [CapsuleShape2D]. + Return the height of the [CapsuleShape2D]. </description> </method> <method name="get_radius" qualifiers="const"> <return type="float"> </return> <description> - Return the radius of the [CapsuleShape2D]. + Return the radius of the [CapsuleShape2D]. </description> </method> <method name="set_height"> <argument index="0" name="height" type="float"> </argument> <description> - Set the height of the [CapsuleShape2D]. + Set the height of the [CapsuleShape2D]. </description> </method> <method name="set_radius"> <argument index="0" name="radius" type="float"> </argument> <description> - Set the radius of the [CapsuleShape2D]. + Set the radius of the [CapsuleShape2D]. </description> </method> </methods> @@ -7682,24 +7682,24 @@ </class> <class name="CenterContainer" inherits="Container" category="Core"> <brief_description> - Keeps children controls centered. + Keeps children controls centered. </brief_description> <description> - CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center. + CenterContainer Keeps children controls centered. This container keeps all children to their minimum size, in the center. </description> <methods> <method name="is_using_top_left" qualifiers="const"> <return type="bool"> </return> <description> - Should put children to the top left corner instead of center of the container. + Should put children to the top left corner instead of center of the container. </description> </method> <method name="set_use_top_left"> <argument index="0" name="enable" type="bool"> </argument> <description> - This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container). + This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container). </description> </method> </methods> @@ -7708,10 +7708,10 @@ </class> <class name="CheckBox" inherits="Button" category="Core"> <brief_description> - Binary choice user interface widget + Binary choice user interface widget </brief_description> <description> - A checkbox allows the user to make a binary choice (choosing only one of two posible options), for example Answer 'yes' or 'no'. + A checkbox allows the user to make a binary choice (choosing only one of two posible options), for example Answer 'yes' or 'no'. </description> <methods> </methods> @@ -7754,10 +7754,10 @@ </class> <class name="CheckButton" inherits="Button" category="Core"> <brief_description> - Checkable button. + Checkable button. </brief_description> <description> - CheckButton is a toggle button displayed as a check field. + CheckButton is a toggle button displayed as a check field. </description> <methods> </methods> @@ -7796,24 +7796,24 @@ </class> <class name="CircleShape2D" inherits="Shape2D" category="Core"> <brief_description> - Circular Shape for 2D Physics. + Circular Shape for 2D Physics. </brief_description> <description> - Circular Shape for 2D Physics. This shape is useful for modeling balls or small characters and it's collision detection with everything else is very fast. + Circular Shape for 2D Physics. This shape is useful for modeling balls or small characters and it's collision detection with everything else is very fast. </description> <methods> <method name="get_radius" qualifiers="const"> <return type="float"> </return> <description> - Return the radius of the circle shape. + Return the radius of the circle shape. </description> </method> <method name="set_radius"> <argument index="0" name="radius" type="float"> </argument> <description> - Set the radius of the circle shape. + Set the radius of the circle shape. </description> </method> </methods> @@ -7972,10 +7972,10 @@ </class> <class name="CollisionObject2D" inherits="Node2D" category="Core"> <brief_description> - Base node for 2D collisionables. + Base node for 2D collisionables. </brief_description> <description> - CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing [CollisionShape2D] and/or [CollisionPolygon2D] nodes as children. Such nodes are for reference and not present outside the editor, so code should use the regular shape API. + CollisionObject2D is the base class for 2D physics collisionables. They can hold any number of 2D collision shapes. Usually, they are edited by placing [CollisionShape2D] and/or [CollisionPolygon2D] nodes as children. Such nodes are for reference and not present outside the editor, so code should use the regular shape API. </description> <methods> <method name="_input_event" qualifiers="virtual"> @@ -7986,7 +7986,7 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> - This method can be used to override normal input processing. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. + This method can be used to override normal input processing. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. </description> </method> <method name="add_shape"> @@ -7995,19 +7995,19 @@ <argument index="1" name="transform" type="Matrix32" default="1,0, 0,1, 0,0"> </argument> <description> - Add a [Shape2D] to the collision body, with a given custom transform. + Add a [Shape2D] to the collision body, with a given custom transform. </description> </method> <method name="clear_shapes"> <description> - Remove all shapes. + Remove all shapes. </description> </method> <method name="get_rid" qualifiers="const"> <return type="RID"> </return> <description> - Return the RID of this object. + Return the RID of this object. </description> </method> <method name="get_shape" qualifiers="const"> @@ -8016,14 +8016,14 @@ <argument index="0" name="shape_idx" type="int"> </argument> <description> - Return the shape in the given index. + Return the shape in the given index. </description> </method> <method name="get_shape_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of shapes in the collision body. Because a [CollisionPolygon2D] can generate more than one [Shape2D], the amount returned does not have to match the sum of [CollisionShape2D] and [CollisionPolygon2D]. + Return the amount of shapes in the collision body. Because a [CollisionPolygon2D] can generate more than one [Shape2D], the amount returned does not have to match the sum of [CollisionShape2D] and [CollisionPolygon2D]. </description> </method> <method name="get_shape_transform" qualifiers="const"> @@ -8032,14 +8032,14 @@ <argument index="0" name="shape_idx" type="int"> </argument> <description> - Return the shape transform in the given index. + Return the shape transform in the given index. </description> </method> <method name="is_pickable" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this object is pickable. + Return whether this object is pickable. </description> </method> <method name="is_shape_set_as_trigger" qualifiers="const"> @@ -8048,21 +8048,21 @@ <argument index="0" name="shape_idx" type="int"> </argument> <description> - Return whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). + Return whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). </description> </method> <method name="remove_shape"> <argument index="0" name="shape_idx" type="int"> </argument> <description> - Remove the shape in the given index. + Remove the shape in the given index. </description> </method> <method name="set_pickable"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events. + Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events. </description> </method> <method name="set_shape"> @@ -8071,7 +8071,7 @@ <argument index="1" name="shape" type="Shape"> </argument> <description> - Change a shape in the collision body. + Change a shape in the collision body. </description> </method> <method name="set_shape_as_trigger"> @@ -8080,7 +8080,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> - Set whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). + Set whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). </description> </method> <method name="set_shape_transform"> @@ -8089,7 +8089,7 @@ <argument index="1" name="transform" type="Matrix32"> </argument> <description> - Change the shape transform in the collision body. + Change the shape transform in the collision body. </description> </method> </methods> @@ -8102,17 +8102,17 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> - This signal triggers when an input event fires over a shape. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. + This signal triggers when an input event fires over a shape. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. </description> </signal> <signal name="mouse_enter"> <description> - This event fires only once when the mouse pointer enters any shape of this object. + This event fires only once when the mouse pointer enters any shape of this object. </description> </signal> <signal name="mouse_exit"> <description> - This event fires only once when the mouse pointer exits all shapes of this object. + This event fires only once when the mouse pointer exits all shapes of this object. </description> </signal> </signals> @@ -8179,24 +8179,24 @@ </class> <class name="CollisionPolygon2D" inherits="Node2D" category="Core"> <brief_description> - Editor-only class for easy editing of collision polygons. + Editor-only class for easy editing of collision polygons. </brief_description> <description> - Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. This class is for editing custom shape polygons. + Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. This class is for editing custom shape polygons. </description> <methods> <method name="get_build_mode" qualifiers="const"> <return type="int"> </return> <description> - Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). + Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). </description> </method> <method name="get_collision_object_first_shape" qualifiers="const"> <return type="int"> </return> <description> - Return the index of the first shape generated by the editor. + Return the index of the first shape generated by the editor. When [code]build_mode[/code] is set to generate convex polygons, the shape shown in the editor may be decomposed into many convex polygons. In that case, a range of indexes is needed to directly access the [Shape2D]. When [code]build_mode[/code] is set to generate concave polygons, there is only one [Shape2D] generated, so the start index and the end index are the same. </description> @@ -8205,35 +8205,35 @@ <return type="int"> </return> <description> - Return the index of the last shape generated by the editor. + Return the index of the last shape generated by the editor. </description> </method> <method name="get_polygon" qualifiers="const"> <return type="Vector2Array"> </return> <description> - Return the list of points that define the polygon. + Return the list of points that define the polygon. </description> </method> <method name="is_trigger" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this polygon is a trigger. + Return whether this polygon is a trigger. </description> </method> <method name="set_build_mode"> <argument index="0" name="build_mode" type="int"> </argument> <description> - Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). + Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]). </description> </method> <method name="set_polygon"> <argument index="0" name="polygon" type="Vector2Array"> </argument> <description> - Set the array of points forming the polygon. + Set the array of points forming the polygon. When editing the point list via the editor, depending on [method get_build_mode], it has to be a list of points (for [code]build_mode==0[/code]), or a list of lines (for [code]build_mode==1[/code]). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point. </description> </method> @@ -8241,7 +8241,7 @@ <argument index="0" name="trigger" type="bool"> </argument> <description> - Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). + Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). </description> </method> </methods> @@ -8300,45 +8300,45 @@ </class> <class name="CollisionShape2D" inherits="Node2D" category="Core"> <brief_description> - Editor-only class for easy editing of shapes. + Editor-only class for easy editing of shapes. </brief_description> <description> - Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. + Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. </description> <methods> <method name="get_collision_object_shape_index" qualifiers="const"> <return type="int"> </return> <description> - Return the index of this shape inside its container [CollisionObject2D]. This can be used to directly access the underlying [Shape2D]. + Return the index of this shape inside its container [CollisionObject2D]. This can be used to directly access the underlying [Shape2D]. </description> </method> <method name="get_shape" qualifiers="const"> <return type="Object"> </return> <description> - Return this shape's [Shape2D]. + Return this shape's [Shape2D]. </description> </method> <method name="is_trigger" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this shape is a trigger. + Return whether this shape is a trigger. </description> </method> <method name="set_shape"> <argument index="0" name="shape" type="Object"> </argument> <description> - Set this shape's [Shape2D]. This will not appear as a node, but can be directly edited as a property. + Set this shape's [Shape2D]. This will not appear as a node, but can be directly edited as a property. </description> </method> <method name="set_trigger"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether this shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. will not block movement of colliding objects). + Set whether this shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. will not block movement of colliding objects). </description> </method> </methods> @@ -8347,10 +8347,10 @@ </class> <class name="Color" category="Built-In Types"> <brief_description> - Color in RGBA format. + Color in RGBA format. </brief_description> <description> - A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate() ) may accept values > 1. + A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate() ) may accept values > 1. </description> <methods> <method name="Color"> @@ -8365,7 +8365,7 @@ <argument index="3" name="a" type="float"> </argument> <description> - Construct the color from an RGBA profile. + Construct the color from an RGBA profile. </description> </method> <method name="Color"> @@ -8378,7 +8378,7 @@ <argument index="2" name="b" type="float"> </argument> <description> - Construct the color from an RGBA profile. + Construct the color from an RGBA profile. </description> </method> <method name="Color"> @@ -8387,7 +8387,7 @@ <argument index="0" name="from" type="int"> </argument> <description> - Construct the color from an RGBA profile. + Construct the color from an RGBA profile. </description> </method> <method name="Color"> @@ -8396,7 +8396,7 @@ <argument index="0" name="from" type="String"> </argument> <description> - Construct the color from an RGBA profile. + Construct the color from an RGBA profile. </description> </method> <method name="blend"> @@ -8405,28 +8405,28 @@ <argument index="0" name="over" type="Color"> </argument> <description> - Return a new color blended with anothor one. + Return a new color blended with anothor one. </description> </method> <method name="contrasted"> <return type="Color"> </return> <description> - Return the most contrasting color with this one. + Return the most contrasting color with this one. </description> </method> <method name="gray"> <return type="float"> </return> <description> - Convert the color to gray. + Convert the color to gray. </description> </method> <method name="inverted"> <return type="Color"> </return> <description> - Return the inverted color (1-r, 1-g, 1-b, 1-a). + Return the inverted color (1-r, 1-g, 1-b, 1-a). </description> </method> <method name="linear_interpolate"> @@ -8437,21 +8437,21 @@ <argument index="1" name="t" type="float"> </argument> <description> - Return the linear interpolation with another color. + Return the linear interpolation with another color. </description> </method> <method name="to_32"> <return type="int"> </return> <description> - Convert the color to a 32 its integer (each byte represents a RGBA). + Convert the color to a 32 its integer (each byte represents a RGBA). </description> </method> <method name="to_ARGB32"> <return type="int"> </return> <description> - Convert color to ARGB32, more compatible with DirectX. + Convert color to ARGB32, more compatible with DirectX. </description> </method> <method name="to_html"> @@ -8460,7 +8460,7 @@ <argument index="0" name="with_alpha" type="bool" default="True"> </argument> <description> - Return the HTML hexadecimal color string. + Return the HTML hexadecimal color string. </description> </method> </methods> @@ -8504,10 +8504,10 @@ </class> <class name="ColorArray" category="Built-In Types"> <brief_description> - Array of Colors + Array of Colors </brief_description> <description> - Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory. + Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory. </description> <methods> <method name="ColorArray"> @@ -8516,21 +8516,21 @@ <argument index="0" name="from" type="Array"> </argument> <description> - Create from a generic array. + Create from a generic array. </description> </method> <method name="append"> <argument index="0" name="color" type="Color"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Append an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="ColorArray"> </argument> <description> - Append an [ColorArray] at the end of this array. + Append an [ColorArray] at the end of this array. </description> </method> <method name="insert"> @@ -8541,33 +8541,33 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array (so first element will now be the last). </description> </method> <method name="push_back"> <argument index="0" name="color" type="Color"> </argument> <description> - Append a value to the array. + Append a value to the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Remove an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the [ColorArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Set the size of the [ColorArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -8576,14 +8576,14 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Change the [Color] at the given index. + Change the [Color] at the given index. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the array size. + Return the array size. </description> </method> </methods> @@ -8592,59 +8592,59 @@ </class> <class name="ColorPicker" inherits="BoxContainer" category="Core"> <brief_description> - Color picker control. + Color picker control. </brief_description> <description> - This is a simple color picker [Control]. It's useful for selecting a color from an RGB/RGBA colorspace. + This is a simple color picker [Control]. It's useful for selecting a color from an RGB/RGBA colorspace. </description> <methods> <method name="add_preset"> <argument index="0" name="arg0" type="Color"> </argument> <description> - Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. + Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. </description> </method> <method name="get_color" qualifiers="const"> <return type="Color"> </return> <description> - Return the current (edited) color. + Return the current (edited) color. </description> </method> <method name="is_editing_alpha" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether the color has transparency or not. + Returns whether the color has transparency or not. </description> </method> <method name="is_raw_mode" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether this color picker is in raw mode or not + Returns whether this color picker is in raw mode or not </description> </method> <method name="set_color"> <argument index="0" name="color" type="Color"> </argument> <description> - Select the current color. + Select the current color. </description> </method> <method name="set_edit_alpha"> <argument index="0" name="show" type="bool"> </argument> <description> - Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. + Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. </description> </method> <method name="set_raw_mode"> <argument index="0" name="mode" type="bool"> </argument> <description> - When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255. + When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255. </description> </method> </methods> @@ -8653,7 +8653,7 @@ <argument index="0" name="color" type="Color"> </argument> <description> - Emitted when the color is changed. + Emitted when the color is changed. </description> </signal> </signals> @@ -8678,17 +8678,17 @@ </class> <class name="ColorPickerButton" inherits="Button" category="Core"> <brief_description> - Button that pops out a [ColorPicker] + Button that pops out a [ColorPicker] </brief_description> <description> - Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility + Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility </description> <methods> <method name="get_color" qualifiers="const"> <return type="Color"> </return> <description> - Gets the current color + Gets the current color </description> </method> <method name="get_picker"> @@ -8701,21 +8701,21 @@ <return type="bool"> </return> <description> - See [method ColorPicker.is_edit_alpha] + See [method ColorPicker.is_edit_alpha] </description> </method> <method name="set_color"> <argument index="0" name="color" type="Color"> </argument> <description> - Sets the current color + Sets the current color </description> </method> <method name="set_edit_alpha"> <argument index="0" name="show" type="bool"> </argument> <description> - See [method ColorPicker.set_edit_alpha] + See [method ColorPicker.set_edit_alpha] </description> </method> </methods> @@ -8724,7 +8724,7 @@ <argument index="0" name="color" type="Color"> </argument> <description> - Emitted when the color is changed. + Emitted when the color is changed. </description> </signal> </signals> @@ -8757,10 +8757,10 @@ </class> <class name="ColorRamp" inherits="Resource" category="Core"> <brief_description> - Color interpolator node + Color interpolator node </brief_description> <description> - Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset offset 0 and the other (white) at the ramp higher offset 1. + Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset offset 0 and the other (white) at the ramp higher offset 1. </description> <methods> <method name="add_point"> @@ -8769,7 +8769,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Adds the specified color to the end of the ramp, with the specified offset + Adds the specified color to the end of the ramp, with the specified offset </description> </method> <method name="get_color" qualifiers="const"> @@ -8778,14 +8778,14 @@ <argument index="0" name="point" type="int"> </argument> <description> - Returns the color of the ramp color at index [i]point[/i] + Returns the color of the ramp color at index [i]point[/i] </description> </method> <method name="get_colors" qualifiers="const"> <return type="ColorArray"> </return> <description> - Returns the colors in the ramp + Returns the colors in the ramp </description> </method> <method name="get_offset" qualifiers="const"> @@ -8794,21 +8794,21 @@ <argument index="0" name="point" type="int"> </argument> <description> - Returns the offset of the ramp color at index [i]point[/i] + Returns the offset of the ramp color at index [i]point[/i] </description> </method> <method name="get_offsets" qualifiers="const"> <return type="RealArray"> </return> <description> - Returns the offsets for the colors in this ramp + Returns the offsets for the colors in this ramp </description> </method> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> <description> - Returns the number of colors in the ramp + Returns the number of colors in the ramp </description> </method> <method name="interpolate"> @@ -8817,14 +8817,14 @@ <argument index="0" name="offset" type="float"> </argument> <description> - Returns the interpolated color specified by [i]offset[/i] + Returns the interpolated color specified by [i]offset[/i] </description> </method> <method name="remove_point"> <argument index="0" name="offset" type="int"> </argument> <description> - Removes the color at the index [i]offset[/i] + Removes the color at the index [i]offset[/i] </description> </method> <method name="set_color"> @@ -8833,14 +8833,14 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Sets the color of the ramp color at index [i]point[/i] + Sets the color of the ramp color at index [i]point[/i] </description> </method> <method name="set_colors"> <argument index="0" name="colors" type="ColorArray"> </argument> <description> - Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements. + Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements. </description> </method> <method name="set_offset"> @@ -8849,14 +8849,14 @@ <argument index="1" name="offset" type="float"> </argument> <description> - Sets the offset for the ramp color at index [i]point[/i] + Sets the offset for the ramp color at index [i]point[/i] </description> </method> <method name="set_offsets"> <argument index="0" name="offsets" type="RealArray"> </argument> <description> - Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements, all new colors will be black by default. + Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements, all new colors will be black by default. </description> </method> </methods> @@ -8865,24 +8865,24 @@ </class> <class name="ConcavePolygonShape" inherits="Shape" category="Core"> <brief_description> - Concave polygon shape. + Concave polygon shape. </brief_description> <description> - Concave polygon shape resource, which can be set into a [PhysicsBody] or area. This shape is created by feeding a list of triangles. + Concave polygon shape resource, which can be set into a [PhysicsBody] or area. This shape is created by feeding a list of triangles. </description> <methods> <method name="get_faces" qualifiers="const"> <return type="Vector3Array"> </return> <description> - Return the faces (an array of triangles). + Return the faces (an array of triangles). </description> </method> <method name="set_faces"> <argument index="0" name="faces" type="Vector3Array"> </argument> <description> - Set the faces (an array of triangles). + Set the faces (an array of triangles). </description> </method> </methods> @@ -8891,10 +8891,10 @@ </class> <class name="ConcavePolygonShape2D" inherits="Shape2D" category="Core"> <brief_description> - Concave polygon 2D shape resource for physics. + Concave polygon 2D shape resource for physics. </brief_description> <description> - Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for [RigidBody2D] nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions. + Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for [RigidBody2D] nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions. The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. </description> <methods> @@ -8902,14 +8902,14 @@ <return type="Vector2Array"> </return> <description> - Return the array of segments. + Return the array of segments. </description> </method> <method name="set_segments"> <argument index="0" name="segments" type="Vector2Array"> </argument> <description> - Set the array of segments. + Set the array of segments. </description> </method> </methods> @@ -8956,10 +8956,10 @@ </class> <class name="ConfigFile" inherits="Reference" category="Core"> <brief_description> - Helper class to handle INI-style files. + Helper class to handle INI-style files. </brief_description> <description> - This helper class can be used to store [Variant] values on the filesystem using an INI-style formatting. The stored values as referenced by a section and a key. The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly with accessing the filesystem. + This helper class can be used to store [Variant] values on the filesystem using an INI-style formatting. The stored values as referenced by a section and a key. The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly with accessing the filesystem. The following example shows how to parse a INI-style file from the system, read its contents and store new values in it: [codeblock] var config = ConfigFile.new() @@ -8981,14 +8981,14 @@ <argument index="0" name="section" type="String"> </argument> <description> - Return an array of all defined key identifiers in the specified section. + Return an array of all defined key identifiers in the specified section. </description> </method> <method name="get_sections" qualifiers="const"> <return type="StringArray"> </return> <description> - Return an array of all defined section identifiers. + Return an array of all defined section identifiers. </description> </method> <method name="get_value" qualifiers="const"> @@ -9001,7 +9001,7 @@ <argument index="2" name="default" type="Variant" default="NULL"> </argument> <description> - Return the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional [i]default[/i] argument (and thus [code]NULL[/code] if not specified). + Return the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional [i]default[/i] argument (and thus [code]NULL[/code] if not specified). </description> </method> <method name="has_section" qualifiers="const"> @@ -9010,7 +9010,7 @@ <argument index="0" name="section" type="String"> </argument> <description> - Check if the specified section exists. + Check if the specified section exists. </description> </method> <method name="has_section_key" qualifiers="const"> @@ -9021,7 +9021,7 @@ <argument index="1" name="key" type="String"> </argument> <description> - Check if the specified section-key pair exists. + Check if the specified section-key pair exists. </description> </method> <method name="load"> @@ -9030,7 +9030,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Load the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object from which the method was called. The return value is one of the OK, FAILED or ERR_* constants listed in [@Global Scope] (if the load was successful, it returns OK). + Load the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object from which the method was called. The return value is one of the OK, FAILED or ERR_* constants listed in [@Global Scope] (if the load was successful, it returns OK). </description> </method> <method name="save"> @@ -9039,7 +9039,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Save the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. + Save the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. The return value is one of the OK, FAILED or ERR_* constants listed in [@Global Scope] (if the save was successful, it returns OK). </description> </method> @@ -9051,7 +9051,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Assign a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a [code]NULL[/code] value deletes the specified key if it exists (and deletes the section if it ends up empty once the key has been removed). + Assign a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a [code]NULL[/code] value deletes the specified key if it exists (and deletes the section if it ends up empty once the key has been removed). </description> </method> </methods> @@ -9060,17 +9060,17 @@ </class> <class name="ConfirmationDialog" inherits="AcceptDialog" category="Core"> <brief_description> - Dialog for confirmation of actions. + Dialog for confirmation of actions. </brief_description> <description> - Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel button (in host OS order). + Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel button (in host OS order). </description> <methods> <method name="get_cancel"> <return type="Button"> </return> <description> - Return the cancel button. + Return the cancel button. </description> </method> </methods> @@ -9079,10 +9079,10 @@ </class> <class name="Container" inherits="Control" category="Core"> <brief_description> - Base node for containers. + Base node for containers. </brief_description> <description> - Base node for containers. A [Container] contains other controls and automatically arranges them in a certain way. + Base node for containers. A [Container] contains other controls and automatically arranges them in a certain way. A Control can inherit this to create custom container classes. </description> <methods> @@ -9092,19 +9092,19 @@ <argument index="1" name="rect" type="Rect2"> </argument> <description> - Fit a child control in a given rect. This is mainly a helper for creating custom container classes. + Fit a child control in a given rect. This is mainly a helper for creating custom container classes. </description> </method> <method name="queue_sort"> <description> - Queue resort of the contained children. This is called automatically anyway, but can be called upon request. + Queue resort of the contained children. This is called automatically anyway, but can be called upon request. </description> </method> </methods> <signals> <signal name="sort_children"> <description> - Emitted when sorting the children is needed. + Emitted when sorting the children is needed. </description> </signal> </signals> @@ -9116,10 +9116,10 @@ </class> <class name="Control" inherits="CanvasItem" category="Core"> <brief_description> - Control is the base node for all the GUI components. + Control is the base node for all the GUI components. </brief_description> <description> - Control is the base class Node for all the GUI components. Every GUI component inherits from it, directly or indirectly. In this way, sections of the scene tree made of contiguous control nodes, become user interfaces. + Control is the base class Node for all the GUI components. Every GUI component inherits from it, directly or indirectly. In this way, sections of the scene tree made of contiguous control nodes, become user interfaces. Controls are relative to the parent position and size by using anchors and margins. This ensures that they can adapt easily in most situation to changing dialog and screen sizes. When more flexibility is desired, [Container] derived nodes can be used. Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range. Input device events ([InputEvent]) are first sent to the root controls via the [method Node._input], which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [method MainLoop._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [method Node._unhandled_input]), the control can accept it by calling [method accept_event]. @@ -9132,12 +9132,12 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Called when an input event reaches the control. + Called when an input event reaches the control. </description> </method> <method name="accept_event"> <description> - Handles the event, no other control will receive it and it will not be sent to nodes waiting on [method Node._unhandled_input] or [method Node._unhandled_key_input]. + Handles the event, no other control will receive it and it will not be sent to nodes waiting on [method Node._unhandled_input] or [method Node._unhandled_key_input]. </description> </method> <method name="add_color_override"> @@ -9154,7 +9154,7 @@ <argument index="1" name="constant" type="int"> </argument> <description> - Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared. + Override a single constant (integer) in the theme of this Control. If constant equals Theme.INVALID_CONSTANT, override is cleared. </description> </method> <method name="add_font_override"> @@ -9163,7 +9163,7 @@ <argument index="1" name="font" type="Font"> </argument> <description> - Override a single font (font) in the theme of this Control. If font is empty, override is cleared. + Override a single font (font) in the theme of this Control. If font is empty, override is cleared. </description> </method> <method name="add_icon_override"> @@ -9172,7 +9172,7 @@ <argument index="1" name="texture" type="Texture"> </argument> <description> - Override a single icon ([Texture]) in the theme of this Control. If texture is empty, override is cleared. + Override a single icon ([Texture]) in the theme of this Control. If texture is empty, override is cleared. </description> </method> <method name="add_shader_override"> @@ -9189,7 +9189,7 @@ <argument index="1" name="stylebox" type="StyleBox"> </argument> <description> - Override a single stylebox ([Stylebox]) in the theme of this Control. If stylebox is empty, override is cleared. + Override a single stylebox ([Stylebox]) in the theme of this Control. If stylebox is empty, override is cleared. </description> </method> <method name="can_drop_data" qualifiers="virtual"> @@ -9224,7 +9224,7 @@ <argument index="0" name="margin" type="int"> </argument> <description> - Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). + Return the anchor type (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). </description> </method> <method name="get_begin" qualifiers="const"> @@ -9265,7 +9265,7 @@ <argument index="0" name="pos" type="Vector2" default="Vector2(0,0)"> </argument> <description> - Return the cursor shape at a certain position in the control. + Return the cursor shape at a certain position in the control. </description> </method> <method name="get_custom_minimum_size" qualifiers="const"> @@ -9278,7 +9278,7 @@ <return type="int"> </return> <description> - Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes. + Return the default cursor shape for this control. See enum CURSOR_* for the list of shapes. </description> </method> <method name="get_drag_data" qualifiers="virtual"> @@ -9293,14 +9293,14 @@ <return type="Vector2"> </return> <description> - Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). + Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). </description> </method> <method name="get_focus_mode" qualifiers="const"> <return type="int"> </return> <description> - Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]). + Returns the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL) (see [method set_focus_mode]). </description> </method> <method name="get_focus_neighbour" qualifiers="const"> @@ -9309,14 +9309,14 @@ <argument index="0" name="margin" type="int"> </argument> <description> - Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. + Return the forced neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. </description> </method> <method name="get_focus_owner" qualifiers="const"> <return type="Control"> </return> <description> - Return which control is owning the keyboard focus, or null if no one. + Return which control is owning the keyboard focus, or null if no one. </description> </method> <method name="get_font" qualifiers="const"> @@ -9333,21 +9333,21 @@ <return type="Vector2"> </return> <description> - Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. + Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. </description> </method> <method name="get_global_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_pos], [method get_size]). + Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_pos], [method get_size]). </description> </method> <method name="get_h_size_flags" qualifiers="const"> <return type="int"> </return> <description> - Hint for containers, return horizontal positioning flags. + Hint for containers, return horizontal positioning flags. </description> </method> <method name="get_icon" qualifiers="const"> @@ -9366,21 +9366,21 @@ <argument index="0" name="margin" type="int"> </argument> <description> - Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode. + Return a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being returned depends on the anchor mode. </description> </method> <method name="get_minimum_size" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. + Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. </description> </method> <method name="get_minimum_size" qualifiers="virtual"> <return type="Vector2"> </return> <description> - Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. + Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. </description> </method> <method name="get_parent_area_size" qualifiers="const"> @@ -9399,14 +9399,14 @@ <return type="Vector2"> </return> <description> - Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. + Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. </description> </method> <method name="get_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_pos], [method get_size]). + Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_pos], [method get_size]). </description> </method> <method name="get_rotation" qualifiers="const"> @@ -9431,14 +9431,14 @@ <return type="Vector2"> </return> <description> - Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by [method get_minimum_size][/b]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]). + Returns the size of the Control, computed from all margins, however the size returned will [b]never be smaller than the minimum size reported by [method get_minimum_size][/b]. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, [method get_minimum_size], [method set_margin], [method set_anchor]). </description> </method> <method name="get_stretch_ratio" qualifiers="const"> <return type="float"> </return> <description> - Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. + Hint for containers, return the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. </description> </method> <method name="get_stylebox" qualifiers="const"> @@ -9455,7 +9455,7 @@ <return type="Theme"> </return> <description> - Return a [Theme] override, if one exists (see [method set_theme]). + Return a [Theme] override, if one exists (see [method set_theme]). </description> </method> <method name="get_tooltip" qualifiers="const"> @@ -9464,14 +9464,14 @@ <argument index="0" name="atpos" type="Vector2" default="Vector2(0,0)"> </argument> <description> - Return the tooltip, which will appear when the cursor is resting over this control. + Return the tooltip, which will appear when the cursor is resting over this control. </description> </method> <method name="get_v_size_flags" qualifiers="const"> <return type="int"> </return> <description> - Hint for containers, return vertical positioning flags. + Hint for containers, return vertical positioning flags. </description> </method> <method name="grab_click_focus"> @@ -9480,7 +9480,7 @@ </method> <method name="grab_focus"> <description> - Steal the focus from another control and become the focused control (see [method set_focus_mode]). + Steal the focus from another control and become the focused control (see [method set_focus_mode]). </description> </method> <method name="has_color" qualifiers="const"> @@ -9523,7 +9523,7 @@ <return type="bool"> </return> <description> - Return whether the Control is the current focused control (see [method set_focus_mode]). + Return whether the Control is the current focused control (see [method set_focus_mode]). </description> </method> <method name="has_font" qualifiers="const"> @@ -9584,7 +9584,7 @@ <return type="bool"> </return> <description> - Return if the control is ignoring mouse events (even touchpad events send mouse events). + Return if the control is ignoring mouse events (even touchpad events send mouse events). </description> </method> <method name="is_stopping_mouse" qualifiers="const"> @@ -9599,7 +9599,7 @@ </method> <method name="release_focus"> <description> - Give up the focus, no other control will be able to receive keyboard input. + Give up the focus, no other control will be able to receive keyboard input. </description> </method> <method name="set_anchor"> @@ -9610,7 +9610,7 @@ <argument index="2" name="keep_margin" type="bool" default="false"> </argument> <description> - Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previous anchor mode to the new one, so margin offsets ([method set_margin]) must be done after setting anchors, or at the same time ([method set_anchor_and_margin]) + Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previous anchor mode to the new one, so margin offsets ([method set_margin]) must be done after setting anchors, or at the same time ([method set_anchor_and_margin]) Additionally, [code]keep_margin[/code] controls whether margins should be left the same, or changed to keep the same position and size on-screen. </description> @@ -9623,21 +9623,21 @@ <argument index="2" name="offset" type="float"> </argument> <description> - Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM), and also set its offset. This is a helper (see [method set_anchor] and [method set_margin]). + Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM), and also set its offset. This is a helper (see [method set_anchor] and [method set_margin]). </description> </method> <method name="set_area_as_parent_rect"> <argument index="0" name="margin" type="int" default="0"> </argument> <description> - Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [method set_anchor], [method set_margin]). + Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [method set_anchor], [method set_margin]). </description> </method> <method name="set_begin"> <argument index="0" name="pos" type="Vector2"> </argument> <description> - Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). + Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). </description> </method> <method name="set_custom_minimum_size"> @@ -9650,7 +9650,7 @@ <argument index="0" name="shape" type="int"> </argument> <description> - Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes. + Set the default cursor shape for this control. See enum CURSOR_* for the list of shapes. </description> </method> <method name="set_drag_forwarding"> @@ -9669,14 +9669,14 @@ <argument index="0" name="pos" type="Vector2"> </argument> <description> - Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]). + Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]). </description> </method> <method name="set_focus_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals. + Set the focus access mode for the control (FOCUS_NONE, FOCUS_CLICK, FOCUS_ALL). Only one Control can be focused at the same time, and it will receive keyboard signals. </description> </method> <method name="set_focus_neighbour"> @@ -9685,28 +9685,28 @@ <argument index="1" name="neighbour" type="NodePath"> </argument> <description> - Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. + Force a neighbour for moving the input focus to. When pressing TAB or directional/joypad directions focus is moved to the next control in that direction. However, the neighbour to move to can be forced with this function. </description> </method> <method name="set_global_pos"> <argument index="0" name="pos" type="Vector2"> </argument> <description> - Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]). + Move the Control to a new position, relative to the top-left corner of the [i]window[/i] Control, and without changing current anchor mode. (see [method set_margin]). </description> </method> <method name="set_h_size_flags"> <argument index="0" name="flags" type="int"> </argument> <description> - Hint for containers, set horizontal positioning flags. + Hint for containers, set horizontal positioning flags. </description> </method> <method name="set_ignore_mouse"> <argument index="0" name="ignore" type="bool"> </argument> <description> - Ignore mouse events on this control (even touchpad events send mouse events). + Ignore mouse events on this control (even touchpad events send mouse events). </description> </method> <method name="set_margin"> @@ -9715,14 +9715,14 @@ <argument index="1" name="offset" type="float"> </argument> <description> - Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode. + Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode. </description> </method> <method name="set_pos"> <argument index="0" name="pos" type="Vector2"> </argument> <description> - Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [method set_margin]). + Move the Control to a new position, relative to the top-left corner of the parent Control, changing all margins if needed and without changing current anchor mode. This is a helper (see [method set_margin]). </description> </method> <method name="set_rotation"> @@ -9747,7 +9747,7 @@ <argument index="0" name="size" type="Vector2"> </argument> <description> - Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]). + Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]). </description> </method> <method name="set_stop_mouse"> @@ -9760,35 +9760,35 @@ <argument index="0" name="ratio" type="float"> </argument> <description> - Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. + Hint for containers, set the stretch ratio. This value is relative to other stretch ratio, so if this control has 2 and another has 1, this one will be twice as big. </description> </method> <method name="set_theme"> <argument index="0" name="theme" type="Theme"> </argument> <description> - Override whole the [Theme] for this Control and all its children controls. + Override whole the [Theme] for this Control and all its children controls. </description> </method> <method name="set_tooltip"> <argument index="0" name="tooltip" type="String"> </argument> <description> - Set a tooltip, which will appear when the cursor is resting over this control. + Set a tooltip, which will appear when the cursor is resting over this control. </description> </method> <method name="set_v_size_flags"> <argument index="0" name="flags" type="int"> </argument> <description> - Hint for containers, set vertical positioning flags. + Hint for containers, set vertical positioning flags. </description> </method> <method name="show_modal"> <argument index="0" name="exclusive" type="bool" default="false"> </argument> <description> - Display a Control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. + Display a Control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. </description> </method> <method name="warp_mouse"> @@ -9801,24 +9801,24 @@ <signals> <signal name="focus_enter"> <description> - Emitted when keyboard focus is gained. + Emitted when keyboard focus is gained. </description> </signal> <signal name="focus_exit"> <description> - Emitted when the keyboard focus is lost. + Emitted when the keyboard focus is lost. </description> </signal> <signal name="input_event"> <argument index="0" name="ev" type="InputEvent"> </argument> <description> - Emitted when an input event is received. Connecting in realtime is recommended for accepting the events. + Emitted when an input event is received. Connecting in realtime is recommended for accepting the events. </description> </signal> <signal name="minimum_size_changed"> <description> - Emitted when the minimum size of the control changed. + Emitted when the minimum size of the control changed. </description> </signal> <signal name="modal_close"> @@ -9827,22 +9827,22 @@ </signal> <signal name="mouse_enter"> <description> - Emitted when the mouse enters the control area. + Emitted when the mouse enters the control area. </description> </signal> <signal name="mouse_exit"> <description> - Emitted when the mouse left the control area. + Emitted when the mouse left the control area. </description> </signal> <signal name="resized"> <description> - Emitted when the control changed size. + Emitted when the control changed size. </description> </signal> <signal name="size_flags_changed"> <description> - Emitted when the size flags changed. + Emitted when the size flags changed. </description> </signal> </signals> @@ -9932,10 +9932,10 @@ </class> <class name="ConvexPolygonShape" inherits="Shape" category="Core"> <brief_description> - Convex Polygon Shape. + Convex Polygon Shape. </brief_description> <description> - Convex polygon shape resource, which can be set into a [PhysicsBody] or area. + Convex polygon shape resource, which can be set into a [PhysicsBody] or area. </description> <methods> <method name="get_points" qualifiers="const"> @@ -9956,10 +9956,10 @@ </class> <class name="ConvexPolygonShape2D" inherits="Shape2D" category="Core"> <brief_description> - Convex Polygon Shape for 2D physics. + Convex Polygon Shape for 2D physics. </brief_description> <description> - Convex Polygon Shape for 2D physics. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check). + Convex Polygon Shape for 2D physics. A convex polygon, whatever its shape, is internally decomposed into as many convex polygons as needed to ensure all collision checks against it are always done on convex polygons (which are faster to check). The main difference between a [ConvexPolygonShape2D] and a [ConcavePolygonShape2D] is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection. </description> <methods> @@ -9967,21 +9967,21 @@ <return type="Vector2Array"> </return> <description> - Return a list of points in either clockwise or counter clockwise order, forming a convex polygon. + Return a list of points in either clockwise or counter clockwise order, forming a convex polygon. </description> </method> <method name="set_point_cloud"> <argument index="0" name="point_cloud" type="Vector2Array"> </argument> <description> - Currently, this method does nothing. + Currently, this method does nothing. </description> </method> <method name="set_points"> <argument index="0" name="points" type="Vector2Array"> </argument> <description> - Set a list of points in either clockwise or counter clockwise order, forming a convex polygon. + Set a list of points in either clockwise or counter clockwise order, forming a convex polygon. </description> </method> </methods> @@ -10096,10 +10096,10 @@ </class> <class name="Curve2D" inherits="Resource" category="Core"> <brief_description> - Describes a Bezier curve in 2D space. + Describes a Bezier curve in 2D space. </brief_description> <description> - This class describes a Bezier curve in 2D space. It is mainly used to give a shape to a [Path2D], but can be manually sampled for other purposes. + This class describes a Bezier curve in 2D space. It is mainly used to give a shape to a [Path2D], but can be manually sampled for other purposes. It keeps a cache of precalculated points along the curve, to speed further calculations up. </description> <methods> @@ -10113,7 +10113,7 @@ It keeps a cache of precalculated points along the curve, to speed further calcu <argument index="3" name="atpos" type="int" default="-1"> </argument> <description> - Adds a point to a curve, at position "pos", with control points "in" and "out". + Adds a point to a curve, at position "pos", with control points "in" and "out". If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= [method get_point_count]), the point will be appended at the end of the point list. </description> </method> @@ -10121,28 +10121,28 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <return type="float"> </return> <description> - Returns the distance between two adjacent cached points. + Returns the distance between two adjacent cached points. </description> </method> <method name="get_baked_length" qualifiers="const"> <return type="float"> </return> <description> - Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough. + Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough. </description> </method> <method name="get_baked_points" qualifiers="const"> <return type="Vector2Array"> </return> <description> - Returns the cache of points as a [Vector2Array]. + Returns the cache of points as a [Vector2Array]. </description> </method> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> <description> - Returns the number of points describing the curve. + Returns the number of points describing the curve. </description> </method> <method name="get_point_in" qualifiers="const"> @@ -10151,7 +10151,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <argument index="0" name="idx" type="int"> </argument> <description> - Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). + Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). </description> </method> <method name="get_point_out" qualifiers="const"> @@ -10160,7 +10160,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <argument index="0" name="idx" type="int"> </argument> <description> - Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). + Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). </description> </method> <method name="get_point_pos" qualifiers="const"> @@ -10169,7 +10169,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <argument index="0" name="idx" type="int"> </argument> <description> - Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). + Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0). </description> </method> <method name="interpolate" qualifiers="const"> @@ -10180,7 +10180,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <argument index="1" name="t" type="float"> </argument> <description> - Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. + Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0). </description> </method> @@ -10192,7 +10192,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i <argument index="1" name="cubic" type="bool" default="false"> </argument> <description> - Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. + Returns a point within the curve at position "offset", where "offset" is measured as a pixel distance along the curve. To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). </description> @@ -10203,21 +10203,21 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and <argument index="0" name="fofs" type="float"> </argument> <description> - Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t". + Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t". </description> </method> <method name="remove_point"> <argument index="0" name="idx" type="int"> </argument> <description> - Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. + Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. </description> </method> <method name="set_bake_interval"> <argument index="0" name="distance" type="float"> </argument> <description> - Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. + Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. </description> </method> <method name="set_point_in"> @@ -10226,7 +10226,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and <argument index="1" name="pos" type="Vector2"> </argument> <description> - Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. + Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="set_point_out"> @@ -10235,7 +10235,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and <argument index="1" name="pos" type="Vector2"> </argument> <description> - Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console. + Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="set_point_pos"> @@ -10244,7 +10244,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and <argument index="1" name="pos" type="Vector2"> </argument> <description> - Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. + Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="tesselate" qualifiers="const"> @@ -10255,7 +10255,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and <argument index="1" name="tolerance_degrees" type="float" default="4"> </argument> <description> - Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. + Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. "max_stages" controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. @@ -10267,10 +10267,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="Curve3D" inherits="Resource" category="Core"> <brief_description> - Describes a Bezier curve in 3D space. + Describes a Bezier curve in 3D space. </brief_description> <description> - This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a [Path], but can be manually sampled for other purposes. + This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a [Path], but can be manually sampled for other purposes. It keeps a cache of precalculated points along the curve, to speed further calculations up. </description> <methods> @@ -10284,7 +10284,7 @@ It keeps a cache of precalculated points along the curve, to speed further calcu <argument index="3" name="atpos" type="int" default="-1"> </argument> <description> - Adds a point to a curve, at position "pos", with control points "in" and "out". + Adds a point to a curve, at position "pos", with control points "in" and "out". If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= [method get_point_count]), the point will be appended at the end of the point list. </description> </method> @@ -10292,35 +10292,35 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <return type="float"> </return> <description> - Returns the distance between two adjacent cached points. + Returns the distance between two adjacent cached points. </description> </method> <method name="get_baked_length" qualifiers="const"> <return type="float"> </return> <description> - Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough. + Returns the total length of the curve, based on the cached points. Given enough density (see [method set_bake_interval]), it should be approximate enough. </description> </method> <method name="get_baked_points" qualifiers="const"> <return type="Vector3Array"> </return> <description> - Returns the cache of points as a [Vector3Array]. + Returns the cache of points as a [Vector3Array]. </description> </method> <method name="get_baked_tilts" qualifiers="const"> <return type="RealArray"> </return> <description> - Returns the cache of tilts as a [RealArray]. + Returns the cache of tilts as a [RealArray]. </description> </method> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> <description> - Returns the number of points describing the curve. + Returns the number of points describing the curve. </description> </method> <method name="get_point_in" qualifiers="const"> @@ -10329,7 +10329,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <argument index="0" name="idx" type="int"> </argument> <description> - Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). + Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). </description> </method> <method name="get_point_out" qualifiers="const"> @@ -10338,7 +10338,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <argument index="0" name="idx" type="int"> </argument> <description> - Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). + Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). </description> </method> <method name="get_point_pos" qualifiers="const"> @@ -10347,7 +10347,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <argument index="0" name="idx" type="int"> </argument> <description> - Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). + Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0). </description> </method> <method name="get_point_tilt" qualifiers="const"> @@ -10356,7 +10356,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <argument index="0" name="idx" type="int"> </argument> <description> - Returns the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console, and returns 0. + Returns the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console, and returns 0. </description> </method> <method name="interpolate" qualifiers="const"> @@ -10367,7 +10367,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi <argument index="1" name="t" type="float"> </argument> <description> - Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. + Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results. If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0, 0). </description> </method> @@ -10379,7 +10379,7 @@ If "idx" is out of bounds it is truncated to the first or last vertex, and "t" i <argument index="1" name="cubic" type="bool" default="false"> </argument> <description> - Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. + Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve. To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false. Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). </description> @@ -10390,21 +10390,21 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and <argument index="0" name="fofs" type="float"> </argument> <description> - Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t". + Returns the position at the vertex "fofs". It calls [method interpolate] using the integer part of fofs as "idx", and its fractional part as "t". </description> </method> <method name="remove_point"> <argument index="0" name="idx" type="int"> </argument> <description> - Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. + Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds. </description> </method> <method name="set_bake_interval"> <argument index="0" name="distance" type="float"> </argument> <description> - Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. + Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care. </description> </method> <method name="set_point_in"> @@ -10413,7 +10413,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and <argument index="1" name="pos" type="Vector3"> </argument> <description> - Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. + Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="set_point_out"> @@ -10422,7 +10422,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and <argument index="1" name="pos" type="Vector3"> </argument> <description> - Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console. + Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="set_point_pos"> @@ -10431,7 +10431,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and <argument index="1" name="pos" type="Vector3"> </argument> <description> - Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. + Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console. </description> </method> <method name="set_point_tilt"> @@ -10440,7 +10440,7 @@ Cubic interpolation tends to follow the curves better, but linear is faster (and <argument index="1" name="tilt" type="float"> </argument> <description> - Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console. + Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console. The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the PathFollow calculates. </description> </method> @@ -10452,7 +10452,7 @@ The tilt controls the rotation along the look-at axis an object traveling the pa <argument index="1" name="tolerance_degrees" type="float" default="4"> </argument> <description> - Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. + Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. "max_stages" controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided. @@ -10464,66 +10464,66 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="DampedSpringJoint2D" inherits="Joint2D" category="Core"> <brief_description> - Damped spring constraint for 2D physics. + Damped spring constraint for 2D physics. </brief_description> <description> - Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length. + Damped spring constraint for 2D physics. This resembles a spring joint that always wants to go back to a given length. </description> <methods> <method name="get_damping" qualifiers="const"> <return type="float"> </return> <description> - Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). + Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). </description> </method> <method name="get_length" qualifiers="const"> <return type="float"> </return> <description> - Return the maximum length of the spring joint. + Return the maximum length of the spring joint. </description> </method> <method name="get_rest_length" qualifiers="const"> <return type="float"> </return> <description> - Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. + Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. </description> </method> <method name="get_stiffness" qualifiers="const"> <return type="float"> </return> <description> - Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. + Return the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. </description> </method> <method name="set_damping"> <argument index="0" name="damping" type="float"> </argument> <description> - Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). + Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping). </description> </method> <method name="set_length"> <argument index="0" name="length" type="float"> </argument> <description> - Set the maximum length of the spring joint. + Set the maximum length of the spring joint. </description> </method> <method name="set_rest_length"> <argument index="0" name="rest_length" type="float"> </argument> <description> - Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. + Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. </description> </method> <method name="set_stiffness"> <argument index="0" name="stiffness" type="float"> </argument> <description> - Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. + Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length. </description> </method> </methods> @@ -10532,29 +10532,29 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="Dictionary" category="Built-In Types"> <brief_description> - Dictionary type. + Dictionary type. </brief_description> <description> - Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference. + Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference. </description> <methods> <method name="clear"> <description> - Clear the dictionary, removing all key/value pairs. + Clear the dictionary, removing all key/value pairs. </description> </method> <method name="empty"> <return type="bool"> </return> <description> - Return true if the dictionary is empty. + Return true if the dictionary is empty. </description> </method> <method name="erase"> <argument index="0" name="key" type="var"> </argument> <description> - Erase a dictionary key/value pair by key. + Erase a dictionary key/value pair by key. </description> </method> <method name="has"> @@ -10563,7 +10563,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="key" type="var"> </argument> <description> - Return true if the dictionary has a given key. + Return true if the dictionary has a given key. </description> </method> <method name="has_all"> @@ -10572,21 +10572,21 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="keys" type="Array"> </argument> <description> - Return true if the dictionary has all of the keys in the given array. + Return true if the dictionary has all of the keys in the given array. </description> </method> <method name="hash"> <return type="int"> </return> <description> - Return a hashed integer value representing the dictionary contents. + Return a hashed integer value representing the dictionary contents. </description> </method> <method name="keys"> <return type="Array"> </return> <description> - Return the list of keys in the [Dictionary]. + Return the list of keys in the [Dictionary]. </description> </method> <method name="parse_json"> @@ -10595,28 +10595,28 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="json" type="String"> </argument> <description> - Parse json text to the dictionary. Return OK when successed or the error code when failed. + Parse json text to the dictionary. Return OK when successed or the error code when failed. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the size of the dictionary (in pairs). + Return the size of the dictionary (in pairs). </description> </method> <method name="to_json"> <return type="String"> </return> <description> - Return the dictionary as json text. + Return the dictionary as json text. </description> </method> <method name="values"> <return type="Array"> </return> <description> - Return the list of values in the [Dictionary]. + Return the list of values in the [Dictionary]. </description> </method> </methods> @@ -10625,10 +10625,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="DirectionalLight" inherits="Light" category="Core"> <brief_description> - Directional Light, such as the Sun or the Moon. + Directional Light, such as the Sun or the Moon. </brief_description> <description> - A DirectionalLight is a type of [Light] node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction. + A DirectionalLight is a type of [Light] node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction. </description> <methods> <method name="get_shadow_mode" qualifiers="const"> @@ -10679,10 +10679,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="Directory" inherits="Reference" category="Core"> <brief_description> - Type used to handle the filesystem. + Type used to handle the filesystem. </brief_description> <description> - Directory type. It is used to manage directories and their content (not restricted to the project folder). + Directory type. It is used to manage directories and their content (not restricted to the project folder). Here is an example on how to iterate through the files of a directory: [codeblock] func dir_contents(path): @@ -10707,7 +10707,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="todir" type="String"> </argument> <description> - 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]). + 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_*). </description> </method> @@ -10719,7 +10719,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="to" type="String"> </argument> <description> - 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. + 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_*). </description> </method> @@ -10727,7 +10727,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="bool"> </return> <description> - Return whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). + Return whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). </description> </method> <method name="dir_exists"> @@ -10736,7 +10736,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. + Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path. </description> </method> <method name="file_exists"> @@ -10745,14 +10745,14 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - Return whether the target file exists. The argument can be relative to the current directory, or an absolute path. + Return whether the target file exists. The argument can be relative to the current directory, or an absolute path. </description> </method> <method name="get_current_dir"> <return type="String"> </return> <description> - Return the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]). + Return the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]). </description> </method> <method name="get_drive"> @@ -10761,41 +10761,41 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - On Windows, return the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On other platforms, or if the requested drive does not existed, the method returns an empty String. + On Windows, return the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On other platforms, or if the requested drive does not existed, the method returns an empty String. </description> </method> <method name="get_drive_count"> <return type="int"> </return> <description> - On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0. + On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0. </description> </method> <method name="get_next"> <return type="String"> </return> <description> - Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code]). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case). + Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code]). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case). </description> </method> <method name="get_space_left"> <return type="int"> </return> <description> - On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1. + On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1. </description> </method> <method name="list_dir_begin"> <return type="bool"> </return> <description> - Initialise the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end]. + Initialise the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end]. Return false if the stream could not be initialised. </description> </method> <method name="list_dir_end"> <description> - Close the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] or not does not matter). + Close the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] or not does not matter). </description> </method> <method name="make_dir"> @@ -10804,7 +10804,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - 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]). + 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_*). </description> </method> @@ -10814,7 +10814,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - 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. + 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. Returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*). </description> </method> @@ -10824,7 +10824,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - 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]). + 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_*). </description> </method> @@ -10834,7 +10834,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - 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. + 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. Returns one of the error code constants defined in [@Global Scope] (OK or FAILED). </description> </method> @@ -10846,7 +10846,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="to" type="String"> </argument> <description> - 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. + 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. Returns one of the error code constants defined in [@Global Scope] (OK or FAILED). </description> </method> @@ -10946,10 +10946,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EditorExportPlugin" inherits="Reference" category="Core"> <brief_description> - Editor plugin to control the export process. + Editor plugin to control the export process. </brief_description> <description> - This plugin is added into EditorImportExport and allows to modify + This plugin is added into EditorImportExport and allows to modify the behavior of the export process for individual files. </description> <methods> @@ -10961,7 +10961,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="platform" type="EditorExportPlatform"> </argument> <description> - This function is called for each file exported and + This function is called for each file exported and depending from the return value one of many things might happen. @@ -11149,10 +11149,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EditorImportPlugin" inherits="Reference" category="Core"> <brief_description> - Import plugin for editor + Import plugin for editor </brief_description> <description> - Import plugins make it easy to handle importing of external assets + Import plugins make it easy to handle importing of external assets into a project. They way they work is not that obvious though, so please make sure @@ -11173,7 +11173,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="platform" type="EditorExportPlatform"> </argument> <description> - Generally, files that are imported stay the same + Generally, files that are imported stay the same when exported. The only exception is in some cases when the file must be re-imported for different platforms (ie. texture compression). @@ -11195,7 +11195,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="String"> </return> <description> - Get the name of the import plugin, which will be + Get the name of the import plugin, which will be used to identify content imported by this plugin. Try to use lowecase and underscores if possible. @@ -11205,7 +11205,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="String"> </return> <description> - Visible name for this plugin, which will be shown on + Visible name for this plugin, which will be shown on the import menu. </description> </method> @@ -11217,7 +11217,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="from" type="ResourceImportMetadata"> </argument> <description> - Perform an import of an external resources into the + Perform an import of an external resources into the project. This function is both called on import (from the dialog) or re-import (manual or automatic when external source files @@ -11246,7 +11246,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="from" type="String"> </argument> <description> - This function is called when either the user chooses + This function is called when either the user chooses to import a resource of this type (Import menu), or when the user chooses to re-import the resource (from filesystem). In the later case, the path for @@ -11292,10 +11292,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EditorPlugin" inherits="Node" category="Core"> <brief_description> - Used by the editor to extend it's functionality. + Used by the editor to extend it's functionality. </brief_description> <description> - Plugins are used by the editor to extend functionality. The most + Plugins are used by the editor to extend functionality. The most common types of plugins are those which edit a given node or resource type, import plugins and export plugins. </description> @@ -11306,7 +11306,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="title" type="String"> </argument> <description> - Add a control to the bottom panel (together with + Add a control to the bottom panel (together with Output, Debug, Animation, etc). If your plugin is being removed, also make sure to @@ -11320,7 +11320,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="control" type="Control"> </argument> <description> - Add a custom control to a container (see + Add a custom control to a container (see CONTAINER_* enum). There are many locations where custom controls can be added in the editor UI. @@ -11338,7 +11338,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="control" type="Control"> </argument> <description> - Add the control to a specific dock slot (see DOCK_* + Add the control to a specific dock slot (see DOCK_* enum for options). If the dock is repositioned and as long as the @@ -11360,7 +11360,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="3" name="icon" type="Texture"> </argument> <description> - Add a custom type, which will appear in the list of + Add a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. @@ -11382,7 +11382,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="plugin" type="EditorExportPlugin"> </argument> <description> - Add an export plugin. Plugins of this kind can + Add an export plugin. Plugins of this kind can change files being exported. On exit don't forget to call [method remove_export_plugin]. </description> @@ -11391,7 +11391,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="plugin" type="EditorImportPlugin"> </argument> <description> - Add an import plugin. These plugins manage importing + Add an import plugin. These plugins manage importing external content (from outside the project) into formats the engine can understand. @@ -11401,7 +11401,7 @@ This approximation makes straight segments between each point, then subdivides t </method> <method name="apply_changes" qualifiers="virtual"> <description> - This method is called when the editor is about to + This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency. @@ -11413,7 +11413,7 @@ This approximation makes straight segments between each point, then subdivides t </method> <method name="clear" qualifiers="virtual"> <description> - Clear all the state and reset the object being + Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node fromt the wrong scene. @@ -11425,7 +11425,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="for_spatial" type="Spatial"> </argument> <description> - This is used for plugins that create gizmos used by + This is used for plugins that create gizmos used by the spatial editor. Just check that the node passed in the "for_spatial" argument matches your plugin. </description> @@ -11434,7 +11434,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="object" type="Object"> </argument> <description> - This function is used for plugins that edit specific + This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. </description> @@ -11445,7 +11445,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="event" type="InputEvent"> </argument> <description> - This is a low level function for plugins that edit a given + This is a low level function for plugins that edit a given object type derived from CanvasItem to capture the input in the 2D editor viewport. The function is only being called if your object is being edited. @@ -11462,7 +11462,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="event" type="InputEvent"> </argument> <description> - This is a low level function for plugins that edit a + This is a low level function for plugins that edit a given objet type derived from Spatial to capture the input of the viewport. The function is only being called if your object is being edited. @@ -11479,7 +11479,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="Control"> </return> <description> - Get a base control where it's safe to place dialogs. + Get a base control where it's safe to place dialogs. Many plugins open dialogs and they need a control as a base to make sure they use the editor icons and theme. @@ -11489,7 +11489,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="StringArray"> </return> <description> - This is for editors that edit script based objects. + This is for editors that edit script based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25 </description> @@ -11498,7 +11498,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="EditorSettings"> </return> <description> - Get the general settings for the editor (the same + Get the general settings for the editor (the same window that appears in the Settings menu). </description> </method> @@ -11506,7 +11506,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="String"> </return> <description> - Get the name of the editor plugin. For main scren + Get the name of the editor plugin. For main scren plugins this is what will appear in the selector (which by default is 2D, 3D, Script). </description> @@ -11515,7 +11515,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="EditorSelection"> </return> <description> - Get the object that handles the selection of nodes + Get the object that handles the selection of nodes in the Scene Tree editor. </description> </method> @@ -11523,7 +11523,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="Dictionary"> </return> <description> - Get the state of your plugin editor. This is used + Get the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). @@ -11533,7 +11533,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="UndoRedo"> </return> <description> - Get the undo/redo object. Most actions in the editor + Get the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. </description> @@ -11544,7 +11544,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="object" type="Object"> </argument> <description> - Implement this function if your plugin edits a + Implement this function if your plugin edits a specific type of object (Resource or Node). If you return true, then you will get the functions [EditorPlugin.edit] and [EditorPlugin.make_visible] @@ -11555,7 +11555,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="bool"> </return> <description> - Return true if this is a main screen editor plugin + Return true if this is a main screen editor plugin (it goes in the main screen selector together with 2D, 3D, Script). </description> @@ -11564,7 +11564,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="visible" type="bool"> </argument> <description> - This function will be called when the editor is + This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. @@ -11576,7 +11576,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="control" type="Control"> </argument> <description> - Remove the control from the bottom panel. Don't forget + Remove the control from the bottom panel. Don't forget to call this if you added one, so the editor can remove it cleanly. </description> @@ -11585,7 +11585,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="control" type="Control"> </argument> <description> - Remove the control from the dock. Don't forget to + Remove the control from the dock. Don't forget to call this if you added one, so the editor can save the layout and remove it cleanly. </description> @@ -11594,7 +11594,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="type" type="String"> </argument> <description> - Remove a custom type added by + Remove a custom type added by [EditorPlugin.add_custom_type] </description> </method> @@ -11602,7 +11602,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="plugin" type="EditorExportPlugin"> </argument> <description> - Remove the export plugin, don't forget to call this + Remove the export plugin, don't forget to call this on exit. </description> </method> @@ -11610,7 +11610,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="plugin" type="EditorImportPlugin"> </argument> <description> - Remove the import plugin, don't forget to call this + Remove the import plugin, don't forget to call this on exit. </description> </method> @@ -11618,7 +11618,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="state" type="Dictionary"> </argument> <description> - Restore the state saved by [EditorPlugin.get_state]. + Restore the state saved by [EditorPlugin.get_state]. </description> </method> </methods> @@ -11659,10 +11659,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EditorScenePostImport" inherits="Reference" category="Core"> <brief_description> - Base script for post-processing scenes being imported. + Base script for post-processing scenes being imported. </brief_description> <description> - These scripts can modify scenes after being imported by the 3D Scene + These scripts can modify scenes after being imported by the 3D Scene import option of the Import menu. </description> <methods> @@ -11670,7 +11670,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="scene" type="Object"> </argument> <description> - This function is called upon import with the + This function is called upon import with the imported scene. Just do any changes desired to the scene and return @@ -11684,10 +11684,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EditorScript" inherits="Reference" category="Core"> <brief_description> - Simple script to perform changes in the currently edited scene. + Simple script to perform changes in the currently edited scene. </brief_description> <description> - This script can be run from the Scene -> Run Script menu option. + This script can be run from the Scene -> Run Script menu option. </description> <methods> <method name="_run" qualifiers="virtual"> @@ -11712,43 +11712,43 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EditorSelection" inherits="Object" category="Core"> <brief_description> - Manages the SceneTree selection in the editor. + Manages the SceneTree selection in the editor. </brief_description> <description> - This object manages the SceneTree selection in the editor. + This object manages the SceneTree selection in the editor. </description> <methods> <method name="add_node"> <argument index="0" name="node" type="Node"> </argument> <description> - Add a node to the selection. + Add a node to the selection. </description> </method> <method name="clear"> <description> - Clear the selection. + Clear the selection. </description> </method> <method name="get_selected_nodes"> <return type="Array"> </return> <description> - Get the list of selectes nodes. + Get the list of selectes nodes. </description> </method> <method name="remove_node"> <argument index="0" name="node" type="Node"> </argument> <description> - Remove a node from the selection. + Remove a node from the selection. </description> </method> </methods> <signals> <signal name="selection_changed"> <description> - Emitted when the selection changes. + Emitted when the selection changes. </description> </signal> </signals> @@ -11757,10 +11757,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EditorSettings" inherits="Resource" category="Core"> <brief_description> - Object that holds the project-independent editor settings. + Object that holds the project-independent editor settings. </brief_description> <description> - Object that holds the project-independent editor settings. These + Object that holds the project-independent editor settings. These settings are generally visible in the Editor Settings menu. Accessing the settings is done by using the regular [Object] API, @@ -11777,14 +11777,14 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="property" type="String"> </argument> <description> - Erase a given setting (pass full property path). + Erase a given setting (pass full property path). </description> </method> <method name="get_favorite_dirs" qualifiers="const"> <return type="StringArray"> </return> <description> - Get the list of favorite directories for this + Get the list of favorite directories for this project. </description> </method> @@ -11792,7 +11792,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="String"> </return> <description> - Get the specific project settings path. Projects all + Get the specific project settings path. Projects all have an unique sub-directory inside the settings path where project specific settings are saved. </description> @@ -11801,7 +11801,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="StringArray"> </return> <description> - Get the list of recently visited folders in the file + Get the list of recently visited folders in the file dialog for this project. </description> </method> @@ -11809,7 +11809,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="String"> </return> <description> - Get the global settings path for the engine. Inside + Get the global settings path for the engine. Inside this path you can find some standard paths such as: settings/tmp - used for temporary storage of files @@ -11822,7 +11822,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="dirs" type="StringArray"> </argument> <description> - Set the list of favorite directories for this + Set the list of favorite directories for this project. </description> </method> @@ -11830,7 +11830,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="dirs" type="StringArray"> </argument> <description> - Set the list of recently visited folders in the file + Set the list of recently visited folders in the file dialog for this project. </description> </method> @@ -11846,10 +11846,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EditorSpatialGizmo" inherits="SpatialGizmo" category="Core"> <brief_description> - Custom gizmo for editing Spatial objects. + Custom gizmo for editing Spatial objects. </brief_description> <description> - Custom gizmo that is used for providing custom visualization and + Custom gizmo that is used for providing custom visualization and editing (handles) for 3D Spatial objects. These are created by [method EditorPlugin.create_spatial_gizmo]. </description> @@ -11864,7 +11864,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="triangles" type="TriangleMesh"> </argument> <description> - Add collision triangles to the gizmo for picking. A + Add collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. @@ -11879,7 +11879,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="2" name="secondary" type="bool" default="false"> </argument> <description> - Add a list of handles (points) which can be used to + Add a list of handles (points) which can be used to deform the object being edited. There are virtual functions which will be called @@ -11896,7 +11896,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="2" name="billboard" type="bool" default="false"> </argument> <description> - Add lines to the gizmo (as sets of 2 points), with a + Add lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. @@ -11911,7 +11911,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="2" name="skeleton" type="RID" default="RID()"> </argument> <description> - Add a mesh to the gizmo, this is used for + Add a mesh to the gizmo, this is used for visualization. Call this function during [method redraw]. @@ -11923,7 +11923,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="default_scale" type="float" default="1"> </argument> <description> - Add an unscaled billboard for visualization. + Add an unscaled billboard for visualization. Call this function during [method redraw]. </description> @@ -11936,7 +11936,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="2" name="cancel" type="bool"> </argument> <description> - Commit a handle being edited (handles must have been + Commit a handle being edited (handles must have been prevously added by [method add_handles]). If the cancel parameter is true, an option to @@ -11950,7 +11950,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="index" type="int"> </argument> <description> - Get the name of an edited handle (handles must have + Get the name of an edited handle (handles must have been previously added by [method add_handles]). Handles can be named for reference to the user when editing. @@ -11962,14 +11962,14 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="index" type="int"> </argument> <description> - Get actual value of a handle. This value can be + Get actual value of a handle. This value can be anything and used for eventually undoing the motion when calling [method commit_handle] </description> </method> <method name="redraw" qualifiers="virtual"> <description> - This function is called when the Spatial this gizmo + This function is called when the Spatial this gizmo refers to changes (the [method Spatial.update_gizmo] is called). </description> @@ -11982,7 +11982,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="2" name="point" type="Vector2"> </argument> <description> - This function is used when the user drags a gizmo + This function is used when the user drags a gizmo handle (previously added with [method add_handles]) in screen coordinates. @@ -11994,7 +11994,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="node" type="Spatial"> </argument> <description> - Call this function once and upon creation of the + Call this function once and upon creation of the gizmo, otherwise no other function will work. The argument is the node being edited by the gizmo. @@ -12188,10 +12188,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EventPlayer" inherits="Node" category="Core"> <brief_description> - Class for event stream playback. + Class for event stream playback. </brief_description> <description> - Class for event stream playback. Event streams are music expressed as a series of events (note on, note off, instrument change...), as opposed to audio streams, which are just audio data. Examples of event-based streams are MIDI files, or MOD music. + Class for event stream playback. Event streams are music expressed as a series of events (note on, note off, instrument change...), as opposed to audio streams, which are just audio data. Examples of event-based streams are MIDI files, or MOD music. Currently, only MOD, S3M, IT, and XM music is supported. </description> <methods> @@ -12201,7 +12201,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="channel" type="int"> </argument> <description> - Return the time at which the last note of a given channel in the stream plays. + Return the time at which the last note of a given channel in the stream plays. </description> </method> <method name="get_channel_volume" qualifiers="const"> @@ -12210,117 +12210,117 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="channel" type="int"> </argument> <description> - Return the volume scale for an individual channel of the stream. + Return the volume scale for an individual channel of the stream. </description> </method> <method name="get_length" qualifiers="const"> <return type="float"> </return> <description> - Return the song length. May be in seconds, but depends on the stream type. + Return the song length. May be in seconds, but depends on the stream type. </description> </method> <method name="get_loop_count" qualifiers="const"> <return type="int"> </return> <description> - Return the number of times the playback has looped. + Return the number of times the playback has looped. </description> </method> <method name="get_pitch_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the pitch scale factor for this player. + Return the pitch scale factor for this player. </description> </method> <method name="get_pos" qualifiers="const"> <return type="float"> </return> <description> - Return the playback position. May be in seconds, but depends on the stream type. + Return the playback position. May be in seconds, but depends on the stream type. </description> </method> <method name="get_stream" qualifiers="const"> <return type="EventStream"> </return> <description> - Return the currently assigned stream. + Return the currently assigned stream. </description> </method> <method name="get_stream_name" qualifiers="const"> <return type="String"> </return> <description> - Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>". + Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>". </description> </method> <method name="get_tempo_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the tempo multiplier. + Return the tempo multiplier. </description> </method> <method name="get_volume" qualifiers="const"> <return type="float"> </return> <description> - Return the playback volume for this player. + Return the playback volume for this player. </description> </method> <method name="get_volume_db" qualifiers="const"> <return type="float"> </return> <description> - Return the playback volume for this player, in decibels. + Return the playback volume for this player, in decibels. </description> </method> <method name="has_autoplay" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this player will start playing as soon as it enters the scene tree. + Return whether this player will start playing as soon as it enters the scene tree. </description> </method> <method name="has_loop" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this player will be restart the playback at the end. + Return whether this player will be restart the playback at the end. </description> </method> <method name="is_paused" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the playback is currently paused. + Return whether the playback is currently paused. </description> </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this player is playing. + Return whether this player is playing. </description> </method> <method name="play"> <description> - Play the currently assigned stream. + Play the currently assigned stream. </description> </method> <method name="seek_pos"> <argument index="0" name="time" type="float"> </argument> <description> - Set the playback position. May be in seconds, but depends on the stream type. + Set the playback position. May be in seconds, but depends on the stream type. </description> </method> <method name="set_autoplay"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether this player will start playing as soon as it enters the scene tree. + Set whether this player will start playing as soon as it enters the scene tree. </description> </method> <method name="set_channel_volume"> @@ -12329,7 +12329,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="channel_volume" type="float"> </argument> <description> - Set the volume scale for an individual channel of the stream, with the same value range as [method set_volume]. The channel number depends on the stream format. For example, MIDIs range from 0 to 15, and MODs from 0 to 63. + Set the volume scale for an individual channel of the stream, with the same value range as [method set_volume]. The channel number depends on the stream format. For example, MIDIs range from 0 to 15, and MODs from 0 to 63. Many stream formats are multichannel, so this allows to affect only a part of the music. </description> </method> @@ -12337,42 +12337,42 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether the stream will be restarted at the end. + Set whether the stream will be restarted at the end. </description> </method> <method name="set_paused"> <argument index="0" name="paused" type="bool"> </argument> <description> - Pause stream playback. + Pause stream playback. </description> </method> <method name="set_pitch_scale"> <argument index="0" name="pitch_scale" type="float"> </argument> <description> - Set the pitch multiplier for all sounds coming from this stream. A value of 2.0 shifts all pitches one octave up, and a value of 0.5 shifts pitches one octave down. + Set the pitch multiplier for all sounds coming from this stream. A value of 2.0 shifts all pitches one octave up, and a value of 0.5 shifts pitches one octave down. </description> </method> <method name="set_stream"> <argument index="0" name="stream" type="EventStream"> </argument> <description> - Set the [EventStream] this player will play. + Set the [EventStream] this player will play. </description> </method> <method name="set_tempo_scale"> <argument index="0" name="tempo_scale" type="float"> </argument> <description> - Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch. + Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch. </description> </method> <method name="set_volume"> <argument index="0" name="volume" type="float"> </argument> <description> - Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference. + Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference. The effect of these special values ultimately depends on the low-level implementation of the file format being played. </description> </method> @@ -12380,12 +12380,12 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="db" type="float"> </argument> <description> - Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see [method set_volume]) still apply. + Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see [method set_volume]) still apply. </description> </method> <method name="stop"> <description> - Stop playing. + Stop playing. </description> </method> </methods> @@ -12394,10 +12394,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EventStream" inherits="Resource" category="Core"> <brief_description> - Base class for all event-based stream drivers. + Base class for all event-based stream drivers. </brief_description> <description> - Base class for all event-based stream drivers. Event streams are music expressed as a series of events (note on, note off, instrument change...), as opposed to audio streams, which are just audio data. Examples of event-based streams are MIDI files, of MOD music. + Base class for all event-based stream drivers. Event streams are music expressed as a series of events (note on, note off, instrument change...), as opposed to audio streams, which are just audio data. Examples of event-based streams are MIDI files, of MOD music. This class exposes no methods. </description> <methods> @@ -12407,10 +12407,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="EventStreamChibi" inherits="EventStream" category="Core"> <brief_description> - Driver for MOD playback. + Driver for MOD playback. </brief_description> <description> - This driver plays MOD music. MOD music, as all event-based streams, is a music format defined by note events occurring at defined moments, instead of a stream of audio samples. + This driver plays MOD music. MOD music, as all event-based streams, is a music format defined by note events occurring at defined moments, instead of a stream of audio samples. Currently, this driver supports the MOD, S3M, IT, and XM formats. This class exposes no methods. This class can return its playback position in seconds, but does not allow to set it, failing with only a console warning. @@ -12424,10 +12424,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="File" inherits="Reference" category="Core"> <brief_description> - Type to handle file reading and writing operations. + Type to handle file reading and writing operations. </brief_description> <description> - File type. This is used to permanently store data into the user device's file system and to read from it. This can be used to store game save data or player configuration files, for example. + File type. This is used to permanently store data into the user device's file system and to read from it. This can be used to store game save data or player configuration files, for example. Here's a sample on how to write and read from a file: @@ -12449,14 +12449,14 @@ This approximation makes straight segments between each point, then subdivides t <methods> <method name="close"> <description> - Close the currently opened file. + Close the currently opened file. </description> </method> <method name="eof_reached" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the file cursor reached the end of the file. + Return whether the file cursor reached the end of the file. </description> </method> <method name="file_exists" qualifiers="const"> @@ -12465,42 +12465,42 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - Get whether or not the file in the specified path exists. + Get whether or not the file in the specified path exists. </description> </method> <method name="get_16" qualifiers="const"> <return type="int"> </return> <description> - Get the next 16 bits from the file as an integer. + Get the next 16 bits from the file as an integer. </description> </method> <method name="get_32" qualifiers="const"> <return type="int"> </return> <description> - Get the next 32 bits from the file as an integer. + Get the next 32 bits from the file as an integer. </description> </method> <method name="get_64" qualifiers="const"> <return type="int"> </return> <description> - Get the next 64 bits from the file as an integer. + Get the next 64 bits from the file as an integer. </description> </method> <method name="get_8" qualifiers="const"> <return type="int"> </return> <description> - Get the next 8 bits from the file as an integer. + Get the next 8 bits from the file as an integer. </description> </method> <method name="get_as_text" qualifiers="const"> <return type="String"> </return> <description> - Get the whole file as a [String]. + Get the whole file as a [String]. </description> </method> <method name="get_buffer" qualifiers="const"> @@ -12509,7 +12509,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="len" type="int"> </argument> <description> - Get next len bytes of the file as a [RawArray]. + Get next len bytes of the file as a [RawArray]. </description> </method> <method name="get_csv_line" qualifiers="const"> @@ -12518,49 +12518,49 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="delim" type="String" default="",""> </argument> <description> - Get the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma). + Get the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma). </description> </method> <method name="get_double" qualifiers="const"> <return type="float"> </return> <description> - Get the next 64 bits from the file as a floating point number. + Get the next 64 bits from the file as a floating point number. </description> </method> <method name="get_endian_swap"> <return type="bool"> </return> <description> - Get whether endian swap is enabled for this file. + Get whether endian swap is enabled for this file. </description> </method> <method name="get_error" qualifiers="const"> <return type="Error"> </return> <description> - Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope]. + Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope]. </description> </method> <method name="get_float" qualifiers="const"> <return type="float"> </return> <description> - Get the next 32 bits from the file as a floating point number. + Get the next 32 bits from the file as a floating point number. </description> </method> <method name="get_len" qualifiers="const"> <return type="int"> </return> <description> - Return the size of the file in bytes. + Return the size of the file in bytes. </description> </method> <method name="get_line" qualifiers="const"> <return type="String"> </return> <description> - Get the next line of the file as a [String]. + Get the next line of the file as a [String]. </description> </method> <method name="get_md5" qualifiers="const"> @@ -12569,28 +12569,28 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - Return a md5 String representing the file at the given path or an empty [String] on failure. + Return a md5 String representing the file at the given path or an empty [String] on failure. </description> </method> <method name="get_pascal_string"> <return type="String"> </return> <description> - Get a [String] saved in Pascal format from the file. + Get a [String] saved in Pascal format from the file. </description> </method> <method name="get_pos" qualifiers="const"> <return type="int"> </return> <description> - Return the file cursor position. + Return the file cursor position. </description> </method> <method name="get_real" qualifiers="const"> <return type="float"> </return> <description> - Get the next bits from the file as a floating point number. + Get the next bits from the file as a floating point number. </description> </method> <method name="get_sha256" qualifiers="const"> @@ -12599,19 +12599,19 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - Return a sha256 String representing the file at the given path or an empty [String] on failure. + Return a sha256 String representing the file at the given path or an empty [String] on failure. </description> </method> <method name="get_var" qualifiers="const"> <description> - Get the next Variant value from the file. + Get the next Variant value from the file. </description> </method> <method name="is_open" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the file is currently opened. + Return whether the file is currently opened. </description> </method> <method name="open"> @@ -12622,7 +12622,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="flags" type="int"> </argument> <description> - Open the file for writing or reading, depending on the flags. + Open the file for writing or reading, depending on the flags. </description> </method> <method name="open_encrypted"> @@ -12635,7 +12635,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="2" name="key" type="RawArray"> </argument> <description> - Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. + Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. </description> </method> <method name="open_encrypted_with_pass"> @@ -12648,28 +12648,28 @@ This approximation makes straight segments between each point, then subdivides t <argument index="2" name="pass" type="String"> </argument> <description> - Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. + Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. </description> </method> <method name="seek"> <argument index="0" name="pos" type="int"> </argument> <description> - Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file). + Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file). </description> </method> <method name="seek_end"> <argument index="0" name="pos" type="int" default="0"> </argument> <description> - Change the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file. + Change the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file. </description> </method> <method name="set_endian_swap"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether to swap the endianess of the file. Enable this if you're dealing with files written in big endian machines. + Set whether to swap the endianess of the file. Enable this if you're dealing with files written in big endian machines. Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file. </description> @@ -12678,84 +12678,84 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="value" type="int"> </argument> <description> - Store an integer as 16 bits in the file. + Store an integer as 16 bits in the file. </description> </method> <method name="store_32"> <argument index="0" name="value" type="int"> </argument> <description> - Store an integer as 32 bits in the file. + Store an integer as 32 bits in the file. </description> </method> <method name="store_64"> <argument index="0" name="value" type="int"> </argument> <description> - Store an integer as 64 bits in the file. + Store an integer as 64 bits in the file. </description> </method> <method name="store_8"> <argument index="0" name="value" type="int"> </argument> <description> - Store an integer as 8 bits in the file. + Store an integer as 8 bits in the file. </description> </method> <method name="store_buffer"> <argument index="0" name="buffer" type="RawArray"> </argument> <description> - Store the given array of bytes in the file. + Store the given array of bytes in the file. </description> </method> <method name="store_double"> <argument index="0" name="value" type="float"> </argument> <description> - Store a floating point number as 64 bits in the file. + Store a floating point number as 64 bits in the file. </description> </method> <method name="store_float"> <argument index="0" name="value" type="float"> </argument> <description> - Store a floating point number as 32 bits in the file. + Store a floating point number as 32 bits in the file. </description> </method> <method name="store_line"> <argument index="0" name="line" type="String"> </argument> <description> - Store the given [String] as a line in the file. + Store the given [String] as a line in the file. </description> </method> <method name="store_pascal_string"> <argument index="0" name="string" type="String"> </argument> <description> - Store the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). + Store the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). </description> </method> <method name="store_real"> <argument index="0" name="value" type="float"> </argument> <description> - Store a floating point number in the file. + Store a floating point number in the file. </description> </method> <method name="store_string"> <argument index="0" name="string" type="String"> </argument> <description> - Store the given [String] in the file. + Store the given [String] in the file. </description> </method> <method name="store_var"> <argument index="0" name="value" type="Variant"> </argument> <description> - Store any Variant value in the file. + Store any Variant value in the file. </description> </method> </methods> @@ -12776,118 +12776,118 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="FileDialog" inherits="ConfirmationDialog" category="Core"> <brief_description> - Dialog for selecting files or directories in the filesystem. + Dialog for selecting files or directories in the filesystem. </brief_description> <description> - FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks. + FileDialog is a preset dialog used to choose files and directories in the filesystem. It supports filter masks. </description> <methods> <method name="add_filter"> <argument index="0" name="filter" type="String"> </argument> <description> - Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images"); + Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("*.png ; PNG Images"); </description> </method> <method name="clear_filters"> <description> - Clear all the added filters in the dialog. + Clear all the added filters in the dialog. </description> </method> <method name="get_access" qualifiers="const"> <return type="int"> </return> <description> - Return the file access permission of the dialog. + Return the file access permission of the dialog. </description> </method> <method name="get_current_dir" qualifiers="const"> <return type="String"> </return> <description> - Get the current working directory of the file dialog. + Get the current working directory of the file dialog. </description> </method> <method name="get_current_file" qualifiers="const"> <return type="String"> </return> <description> - Get the current selected file of the file dialog (empty if none). + Get the current selected file of the file dialog (empty if none). </description> </method> <method name="get_current_path" qualifiers="const"> <return type="String"> </return> <description> - Get the current selected path (directory and file) of the file dialog (empty if none). + Get the current selected path (directory and file) of the file dialog (empty if none). </description> </method> <method name="get_mode" qualifiers="const"> <return type="int"> </return> <description> - Get the file dialog mode from the MODE_* enum. + Get the file dialog mode from the MODE_* enum. </description> </method> <method name="get_vbox"> <return type="VBoxContainer"> </return> <description> - Return the vertical box container of the dialog, custom controls can be added to it. + Return the vertical box container of the dialog, custom controls can be added to it. </description> </method> <method name="invalidate"> <description> - Invalidate and update the current dialog content list. + Invalidate and update the current dialog content list. </description> </method> <method name="is_showing_hidden_files" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the diaog allows show hidden files. + Return true if the diaog allows show hidden files. </description> </method> <method name="set_access"> <argument index="0" name="access" type="int"> </argument> <description> - Set the file access permission of the dialog(Must be one of [ACCESS_RESOURCES], [ACCESS_USERDATA] or [ACCESS_FILESYSTEM]). + Set the file access permission of the dialog(Must be one of [ACCESS_RESOURCES], [ACCESS_USERDATA] or [ACCESS_FILESYSTEM]). </description> </method> <method name="set_current_dir"> <argument index="0" name="dir" type="String"> </argument> <description> - Set the current working directory of the file dialog. + Set the current working directory of the file dialog. </description> </method> <method name="set_current_file"> <argument index="0" name="file" type="String"> </argument> <description> - Set the current selected file name of the file dialog. + Set the current selected file name of the file dialog. </description> </method> <method name="set_current_path"> <argument index="0" name="path" type="String"> </argument> <description> - Set the current selected file path of the file dialog. + Set the current selected file path of the file dialog. </description> </method> <method name="set_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set the file dialog mode from the MODE_* enum. + Set the file dialog mode from the MODE_* enum. </description> </method> <method name="set_show_hidden_files"> <argument index="0" name="show" type="bool"> </argument> <description> - Set the dialog should show hidden files. + Set the dialog should show hidden files. </description> </method> </methods> @@ -12896,21 +12896,21 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="dir" type="String"> </argument> <description> - Event emitted when the user selects a directory. + Event emitted when the user selects a directory. </description> </signal> <signal name="file_selected"> <argument index="0" name="path" type="String"> </argument> <description> - Event emitted when the user selects a file (double clicks it or presses the OK button). + Event emitted when the user selects a file (double clicks it or presses the OK button). </description> </signal> <signal name="files_selected"> <argument index="0" name="paths" type="StringArray"> </argument> <description> - Event emitted when the user selects multiple files. + Event emitted when the user selects multiple files. </description> </signal> </signals> @@ -12951,10 +12951,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="FixedMaterial" inherits="Material" category="Core"> <brief_description> - Simple Material with a fixed parameter set. + Simple Material with a fixed parameter set. </brief_description> <description> - FixedMaterial is a simple type of material [Resource], which contains a fixed amount of parameters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to [ShaderMaterial] for most simple use cases. + FixedMaterial is a simple type of material [Resource], which contains a fixed amount of parameters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to [ShaderMaterial] for most simple use cases. </description> <methods> <method name="get_fixed_flag" qualifiers="const"> @@ -12975,7 +12975,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="param" type="int"> </argument> <description> - Return a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum. + Return a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum. </description> </method> <method name="get_point_size" qualifiers="const"> @@ -12990,7 +12990,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="param" type="int"> </argument> <description> - Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. + Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. </description> </method> <method name="get_texture" qualifiers="const"> @@ -12999,14 +12999,14 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="param" type="int"> </argument> <description> - Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]). + Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]). </description> </method> <method name="get_uv_transform" qualifiers="const"> <return type="Transform"> </return> <description> - Returns the special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. + Returns the special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. </description> </method> <method name="set_fixed_flag"> @@ -13029,7 +13029,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="value" type="Variant"> </argument> <description> - Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum. + Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum. </description> </method> <method name="set_point_size"> @@ -13044,7 +13044,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="mode" type="int"> </argument> <description> - Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. + Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. </description> </method> <method name="set_texture"> @@ -13053,14 +13053,14 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="texture" type="Texture"> </argument> <description> - Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]). + Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]). </description> </method> <method name="set_uv_transform"> <argument index="0" name="transform" type="Transform"> </argument> <description> - Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. + Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. </description> </method> </methods> @@ -13122,10 +13122,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="Font" inherits="Resource" category="Core"> <brief_description> - Internationalized font and text drawing support. + Internationalized font and text drawing support. </brief_description> <description> - Font contains an unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc. + Font contains an unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc. </description> <methods> <method name="draw" qualifiers="const"> @@ -13140,7 +13140,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="4" name="clip_w" type="int" default="-1"> </argument> <description> - Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. + Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. </description> </method> <method name="draw_char" qualifiers="const"> @@ -13157,28 +13157,28 @@ This approximation makes straight segments between each point, then subdivides t <argument index="4" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> <description> - Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. + Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. </description> </method> <method name="get_ascent" qualifiers="const"> <return type="float"> </return> <description> - Return the font ascent (number of pixels above the baseline). + Return the font ascent (number of pixels above the baseline). </description> </method> <method name="get_descent" qualifiers="const"> <return type="float"> </return> <description> - Return the font descent (number of pixels below the baseline). + Return the font descent (number of pixels below the baseline). </description> </method> <method name="get_height" qualifiers="const"> <return type="float"> </return> <description> - Return the total font height (ascent plus descent) in pixels. + Return the total font height (ascent plus descent) in pixels. </description> </method> <method name="get_string_size" qualifiers="const"> @@ -13187,7 +13187,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="string" type="String"> </argument> <description> - Return the size of a string, taking kerning and advance into account. + Return the size of a string, taking kerning and advance into account. </description> </method> <method name="is_distance_field_hint" qualifiers="const"> @@ -13256,7 +13256,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="bool"> </return> <description> - Should put children to the top left corner instead of center of the container. + Should put children to the top left corner instead of center of the container. </description> </method> <method name="resume"> @@ -13671,10 +13671,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="GeometryInstance" inherits="VisualInstance" category="Core"> <brief_description> - Base node for geometry based visual instances. + Base node for geometry based visual instances. </brief_description> <description> - Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials. + Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials. </description> <methods> <method name="get_baked_light_texture_id" qualifiers="const"> @@ -13719,7 +13719,7 @@ This approximation makes straight segments between each point, then subdivides t <return type="Object"> </return> <description> - Return the material override for the whole geometry. + Return the material override for the whole geometry. </description> </method> <method name="set_baked_light_texture_id"> @@ -13764,7 +13764,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="material" type="Object"> </argument> <description> - Set the material override for the whole geometry. + Set the material override for the whole geometry. </description> </method> </methods> @@ -13797,17 +13797,17 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="Globals" inherits="Object" category="Core"> <brief_description> - Contains global variables accessible from everywhere. + Contains global variables accessible from everywhere. </brief_description> <description> - Contains global variables accessible from everywhere. Use the normal [Object] API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in engine.cfg are also loaded into globals, making this object very useful for reading custom game configuration options. + Contains global variables accessible from everywhere. Use the normal [Object] API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in engine.cfg are also loaded into globals, making this object very useful for reading custom game configuration options. </description> <methods> <method name="clear"> <argument index="0" name="name" type="String"> </argument> <description> - Clear the whole configuration (not recommended, may break things). + Clear the whole configuration (not recommended, may break things). </description> </method> <method name="get_order" qualifiers="const"> @@ -13816,7 +13816,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="name" type="String"> </argument> <description> - Return the order of a configuration value (influences when saved to the config file). + Return the order of a configuration value (influences when saved to the config file). </description> </method> <method name="get_singleton" qualifiers="const"> @@ -13833,7 +13833,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - Convert a localized path (res://) to a full native OS path. + Convert a localized path (res://) to a full native OS path. </description> </method> <method name="has" qualifiers="const"> @@ -13842,7 +13842,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="name" type="String"> </argument> <description> - Return true if a configuration value is present. + Return true if a configuration value is present. </description> </method> <method name="has_singleton" qualifiers="const"> @@ -13859,7 +13859,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="name" type="String"> </argument> <description> - If returns true, this value can be saved to the configuration file. This is useful for editors. + If returns true, this value can be saved to the configuration file. This is useful for editors. </description> </method> <method name="load_resource_pack"> @@ -13876,7 +13876,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="path" type="String"> </argument> <description> - Convert a path to a localized path (res:// path). + Convert a path to a localized path (res:// path). </description> </method> <method name="save"> @@ -13899,7 +13899,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="pos" type="int"> </argument> <description> - Set the order of a configuration value (influences when saved to the config file). + Set the order of a configuration value (influences when saved to the config file). </description> </method> <method name="set_persisting"> @@ -13908,7 +13908,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="enable" type="bool"> </argument> <description> - If set to true, this value can be saved to the configuration file. This is useful for editors. + If set to true, this value can be saved to the configuration file. This is useful for editors. </description> </method> </methods> @@ -13917,10 +13917,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="GraphEdit" inherits="Control" category="Core"> <brief_description> - GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. + GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. </brief_description> <description> - GraphEdit manages the showing of GraphNodes it contains, as well as connections an disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. + GraphEdit manages the showing of GraphNodes it contains, as well as connections an disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. It is greatly advised to enable low processor usage mode (see [method OS.set_low_processor_usage_mode]) when using GraphEdits. </description> <methods> @@ -13936,7 +13936,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="3" name="to_port" type="int"> </argument> <description> - Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. + Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. </description> </method> <method name="disconnect_node"> @@ -13949,28 +13949,28 @@ This approximation makes straight segments between each point, then subdivides t <argument index="3" name="to_port" type="int"> </argument> <description> - Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. + Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. </description> </method> <method name="get_connection_list" qualifiers="const"> <return type="Array"> </return> <description> - Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } + Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } </description> </method> <method name="get_scroll_ofs" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the scroll offset. + Return the scroll offset. </description> </method> <method name="get_zoom" qualifiers="const"> <return type="float"> </return> <description> - Return the current zoom value. + Return the current zoom value. </description> </method> <method name="is_node_connected"> @@ -13985,40 +13985,40 @@ This approximation makes straight segments between each point, then subdivides t <argument index="3" name="to_port" type="int"> </argument> <description> - Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. + Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. </description> </method> <method name="is_right_disconnects_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. + Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. </description> </method> <method name="set_right_disconnects"> <argument index="0" name="enable" type="bool"> </argument> <description> - Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. + Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. </description> </method> <method name="set_zoom"> <argument index="0" name="p_zoom" type="float"> </argument> <description> - Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728]. + Set the zoom value of the GraphEdit. Zoom value is between [0.01; 1.728]. </description> </method> </methods> <signals> <signal name="_begin_node_move"> <description> - Signal sent at the beginning of a GraphNode movement. + Signal sent at the beginning of a GraphNode movement. </description> </signal> <signal name="_end_node_move"> <description> - Signal sent at the end of a GraphNode movement. + Signal sent at the end of a GraphNode movement. </description> </signal> <signal name="connection_request"> @@ -14031,12 +14031,12 @@ This approximation makes straight segments between each point, then subdivides t <argument index="3" name="to_slot" type="int"> </argument> <description> - Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. + Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. </description> </signal> <signal name="delete_nodes_request"> <description> - Signal sent when a GraphNode is attempted to be removed from the GraphEdit. + Signal sent when a GraphNode is attempted to be removed from the GraphEdit. </description> </signal> <signal name="disconnection_request"> @@ -14049,19 +14049,19 @@ This approximation makes straight segments between each point, then subdivides t <argument index="3" name="to_slot" type="int"> </argument> <description> - Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. + Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. </description> </signal> <signal name="duplicate_nodes_request"> <description> - Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. + Signal sent when a GraphNode is attempted to be duplicated in the GraphEdit. </description> </signal> <signal name="popup_request"> <argument index="0" name="p_position" type="Vector2"> </argument> <description> - Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. + Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. </description> </signal> </signals> @@ -14080,22 +14080,22 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="GraphNode" inherits="Container" category="Core"> <brief_description> - A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. + A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. </brief_description> <description> - A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. + A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. </description> <methods> <method name="clear_all_slots"> <description> - Disable all input and output slots of the GraphNode. + Disable all input and output slots of the GraphNode. </description> </method> <method name="clear_slot"> <argument index="0" name="idx" type="int"> </argument> <description> - Disable input and output slot whose index is 'idx'. + Disable input and output slot whose index is 'idx'. </description> </method> <method name="get_connection_input_color"> @@ -14104,14 +14104,14 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return the color of the input connection 'idx'. + Return the color of the input connection 'idx'. </description> </method> <method name="get_connection_input_count"> <return type="int"> </return> <description> - Return the number of enabled input slots (connections) to the GraphNode. + Return the number of enabled input slots (connections) to the GraphNode. </description> </method> <method name="get_connection_input_pos"> @@ -14120,7 +14120,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return the position of the input connection 'idx'. + Return the position of the input connection 'idx'. </description> </method> <method name="get_connection_input_type"> @@ -14129,7 +14129,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return the type of the input connection 'idx'. + Return the type of the input connection 'idx'. </description> </method> <method name="get_connection_output_color"> @@ -14138,14 +14138,14 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return the color of the output connection 'idx'. + Return the color of the output connection 'idx'. </description> </method> <method name="get_connection_output_count"> <return type="int"> </return> <description> - Return the number of enabled output slots (connections) of the GraphNode. + Return the number of enabled output slots (connections) of the GraphNode. </description> </method> <method name="get_connection_output_pos"> @@ -14154,7 +14154,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return the position of the output connection 'idx'. + Return the position of the output connection 'idx'. </description> </method> <method name="get_connection_output_type"> @@ -14163,14 +14163,14 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return the type of the output connection 'idx'. + Return the type of the output connection 'idx'. </description> </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the offset of the GraphNode. + Return the offset of the GraphNode. </description> </method> <method name="get_slot_color_left" qualifiers="const"> @@ -14179,7 +14179,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return the color set to 'idx' left (input) slot. + Return the color set to 'idx' left (input) slot. </description> </method> <method name="get_slot_color_right" qualifiers="const"> @@ -14188,7 +14188,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return the color set to 'idx' right (output) slot. + Return the color set to 'idx' right (output) slot. </description> </method> <method name="get_slot_type_left" qualifiers="const"> @@ -14197,7 +14197,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return the (integer) type of left (input) 'idx' slot. + Return the (integer) type of left (input) 'idx' slot. </description> </method> <method name="get_slot_type_right" qualifiers="const"> @@ -14206,21 +14206,21 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return the (integer) type of right (output) 'idx' slot. + Return the (integer) type of right (output) 'idx' slot. </description> </method> <method name="get_title" qualifiers="const"> <return type="String"> </return> <description> - Return the title of the GraphNode. + Return the title of the GraphNode. </description> </method> <method name="is_close_button_visible" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if the close button is shown. False otherwise. + Returns true if the close button is shown. False otherwise. </description> </method> <method name="is_slot_enabled_left" qualifiers="const"> @@ -14229,7 +14229,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return true if left (input) slot 'idx' is enabled. False otherwise. + Return true if left (input) slot 'idx' is enabled. False otherwise. </description> </method> <method name="is_slot_enabled_right" qualifiers="const"> @@ -14238,21 +14238,21 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Return true if right (output) slot 'idx' is enabled. False otherwise. + Return true if right (output) slot 'idx' is enabled. False otherwise. </description> </method> <method name="set_offset"> <argument index="0" name="offset" type="Vector2"> </argument> <description> - Set the offset of the GraphNode. + Set the offset of the GraphNode. </description> </method> <method name="set_show_close_button"> <argument index="0" name="show" type="bool"> </argument> <description> - Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work. + Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work. </description> </method> <method name="set_slot"> @@ -14271,21 +14271,21 @@ This approximation makes straight segments between each point, then subdivides t <argument index="6" name="color_right" type="Color"> </argument> <description> - Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types. + Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types. </description> </method> <method name="set_title"> <argument index="0" name="title" type="String"> </argument> <description> - Set the title of the GraphNode. + Set the title of the GraphNode. </description> </method> </methods> <signals> <signal name="close_request"> <description> - Signal sent on closing the GraphNode. + Signal sent on closing the GraphNode. </description> </signal> <signal name="dragged"> @@ -14294,17 +14294,17 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="to" type="Vector2"> </argument> <description> - Signal sent when the GraphNode is dragged. + Signal sent when the GraphNode is dragged. </description> </signal> <signal name="offset_changed"> <description> - Signal sent when the GraphNode is moved. + Signal sent when the GraphNode is moved. </description> </signal> <signal name="raise_request"> <description> - Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. + Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. </description> </signal> </signals> @@ -14339,24 +14339,24 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="GridContainer" inherits="Container" category="Core"> <brief_description> - Grid container used to arrange elements in a grid like layout + Grid container used to arrange elements in a grid like layout </brief_description> <description> - Grid container will arrange its children in a grid like structure, the grid columns are specified using the [method set_columns] method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container. + Grid container will arrange its children in a grid like structure, the grid columns are specified using the [method set_columns] method and the number of rows will be equal to the number of children in the container divided by the number of columns, for example: if the container has 5 children, and 2 columns, there will be 3 rows in the container. Notice that grid layout will preserve the columns and rows for every size of the container. </description> <methods> <method name="get_columns" qualifiers="const"> <return type="int"> </return> <description> - Returns the number of columns in this container + Returns the number of columns in this container </description> </method> <method name="set_columns"> <argument index="0" name="columns" type="int"> </argument> <description> - Sets the numbers of columns in the container, then reorder its children to accommodate the new layout + Sets the numbers of columns in the container, then reorder its children to accommodate the new layout </description> </method> </methods> @@ -14637,38 +14637,38 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="GrooveJoint2D" inherits="Joint2D" category="Core"> <brief_description> - Groove constraint for 2D physics. + Groove constraint for 2D physics. </brief_description> <description> - Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another. + Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another. </description> <methods> <method name="get_initial_offset" qualifiers="const"> <return type="float"> </return> <description> - Set the final offset of the groove on body A. + Set the final offset of the groove on body A. </description> </method> <method name="get_length" qualifiers="const"> <return type="float"> </return> <description> - Return the length of the groove. + Return the length of the groove. </description> </method> <method name="set_initial_offset"> <argument index="0" name="offset" type="float"> </argument> <description> - Set the initial offset of the groove on body A. + Set the initial offset of the groove on body A. </description> </method> <method name="set_length"> <argument index="0" name="length" type="float"> </argument> <description> - Set the length of the groove. + Set the length of the groove. </description> </method> </methods> @@ -14677,10 +14677,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="HBoxContainer" inherits="BoxContainer" category="Core"> <brief_description> - Horizontal box container. + Horizontal box container. </brief_description> <description> - Horizontal box container. See [BoxContainer]. + Horizontal box container. See [BoxContainer]. </description> <methods> </methods> @@ -14693,10 +14693,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="HButtonArray" inherits="ButtonArray" category="Core"> <brief_description> - Horizontal button array. + Horizontal button array. </brief_description> <description> - Horizontal button array. See [ButtonArray]. + Horizontal button array. See [ButtonArray]. </description> <methods> </methods> @@ -14727,10 +14727,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="HScrollBar" inherits="ScrollBar" category="Core"> <brief_description> - Horizontal scroll bar. + Horizontal scroll bar. </brief_description> <description> - Horizontal scroll bar. See [ScrollBar]. This one goes from left (min) to right (max). + Horizontal scroll bar. See [ScrollBar]. This one goes from left (min) to right (max). </description> <methods> </methods> @@ -14757,10 +14757,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="HSeparator" inherits="Separator" category="Core"> <brief_description> - Horizontal separator. + Horizontal separator. </brief_description> <description> - Horizontal separator. See [Separator]. It is used to separate objects vertically, though (but it looks horizontal!). + Horizontal separator. See [Separator]. It is used to separate objects vertically, though (but it looks horizontal!). </description> <methods> </methods> @@ -14775,10 +14775,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="HSlider" inherits="Slider" category="Core"> <brief_description> - Horizontal slider. + Horizontal slider. </brief_description> <description> - Horizontal slider. See [Slider]. This one goes from left (min) to right (max). + Horizontal slider. See [Slider]. This one goes from left (min) to right (max). </description> <methods> </methods> @@ -14801,10 +14801,10 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="HSplitContainer" inherits="SplitContainer" category="Core"> <brief_description> - Horizontal split container. + Horizontal split container. </brief_description> <description> - Horizontal split container. See [SplitContainer]. This goes from left to right. + Horizontal split container. See [SplitContainer]. This goes from left to right. </description> <methods> </methods> @@ -14823,16 +14823,16 @@ This approximation makes straight segments between each point, then subdivides t </class> <class name="HTTPClient" inherits="Reference" category="Core"> <brief_description> - Hyper-text transfer protocol client. + Hyper-text transfer protocol client. </brief_description> <description> - Hyper-text transfer protocol client. Supports SSL and SSL server certificate verification. + Hyper-text transfer protocol client. Supports SSL and SSL server certificate verification. Can be reused to connect to different hosts and make many requests. </description> <methods> <method name="close"> <description> - Cloces the current connection, allows for reusal of [HTTPClient]. + Cloces the current connection, allows for reusal of [HTTPClient]. </description> </method> <method name="connect"> @@ -14847,7 +14847,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="3" name="verify_host" type="bool" default="true"> </argument> <description> - Connect to a host. This needs to be done before any requests are sent. + Connect to a host. This needs to be done before any requests are sent. The host should not have http:// prepended but will strip the protocol identifier if provided. verify_host will check the SSL identity of the host if set to true. </description> @@ -14856,35 +14856,35 @@ This approximation makes straight segments between each point, then subdivides t <return type="StreamPeer"> </return> <description> - Return current connection. + Return current connection. </description> </method> <method name="get_response_body_length" qualifiers="const"> <return type="int"> </return> <description> - Return the response's body length. + Return the response's body length. </description> </method> <method name="get_response_code" qualifiers="const"> <return type="int"> </return> <description> - Return the HTTP status code of the response. + Return the HTTP status code of the response. </description> </method> <method name="get_response_headers"> <return type="StringArray"> </return> <description> - Return the response headers. + Return the response headers. </description> </method> <method name="get_response_headers_as_dictionary"> <return type="Dictionary"> </return> <description> - Returns all response headers as dictionary where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. + Returns all response headers as dictionary where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. Structure: ("key":"value1; value2") Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </description> @@ -14893,35 +14893,35 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates. + Returns a status string like STATUS_REQUESTING. Need to call [method poll] in order to get status updates. </description> </method> <method name="has_response" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this [HTTPClient] has a response available. + Return whether this [HTTPClient] has a response available. </description> </method> <method name="is_blocking_mode_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether blocking mode is enabled. + Return whether blocking mode is enabled. </description> </method> <method name="is_response_chunked" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this [HTTPClient] has a response that is chunked. + Return whether this [HTTPClient] has a response that is chunked. </description> </method> <method name="poll"> <return type="Error"> </return> <description> - This needs to be called in order to have any request processed. Check results with [method get_status] + This needs to be called in order to have any request processed. Check results with [method get_status] </description> </method> <method name="query_string_from_dict"> @@ -14930,7 +14930,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="fields" type="Dictionary"> </argument> <description> - Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: + Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: [codeblock] var fields = {"username": "user", "password": "pass"} String queryString = httpClient.query_string_from_dict(fields) @@ -14942,7 +14942,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="RawArray"> </return> <description> - Reads one chunk from the response. + Reads one chunk from the response. </description> </method> <method name="request"> @@ -14957,7 +14957,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="3" name="body" type="String" default=""""> </argument> <description> - Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". + Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". Headers are HTTP request headers. To create a POST request with query strings to push to the server, do: [codeblock] @@ -14980,7 +14980,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="3" name="body" type="RawArray"> </argument> <description> - Sends a raw request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". + Sends a raw request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". Headers are HTTP request headers. Sends body raw, as a byte array, does not encode it in any way. </description> @@ -14991,7 +14991,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="body" type="RawArray"> </argument> <description> - Stub function + Stub function </description> </method> <method name="send_body_text"> @@ -15000,28 +15000,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="body" type="String"> </argument> <description> - Stub function + Stub function </description> </method> <method name="set_blocking_mode"> <argument index="0" name="enabled" type="bool"> </argument> <description> - If set to true, execution will block until all data is read from the response. + If set to true, execution will block until all data is read from the response. </description> </method> <method name="set_connection"> <argument index="0" name="connection" type="StreamPeer"> </argument> <description> - Set connection to use, for this client. + Set connection to use, for this client. </description> </method> <method name="set_read_chunk_size"> <argument index="0" name="bytes" type="int"> </argument> <description> - Sets the size of the buffer used and maximum bytes to read per iteration. see [method read_response_body_chunk] + Sets the size of the buffer used and maximum bytes to read per iteration. see [method read_response_body_chunk] </description> </method> </methods> @@ -15166,65 +15166,65 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="HTTPRequest" inherits="Node" category="Core"> <brief_description> - A Node with the ability to send HTTP requests. + A Node with the ability to send HTTP requests. </brief_description> <description> - A Node with the ability to send HTTP requests. Uses a [HTTPClient] internally, supports HTTPS. + A Node with the ability to send HTTP requests. Uses a [HTTPClient] internally, supports HTTPS. Can be used to make HTTP requests or download files via HTTP. </description> <methods> <method name="cancel_request"> <description> - Cancel the current request. + Cancel the current request. </description> </method> <method name="get_body_size" qualifiers="const"> <return type="int"> </return> <description> - Return the response body length. + Return the response body length. </description> </method> <method name="get_body_size_limit" qualifiers="const"> <return type="int"> </return> <description> - Return current body size limit. + Return current body size limit. </description> </method> <method name="get_download_file" qualifiers="const"> <return type="String"> </return> <description> - Return the file this request will download into. + Return the file this request will download into. </description> </method> <method name="get_downloaded_bytes" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of bytes this HTTPRequest downloaded. + Return the amount of bytes this HTTPRequest downloaded. </description> </method> <method name="get_http_client_status" qualifiers="const"> <return type="int"> </return> <description> - Return the current status of the underlying [HTTPClient]. + Return the current status of the underlying [HTTPClient]. </description> </method> <method name="get_max_redirects" qualifiers="const"> <return type="int"> </return> <description> - Return the maximum amount of redirects that will be followed. + Return the maximum amount of redirects that will be followed. </description> </method> <method name="is_using_threads" qualifiers="const"> <return type="bool"> </return> <description> - Whether this request is using threads. + Whether this request is using threads. </description> </method> <method name="request"> @@ -15237,7 +15237,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="ssl_validate_domain" type="bool" default="true"> </argument> <description> - Make a HTTP GET request. The url is the complete url including "http://" or "https://" which will be parsed for a host and a port. + Make a HTTP GET request. The url is the complete url including "http://" or "https://" which will be parsed for a host and a port. The custom_headers are HTTP request headers which will be used. If User-Agent is not specified a Godot specific will be used. The ssl_validate_domain specifies if in case of HTTPS the server certificate should be verified. </description> @@ -15246,28 +15246,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="bytes" type="int"> </argument> <description> - Set the response body size limit. + Set the response body size limit. </description> </method> <method name="set_download_file"> <argument index="0" name="path" type="String"> </argument> <description> - Set the file to download into. Outputs the response body into the file. + Set the file to download into. Outputs the response body into the file. </description> </method> <method name="set_max_redirects"> <argument index="0" name="amount" type="int"> </argument> <description> - Set the maximum amount of redirects the request will follow. + Set the maximum amount of redirects the request will follow. </description> </method> <method name="set_use_threads"> <argument index="0" name="enable" type="bool"> </argument> <description> - Make this HTTPRequest use threads. + Make this HTTPRequest use threads. </description> </method> </methods> @@ -15282,7 +15282,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="3" name="body" type="RawArray"> </argument> <description> - This signal is emitted upon request completion. + This signal is emitted upon request completion. </description> </signal> </signals> @@ -15392,17 +15392,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="IP" inherits="Object" category="Core"> <brief_description> - IP Protocol support functions. + IP Protocol support functions. </brief_description> <description> - IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see [StreamPeerTCP] and [TCP_Server]). IP provides hostname resolution support, both blocking and threaded. + IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see [StreamPeerTCP] and [TCP_Server]). IP provides hostname resolution support, both blocking and threaded. </description> <methods> <method name="erase_resolve_item"> <argument index="0" name="id" type="int"> </argument> <description> - Erase a queue ID, removing it from the queue if needed. This should be used after a queue is completed to free it and enable more queries to happen. + Erase a queue ID, removing it from the queue if needed. This should be used after a queue is completed to free it and enable more queries to happen. </description> </method> <method name="get_local_addresses" qualifiers="const"> @@ -15417,7 +15417,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="id" type="int"> </argument> <description> - Return a resolved item address, or an empty string if an error happened or resolution didn't happen yet (see [method get_resolve_item_status]). + Return a resolved item address, or an empty string if an error happened or resolution didn't happen yet (see [method get_resolve_item_status]). </description> </method> <method name="get_resolve_item_status" qualifiers="const"> @@ -15426,7 +15426,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="id" type="int"> </argument> <description> - Return the status of hostname queued for resolving, given it's queue ID. Returned status can be any of the RESOLVER_STATUS_* enumeration. + Return the status of hostname queued for resolving, given it's queue ID. Returned status can be any of the RESOLVER_STATUS_* enumeration. </description> </method> <method name="resolve_hostname"> @@ -15435,7 +15435,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="host" type="String"> </argument> <description> - Resolve a given hostname, blocking. Resolved hostname is returned as an IP. + Resolve a given hostname, blocking. Resolved hostname is returned as an IP. </description> </method> <method name="resolve_hostname_queue_item"> @@ -15444,7 +15444,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="host" type="String"> </argument> <description> - Create a queue item for resolving a given hostname. The queue ID is returned, or RESOLVER_INVALID_ID on error. + Create a queue item for resolving a given hostname. The queue ID is returned, or RESOLVER_INVALID_ID on error. </description> </method> </methods> @@ -15475,10 +15475,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Image" category="Built-In Types"> <brief_description> - Image datatype. + Image datatype. </brief_description> <description> - Built in native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it. + Built in native image datatype. Contains image data, which can be converted to a texture, and several functions to interact with it. </description> <methods> <method name="Image"> @@ -15493,7 +15493,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="3" name="format" type="int"> </argument> <description> - Create an empty image of a specific size and format. + Create an empty image of a specific size and format. </description> </method> <method name="blit_rect"> @@ -15504,7 +15504,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="dest" type="Vector2" default="0"> </argument> <description> - Copy a "src_rect" [Rect2] from "src" [Image] to this [Image] on coordinates "dest". + Copy a "src_rect" [Rect2] from "src" [Image] to this [Image] on coordinates "dest". </description> </method> <method name="brush_transfer"> @@ -15515,7 +15515,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="pos" type="Vector2" default="0"> </argument> <description> - Transfer data from "src" to this [Image] using a "brush" as a mask/brush on coordinates "pos". + Transfer data from "src" to this [Image] using a "brush" as a mask/brush on coordinates "pos". </description> </method> <method name="brushed"> @@ -15528,7 +15528,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="pos" type="Vector2" default="0"> </argument> <description> - Return a new [Image] from this [Image] that is created by brushhing see [method brush_transfer]. + Return a new [Image] from this [Image] that is created by brushhing see [method brush_transfer]. </description> </method> <method name="compressed"> @@ -15537,7 +15537,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="format" type="int" default="0"> </argument> <description> - Return a new compressed [Image] from this [Image] using one of [Image].COMPRESS_*. + Return a new compressed [Image] from this [Image] using one of [Image].COMPRESS_*. </description> </method> <method name="converted"> @@ -15546,21 +15546,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="format" type="int" default="0"> </argument> <description> - Return a new [Image] from this [Image] with a different format. + Return a new [Image] from this [Image] with a different format. </description> </method> <method name="decompressed"> <return type="Image"> </return> <description> - Return a new decompressed [Image]. + Return a new decompressed [Image]. </description> </method> <method name="empty"> <return type="bool"> </return> <description> - Return whether this [Image] is empty(no data). + Return whether this [Image] is empty(no data). </description> </method> <method name="fix_alpha_edges"> @@ -15571,21 +15571,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="RawArray"> </return> <description> - Return the raw data of the [Image]. + Return the raw data of the [Image]. </description> </method> <method name="get_format"> <return type="int"> </return> <description> - Return the format of the [Image], one of [Image].FORMAT_*. + Return the format of the [Image], one of [Image].FORMAT_*. </description> </method> <method name="get_height"> <return type="int"> </return> <description> - Return the height of the [Image]. + Return the height of the [Image]. </description> </method> <method name="get_pixel"> @@ -15598,7 +15598,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="mipmap_level" type="int" default="0"> </argument> <description> - Return the color of the pixel in the [Image] on coordinates "x,y" on mipmap level "mipmap_level". + Return the color of the pixel in the [Image] on coordinates "x,y" on mipmap level "mipmap_level". </description> </method> <method name="get_rect"> @@ -15607,21 +15607,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="area" type="Rect2" default="0"> </argument> <description> - Return a new [Image] that is a copy of "area" in this [Image]. + Return a new [Image] that is a copy of "area" in this [Image]. </description> </method> <method name="get_used_rect"> <return type="Rect2"> </return> <description> - Return the area of this [Image] that is used/visibly colored/opaque. + Return the area of this [Image] that is used/visibly colored/opaque. </description> </method> <method name="get_width"> <return type="int"> </return> <description> - Return the width of the [Image]. + Return the width of the [Image]. </description> </method> <method name="load"> @@ -15630,7 +15630,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="path" type="String" default="0"> </argument> <description> - Load an [Image]. + Load an [Image]. </description> </method> <method name="put_pixel"> @@ -15643,7 +15643,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="3" name="mipmap_level" type="int" default="0"> </argument> <description> - Put a pixel of "color" on coordinates "x,y" on mipmap level "mipmap_level". + Put a pixel of "color" on coordinates "x,y" on mipmap level "mipmap_level". </description> </method> <method name="resized"> @@ -15656,7 +15656,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="interpolation" type="int" default="1"> </argument> <description> - Return a new [Image] from this [Image] that is resized to size "x,y" using [Image].INTERPOLATE_*. + Return a new [Image] from this [Image] that is resized to size "x,y" using [Image].INTERPOLATE_*. </description> </method> <method name="save_png"> @@ -15665,7 +15665,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="path" type="String" default="0"> </argument> <description> - Save this [Image] as a png. + Save this [Image] as a png. </description> </method> </methods> @@ -15734,10 +15734,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="ImageTexture" inherits="Texture" category="Core"> <brief_description> - A [Texture] based on an [Image]. + A [Texture] based on an [Image]. </brief_description> <description> - A [Texture] based on an [Image]. Can be created from an [Image]. + A [Texture] based on an [Image]. Can be created from an [Image]. </description> <methods> <method name="create"> @@ -15750,7 +15750,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="3" name="flags" type="int" default="7"> </argument> <description> - Create a new [ImageTexture] with "width" and "height". + Create a new [ImageTexture] with "width" and "height". "format" one of [Image].FORMAT_*. "flags" one or more of [Texture].FLAG_*. </description> @@ -15761,7 +15761,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="flags" type="int" default="7"> </argument> <description> - Create a new [ImageTexture] from an [Image] with "flags" from [Texture].FLAG_*. + Create a new [ImageTexture] from an [Image] with "flags" from [Texture].FLAG_*. </description> </method> <method name="fix_alpha_edges"> @@ -15772,35 +15772,35 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Image"> </return> <description> - Return the [Image] of this [ImageTexture]. + Return the [Image] of this [ImageTexture]. </description> </method> <method name="get_format" qualifiers="const"> <return type="int"> </return> <description> - Return the format of the [ImageTexture], one of [Image].FORMAT_*. + Return the format of the [ImageTexture], one of [Image].FORMAT_*. </description> </method> <method name="get_lossy_storage_quality" qualifiers="const"> <return type="float"> </return> <description> - Return the storage quality for [ImageTexture].STORAGE_COMPRESS_LOSSY. + Return the storage quality for [ImageTexture].STORAGE_COMPRESS_LOSSY. </description> </method> <method name="get_storage" qualifiers="const"> <return type="int"> </return> <description> - Return the storage type. One of [ImageTexture].STORAGE_*. + Return the storage type. One of [ImageTexture].STORAGE_*. </description> </method> <method name="load"> <argument index="0" name="path" type="String"> </argument> <description> - Load an [ImageTexure]. + Load an [ImageTexure]. </description> </method> <method name="normal_to_xy"> @@ -15815,14 +15815,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="image" type="Image"> </argument> <description> - Set the [Image] of this [ImageTexture]. + Set the [Image] of this [ImageTexture]. </description> </method> <method name="set_lossy_storage_quality"> <argument index="0" name="quality" type="float"> </argument> <description> - Set the storage quality in case of [ImageTexture].STORAGE_COMPRESS_LOSSY. + Set the storage quality in case of [ImageTexture].STORAGE_COMPRESS_LOSSY. </description> </method> <method name="set_size_override"> @@ -15835,7 +15835,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="mode" type="int"> </argument> <description> - Set the storage type. One of [ImageTexture].STORAGE_*. + Set the storage type. One of [ImageTexture].STORAGE_*. </description> </method> <method name="shrink_x2_and_keep_size"> @@ -15929,24 +15929,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Input" inherits="Object" category="Core"> <brief_description> - A Singleton that deals with inputs. + A Singleton that deals with inputs. </brief_description> <description> - A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joysticks, and input actions. + A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joysticks, and input actions. </description> <methods> <method name="action_press"> <argument index="0" name="action" type="String"> </argument> <description> - This will simulate pressing the specificed action. + This will simulate pressing the specificed action. </description> </method> <method name="action_release"> <argument index="0" name="action" type="String"> </argument> <description> - If the specified action is already pressed, this will release it. + If the specified action is already pressed, this will release it. </description> </method> <method name="add_joy_mapping"> @@ -15955,14 +15955,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="update_existing" type="bool" default="false"> </argument> <description> - Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. + Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. </description> </method> <method name="get_accelerometer"> <return type="Vector3"> </return> <description> - If the device has an accelerometer, this will return the movement. + If the device has an accelerometer, this will return the movement. </description> </method> <method name="get_joy_axis"> @@ -15973,7 +15973,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="axis" type="int"> </argument> <description> - Returns the current value of the joystick axis at given index (see JOY_* constants in [@Global Scope]) + Returns the current value of the joystick axis at given index (see JOY_* constants in [@Global Scope]) </description> </method> <method name="get_joy_guid" qualifiers="const"> @@ -15982,7 +15982,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="device" type="int"> </argument> <description> - Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise. + Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise. </description> </method> <method name="get_joy_name"> @@ -15991,7 +15991,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="device" type="int"> </argument> <description> - Returns the name of the joystick at the specified device index + Returns the name of the joystick at the specified device index </description> </method> <method name="get_joy_vibration_duration"> @@ -16000,7 +16000,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="device" type="int"> </argument> <description> - Returns the duration of the current vibration effect in seconds. + Returns the duration of the current vibration effect in seconds. </description> </method> <method name="get_joy_vibration_strength"> @@ -16009,35 +16009,35 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="device" type="int"> </argument> <description> - Returns the strength of the joystick vibration: x is the strength of the weak motor, and y is the strength of the strong motor. + Returns the strength of the joystick vibration: x is the strength of the weak motor, and y is the strength of the strong motor. </description> </method> <method name="get_magnetometer"> <return type="Vector3"> </return> <description> - If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. + If the device has a magnetometer, this will return the magnetic field strength in micro-Tesla for all axes. </description> </method> <method name="get_mouse_button_mask" qualifiers="const"> <return type="int"> </return> <description> - Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together. + Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together. </description> </method> <method name="get_mouse_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the mouse mode. See the constants for more information. + Return the mouse mode. See the constants for more information. </description> </method> <method name="get_mouse_speed" qualifiers="const"> <return type="Vector2"> </return> <description> - Returns the mouse speed. + Returns the mouse speed. </description> </method> <method name="is_action_pressed"> @@ -16046,7 +16046,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="action" type="String"> </argument> <description> - Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap]. + Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap]. </description> </method> <method name="is_joy_button_pressed"> @@ -16057,7 +16057,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="button" type="int"> </argument> <description> - Returns if the joystick button at the given index is currently pressed. (see JOY_* constants in [@Global Scope]) + Returns if the joystick button at the given index is currently pressed. (see JOY_* constants in [@Global Scope]) </description> </method> <method name="is_joy_known"> @@ -16066,7 +16066,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="device" type="int"> </argument> <description> - Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them. + Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them. </description> </method> <method name="is_key_pressed"> @@ -16075,7 +16075,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="scancode" type="int"> </argument> <description> - Returns true or false depending on whether the key is pressed or not. You can pass KEY_*, which are pre-defined constants listed in [@Global Scope]. + Returns true or false depending on whether the key is pressed or not. You can pass KEY_*, which are pre-defined constants listed in [@Global Scope]. </description> </method> <method name="is_mouse_button_pressed"> @@ -16084,14 +16084,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="button" type="int"> </argument> <description> - Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON_*, which are pre-defined constants listed in [@Global Scope]. + Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON_*, which are pre-defined constants listed in [@Global Scope]. </description> </method> <method name="remove_joy_mapping"> <argument index="0" name="guid" type="String"> </argument> <description> - Removes all mappings from the internal db that match the given uid. + Removes all mappings from the internal db that match the given uid. </description> </method> <method name="set_custom_mouse_cursor"> @@ -16100,14 +16100,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="hotspot" type="Vector2" default="Vector2(0,0)"> </argument> <description> - Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. + Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. </description> </method> <method name="set_mouse_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set the mouse mode. See the constants for more information. + Set the mouse mode. See the constants for more information. </description> </method> <method name="start_joy_vibration"> @@ -16120,21 +16120,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="3" name="duration" type="float" default="0"> </argument> <description> - Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will play the vibration indefinitely). + Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will play the vibration indefinitely). </description> </method> <method name="stop_joy_vibration"> <argument index="0" name="device" type="int"> </argument> <description> - Stops the vibration of the joystick. + Stops the vibration of the joystick. </description> </method> <method name="warp_mouse_pos"> <argument index="0" name="to" type="Vector2"> </argument> <description> - Sets the mouse position to the specified vector. + Sets the mouse position to the specified vector. </description> </method> </methods> @@ -16145,7 +16145,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="connected" type="bool"> </argument> <description> - Emitted when a joystick device has been connected or disconnected + Emitted when a joystick device has been connected or disconnected </description> </signal> </signals> @@ -16173,10 +16173,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="InputEvent" category="Built-In Types"> <brief_description> - Built-in input event data. + Built-in input event data. </brief_description> <description> - Built-in input event data. InputEvent is a built-in engine datatype, given that it's passed around and used so much. Depending on it's type, the members contained can be different, so read the documentation well!. Input events can also represent actions (editable from the project settings). + Built-in input event data. InputEvent is a built-in engine datatype, given that it's passed around and used so much. Depending on it's type, the members contained can be different, so read the documentation well!. Input events can also represent actions (editable from the project settings). </description> <methods> <method name="is_action"> @@ -16185,7 +16185,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="action" type="String"> </argument> <description> - Return if this input event matches a pre-defined action, no matter the type. + Return if this input event matches a pre-defined action, no matter the type. </description> </method> <method name="is_action_pressed"> @@ -16208,14 +16208,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return if this input event is an echo event (usually for key events). + Return if this input event is an echo event (usually for key events). </description> </method> <method name="is_pressed"> <return type="bool"> </return> <description> - Return if this input event is pressed (for key, mouse, joy button or screen press events). + Return if this input event is pressed (for key, mouse, joy button or screen press events). </description> </method> <method name="set_as_action"> @@ -17022,10 +17022,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="InputMap" inherits="Object" category="Core"> <brief_description> - Singleton that manages actions. + Singleton that manages actions. </brief_description> <description> - Singleton that manages actions. InputMap has a list of the actions used in InputEvent, which can be modified. + Singleton that manages actions. InputMap has a list of the actions used in InputEvent, which can be modified. </description> <methods> <method name="action_add_event"> @@ -17034,7 +17034,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="event" type="InputEvent"> </argument> <description> - Add an [InputEvent] to action. This [InputEvent] will trigger the action. + Add an [InputEvent] to action. This [InputEvent] will trigger the action. </description> </method> <method name="action_erase_event"> @@ -17043,7 +17043,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="event" type="InputEvent"> </argument> <description> - Remove an [InputEvent] from an action. + Remove an [InputEvent] from an action. </description> </method> <method name="action_has_event"> @@ -17054,21 +17054,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="event" type="InputEvent"> </argument> <description> - Whether an action has an [InputEvent] associated with it. + Whether an action has an [InputEvent] associated with it. </description> </method> <method name="add_action"> <argument index="0" name="action" type="String"> </argument> <description> - Add an action to the [InputMap]. + Add an action to the [InputMap]. </description> </method> <method name="erase_action"> <argument index="0" name="action" type="String"> </argument> <description> - Remove an action from the [InputMap]. + Remove an action from the [InputMap]. </description> </method> <method name="event_is_action" qualifiers="const"> @@ -17087,7 +17087,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="id" type="int"> </argument> <description> - Return the action from an id. + Return the action from an id. </description> </method> <method name="get_action_id" qualifiers="const"> @@ -17096,7 +17096,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="action" type="String"> </argument> <description> - Return the id of an action. + Return the id of an action. </description> </method> <method name="get_action_list"> @@ -17105,14 +17105,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="action" type="String"> </argument> <description> - Return an [Array] of [InputEvent]s associated with an action. + Return an [Array] of [InputEvent]s associated with an action. </description> </method> <method name="get_actions"> <return type="Array"> </return> <description> - Return an [Array] of all actions in the [InputMap]. + Return an [Array] of all actions in the [InputMap]. </description> </method> <method name="has_action" qualifiers="const"> @@ -17121,12 +17121,12 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="action" type="String"> </argument> <description> - Whether this InputMap has an action with name "action". + Whether this InputMap has an action with name "action". </description> </method> <method name="load_from_globals"> <description> - Clears the [InputMap] and loads it from [Globals]. + Clears the [InputMap] and loads it from [Globals]. </description> </method> </methods> @@ -17157,10 +17157,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="IntArray" category="Built-In Types"> <brief_description> - Integer Array. + Integer Array. </brief_description> <description> - Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory. + Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory. </description> <methods> <method name="IntArray"> @@ -17169,21 +17169,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="from" type="Array"> </argument> <description> - Create from a generic array. + Create from a generic array. </description> </method> <method name="append"> <argument index="0" name="integer" type="int"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Append an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="IntArray"> </argument> <description> - Append an [IntArray] at the end of this array. + Append an [IntArray] at the end of this array. </description> </method> <method name="insert"> @@ -17194,33 +17194,33 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="integer" type="int"> </argument> <description> - Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array (so first element will now be the last). </description> </method> <method name="push_back"> <argument index="0" name="integer" type="int"> </argument> <description> - Append a value to the array. + Append a value to the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Remove an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the [IntArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Set the size of the [IntArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -17229,14 +17229,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="integer" type="int"> </argument> <description> - Change the int at the given index. + Change the int at the given index. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the array size. + Return the array size. </description> </method> </methods> @@ -17511,7 +17511,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="IntArray"> </return> <description> - Returns a list of selected indexes. + Returns a list of selected indexes. </description> </method> <method name="is_item_disabled" qualifiers="const"> @@ -17818,10 +17818,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Joint2D" inherits="Node2D" category="Core"> <brief_description> - Base node for all joint constraints in 2D physics. + Base node for all joint constraints in 2D physics. </brief_description> <description> - Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint. + Base node for all joint constraints in 2D physics. Joints take 2 bodies and apply a custom constraint. </description> <methods> <method name="get_bias" qualifiers="const"> @@ -17840,14 +17840,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="NodePath"> </return> <description> - Return the path to the A node for the joint. + Return the path to the A node for the joint. </description> </method> <method name="get_node_b" qualifiers="const"> <return type="NodePath"> </return> <description> - Return the path to the B node for the joint. + Return the path to the B node for the joint. </description> </method> <method name="set_bias"> @@ -17866,14 +17866,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="node" type="NodePath"> </argument> <description> - Set the path to the A node for the joint. Must be of type [PhysicsBody2D]. + Set the path to the A node for the joint. Must be of type [PhysicsBody2D]. </description> </method> <method name="set_node_b"> <argument index="0" name="node" type="NodePath"> </argument> <description> - Set the path to the B node for the joint. Must be of type [PhysicsBody2D]. + Set the path to the B node for the joint. Must be of type [PhysicsBody2D]. </description> </method> </methods> @@ -17882,10 +17882,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="KinematicBody" inherits="PhysicsBody" category="Core"> <brief_description> - Kinematic body 3D node. + Kinematic body 3D node. </brief_description> <description> - Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: + Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). Kinematic Characters: KinematicBody also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. </description> @@ -17894,28 +17894,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return if this body can collide with character bodies. + Return if this body can collide with character bodies. </description> </method> <method name="can_collide_with_kinematic_bodies" qualifiers="const"> <return type="bool"> </return> <description> - Return if this body can collide with kinematic bodies. + Return if this body can collide with kinematic bodies. </description> </method> <method name="can_collide_with_rigid_bodies" qualifiers="const"> <return type="bool"> </return> <description> - Return if this body can collide with rigid bodies. + Return if this body can collide with rigid bodies. </description> </method> <method name="can_collide_with_static_bodies" qualifiers="const"> <return type="bool"> </return> <description> - Return if this body can collide with static bodies. + Return if this body can collide with static bodies. </description> </method> <method name="can_teleport_to"> @@ -17924,56 +17924,56 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="position" type="Vector3"> </argument> <description> - Returns whether the KinematicBody can be teleported to the destination given as an argument, checking all collision shapes of the body against potential colliders at the destination. + Returns whether the KinematicBody can be teleported to the destination given as an argument, checking all collision shapes of the body against potential colliders at the destination. </description> </method> <method name="get_collider" qualifiers="const"> <return type="Object"> </return> <description> - Return the body that collided with this one. + Return the body that collided with this one. </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int"> </return> <description> - Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding]. + Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding]. </description> </method> <method name="get_collider_velocity" qualifiers="const"> <return type="Vector3"> </return> <description> - Return the velocity of the body that collided with this one. + Return the velocity of the body that collided with this one. </description> </method> <method name="get_collision_margin" qualifiers="const"> <return type="float"> </return> <description> - Return the collision margin for this object. + Return the collision margin for this object. </description> </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector3"> </return> <description> - Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. + Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. </description> </method> <method name="get_collision_pos" qualifiers="const"> <return type="Vector3"> </return> <description> - Return the point in space where the body is touching another. If there is no collision, this method will return (0,0,0), so collisions must be checked first with [method is_colliding]. + Return the point in space where the body is touching another. If there is no collision, this method will return (0,0,0), so collisions must be checked first with [method is_colliding]. </description> </method> <method name="is_colliding" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the body is colliding with another. + Return whether the body is colliding with another. </description> </method> <method name="move"> @@ -17982,7 +17982,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="rel_vec" type="Vector3"> </argument> <description> - Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. + Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. </description> </method> <method name="move_to"> @@ -17991,42 +17991,42 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="position" type="Vector3"> </argument> <description> - Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped. + Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped. </description> </method> <method name="set_collide_with_character_bodies"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set if this body should collide with character bodies. + Set if this body should collide with character bodies. </description> </method> <method name="set_collide_with_kinematic_bodies"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set if this body should collide with kinematic bodies. + Set if this body should collide with kinematic bodies. </description> </method> <method name="set_collide_with_rigid_bodies"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set if this body should collide with rigid bodies. + Set if this body should collide with rigid bodies. </description> </method> <method name="set_collide_with_static_bodies"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set if this body should collide with static bodies. + Set if this body should collide with static bodies. </description> </method> <method name="set_collision_margin"> <argument index="0" name="pixels" type="float"> </argument> <description> - Set the collision margin for this object. A collision margin is an amount that all shapes will grow when computing collisions, to account for numerical imprecision. + Set the collision margin for this object. A collision margin is an amount that all shapes will grow when computing collisions, to account for numerical imprecision. </description> </method> </methods> @@ -18035,10 +18035,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="KinematicBody2D" inherits="PhysicsBody2D" category="Core"> <brief_description> - Kinematic body 2D node. + Kinematic body 2D node. </brief_description> <description> - Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: + Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all (to other types of bodies, such a character or a rigid body, these are the same as a static body). They have however, two main uses: Simulated Motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with process mode set to fixed), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc). Kinematic Characters: KinematicBody2D also has an api for moving objects (the [method move] method) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics. </description> @@ -18047,63 +18047,63 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Object"> </return> <description> - Return the body that collided with this one. + Return the body that collided with this one. </description> </method> <method name="get_collider_metadata" qualifiers="const"> <return type="Variant"> </return> <description> - Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Additionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata]. + Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Additionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata]. </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int"> </return> <description> - Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding]. + Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with [method is_colliding]. </description> </method> <method name="get_collider_velocity" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the velocity of the body that collided with this one. + Return the velocity of the body that collided with this one. </description> </method> <method name="get_collision_margin" qualifiers="const"> <return type="float"> </return> <description> - Return the collision margin for this object. + Return the collision margin for this object. </description> </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. + Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. </description> </method> <method name="get_collision_pos" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with [method is_colliding]. + Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with [method is_colliding]. </description> </method> <method name="get_travel" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the last movement done by the body. + Return the last movement done by the body. </description> </method> <method name="is_colliding" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the body is colliding with another. + Return whether the body is colliding with another. </description> </method> <method name="move"> @@ -18112,7 +18112,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="rel_vec" type="Vector2"> </argument> <description> - Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. + Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. </description> </method> <method name="move_to"> @@ -18121,19 +18121,19 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="position" type="Vector2"> </argument> <description> - Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped. + Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped. </description> </method> <method name="revert_motion"> <description> - Undo the last movement done by the body. + Undo the last movement done by the body. </description> </method> <method name="set_collision_margin"> <argument index="0" name="pixels" type="float"> </argument> <description> - Set the collision margin for this object. A collision margin is an amount (in pixels) that all shapes will grow when computing collisions, to account for numerical imprecision. + Set the collision margin for this object. A collision margin is an amount (in pixels) that all shapes will grow when computing collisions, to account for numerical imprecision. </description> </method> <method name="test_move"> @@ -18142,7 +18142,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="rel_vec" type="Vector2"> </argument> <description> - Return true if there would be a collision if the body moved in the given direction. + Return true if there would be a collision if the body moved in the given direction. </description> </method> </methods> @@ -18151,171 +18151,171 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Label" inherits="Control" category="Core"> <brief_description> - Control that displays formatted text. + Control that displays formatted text. </brief_description> <description> - Label is a control that displays formatted text, optionally autowrapping it to the [Control] area. It inherits from range to be able to scroll wrapped text vertically. + Label is a control that displays formatted text, optionally autowrapping it to the [Control] area. It inherits from range to be able to scroll wrapped text vertically. </description> <methods> <method name="get_align" qualifiers="const"> <return type="int"> </return> <description> - Return the alignment mode (any of the ALIGN_* enumeration values). + Return the alignment mode (any of the ALIGN_* enumeration values). </description> </method> <method name="get_line_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of lines. + Return the amount of lines. </description> </method> <method name="get_line_height" qualifiers="const"> <return type="int"> </return> <description> - Return the height of a line. + Return the height of a line. </description> </method> <method name="get_lines_skipped" qualifiers="const"> <return type="int"> </return> <description> - Return the the number of lines to skipped before displaying. + Return the the number of lines to skipped before displaying. </description> </method> <method name="get_max_lines_visible" qualifiers="const"> <return type="int"> </return> <description> - Return the restricted number of lines to display. Returns -1 if unrestricted. + Return the restricted number of lines to display. Returns -1 if unrestricted. </description> </method> <method name="get_percent_visible" qualifiers="const"> <return type="float"> </return> <description> - Return the restricted number of characters to display (as a percentage of the total text). + Return the restricted number of characters to display (as a percentage of the total text). </description> </method> <method name="get_text" qualifiers="const"> <return type="String"> </return> <description> - Return the label text. Text can contain newlines. + Return the label text. Text can contain newlines. </description> </method> <method name="get_total_character_count" qualifiers="const"> <return type="int"> </return> <description> - Return the total length of the text. + Return the total length of the text. </description> </method> <method name="get_valign" qualifiers="const"> <return type="int"> </return> <description> - Return the vertical alignment mode (any of the VALIGN_* enumeration values). + Return the vertical alignment mode (any of the VALIGN_* enumeration values). </description> </method> <method name="get_visible_characters" qualifiers="const"> <return type="int"> </return> <description> - Return the restricted number of characters to display. Returns -1 if unrestricted. + Return the restricted number of characters to display. Returns -1 if unrestricted. </description> </method> <method name="has_autowrap" qualifiers="const"> <return type="bool"> </return> <description> - Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]). + Return the state of the [i]autowrap[/i] mode (see [method set_autowrap]). </description> </method> <method name="is_clipping_text" qualifiers="const"> <return type="bool"> </return> <description> - Return true if text would be cut off if it is too wide. + Return true if text would be cut off if it is too wide. </description> </method> <method name="is_uppercase" qualifiers="const"> <return type="bool"> </return> <description> - Return true if text is displayed in all capitals. + Return true if text is displayed in all capitals. </description> </method> <method name="set_align"> <argument index="0" name="align" type="int"> </argument> <description> - Sets the alignment mode to any of the ALIGN_* enumeration values. + Sets the alignment mode to any of the ALIGN_* enumeration values. </description> </method> <method name="set_autowrap"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set [i]autowrap[/i] mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows. + Set [i]autowrap[/i] mode. When enabled, autowrap will fit text to the control width, breaking sentences when they exceed the available horizontal space. When disabled, the label minimum width becomes the width of the longest row, and the minimum height large enough to fit all rows. </description> </method> <method name="set_clip_text"> <argument index="0" name="enable" type="bool"> </argument> <description> - Cuts off the rest of the text if it is too wide. + Cuts off the rest of the text if it is too wide. </description> </method> <method name="set_lines_skipped"> <argument index="0" name="lines_skipped" type="int"> </argument> <description> - Sets the number of lines to skip before displaying. Useful for scrolling text. + Sets the number of lines to skip before displaying. Useful for scrolling text. </description> </method> <method name="set_max_lines_visible"> <argument index="0" name="lines_visible" type="int"> </argument> <description> - Restricts the number of lines to display. Set to -1 to disable. + Restricts the number of lines to display. Set to -1 to disable. </description> </method> <method name="set_percent_visible"> <argument index="0" name="percent_visible" type="float"> </argument> <description> - Restricts the number of characters to display (as a percentage of the total text). + Restricts the number of characters to display (as a percentage of the total text). </description> </method> <method name="set_text"> <argument index="0" name="text" type="String"> </argument> <description> - Set the label text. Text can contain newlines. + Set the label text. Text can contain newlines. </description> </method> <method name="set_uppercase"> <argument index="0" name="enable" type="bool"> </argument> <description> - Display text in all capitals. + Display text in all capitals. </description> </method> <method name="set_valign"> <argument index="0" name="valign" type="int"> </argument> <description> - Sets the vertical alignment mode to any of the VALIGN_* enumeration values. + Sets the vertical alignment mode to any of the VALIGN_* enumeration values. </description> </method> <method name="set_visible_characters"> <argument index="0" name="amount" type="int"> </argument> <description> - Restricts the number of characters to display. Set to -1 to disable. + Restricts the number of characters to display. Set to -1 to disable. </description> </method> </methods> @@ -18364,10 +18364,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="LargeTexture" inherits="Texture" category="Core"> <brief_description> - A Texture capable of storing many smaller Textures with offsets. + A Texture capable of storing many smaller Textures with offsets. </brief_description> <description> - A Texture capable of storing many smaller Textures with offsets. + A Texture capable of storing many smaller Textures with offsets. You can dynamically add pieces(Textures) to this fLargeTexture] using different offsets. </description> <methods> @@ -18379,19 +18379,19 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="texture" type="Texture"> </argument> <description> - Add another [Texture] to this [LargeTexture], starting on offset "ofs". + Add another [Texture] to this [LargeTexture], starting on offset "ofs". </description> </method> <method name="clear"> <description> - Clear the [LargeTexture]. + Clear the [LargeTexture]. </description> </method> <method name="get_piece_count" qualifiers="const"> <return type="int"> </return> <description> - Return the number of pieces currently in this [LargeTexture]. + Return the number of pieces currently in this [LargeTexture]. </description> </method> <method name="get_piece_offset" qualifiers="const"> @@ -18400,7 +18400,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="idx" type="int"> </argument> <description> - Return the offset of the piece with index "idx". + Return the offset of the piece with index "idx". </description> </method> <method name="get_piece_texture" qualifiers="const"> @@ -18409,7 +18409,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="idx" type="int"> </argument> <description> - Return the [Texture] of the piece with index "idx". + Return the [Texture] of the piece with index "idx". </description> </method> <method name="set_piece_offset"> @@ -18418,7 +18418,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="ofs" type="Vector2"> </argument> <description> - Set the offset of the piece with index "idx" to "ofs". + Set the offset of the piece with index "idx" to "ofs". </description> </method> <method name="set_piece_texture"> @@ -18427,14 +18427,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="texture" type="Texture"> </argument> <description> - Set the [Texture] of the piece with index "idx" to "ofs". + Set the [Texture] of the piece with index "idx" to "ofs". </description> </method> <method name="set_size"> <argument index="0" name="size" type="Vector2"> </argument> <description> - Set the size of this [LargeTexture]. + Set the size of this [LargeTexture]. </description> </method> </methods> @@ -18443,10 +18443,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Light" inherits="VisualInstance" category="Core"> <brief_description> - Provides a base class for different kinds of light nodes. + Provides a base class for different kinds of light nodes. </brief_description> <description> - Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting. + Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting. </description> <methods> <method name="get_bake_mode" qualifiers="const"> @@ -18585,262 +18585,262 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Light2D" inherits="Node2D" category="Core"> <brief_description> - Node that casts light in a 2D environment. + Node that casts light in a 2D environment. </brief_description> <description> - Node that casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask. + Node that casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask. </description> <methods> <method name="get_color" qualifiers="const"> <return type="Color"> </return> <description> - Return the color of the Light2D. + Return the color of the Light2D. </description> </method> <method name="get_energy" qualifiers="const"> <return type="float"> </return> <description> - Return the energy value of the Light2D. + Return the energy value of the Light2D. </description> </method> <method name="get_height" qualifiers="const"> <return type="float"> </return> <description> - Return the height of the Light2D. Used with 2D normalmapping. + Return the height of the Light2D. Used with 2D normalmapping. </description> </method> <method name="get_item_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the item mask of the Light2D. + Return the item mask of the Light2D. </description> </method> <method name="get_item_shadow_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the item shadow mask of the Light2D. + Return the item shadow mask of the Light2D. </description> </method> <method name="get_layer_range_max" qualifiers="const"> <return type="int"> </return> <description> - Set the maximum layer value of objects of the scene that are affected by the Light2D. + Set the maximum layer value of objects of the scene that are affected by the Light2D. </description> </method> <method name="get_layer_range_min" qualifiers="const"> <return type="int"> </return> <description> - Get the minimum layer value of objects of the scene that are affected by the Light2D. + Get the minimum layer value of objects of the scene that are affected by the Light2D. </description> </method> <method name="get_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the current mode set to the Light2D. + Return the current mode set to the Light2D. </description> </method> <method name="get_shadow_buffer_size" qualifiers="const"> <return type="int"> </return> <description> - Return the shadow buffer size. + Return the shadow buffer size. </description> </method> <method name="get_shadow_color" qualifiers="const"> <return type="Color"> </return> <description> - Return the color of casted shadows for this Light2D. + Return the color of casted shadows for this Light2D. </description> </method> <method name="get_shadow_esm_multiplier" qualifiers="const"> <return type="float"> </return> <description> - Return the Exponential Shadow Multiplier (ESM) value of the Light2D. + Return the Exponential Shadow Multiplier (ESM) value of the Light2D. </description> </method> <method name="get_texture" qualifiers="const"> <return type="Object"> </return> <description> - Return the texture of the Light2D. + Return the texture of the Light2D. </description> </method> <method name="get_texture_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the offset of the light texture. + Return the offset of the light texture. </description> </method> <method name="get_texture_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the scale value of the light texture. + Return the scale value of the light texture. </description> </method> <method name="get_z_range_max" qualifiers="const"> <return type="int"> </return> <description> - Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D. + Get the maximum Z value that objects of the scene can be in order to be affected by the Light2D. </description> </method> <method name="get_z_range_min" qualifiers="const"> <return type="int"> </return> <description> - Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. + Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. </description> </method> <method name="is_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the Light2D is enabled, false if it is not. + Return true if the Light2D is enabled, false if it is not. </description> </method> <method name="is_shadow_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return true if shadow casting is enabled for this Light2D, else return false. + Return true if shadow casting is enabled for this Light2D, else return false. </description> </method> <method name="set_color"> <argument index="0" name="color" type="Color"> </argument> <description> - Set the color of the Light2D. + Set the color of the Light2D. </description> </method> <method name="set_enabled"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Switches the Light2D on or off, depending on the 'enabled' parameter. + Switches the Light2D on or off, depending on the 'enabled' parameter. </description> </method> <method name="set_energy"> <argument index="0" name="energy" type="float"> </argument> <description> - Set the energy value of the Light2D. The bigger the value, the stronger the light. + Set the energy value of the Light2D. The bigger the value, the stronger the light. </description> </method> <method name="set_height"> <argument index="0" name="height" type="float"> </argument> <description> - Set the height of the Light2D. Used with 2D normalmapping. + Set the height of the Light2D. Used with 2D normalmapping. </description> </method> <method name="set_item_mask"> <argument index="0" name="item_mask" type="int"> </argument> <description> - Set the item mask of the Light2D to 'item_mask' value. + Set the item mask of the Light2D to 'item_mask' value. </description> </method> <method name="set_item_shadow_mask"> <argument index="0" name="item_shadow_mask" type="int"> </argument> <description> - Set the item shadow mask to 'item_shadow_mask' value. + Set the item shadow mask to 'item_shadow_mask' value. </description> </method> <method name="set_layer_range_max"> <argument index="0" name="layer" type="int"> </argument> <description> - Set the maximum layer value of objects of the scene that are affected by the Light2D. + Set the maximum layer value of objects of the scene that are affected by the Light2D. </description> </method> <method name="set_layer_range_min"> <argument index="0" name="layer" type="int"> </argument> <description> - Set the minimum layer value of objects of the scene that are affected by the Light2D. + Set the minimum layer value of objects of the scene that are affected by the Light2D. </description> </method> <method name="set_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set the behaviour mode of the Light2D. Use constants defined in the constants section. + Set the behaviour mode of the Light2D. Use constants defined in the constants section. </description> </method> <method name="set_shadow_buffer_size"> <argument index="0" name="size" type="int"> </argument> <description> - Set the shadow buffer size. + Set the shadow buffer size. </description> </method> <method name="set_shadow_color"> <argument index="0" name="shadow_color" type="Color"> </argument> <description> - Set the color of casted shadows for this Light2D. + Set the color of casted shadows for this Light2D. </description> </method> <method name="set_shadow_enabled"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. + Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. </description> </method> <method name="set_shadow_esm_multiplier"> <argument index="0" name="multiplier" type="float"> </argument> <description> - Set the Exponential Shadow Multiplier (ESM) value of the Light2D. + Set the Exponential Shadow Multiplier (ESM) value of the Light2D. </description> </method> <method name="set_texture"> <argument index="0" name="texture" type="Object"> </argument> <description> - Set the texture of the Light2D. + Set the texture of the Light2D. </description> </method> <method name="set_texture_offset"> <argument index="0" name="texture_offset" type="Vector2"> </argument> <description> - Set the offset of the light texture. + Set the offset of the light texture. </description> </method> <method name="set_texture_scale"> <argument index="0" name="texture_scale" type="float"> </argument> <description> - Set the scale value of the light texture. + Set the scale value of the light texture. </description> </method> <method name="set_z_range_max"> <argument index="0" name="z" type="int"> </argument> <description> - Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D. + Set the maximum Z value that objects of the scene can be in order to be affected by the Light2D. </description> </method> <method name="set_z_range_min"> <argument index="0" name="z" type="int"> </argument> <description> - Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. + Set the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. </description> </method> </methods> @@ -18861,38 +18861,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="LightOccluder2D" inherits="Node2D" category="Core"> <brief_description> - Occludes light cast by a Light2D, thus casting shadows. + Occludes light cast by a Light2D, thus casting shadows. </brief_description> <description> - Occludes light cast by a Light2D, thus casting shadows. The LightOccluder2D must be provided with a shape (see OccluderPolygon2D) that allows the shadow to be computed. This shape affects the resulting shadow, while the shape of the representating asset shadowed does not actually affect shadows. + Occludes light cast by a Light2D, thus casting shadows. The LightOccluder2D must be provided with a shape (see OccluderPolygon2D) that allows the shadow to be computed. This shape affects the resulting shadow, while the shape of the representating asset shadowed does not actually affect shadows. </description> <methods> <method name="get_occluder_light_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the light mask of the LightOccluder2D. + Return the light mask of the LightOccluder2D. </description> </method> <method name="get_occluder_polygon" qualifiers="const"> <return type="OccluderPolygon2D"> </return> <description> - Return the OccluderPolygon2D that defines the LightOccluder2D. + Return the OccluderPolygon2D that defines the LightOccluder2D. </description> </method> <method name="set_occluder_light_mask"> <argument index="0" name="mask" type="int"> </argument> <description> - Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s). + Set the LightOccluder2D light mask. The LightOccluder2D will cast shadows only from Light2Ds that belong to the same light mask(s). </description> </method> <method name="set_occluder_polygon"> <argument index="0" name="polygon" type="OccluderPolygon2D"> </argument> <description> - Set the OccluderPolygon2D that defines the LightOccluder2D. + Set the OccluderPolygon2D that defines the LightOccluder2D. </description> </method> </methods> @@ -18901,50 +18901,50 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="LineEdit" inherits="Control" category="Core"> <brief_description> - Control that provides single line string editing. + Control that provides single line string editing. </brief_description> <description> - LineEdit provides a single line string editor, used for text fields. + LineEdit provides a single line string editor, used for text fields. </description> <methods> <method name="append_at_cursor"> <argument index="0" name="text" type="String"> </argument> <description> - Append text at cursor, scrolling the [LineEdit] when needed. + Append text at cursor, scrolling the [LineEdit] when needed. </description> </method> <method name="clear"> <description> - Clear the [LineEdit] text. + Clear the [LineEdit] text. </description> </method> <method name="cursor_get_blink_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Gets whether the line edit caret is blinking. + Gets whether the line edit caret is blinking. </description> </method> <method name="cursor_get_blink_speed" qualifiers="const"> <return type="float"> </return> <description> - Gets the line edit caret blink speed. + Gets the line edit caret blink speed. </description> </method> <method name="cursor_set_blink_enabled"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set the line edit caret to blink. + Set the line edit caret to blink. </description> </method> <method name="cursor_set_blink_speed"> <argument index="0" name="blink_speed" type="float"> </argument> <description> - Set the line edit caret blink speed. Cannot be less then or equal to 0. + Set the line edit caret blink speed. Cannot be less then or equal to 0. </description> </method> <method name="get_align" qualifiers="const"> @@ -18957,14 +18957,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Return the cursor position inside the [LineEdit]. + Return the cursor position inside the [LineEdit]. </description> </method> <method name="get_max_length" qualifiers="const"> <return type="int"> </return> <description> - Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists. + Return the maximum amount of characters the [LineEdit] can edit. If 0 is returned, no limit exists. </description> </method> <method name="get_menu" qualifiers="const"> @@ -18989,21 +18989,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="String"> </return> <description> - Return the text in the [LineEdit]. + Return the text in the [LineEdit]. </description> </method> <method name="is_editable" qualifiers="const"> <return type="bool"> </return> <description> - Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]). + Return the [i]editable[/i] status of the [LineEdit] (see [method set_editable]). </description> </method> <method name="is_secret" qualifiers="const"> <return type="bool"> </return> <description> - Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]). + Return the [i]secret[/i] status of the [LineEdit] (see [method set_secret]). </description> </method> <method name="menu_option"> @@ -19022,7 +19022,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> <method name="select_all"> <description> - Select the whole string. + Select the whole string. </description> </method> <method name="set_align"> @@ -19035,21 +19035,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="pos" type="int"> </argument> <description> - Set the cursor position inside the [LineEdit], causing it to scroll if needed. + Set the cursor position inside the [LineEdit], causing it to scroll if needed. </description> </method> <method name="set_editable"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added. + Set the [i]editable[/i] status of the [LineEdit]. When disabled, existing text can't be modified and new text can't be added. </description> </method> <method name="set_max_length"> <argument index="0" name="chars" type="int"> </argument> <description> - Set the maximum amount of characters the [LineEdit] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. + Set the maximum amount of characters the [LineEdit] can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit. </description> </method> <method name="set_placeholder"> @@ -19068,14 +19068,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*". + Set the [i]secret[/i] status of the [LineEdit]. When enabled, every character is displayed as "*". </description> </method> <method name="set_text"> <argument index="0" name="text" type="String"> </argument> <description> - Set the text in the [LineEdit], clearing the existing one and the selection. + Set the text in the [LineEdit], clearing the existing one and the selection. </description> </method> </methods> @@ -19084,14 +19084,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="text" type="String"> </argument> <description> - When the text changes, this signal is emitted. + When the text changes, this signal is emitted. </description> </signal> <signal name="text_entered"> <argument index="0" name="text" type="String"> </argument> <description> - This signal is emitted when the user presses KEY_ENTER on the [LineEdit]. This signal is often used as an alternate confirmation mechanism in dialogs. + This signal is emitted when the user presses KEY_ENTER on the [LineEdit]. This signal is often used as an alternate confirmation mechanism in dialogs. </description> </signal> </signals> @@ -19142,38 +19142,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="LineShape2D" inherits="Shape2D" category="Core"> <brief_description> - Line shape for 2D collision objects. + Line shape for 2D collision objects. </brief_description> <description> - Line shape for 2D collision objects. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. + Line shape for 2D collision objects. It works like a 2D plane and will not allow any body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame. </description> <methods> <method name="get_d" qualifiers="const"> <return type="float"> </return> <description> - Return the line distance from the origin. + Return the line distance from the origin. </description> </method> <method name="get_normal" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the line normal. + Return the line normal. </description> </method> <method name="set_d"> <argument index="0" name="d" type="float"> </argument> <description> - Set the line distance from the origin. + Set the line distance from the origin. </description> </method> <method name="set_normal"> <argument index="0" name="normal" type="Vector2"> </argument> <description> - Set the line normal. + Set the line normal. </description> </method> </methods> @@ -19182,38 +19182,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="LinkButton" inherits="BaseButton" category="Core"> <brief_description> - Simple button used to represent a link to some resource + Simple button used to represent a link to some resource </brief_description> <description> - This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page). + This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page). </description> <methods> <method name="get_text" qualifiers="const"> <return type="String"> </return> <description> - Returns the text of the button. + Returns the text of the button. </description> </method> <method name="get_underline_mode" qualifiers="const"> <return type="int"> </return> <description> - Returns the underline mode for this button. + Returns the underline mode for this button. </description> </method> <method name="set_text"> <argument index="0" name="text" type="String"> </argument> <description> - Sets the text of the button. + Sets the text of the button. </description> </method> <method name="set_underline_mode"> <argument index="0" name="underline_mode" type="int"> </argument> <description> - Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section). + Sets the underline mode for this button, the argument must be one of the [LinkButton] constants (see constants section). </description> </method> </methods> @@ -19270,10 +19270,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="MainLoop" inherits="Object" category="Core"> <brief_description> - Main loop is the abstract main loop base class. + Main loop is the abstract main loop base class. </brief_description> <description> - Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [MainLoop] has to be provided to OS, else the application will exit. This happens automatically (and a [SceneTree] is created), unless a main [Script] is supplied, which may or not create and return a [MainLoop]. + Main loop is the abstract main loop base class. All other main loop classes are derived from it. Upon application start, a [MainLoop] has to be provided to OS, else the application will exit. This happens automatically (and a [SceneTree] is created), unless a main [Script] is supplied, which may or not create and return a [MainLoop]. </description> <methods> <method name="_drop_files" qualifiers="virtual"> @@ -19372,10 +19372,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="MarginContainer" inherits="Container" category="Core"> <brief_description> - Simple margin container. + Simple margin container. </brief_description> <description> - Simple margin container. Adds a left margin to anything contained. + Simple margin container. Adds a left margin to anything contained. </description> <methods> </methods> @@ -19452,17 +19452,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Material" inherits="Resource" category="Core"> <brief_description> - Abstract base [Resource] for coloring and shading geometry. + Abstract base [Resource] for coloring and shading geometry. </brief_description> <description> - Material is a base [Resource] used for coloring and shading geometry. All materials inherit from it and almost all [VisualInstance] derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. + Material is a base [Resource] used for coloring and shading geometry. All materials inherit from it and almost all [VisualInstance] derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. </description> <methods> <method name="get_blend_mode" qualifiers="const"> <return type="int"> </return> <description> - Return blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations. + Return blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations. </description> </method> <method name="get_depth_draw_mode" qualifiers="const"> @@ -19477,21 +19477,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="flag" type="int"> </argument> <description> - Return a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. + Return a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. </description> </method> <method name="get_line_width" qualifiers="const"> <return type="float"> </return> <description> - Return the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). + Return the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). </description> </method> <method name="set_blend_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations. + Set blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations. </description> </method> <method name="set_depth_draw_mode"> @@ -19506,14 +19506,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="enable" type="bool"> </argument> <description> - Set a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. + Set a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. </description> </method> <method name="set_line_width"> <argument index="0" name="width" type="float"> </argument> <description> - Set the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). + Set the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). </description> </method> </methods> @@ -19584,10 +19584,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Matrix3" category="Built-In Types"> <brief_description> - 3x3 matrix datatype. + 3x3 matrix datatype. </brief_description> <description> - 3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z. Can also be accessed as array of 3D vectors. Almost always used as orthogonal basis for a [Transform]. + 3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z. Can also be accessed as array of 3D vectors. Almost always used as orthogonal basis for a [Transform]. </description> <methods> <method name="Matrix3"> @@ -19596,7 +19596,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="from" type="Quat"> </argument> <description> - Create a matrix from a quaternion. + Create a matrix from a quaternion. </description> </method> <method name="Matrix3"> @@ -19607,7 +19607,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="phi" type="float"> </argument> <description> - Create a matrix from an axis vector and an angle. + Create a matrix from an axis vector and an angle. </description> </method> <method name="Matrix3"> @@ -19620,21 +19620,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="z_axis" type="Vector3"> </argument> <description> - Create a matrix from 3 axis vectors. + Create a matrix from 3 axis vectors. </description> </method> <method name="determinant"> <return type="float"> </return> <description> - Return the determinant of the matrix. + Return the determinant of the matrix. </description> </method> <method name="get_euler"> <return type="Vector3"> </return> <description> - Return euler angles from the matrix. + Return euler angles from the matrix. </description> </method> <method name="get_orthogonal_index"> @@ -19653,14 +19653,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Matrix3"> </return> <description> - Return the affine inverse of the matrix. + Return the affine inverse of the matrix. </description> </method> <method name="orthonormalized"> <return type="Matrix3"> </return> <description> - Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error). + Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error). </description> </method> <method name="rotated"> @@ -19671,7 +19671,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="phi" type="float"> </argument> <description> - Return the rotated version of the matrix, by a given axis and angle. + Return the rotated version of the matrix, by a given axis and angle. </description> </method> <method name="scaled"> @@ -19680,7 +19680,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="scale" type="Vector3"> </argument> <description> - Return the scaled version of the matrix, by a 3D scale. + Return the scaled version of the matrix, by a 3D scale. </description> </method> <method name="tdotx"> @@ -19689,7 +19689,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="with" type="Vector3"> </argument> <description> - Transposed dot product with the x axis of the matrix. + Transposed dot product with the x axis of the matrix. </description> </method> <method name="tdoty"> @@ -19698,7 +19698,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="with" type="Vector3"> </argument> <description> - Transposed dot product with the y axis of the matrix. + Transposed dot product with the y axis of the matrix. </description> </method> <method name="tdotz"> @@ -19707,14 +19707,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="with" type="Vector3"> </argument> <description> - Transposed dot product with the z axis of the matrix. + Transposed dot product with the z axis of the matrix. </description> </method> <method name="transposed"> <return type="Matrix3"> </return> <description> - Return the transposed version of the matrix. + Return the transposed version of the matrix. </description> </method> <method name="xform"> @@ -19723,7 +19723,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="v" type="Vector3"> </argument> <description> - Return a vector transformed by the matrix and return it. + Return a vector transformed by the matrix and return it. </description> </method> <method name="xform_inv"> @@ -19732,7 +19732,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="v" type="Vector3"> </argument> <description> - Return a vector transformed by the transposed matrix and return it. + Return a vector transformed by the transposed matrix and return it. </description> </method> </methods> @@ -19749,10 +19749,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Matrix32" category="Built-In Types"> <brief_description> - 3x2 Matrix for 2D transforms. + 3x2 Matrix for 2D transforms. </brief_description> <description> - 3x2 Matrix for 2D transforms. + 3x2 Matrix for 2D transforms. </description> <methods> <method name="Matrix32"> @@ -19901,17 +19901,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="MenuButton" inherits="Button" category="Core"> <brief_description> - Special button that brings up a [PopupMenu] when clicked. + Special button that brings up a [PopupMenu] when clicked. </brief_description> <description> - Special button that brings up a [PopupMenu] when clicked. That's pretty much all it does, as it's just a helper class when building GUIs. + Special button that brings up a [PopupMenu] when clicked. That's pretty much all it does, as it's just a helper class when building GUIs. </description> <methods> <method name="get_popup"> <return type="PopupMenu"> </return> <description> - Return the [PopupMenu] contained in this button. + Return the [PopupMenu] contained in this button. </description> </method> </methods> @@ -19950,10 +19950,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Mesh" inherits="Resource" category="Core"> <brief_description> - A [Resource] that contains vertex-array based geometry. + A [Resource] that contains vertex-array based geometry. </brief_description> <description> - Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. + Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. </description> <methods> <method name="add_morph_target"> @@ -19972,7 +19972,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="3" name="alphasort" type="bool" default="false"> </argument> <description> - Create a new surface ([method get_surface_count] that will become surf_idx for this. + Create a new surface ([method get_surface_count] that will become surf_idx for this. Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed. </description> @@ -20015,7 +20015,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Return the amount of surfaces that the [Mesh] holds. + Return the amount of surfaces that the [Mesh] holds. </description> </method> <method name="regen_normalmaps"> @@ -20040,7 +20040,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the length in indices of the index array in the requested surface (see [method add_surface]). + Return the length in indices of the index array in the requested surface (see [method add_surface]). </description> </method> <method name="surface_get_array_len" qualifiers="const"> @@ -20049,7 +20049,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the length in vertices of the vertex array in the requested surface (see [method add_surface]). + Return the length in vertices of the vertex array in the requested surface (see [method add_surface]). </description> </method> <method name="surface_get_format" qualifiers="const"> @@ -20058,7 +20058,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the format mask of the requested surface (see [method add_surface]). + Return the format mask of the requested surface (see [method add_surface]). </description> </method> <method name="surface_get_material" qualifiers="const"> @@ -20067,7 +20067,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return a [Material] in a given surface. Surface is rendered using this material. + Return a [Material] in a given surface. Surface is rendered using this material. </description> </method> <method name="surface_get_name" qualifiers="const"> @@ -20084,14 +20084,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="surf_idx" type="int"> </argument> <description> - Return the primitive type of the requested surface (see [method add_surface]). + Return the primitive type of the requested surface (see [method add_surface]). </description> </method> <method name="surface_remove"> <argument index="0" name="surf_idx" type="int"> </argument> <description> - Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. + Remove a surface at position surf_idx, shifting greater surfaces one surf_idx slot down. </description> </method> <method name="surface_set_material"> @@ -20100,7 +20100,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="material" type="Material"> </argument> <description> - Set a [Material] for a given surface. Surface will be rendered using this material. + Set a [Material] for a given surface. Surface will be rendered using this material. </description> </method> <method name="surface_set_name"> @@ -20498,10 +20498,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="MeshInstance" inherits="GeometryInstance" category="Core"> <brief_description> - Node that instances meshes into a scenario. + Node that instances meshes into a scenario. </brief_description> <description> - MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. + MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. </description> <methods> <method name="create_convex_collision"> @@ -20510,21 +20510,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> <method name="create_trimesh_collision"> <description> - This helper creates a [StaticBody] child [Node] using the mesh geometry as collision. It's mainly used for testing. + This helper creates a [StaticBody] child [Node] using the mesh geometry as collision. It's mainly used for testing. </description> </method> <method name="get_aabb" qualifiers="const"> <return type="AABB"> </return> <description> - Return the AABB of the mesh, in local coordinates. + Return the AABB of the mesh, in local coordinates. </description> </method> <method name="get_mesh" qualifiers="const"> <return type="Mesh"> </return> <description> - Return the current [Mesh] resource for the instance. + Return the current [Mesh] resource for the instance. </description> </method> <method name="get_skeleton_path"> @@ -20537,7 +20537,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="mesh" type="Mesh"> </argument> <description> - Set the [Mesh] resource for the instance. + Set the [Mesh] resource for the instance. </description> </method> <method name="set_skeleton_path"> @@ -20552,29 +20552,29 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="MeshLibrary" inherits="Resource" category="Core"> <brief_description> - Library of meshes. + Library of meshes. </brief_description> <description> - Library of meshes. Contains a list of [Mesh] resources, each with name and ID. Useful for GridMap or painting Terrain. + Library of meshes. Contains a list of [Mesh] resources, each with name and ID. Useful for GridMap or painting Terrain. </description> <methods> <method name="clear"> <description> - Clear the library. + Clear the library. </description> </method> <method name="create_item"> <argument index="0" name="id" type="int"> </argument> <description> - Create a new item in the library, supplied an id. + Create a new item in the library, supplied an id. </description> </method> <method name="get_item_list" qualifiers="const"> <return type="IntArray"> </return> <description> - Return the list of items. + Return the list of items. </description> </method> <method name="get_item_mesh" qualifiers="const"> @@ -20583,7 +20583,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="id" type="int"> </argument> <description> - Return the mesh of the item. + Return the mesh of the item. </description> </method> <method name="get_item_name" qualifiers="const"> @@ -20592,7 +20592,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="id" type="int"> </argument> <description> - Return the name of the item. + Return the name of the item. </description> </method> <method name="get_item_navmesh" qualifiers="const"> @@ -20615,14 +20615,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Get an unused id for a new item. + Get an unused id for a new item. </description> </method> <method name="remove_item"> <argument index="0" name="id" type="int"> </argument> <description> - Remove the item. + Remove the item. </description> </method> <method name="set_item_mesh"> @@ -20631,7 +20631,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="mesh" type="Mesh"> </argument> <description> - Set the mesh of the item. + Set the mesh of the item. </description> </method> <method name="set_item_name"> @@ -20640,7 +20640,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="name" type="String"> </argument> <description> - Set the name of the item. + Set the name of the item. </description> </method> <method name="set_item_navmesh"> @@ -20665,10 +20665,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="MultiMesh" inherits="Resource" category="Core"> <brief_description> - Provides high performance mesh instancing. + Provides high performance mesh instancing. </brief_description> <description> - MultiMesh provides low level mesh instancing. If the amount of [Mesh] instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance] nodes may affect performance by using too much CPU or video memory. + MultiMesh provides low level mesh instancing. If the amount of [Mesh] instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance] nodes may affect performance by using too much CPU or video memory. For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead. As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [method generate_aabb]. @@ -20676,14 +20676,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <methods> <method name="generate_aabb"> <description> - Generate a new visibility AABB, using mesh AABB and instance transforms. Since instance information is stored in the [VisualServer], this function is VERY SLOW and must NOT be used often. + Generate a new visibility AABB, using mesh AABB and instance transforms. Since instance information is stored in the [VisualServer], this function is VERY SLOW and must NOT be used often. </description> </method> <method name="get_aabb" qualifiers="const"> <return type="AABB"> </return> <description> - Return the visibility AABB. + Return the visibility AABB. </description> </method> <method name="get_instance_color" qualifiers="const"> @@ -20692,14 +20692,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="instance" type="int"> </argument> <description> - Get the color of a specific instance. + Get the color of a specific instance. </description> </method> <method name="get_instance_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of instances that is going to be drawn. + Return the amount of instances that is going to be drawn. </description> </method> <method name="get_instance_transform" qualifiers="const"> @@ -20708,21 +20708,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="instance" type="int"> </argument> <description> - Return the transform of a specific instance. + Return the transform of a specific instance. </description> </method> <method name="get_mesh" qualifiers="const"> <return type="Mesh"> </return> <description> - Return the [Mesh] resource drawn as multiple instances. + Return the [Mesh] resource drawn as multiple instances. </description> </method> <method name="set_aabb"> <argument index="0" name="visibility_aabb" type="AABB"> </argument> <description> - Set the visibility AABB. If not provided, MultiMesh will not be visible. + Set the visibility AABB. If not provided, MultiMesh will not be visible. </description> </method> <method name="set_instance_color"> @@ -20731,14 +20731,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="color" type="Color"> </argument> <description> - Set the color of a specific instance. + Set the color of a specific instance. </description> </method> <method name="set_instance_count"> <argument index="0" name="count" type="int"> </argument> <description> - Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data. + Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data. </description> </method> <method name="set_instance_transform"> @@ -20747,14 +20747,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="transform" type="Transform"> </argument> <description> - Set the transform for a specific instance. + Set the transform for a specific instance. </description> </method> <method name="set_mesh"> <argument index="0" name="mesh" type="Mesh"> </argument> <description> - Set the [Mesh] resource to be drawn in multiple instances. + Set the [Mesh] resource to be drawn in multiple instances. </description> </method> </methods> @@ -20763,24 +20763,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="MultiMeshInstance" inherits="GeometryInstance" category="Core"> <brief_description> - Node that instances a [MultiMesh]. + Node that instances a [MultiMesh]. </brief_description> <description> - MultiMeshInstance is a [Node] that takes a [MultiMesh] resource and adds it to the current scenario by creating an instance of it (yes, this is an instance of instances). + MultiMeshInstance is a [Node] that takes a [MultiMesh] resource and adds it to the current scenario by creating an instance of it (yes, this is an instance of instances). </description> <methods> <method name="get_multimesh" qualifiers="const"> <return type="Object"> </return> <description> - Return the [MultiMesh] that is used for instancing. + Return the [MultiMesh] that is used for instancing. </description> </method> <method name="set_multimesh"> <argument index="0" name="multimesh" type="Object"> </argument> <description> - Set the [MultiMesh] to be instance. + Set the [MultiMesh] to be instance. </description> </method> </methods> @@ -20789,27 +20789,27 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Mutex" inherits="Reference" category="Core"> <brief_description> - A synchronization Mutex. + A synchronization Mutex. </brief_description> <description> - A synchronization Mutex. Element used in multi-threadding. Basically a binary [Semaphore]. Guarantees that only one thread has this lock, can be used to protect a critical section. + A synchronization Mutex. Element used in multi-threadding. Basically a binary [Semaphore]. Guarantees that only one thread has this lock, can be used to protect a critical section. </description> <methods> <method name="lock"> <description> - Lock this [Mutex], blocks until it is unlocked by the current owner. + Lock this [Mutex], blocks until it is unlocked by the current owner. </description> </method> <method name="try_lock"> <return type="Error"> </return> <description> - Try locking this [Mutex], does not block. Returns [OK] on success else [ERR_BUSY]. + Try locking this [Mutex], does not block. Returns [OK] on success else [ERR_BUSY]. </description> </method> <method name="unlock"> <description> - Unlock this [Mutex], leaving it to others threads. + Unlock this [Mutex], leaving it to others threads. </description> </method> </methods> @@ -21366,10 +21366,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Node" inherits="Object" category="Core"> <brief_description> - Base class for all the "Scene" elements. + Base class for all the "Scene" elements. </brief_description> <description> - Nodes can be set as children of other nodes, resulting in a tree arrangement. Any tree of nodes is called a "Scene". + Nodes can be set as children of other nodes, resulting in a tree arrangement. Any tree of nodes is called a "Scene". Scenes can be saved to disk, and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of the projects. [SceneTree] contains the "active" tree of nodes, and a node becomes active (receiving NOTIFICATION_ENTER_SCENE) when added to that tree. A node can contain any number of nodes as a children (but there is only one tree root) with the requirement that no two children with the same name can exist. @@ -21392,40 +21392,40 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="delta" type="float"> </argument> <description> - Called for fixed processing (synced to the physics). + Called for fixed processing (synced to the physics). </description> </method> <method name="_input" qualifiers="virtual"> <argument index="0" name="event" type="InputEvent"> </argument> <description> - Called when any input happens (also must enable with [method set_process_input] or the property). + Called when any input happens (also must enable with [method set_process_input] or the property). </description> </method> <method name="_process" qualifiers="virtual"> <argument index="0" name="delta" type="float"> </argument> <description> - Called for processing. This is called every frame, with the delta time from the previous frame. + Called for processing. This is called every frame, with the delta time from the previous frame. </description> </method> <method name="_ready" qualifiers="virtual"> <description> - Called when ready (entered scene and children entered too). + Called when ready (entered scene and children entered too). </description> </method> <method name="_unhandled_input" qualifiers="virtual"> <argument index="0" name="event" type="InputEvent"> </argument> <description> - Called when any input happens that was not handled by something else (also must enable with [method set_process_unhandled_input] or the property). + Called when any input happens that was not handled by something else (also must enable with [method set_process_unhandled_input] or the property). </description> </method> <method name="_unhandled_key_input" qualifiers="virtual"> <argument index="0" name="key_event" type="InputEvent"> </argument> <description> - Called when any key input happens that was not handled by something else. + Called when any key input happens that was not handled by something else. </description> </method> <method name="add_child"> @@ -21434,7 +21434,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="legible_unique_name" type="bool" default="false"> </argument> <description> - Add a child [Node]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. + Add a child [Node]. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node. The optional boolean argument enforces creating child node with human-readable names, based on the name of node being instanced instead of its type only. </description> </method> @@ -21444,14 +21444,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="persistent" type="bool" default="false"> </argument> <description> - Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies", "Collectables", etc. A [Node] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_tree]). + Add a node to a group. Groups are helpers to name and organize group of nodes, like for example: "Enemies", "Collectables", etc. A [Node] can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see [method is_inside_tree]). </description> </method> <method name="can_process" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the node can process. + Return true if the node can process. </description> </method> <method name="duplicate" qualifiers="const"> @@ -21472,7 +21472,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="owned" type="bool" default="true"> </argument> <description> - Find a descendant of this node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. + Find a descendant of this node whose name matches [code]mask[/code] as in [method String.match] (i.e. case sensitive, but '*' matches zero or more characters and '?' matches any single character except '.'). Note that it does not match against the full path, just against individual node names. </description> </method> <method name="get_child" qualifiers="const"> @@ -21481,14 +21481,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="idx" type="int"> </argument> <description> - Return a children node by it's index (see [method get_child_count]). This method is often used for iterating all children of a node. + Return a children node by it's index (see [method get_child_count]). This method is often used for iterating all children of a node. </description> </method> <method name="get_child_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of children nodes. + Return the amount of children nodes. </description> </method> <method name="get_children" qualifiers="const"> @@ -21501,14 +21501,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="String"> </return> <description> - Return a filename that may be containedA node can contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [method set_filename]). + Return a filename that may be containedA node can contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see [method set_filename]). </description> </method> <method name="get_fixed_process_delta_time" qualifiers="const"> <return type="float"> </return> <description> - Return the time elapsed since the last fixed frame. This is always the same in fixed processing unless the frames per second is changed in [OS]. + Return the time elapsed since the last fixed frame. This is always the same in fixed processing unless the frames per second is changed in [OS]. </description> </method> <method name="get_groups" qualifiers="const"> @@ -21521,14 +21521,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Get the node index in the parent (assuming it has a parent). + Get the node index in the parent (assuming it has a parent). </description> </method> <method name="get_name" qualifiers="const"> <return type="String"> </return> <description> - Return the name of the [Node]. Name is be unique within parent. + Return the name of the [Node]. Name is be unique within parent. </description> </method> <method name="get_node" qualifiers="const"> @@ -21537,7 +21537,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="path" type="NodePath"> </argument> <description> - Fetch a node. NodePath must be valid (or else error will occur) and can be either the path to child node, a relative path (from the current node to another node), or an absolute path to a node. + Fetch a node. NodePath must be valid (or else error will occur) and can be either the path to child node, a relative path (from the current node to another node), or an absolute path to a node. Note: fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). Examples. Assume your current node is Character and following tree:[br] root/ root/Character @@ -21567,21 +21567,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Node"> </return> <description> - Get the node owner (see [method set_owner]). + Get the node owner (see [method set_owner]). </description> </method> <method name="get_parent" qualifiers="const"> <return type="Node"> </return> <description> - Return the parent [Node] of the current [Node], or an empty Object if the node lacks a parent. + Return the parent [Node] of the current [Node], or an empty Object if the node lacks a parent. </description> </method> <method name="get_path" qualifiers="const"> <return type="NodePath"> </return> <description> - Return the absolute path of the current node. This only works if the current node is inside the scene tree (see [method is_inside_tree]). + Return the absolute path of the current node. This only works if the current node is inside the scene tree (see [method is_inside_tree]). </description> </method> <method name="get_path_to" qualifiers="const"> @@ -21590,7 +21590,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="node" type="Node"> </argument> <description> - Return the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or else the function will fail. + Return the relative path from the current node to the specified node in "node" argument. Both nodes must be in the same scene, or else the function will fail. </description> </method> <method name="get_pause_mode" qualifiers="const"> @@ -21609,7 +21609,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="float"> </return> <description> - Return the time elapsed (in seconds) since the last process callback. This is almost always different each time. + Return the time elapsed (in seconds) since the last process callback. This is almost always different each time. </description> </method> <method name="get_scene_instance_load_placeholder" qualifiers="const"> @@ -21652,7 +21652,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="node" type="Node"> </argument> <description> - Return [i]true[/i] if the "node" argument is a direct or indirect child of the current node, otherwise return [i]false[/i]. + Return [i]true[/i] if the "node" argument is a direct or indirect child of the current node, otherwise return [i]false[/i]. </description> </method> <method name="is_displayed_folded" qualifiers="const"> @@ -21665,7 +21665,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return true if fixed processing is enabled (see [method set_fixed_process]). + Return true if fixed processing is enabled (see [method set_fixed_process]). </description> </method> <method name="is_greater_than" qualifiers="const"> @@ -21674,7 +21674,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="node" type="Node"> </argument> <description> - Return [i]true[/i] if "node" occurs later in the scene hierarchy than the current node, otherwise return [i]false[/i]. + Return [i]true[/i] if "node" occurs later in the scene hierarchy than the current node, otherwise return [i]false[/i]. </description> </method> <method name="is_in_group" qualifiers="const"> @@ -21695,21 +21695,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return whether processing is enabled in the current node (see [method set_process]). + Return whether processing is enabled in the current node (see [method set_process]). </description> </method> <method name="is_processing_input" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the node is processing input (see [method set_process_input]). + Return true if the node is processing input (see [method set_process_input]). </description> </method> <method name="is_processing_unhandled_input" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the node is processing unhandled input (see [method set_process_unhandled_input]). + Return true if the node is processing unhandled input (see [method set_process_unhandled_input]). </description> </method> <method name="is_processing_unhandled_key_input" qualifiers="const"> @@ -21724,7 +21724,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="to_pos" type="int"> </argument> <description> - Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. + Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. </description> </method> <method name="print_stray_nodes"> @@ -21733,14 +21733,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> <method name="print_tree"> <description> - Print the scene to stdout. Used mainly for debugging purposes. + Print the scene to stdout. Used mainly for debugging purposes. </description> </method> <method name="propagate_notification"> <argument index="0" name="what" type="int"> </argument> <description> - Notify the current node and all its children recursively by calling notification() in all of them. + Notify the current node and all its children recursively by calling notification() in all of them. </description> </method> <method name="queue_free"> @@ -21749,26 +21749,26 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </method> <method name="raise"> <description> - Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs ([Control]), because their order of drawing fully depends on their order in the tree. + Move this node to the top of the array of nodes of the parent node. This is often useful on GUIs ([Control]), because their order of drawing fully depends on their order in the tree. </description> </method> <method name="remove_and_skip"> <description> - Remove a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. + Remove a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. </description> </method> <method name="remove_child"> <argument index="0" name="node" type="Node"> </argument> <description> - Remove a child [Node]. Node is NOT deleted and will have to be deleted manually. + Remove a child [Node]. Node is NOT deleted and will have to be deleted manually. </description> </method> <method name="remove_from_group"> <argument index="0" name="group" type="String"> </argument> <description> - Remove a node from a group. + Remove a node from a group. </description> </method> <method name="replace_by"> @@ -21777,7 +21777,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="keep_data" type="bool" default="false"> </argument> <description> - Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. + Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. </description> </method> <method name="set_display_folded"> @@ -21790,28 +21790,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="filename" type="String"> </argument> <description> - A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded. + A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded. </description> </method> <method name="set_fixed_process"> <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_delta_time]. + Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_delta_time]. </description> </method> <method name="set_name"> <argument index="0" name="name" type="String"> </argument> <description> - Set the name of the [Node]. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed. + Set the name of the [Node]. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed. </description> </method> <method name="set_owner"> <argument index="0" name="owner" type="Node"> </argument> <description> - Set the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing. + Set the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing. </description> </method> <method name="set_pause_mode"> @@ -21824,21 +21824,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_process_delta_time]. + Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the [method _process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_process_delta_time]. </description> </method> <method name="set_process_input"> <argument index="0" name="enable" type="bool"> </argument> <description> - Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]). + Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]). </description> </method> <method name="set_process_unhandled_input"> <argument index="0" name="enable" type="bool"> </argument> <description> - Enable unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]). + Enable unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]). </description> </method> <method name="set_process_unhandled_key_input"> @@ -21865,7 +21865,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </signal> <signal name="renamed"> <description> - Emitted when the node is renamed. + Emitted when the node is renamed. </description> </signal> </signals> @@ -21909,17 +21909,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Node2D" inherits="CanvasItem" category="Core"> <brief_description> - Base node for 2D system. + Base node for 2D system. </brief_description> <description> - Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierarchies for animation and positioning. + Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierarchies for animation and positioning. </description> <methods> <method name="edit_set_pivot"> <argument index="0" name="pivot" type="Vector2"> </argument> <description> - Set the pivot position of the 2D node to 'pivot' value. This method is implemented only in some nodes that inherit Node2D. + Set the pivot position of the 2D node to 'pivot' value. This method is implemented only in some nodes that inherit Node2D. </description> </method> <method name="get_angle_to" qualifiers="const"> @@ -21928,21 +21928,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="point" type="Vector2"> </argument> <description> - Return the rotation angle in radians needed for the 2d node to point at 'point' position. + Return the rotation angle in radians needed for the 2d node to point at 'point' position. </description> </method> <method name="get_global_pos" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the global position of the 2D node. + Return the global position of the 2D node. </description> </method> <method name="get_pos" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the position of the 2D node. + Return the position of the 2D node. </description> </method> <method name="get_relative_transform_to_parent" qualifiers="const"> @@ -21951,14 +21951,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="parent" type="Object"> </argument> <description> - Return the transform [Matrix32] calculated relatively to the parent of this 2D node. + Return the transform [Matrix32] calculated relatively to the parent of this 2D node. </description> </method> <method name="get_rot" qualifiers="const"> <return type="float"> </return> <description> - Return the rotation of the 2D node. + Return the rotation of the 2D node. </description> </method> <method name="get_rotd" qualifiers="const"> @@ -21971,35 +21971,35 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Vector2"> </return> <description> - Return the scale of the 2D node. + Return the scale of the 2D node. </description> </method> <method name="get_z" qualifiers="const"> <return type="int"> </return> <description> - Return the Z-index of the 2D node. + Return the Z-index of the 2D node. </description> </method> <method name="global_translate"> <argument index="0" name="offset" type="Vector2"> </argument> <description> - Apply a global translation of 'offset' to the 2D node, starting from its current global position. + Apply a global translation of 'offset' to the 2D node, starting from its current global position. </description> </method> <method name="is_z_relative" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the Z-index value of this 2D node is relative to its parent's. Else, return false. + Return true if the Z-index value of this 2D node is relative to its parent's. Else, return false. </description> </method> <method name="look_at"> <argument index="0" name="point" type="Vector2"> </argument> <description> - Rotate the 2d node so it points at 'point' position. + Rotate the 2d node so it points at 'point' position. </description> </method> <method name="move_local_x"> @@ -22008,7 +22008,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> - Apply a local translation on X axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. + Apply a local translation on X axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. </description> </method> <method name="move_local_y"> @@ -22017,91 +22017,91 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="scaled" type="bool" default="false"> </argument> <description> - Apply a local translation on Y axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. + Apply a local translation on Y axis to the 2D node according to the 'delta' of the process. If 'scaled' is false, the movement is normalized. </description> </method> <method name="rotate"> <argument index="0" name="radians" type="float"> </argument> <description> - Apply a 'radians' rotation to the 2D node, starting from its current rotation. + Apply a 'radians' rotation to the 2D node, starting from its current rotation. </description> </method> <method name="scale"> <argument index="0" name="ratio" type="Vector2"> </argument> <description> - Apply the 'ratio' scale to the 2D node, according to its current scale value. + Apply the 'ratio' scale to the 2D node, according to its current scale value. </description> </method> <method name="set_global_pos"> <argument index="0" name="pos" type="Vector2"> </argument> <description> - Set the global position of the 2D node to 'pos'. + Set the global position of the 2D node to 'pos'. </description> </method> <method name="set_global_transform"> <argument index="0" name="xform" type="Matrix32"> </argument> <description> - Set the global transform [Matrix32] of the 2D node. + Set the global transform [Matrix32] of the 2D node. </description> </method> <method name="set_pos"> <argument index="0" name="pos" type="Vector2"> </argument> <description> - Set the position of the 2D node. + Set the position of the 2D node. </description> </method> <method name="set_rot"> <argument index="0" name="radians" type="float"> </argument> <description> - Set the rotation of the 2D node. + Set the rotation of the 2D node. </description> </method> <method name="set_rotd"> <argument index="0" name="degrees" type="float"> </argument> <description> - Set the rotation of the 2D node. + Set the rotation of the 2D node. </description> </method> <method name="set_scale"> <argument index="0" name="scale" type="Vector2"> </argument> <description> - Set the scale of the 2D node. + Set the scale of the 2D node. </description> </method> <method name="set_transform"> <argument index="0" name="xform" type="Matrix32"> </argument> <description> - Set the local transform [Matrix32] of the 2D node. + Set the local transform [Matrix32] of the 2D node. </description> </method> <method name="set_z"> <argument index="0" name="z" type="int"> </argument> <description> - Set the Z-index value of the 2D node. + Set the Z-index value of the 2D node. </description> </method> <method name="set_z_as_relative"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set the Z-index value as relative to the parent node of this 2D node. Thus, if this 2D node's Z-index value is 2 and its parent's effective Z-index is 3, then the effective Z-index value of this 2D node would be 3 + 2 = 5. + Set the Z-index value as relative to the parent node of this 2D node. Thus, if this 2D node's Z-index value is 2 and its parent's effective Z-index is 3, then the effective Z-index value of this 2D node would be 3 + 2 = 5. </description> </method> <method name="translate"> <argument index="0" name="offset" type="Vector2"> </argument> <description> - Apply a local translation of 'offset' to the 2D node, starting from its current local position. + Apply a local translation of 'offset' to the 2D node, starting from its current local position. </description> </method> </methods> @@ -22110,10 +22110,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="NodePath" category="Built-In Types"> <brief_description> - Pre-parsed scene tree path. + Pre-parsed scene tree path. </brief_description> <description> - A pre-parsed relative or absolute path in a scene tree, for use with [method Node.get_node] and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, [code]"Path2D/PathFollow2D/Sprite:texture:size"[/code] would refer to the size property of the texture resource on the node named "Sprite" which is a child of the other named nodes in the path. Note that if you want to get a resource, you must end the path with a colon, otherwise the last element will be used as a property name. + A pre-parsed relative or absolute path in a scene tree, for use with [method Node.get_node] and similar functions. It can reference a node, a resource within a node, or a property of a node or resource. For instance, [code]"Path2D/PathFollow2D/Sprite:texture:size"[/code] would refer to the size property of the texture resource on the node named "Sprite" which is a child of the other named nodes in the path. Note that if you want to get a resource, you must end the path with a colon, otherwise the last element will be used as a property name. You will usually just pass a string to [method Node.get_node] and it will be automatically converted, but you may occasionally want to parse a path ahead of time with [NodePath] or the literal syntax [code]@"path"[/code]. Exporting a [NodePath] variable will give you a node selection widget in the properties panel of the editor, which can often be useful. A [NodePath] is made up of a list of node names, a list of "subnode" (resource) names, and the name of a property in the final node or resource. </description> @@ -22124,7 +22124,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="from" type="String"> </argument> <description> - Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent. + Create a NodePath from a string, e.g. "Path2D/PathFollow2D/Sprite:texture:size". A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent. </description> </method> <method name="get_name"> @@ -22133,21 +22133,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="idx" type="int"> </argument> <description> - Get the node name indicated by [code]idx[/code] (0 to [method get_name_count]) + Get the node name indicated by [code]idx[/code] (0 to [method get_name_count]) </description> </method> <method name="get_name_count"> <return type="int"> </return> <description> - Get the number of node names which make up the path. + Get the number of node names which make up the path. </description> </method> <method name="get_property"> <return type="String"> </return> <description> - Get the path's property name, or an empty string if the path doesn't have a property. + Get the path's property name, or an empty string if the path doesn't have a property. </description> </method> <method name="get_subname"> @@ -22156,28 +22156,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="idx" type="int"> </argument> <description> - Get the resource name indicated by [code]idx[/code] (0 to [method get_subname_count]) + Get the resource name indicated by [code]idx[/code] (0 to [method get_subname_count]) </description> </method> <method name="get_subname_count"> <return type="int"> </return> <description> - Get the number of resource names in the path. + Get the number of resource names in the path. </description> </method> <method name="is_absolute"> <return type="bool"> </return> <description> - Return true if the node path is absolute (not relative). + Return true if the node path is absolute (not relative). </description> </method> <method name="is_empty"> <return type="bool"> </return> <description> - Return true if the node path is empty. + Return true if the node path is empty. </description> </method> </methods> @@ -22186,10 +22186,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="OS" inherits="Object" category="Core"> <brief_description> - Operating System functions. + Operating System functions. </brief_description> <description> - Operating System functions. OS Wraps the most common functionality to communicate with the host Operating System, such as: + Operating System functions. OS Wraps the most common functionality to communicate with the host Operating System, such as: -Mouse Grabbing -Mouse Cursors -Clipboard @@ -22213,7 +22213,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return true if the host OS allows drawing. + Return true if the host OS allows drawing. </description> </method> <method name="can_use_threads" qualifiers="const"> @@ -22226,14 +22226,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="msec" type="int"> </argument> <description> - Delay executing of the current thread by given milliseconds. + Delay executing of the current thread by given milliseconds. </description> </method> <method name="delay_usec" qualifiers="const"> <argument index="0" name="usec" type="int"> </argument> <description> - Delay executing of the current thread by given microseconds. + Delay executing of the current thread by given microseconds. </description> </method> <method name="dump_memory_to_file"> @@ -22260,7 +22260,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="3" name="output" type="Array" default="Array()"> </argument> <description> - Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. + Execute the binary file in given path, optionally blocking until it returns. A process ID is returned. </description> </method> <method name="find_scancode_from_string" qualifiers="const"> @@ -22281,21 +22281,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="String"> </return> <description> - Get clipboard from the host OS. + Get clipboard from the host OS. </description> </method> <method name="get_cmdline_args"> <return type="StringArray"> </return> <description> - Return the commandline passed to the engine. + Return the commandline passed to the engine. </description> </method> <method name="get_current_screen" qualifiers="const"> <return type="int"> </return> <description> - Returns the current screen index (0 padded). + Returns the current screen index (0 padded). </description> </method> <method name="get_custom_level" qualifiers="const"> @@ -22308,7 +22308,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="String"> </return> <description> - Return the absolute directory path of user data path([user://]). + Return the absolute directory path of user data path([user://]). </description> </method> <method name="get_date" qualifiers="const"> @@ -22317,7 +22317,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="utc" type="bool" default="false"> </argument> <description> - Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time). + Returns current date as a dictionary of keys: year, month, day, weekday, dst (daylight savings time). </description> </method> <method name="get_datetime" qualifiers="const"> @@ -22326,7 +22326,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="utc" type="bool" default="false"> </argument> <description> - Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second. + Returns current datetime as a dictionary of keys: year, month, day, weekday, dst (daylight savings time), hour, minute, second. </description> </method> <method name="get_datetime_from_unix_time" qualifiers="const"> @@ -22335,7 +22335,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="unix_time_val" type="int"> </argument> <description> - Get a dictionary of time values when given epoch time. + Get a dictionary of time values when given epoch time. Dictionary Time values will be a union of values from [method get_time] and [method get_date] dictionaries (with the exception of dst = day light standard time, as it cannot be determined from epoch). </description> </method> @@ -22343,7 +22343,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Return the total amount of dynamic memory used (only works in debug). + Return the total amount of dynamic memory used (only works in debug). </description> </method> <method name="get_environment" qualifiers="const"> @@ -22352,28 +22352,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="environment" type="String"> </argument> <description> - Return an environment variable. + Return an environment variable. </description> </method> <method name="get_executable_path" qualifiers="const"> <return type="String"> </return> <description> - Return the path to the current engine executable. + Return the path to the current engine executable. </description> </method> <method name="get_frames_drawn"> <return type="int"> </return> <description> - Return the total amount of frames drawn. + Return the total amount of frames drawn. </description> </method> <method name="get_frames_per_second" qualifiers="const"> <return type="float"> </return> <description> - Returns the frames per second of the running game. + Returns the frames per second of the running game. </description> </method> <method name="get_fullscreen_mode_list" qualifiers="const"> @@ -22382,28 +22382,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="screen" type="int" default="0"> </argument> <description> - Return the list of fullscreen modes. + Return the list of fullscreen modes. </description> </method> <method name="get_iterations_per_second" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of fixed iterations per second (for fixed process and physics). + Return the amount of fixed iterations per second (for fixed process and physics). </description> </method> <method name="get_locale" qualifiers="const"> <return type="String"> </return> <description> - Return the host OS locale. + Return the host OS locale. </description> </method> <method name="get_main_loop" qualifiers="const"> <return type="Object"> </return> <description> - Return the main loop object (see [MainLoop]). + Return the main loop object (see [MainLoop]). </description> </method> <method name="get_model_name" qualifiers="const"> @@ -22416,21 +22416,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="String"> </return> <description> - Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "WinRT", "X11" + Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "WinRT", "X11" </description> </method> <method name="get_process_ID" qualifiers="const"> <return type="int"> </return> <description> - Returns the game process ID + Returns the game process ID </description> </method> <method name="get_processor_count" qualifiers="const"> <return type="int"> </return> <description> - Returns the number of cores available in the host machine. + Returns the number of cores available in the host machine. </description> </method> <method name="get_scancode_string" qualifiers="const"> @@ -22445,7 +22445,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Returns the number of displays attached to the host machine + Returns the number of displays attached to the host machine </description> </method> <method name="get_screen_dpi" qualifiers="const"> @@ -22460,7 +22460,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class. + Returns the current screen orientation, the return value will be one of the SCREEN_ORIENTATION constants in this class. </description> </method> <method name="get_screen_position" qualifiers="const"> @@ -22477,7 +22477,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="screen" type="int" default="0"> </argument> <description> - Returns the dimensions in pixels of the specified screen. + Returns the dimensions in pixels of the specified screen. </description> </method> <method name="get_splash_tick_msec" qualifiers="const"> @@ -22490,7 +22490,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Return the max amount of static memory used (only works in debug). + Return the max amount of static memory used (only works in debug). </description> </method> <method name="get_static_memory_usage" qualifiers="const"> @@ -22523,7 +22523,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Return the amount of time passed in milliseconds since the engine started. + Return the amount of time passed in milliseconds since the engine started. </description> </method> <method name="get_time" qualifiers="const"> @@ -22532,7 +22532,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="utc" type="bool" default="false"> </argument> <description> - Returns current time as a dictionary of keys: hour, minute, second + Returns current time as a dictionary of keys: hour, minute, second </description> </method> <method name="get_time_scale"> @@ -22557,7 +22557,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="int"> </return> <description> - Return the current unix timestamp. + Return the current unix timestamp. </description> </method> <method name="get_unix_time_from_datetime" qualifiers="const"> @@ -22566,7 +22566,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="datetime" type="Dictionary"> </argument> <description> - Get an epoch time value from a dictionary of time values. + Get an epoch time value from a dictionary of time values. [code]datetime[/code] must be populated with the following keys: year, month, day, hour, minute, second. You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored. </description> @@ -22577,21 +22577,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="screen" type="int" default="0"> </argument> <description> - Return the current video mode size. + Return the current video mode size. </description> </method> <method name="get_window_position" qualifiers="const"> <return type="Vector2"> </return> <description> - Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. + Returns the window position relative to the screen, the origin is the top left corner, +Y axis goes to the bottom and +X axis goes to the right. </description> </method> <method name="get_window_size" qualifiers="const"> <return type="Vector2"> </return> <description> - Returns the size of the window (without counting window manager decorations). + Returns the size of the window (without counting window manager decorations). </description> </method> <method name="has_environment" qualifiers="const"> @@ -22600,7 +22600,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="environment" type="String"> </argument> <description> - Return true if an environment variable exists. + Return true if an environment variable exists. </description> </method> <method name="has_touchscreen_ui_hint" qualifiers="const"> @@ -22619,14 +22619,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return true if low cpu usage mode is enabled. + Return true if low cpu usage mode is enabled. </description> </method> <method name="is_keep_screen_on" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether the screen is being kept on or not. + Returns whether the screen is being kept on or not. </description> </method> <method name="is_ok_left_and_cancel_right" qualifiers="const"> @@ -22647,7 +22647,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return true if the engine was executed with -v (verbose stdout). + Return true if the engine was executed with -v (verbose stdout). </description> </method> <method name="is_video_mode_fullscreen" qualifiers="const"> @@ -22656,7 +22656,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="screen" type="int" default="0"> </argument> <description> - Return true if the current video mode is fullscreen. + Return true if the current video mode is fullscreen. </description> </method> <method name="is_video_mode_resizable" qualifiers="const"> @@ -22665,7 +22665,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="screen" type="int" default="0"> </argument> <description> - Return true if the window is resizable. + Return true if the window is resizable. </description> </method> <method name="is_vsnc_enabled" qualifiers="const"> @@ -22678,28 +22678,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Returns whether the window is in fullscreen mode or not. + Returns whether the window is in fullscreen mode or not. </description> </method> <method name="is_window_maximized" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the window is maximized. + Return true if the window is maximized. </description> </method> <method name="is_window_minimized" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the window is minimized. + Return true if the window is minimized. </description> </method> <method name="is_window_resizable" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether the window is resizable or not. + Returns whether the window is resizable or not. </description> </method> <method name="kill"> @@ -22708,7 +22708,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="pid" type="int"> </argument> <description> - Kill a process ID (this method can be used to kill processes that were not spawned by the game). + Kill a process ID (this method can be used to kill processes that were not spawned by the game). </description> </method> <method name="native_video_is_playing"> @@ -22775,7 +22775,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="clipboard" type="String"> </argument> <description> - Set clipboard to the OS. + Set clipboard to the OS. </description> </method> <method name="set_current_screen"> @@ -22794,28 +22794,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="iterations_per_second" type="int"> </argument> <description> - Set the amount of fixed iterations per second (for fixed process and physics). + Set the amount of fixed iterations per second (for fixed process and physics). </description> </method> <method name="set_keep_screen_on"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS) + Set keep screen on if true, or goes to sleep by device setting if false. (for Android/iOS) </description> </method> <method name="set_low_processor_usage_mode"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set to true to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. This way, editors using the engine UI only use very little cpu. + Set to true to enable the low cpu usage mode. In this mode, the screen only redraws when there are changes, and a considerable sleep time is inserted between frames. This way, editors using the engine UI only use very little cpu. </description> </method> <method name="set_screen_orientation"> <argument index="0" name="orientation" type="int"> </argument> <description> - Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. + Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. </description> </method> <method name="set_target_fps"> @@ -22836,7 +22836,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="time_scale" type="float"> </argument> <description> - Speeds up or slows down the physics by changing the delta variable. (delta * time_scale) + Speeds up or slows down the physics by changing the delta variable. (delta * time_scale) </description> </method> <method name="set_use_file_access_save_and_swap"> @@ -22861,56 +22861,56 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="3" name="screen" type="int" default="0"> </argument> <description> - Change the video mode. + Change the video mode. </description> </method> <method name="set_window_fullscreen"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Sets window fullscreen mode to the [i]enabled[/i] argument, [i]enabled[/i] is a toggle for the fullscreen mode, calling the function with [i]enabled[/i] true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with [i]enabled[/i] false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode. + Sets window fullscreen mode to the [i]enabled[/i] argument, [i]enabled[/i] is a toggle for the fullscreen mode, calling the function with [i]enabled[/i] true when the screen is not on fullscreen mode will cause the screen to go to fullscreen mode, calling the function with [i]enabled[/i] false when the screen is in fullscreen mode will cause the window to exit the fullscreen mode. </description> </method> <method name="set_window_maximized"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the window size to maximized. + Set the window size to maximized. </description> </method> <method name="set_window_minimized"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether the window is minimized. + Set whether the window is minimized. </description> </method> <method name="set_window_position"> <argument index="0" name="position" type="Vector2"> </argument> <description> - Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen). + Sets the position of the window to the specified position (this function could be restricted by the window manager, meaning that there could be some unreachable areas of the screen). </description> </method> <method name="set_window_resizable"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings. + Set the window resizable state, if the window is not resizable it will preserve the dimensions specified in the project settings. </description> </method> <method name="set_window_size"> <argument index="0" name="size" type="Vector2"> </argument> <description> - Sets the window size to the specified size. + Sets the window size to the specified size. </description> </method> <method name="set_window_title"> <argument index="0" name="title" type="String"> </argument> <description> - Sets the window title to the specified string. + Sets the window title to the specified string. </description> </method> <method name="shell_open"> @@ -22995,10 +22995,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Object" category="Core"> <brief_description> - Base class for all non built-in types. + Base class for all non built-in types. </brief_description> <description> - Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. + Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [method free] function from the script or delete from C++). Some derivates add memory management, such as [Reference] (which keeps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted. Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [method _get_property_list] and handled in [method _get] and [method _set]. However, scripting languages and C++ have simpler means to export them. @@ -23011,21 +23011,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="message" type="String"> </argument> <description> - Deprecated, will go away. + Deprecated, will go away. </description> </method> <method name="_get" qualifiers="virtual"> <argument index="0" name="property" type="String"> </argument> <description> - Return a property, return null if the property does not exist. + Return a property, return null if the property does not exist. </description> </method> <method name="_get_property_list" qualifiers="virtual"> <return type="Array"> </return> <description> - Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). + Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). </description> </method> <method name="_init" qualifiers="virtual"> @@ -23036,7 +23036,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="what" type="int"> </argument> <description> - Notification request, the notification id is received. + Notification request, the notification id is received. </description> </method> <method name="_set" qualifiers="virtual"> @@ -23045,7 +23045,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="value" type="Variant"> </argument> <description> - Set a property. Return true if the property was found. + Set a property. Return true if the property was found. </description> </method> <method name="add_user_signal"> @@ -23054,7 +23054,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="arguments" type="Array" default="Array()"> </argument> <description> - Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*). + Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*). </description> </method> <method name="call"> @@ -23081,7 +23081,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="10" name="arg9" type="Variant" default="NULL"> </argument> <description> - Call a function in the object, result is returned. + Call a function in the object, result is returned. </description> </method> <method name="call_deferred"> @@ -23098,7 +23098,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="5" name="arg4" type="Variant" default="NULL"> </argument> <description> - Create and store a function in the object. The call will take place on idle time. + Create and store a function in the object. The call will take place on idle time. </description> </method> <method name="callv"> @@ -23115,7 +23115,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return true if this object can translate strings. + Return true if this object can translate strings. </description> </method> <method name="connect"> @@ -23132,7 +23132,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="4" name="flags" type="int" default="0"> </argument> <description> - Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT_*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use [method is_connected] to check. + Connect a signal to a method at a target (member function). Binds are optional and are passed as extra arguments to the call. Flags specify optional deferred or one shot connections, see enum CONNECT_*. A signal can only be connected once to a method, and it will throw an error if already connected. If you want to avoid this, use [method is_connected] to check. </description> </method> <method name="disconnect"> @@ -23143,7 +23143,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="method" type="String"> </argument> <description> - Disconnect a signal from a method. + Disconnect a signal from a method. </description> </method> <method name="emit_signal"> @@ -23160,7 +23160,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="5" name="arg4" type="Variant" default="NULL"> </argument> <description> - Emit a signal. Arguments are passed in an array. + Emit a signal. Arguments are passed in an array. </description> </method> <method name="free"> @@ -23171,28 +23171,28 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="property" type="String"> </argument> <description> - Get a property from the object. + Get a property from the object. </description> </method> <method name="get_instance_ID" qualifiers="const"> <return type="int"> </return> <description> - Return the instance ID. All objects have a unique instance ID. + Return the instance ID. All objects have a unique instance ID. </description> </method> <method name="get_meta" qualifiers="const"> <argument index="0" name="name" type="String"> </argument> <description> - Return a metadata from the object. + Return a metadata from the object. </description> </method> <method name="get_meta_list" qualifiers="const"> <return type="StringArray"> </return> <description> - Return the list of metadata in the object. + Return the list of metadata in the object. </description> </method> <method name="get_method_list" qualifiers="const"> @@ -23205,14 +23205,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Array"> </return> <description> - Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). + Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). </description> </method> <method name="get_script" qualifiers="const"> <return type="Script"> </return> <description> - Return the object script (or null if it doesn't have one). + Return the object script (or null if it doesn't have one). </description> </method> <method name="get_signal_connection_list" qualifiers="const"> @@ -23227,14 +23227,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Array"> </return> <description> - Return the list of signals as an array of dictionaries. + Return the list of signals as an array of dictionaries. </description> </method> <method name="get_type" qualifiers="const"> <return type="String"> </return> <description> - Return the type of the object as a string. + Return the type of the object as a string. </description> </method> <method name="has_meta" qualifiers="const"> @@ -23243,7 +23243,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="name" type="String"> </argument> <description> - Return true if a metadata is found with the requested name. + Return true if a metadata is found with the requested name. </description> </method> <method name="has_method" qualifiers="const"> @@ -23266,7 +23266,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return true if signal emission blocking is enabled. + Return true if signal emission blocking is enabled. </description> </method> <method name="is_connected" qualifiers="const"> @@ -23279,7 +23279,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="method" type="String"> </argument> <description> - Return true if a connection exists for a given signal and target/method. + Return true if a connection exists for a given signal and target/method. </description> </method> <method name="is_queued_for_deletion" qualifiers="const"> @@ -23294,7 +23294,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="type" type="String"> </argument> <description> - Check the type of the object against a string (including inheritance). + Check the type of the object against a string (including inheritance). </description> </method> <method name="notification"> @@ -23303,7 +23303,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="reversed" type="bool" default="false"> </argument> <description> - Notify the object of something. + Notify the object of something. </description> </method> <method name="property_list_changed_notify"> @@ -23316,21 +23316,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="value" type="Variant"> </argument> <description> - Set property into the object. + Set property into the object. </description> </method> <method name="set_block_signals"> <argument index="0" name="enable" type="bool"> </argument> <description> - If set to true, signal emission is blocked. + If set to true, signal emission is blocked. </description> </method> <method name="set_message_translation"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set true if this object can translate strings (in calls to tr() ). Default is true. + Set true if this object can translate strings (in calls to tr() ). Default is true. </description> </method> <method name="set_meta"> @@ -23339,14 +23339,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="value" type="Variant"> </argument> <description> - Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i]. + Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i]. </description> </method> <method name="set_script"> <argument index="0" name="script" type="Script"> </argument> <description> - Set a script into the object, scripts extend the object functionality. + Set a script into the object, scripts extend the object functionality. </description> </method> <method name="tr" qualifiers="const"> @@ -23355,7 +23355,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="message" type="String"> </argument> <description> - Translate a message. Only works in message translation is enabled (which is by default). See [method set_message_translation]. + Translate a message. Only works in message translation is enabled (which is by default). See [method set_message_translation]. </description> </method> </methods> @@ -23437,10 +23437,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="OmniLight" inherits="Light" category="Core"> <brief_description> - OmniDirectional Light, such as a light bulb or a candle. + OmniDirectional Light, such as a light bulb or a candle. </brief_description> <description> - An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of an omnilight. + An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of an omnilight. </description> <methods> </methods> @@ -23449,10 +23449,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="OptionButton" inherits="Button" category="Core"> <brief_description> - Button control that provides selectable options when pressed. + Button control that provides selectable options when pressed. </brief_description> <description> - OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text. + OptionButton is a type button that provides a selectable list of items when pressed. The item selected becomes the "current" item and is displayed as the button text. </description> <methods> <method name="add_icon_item"> @@ -23463,7 +23463,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="2" name="id" type="int"> </argument> <description> - Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. + Add an item, with a "texture" icon, text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. </description> </method> <method name="add_item"> @@ -23472,17 +23472,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="id" type="int" default="-1"> </argument> <description> - Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. + Add an item, with text "label" and (optionally) id. If no "id" is passed, "id" becomes the item index. New items are appended at the end. </description> </method> <method name="add_separator"> <description> - Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. + Add a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. </description> </method> <method name="clear"> <description> - Clear all the items in the [OptionButton]. + Clear all the items in the [OptionButton]. </description> </method> <method name="get_item_ID" qualifiers="const"> @@ -23491,14 +23491,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="idx" type="int"> </argument> <description> - Return the ID of the item at index "idx". + Return the ID of the item at index "idx". </description> </method> <method name="get_item_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of items in the OptionButton. + Return the amount of items in the OptionButton. </description> </method> <method name="get_item_icon" qualifiers="const"> @@ -23507,7 +23507,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="idx" type="int"> </argument> <description> - Return the icon of the item at index "idx". + Return the icon of the item at index "idx". </description> </method> <method name="get_item_metadata" qualifiers="const"> @@ -23522,14 +23522,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="idx" type="int"> </argument> <description> - Return the text of the item at index "idx". + Return the text of the item at index "idx". </description> </method> <method name="get_selected" qualifiers="const"> <return type="int"> </return> <description> - Return the current item index + Return the current item index </description> </method> <method name="get_selected_ID" qualifiers="const"> @@ -23560,7 +23560,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="idx" type="int"> </argument> <description> - Select an item by index and make it the current item. + Select an item by index and make it the current item. </description> </method> <method name="set_item_ID"> @@ -23569,7 +23569,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="id" type="int"> </argument> <description> - Set the ID of an item at index "idx". + Set the ID of an item at index "idx". </description> </method> <method name="set_item_disabled"> @@ -23586,7 +23586,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="texture" type="Texture"> </argument> <description> - Set the icon of an item at index "idx". + Set the icon of an item at index "idx". </description> </method> <method name="set_item_metadata"> @@ -23603,7 +23603,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="text" type="String"> </argument> <description> - Set the text of an item at index "idx". + Set the text of an item at index "idx". </description> </method> </methods> @@ -23612,7 +23612,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="ID" type="int"> </argument> <description> - This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). + This signal is emitted when the current item was changed by the user. ID of the item selected is passed as argument (if no IDs were added, ID will be just the item index). </description> </signal> </signals> @@ -23687,10 +23687,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="PHashTranslation" inherits="Translation" category="Core"> <brief_description> - Optimized translation. + Optimized translation. </brief_description> <description> - Optimized translation. Uses real-time compressed translations, which results in very small dictionaries. + Optimized translation. Uses real-time compressed translations, which results in very small dictionaries. </description> <methods> <method name="generate"> @@ -23747,7 +23747,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <brief_description> </brief_description> <description> - TODO: explain ownership, and that node does not need to own itself + TODO: explain ownership, and that node does not need to own itself </description> <methods> <method name="can_instance" qualifiers="const"> @@ -23776,7 +23776,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="path" type="Node"> </argument> <description> - Pack will ignore any sub-nodes not owned by given node. See [method Node.set_owner]. + Pack will ignore any sub-nodes not owned by given node. See [method Node.set_owner]. </description> </method> </methods> @@ -23785,38 +23785,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="PacketPeer" inherits="Reference" category="Core"> <brief_description> - Abstraction and base class for packet-based protocols. + Abstraction and base class for packet-based protocols. </brief_description> <description> - PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering. + PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering. </description> <methods> <method name="get_available_packet_count" qualifiers="const"> <return type="int"> </return> <description> - Return the number of packets currently available in the ring-buffer. + Return the number of packets currently available in the ring-buffer. </description> </method> <method name="get_packet" qualifiers="const"> <return type="RawArray"> </return> <description> - Get a raw packet. + Get a raw packet. </description> </method> <method name="get_packet_error" qualifiers="const"> <return type="Error"> </return> <description> - Return the error state of the last packet received (via [method get_packet] and [method get_var]). + Return the error state of the last packet received (via [method get_packet] and [method get_var]). </description> </method> <method name="get_var" qualifiers="const"> <return type="Variant"> </return> <description> - Get a Variant. + Get a Variant. </description> </method> <method name="put_packet"> @@ -23825,7 +23825,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="buffer" type="RawArray"> </argument> <description> - Send a raw packet. + Send a raw packet. </description> </method> <method name="put_var"> @@ -23834,7 +23834,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="var" type="Variant"> </argument> <description> - Send a Variant as a packet. + Send a Variant as a packet. </description> </method> </methods> @@ -23843,17 +23843,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="PacketPeerStream" inherits="PacketPeer" category="Core"> <brief_description> - Wrapper to use a PacketPeer over a StreamPeer. + Wrapper to use a PacketPeer over a StreamPeer. </brief_description> <description> - PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly. + PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly. </description> <methods> <method name="set_stream_peer"> <argument index="0" name="peer" type="StreamPeer"> </argument> <description> - Set the StreamPeer object to be wrapped + Set the StreamPeer object to be wrapped </description> </method> </methods> @@ -23862,43 +23862,43 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="PacketPeerUDP" inherits="PacketPeer" category="Core"> <brief_description> - UDP packet peer. + UDP packet peer. </brief_description> <description> - UDP packet peer. Can be used to send raw UDP packets as well as [Variant]s. + UDP packet peer. Can be used to send raw UDP packets as well as [Variant]s. </description> <methods> <method name="close"> <description> - Close the UDP socket the [PacketPeerUDP] is currently listening on. + Close the UDP socket the [PacketPeerUDP] is currently listening on. </description> </method> <method name="get_packet_address" qualifiers="const"> <return type="int"> </return> <description> - Return the address of the remote peer(as a 32bit integer) that sent the last packet(that was received with [method get_packet] or [method get_var]). + Return the address of the remote peer(as a 32bit integer) that sent the last packet(that was received with [method get_packet] or [method get_var]). </description> </method> <method name="get_packet_ip" qualifiers="const"> <return type="String"> </return> <description> - Return the IP of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). + Return the IP of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). </description> </method> <method name="get_packet_port" qualifiers="const"> <return type="int"> </return> <description> - Return the port of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). + Return the port of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]). </description> </method> <method name="is_listening" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this [PacketPeerUDP] is listening. + Return whether this [PacketPeerUDP] is listening. </description> </method> <method name="listen"> @@ -23909,7 +23909,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="recv_buf_size" type="int" default="65536"> </argument> <description> - Make this [PacketPeerUDP] listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses. + Make this [PacketPeerUDP] listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses. </description> </method> <method name="set_send_address"> @@ -23920,14 +23920,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="port" type="int"> </argument> <description> - Set the destination address and port for sending packets and variables, a hostname will be resolved if valid. + Set the destination address and port for sending packets and variables, a hostname will be resolved if valid. </description> </method> <method name="wait"> <return type="Error"> </return> <description> - Wait for a packet to arrive on the listening port, see [method listen]. + Wait for a packet to arrive on the listening port, see [method listen]. </description> </method> </methods> @@ -23936,10 +23936,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Panel" inherits="Control" category="Core"> <brief_description> - Provides an opaque background for [Control] children. + Provides an opaque background for [Control] children. </brief_description> <description> - Panel is a [Control] that displays an opaque background. It's commonly used as a parent and container for other types of [Control] nodes. + Panel is a [Control] that displays an opaque background. It's commonly used as a parent and container for other types of [Control] nodes. </description> <methods> </methods> @@ -23956,10 +23956,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="PanelContainer" inherits="Container" category="Core"> <brief_description> - Panel container type. + Panel container type. </brief_description> <description> - Panel container type. This container fits controls inside of the delimited area of a stylebox. It's useful for giving controls an outline. + Panel container type. This container fits controls inside of the delimited area of a stylebox. It's useful for giving controls an outline. </description> <methods> </methods> @@ -23972,38 +23972,38 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="ParallaxBackground" inherits="CanvasLayer" category="Core"> <brief_description> - A node used to create a parallax scrolling background. + A node used to create a parallax scrolling background. </brief_description> <description> - A ParallaxBackground will use one or more [ParallaxLayer] nodes to create a parallax scrolling background. Each [ParallaxLayer] can be set to move at different speeds relative to the camera movement, this can be used to create an illusion of depth in a 2D game. + A ParallaxBackground will use one or more [ParallaxLayer] nodes to create a parallax scrolling background. Each [ParallaxLayer] can be set to move at different speeds relative to the camera movement, this can be used to create an illusion of depth in a 2D game. </description> <methods> <method name="get_limit_begin" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the beginning limit. + Return the beginning limit. </description> </method> <method name="get_limit_end" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the ending limit. + Return the ending limit. </description> </method> <method name="get_scroll_base_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the base offset. + Return the base offset. </description> </method> <method name="get_scroll_base_scale" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the base motion scale. + Return the base motion scale. </description> </method> <method name="get_scroll_offset" qualifiers="const"> @@ -24016,42 +24016,42 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return ignoring camera zoom. + Return ignoring camera zoom. </description> </method> <method name="set_ignore_camera_zoom"> <argument index="0" name="ignore" type="bool"> </argument> <description> - Set to true for all child [ParallaxLayer] nodes to not be affected by the zoom level of the camera. + Set to true for all child [ParallaxLayer] nodes to not be affected by the zoom level of the camera. </description> </method> <method name="set_limit_begin"> <argument index="0" name="ofs" type="Vector2"> </argument> <description> - Set the left and top limits in pixels for scrolling to begin. If the camera is outside of this limit the background will not continue to scroll. If an axis is greater than or equal to the corresponding axis of limit_end, then it will not limit scrolling for that axis. + Set the left and top limits in pixels for scrolling to begin. If the camera is outside of this limit the background will not continue to scroll. If an axis is greater than or equal to the corresponding axis of limit_end, then it will not limit scrolling for that axis. </description> </method> <method name="set_limit_end"> <argument index="0" name="ofs" type="Vector2"> </argument> <description> - Set the right and bottom limits in pixels for scrolling to end. If the camera is outside of this limit the background will not continue to scroll. If an axis is less than or equal to the corresponding axis of limit_begin, then it will not limit scrolling for that axis. + Set the right and bottom limits in pixels for scrolling to end. If the camera is outside of this limit the background will not continue to scroll. If an axis is less than or equal to the corresponding axis of limit_begin, then it will not limit scrolling for that axis. </description> </method> <method name="set_scroll_base_offset"> <argument index="0" name="ofs" type="Vector2"> </argument> <description> - Set the base offset in pixels of all children [ParallaxLayer] nodes. + Set the base offset in pixels of all children [ParallaxLayer] nodes. </description> </method> <method name="set_scroll_base_scale"> <argument index="0" name="scale" type="Vector2"> </argument> <description> - Set the base motion scale of all children [ParallaxLayer] nodes. + Set the base motion scale of all children [ParallaxLayer] nodes. </description> </method> <method name="set_scroll_offset"> @@ -24066,17 +24066,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="ParallaxLayer" inherits="Node2D" category="Core"> <brief_description> - A parallax scrolling layer to be used with [ParallaxBackground]. + A parallax scrolling layer to be used with [ParallaxBackground]. </brief_description> <description> - A ParallaxLayer must be the child of a [ParallaxBackground] node. All child nodes will be affected by the parallax scrolling of this layer. + A ParallaxLayer must be the child of a [ParallaxBackground] node. All child nodes will be affected by the parallax scrolling of this layer. </description> <methods> <method name="get_mirroring" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the mirroring of the ParallaxLayer. + Return the mirroring of the ParallaxLayer. </description> </method> <method name="get_motion_offset" qualifiers="const"> @@ -24089,14 +24089,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Vector2"> </return> <description> - Return the motion scale of the ParallaxLayer. + Return the motion scale of the ParallaxLayer. </description> </method> <method name="set_mirroring"> <argument index="0" name="mirror" type="Vector2"> </argument> <description> - Set the mirroring of the ParallaxLayer. If an axis is set to 0 then that axis will have no mirroring. + Set the mirroring of the ParallaxLayer. If an axis is set to 0 then that axis will have no mirroring. </description> </method> <method name="set_motion_offset"> @@ -24109,7 +24109,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="scale" type="Vector2"> </argument> <description> - Set the motion scale of the ParallaxLayer. If an axis is set to 0 then it will not move at all, it will stick with the camera. + Set the motion scale of the ParallaxLayer. If an axis is set to 0 then it will not move at all, it will stick with the camera. </description> </method> </methods> @@ -24200,17 +24200,17 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Particles" inherits="GeometryInstance" category="Core"> <brief_description> - Particle system 3D Node + Particle system 3D Node </brief_description> <description> - Particles is a particle system 3D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist). + Particles is a particle system 3D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist). </description> <methods> <method name="get_amount" qualifiers="const"> <return type="int"> </return> <description> - Return the total amount of particles in the system. + Return the total amount of particles in the system. </description> </method> <method name="get_color_phase_color" qualifiers="const"> @@ -24219,7 +24219,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="phase" type="int"> </argument> <description> - Return the color of a color phase. + Return the color of a color phase. </description> </method> <method name="get_color_phase_pos" qualifiers="const"> @@ -24228,7 +24228,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="phase" type="int"> </argument> <description> - Return the position of a color phase (0 to 1). + Return the position of a color phase (0 to 1). </description> </method> <method name="get_color_phases" qualifiers="const"> @@ -24247,7 +24247,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Vector3"> </return> <description> - Return the half extents for the emission box. + Return the half extents for the emission box. </description> </method> <method name="get_emission_points" qualifiers="const"> @@ -24266,14 +24266,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Vector3"> </return> <description> - Return the normal vector towards where gravity is pulling (by default, negative Y). + Return the normal vector towards where gravity is pulling (by default, negative Y). </description> </method> <method name="get_material" qualifiers="const"> <return type="Material"> </return> <description> - Return the material used to draw particles. + Return the material used to draw particles. </description> </method> <method name="get_randomness" qualifiers="const"> @@ -24282,7 +24282,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="variable" type="int"> </argument> <description> - Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. + Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. </description> </method> <method name="get_variable" qualifiers="const"> @@ -24291,14 +24291,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="variable" type="int"> </argument> <description> - Return a specific variable for the particle system (see VAR_* enum). + Return a specific variable for the particle system (see VAR_* enum). </description> </method> <method name="get_visibility_aabb" qualifiers="const"> <return type="AABB"> </return> <description> - Return the current visibility AABB. + Return the current visibility AABB. </description> </method> <method name="has_height_from_velocity" qualifiers="const"> @@ -24311,7 +24311,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Return the "emitting" property state (see [method set_emitting]). + Return the "emitting" property state (see [method set_emitting]). </description> </method> <method name="is_using_local_coordinates" qualifiers="const"> @@ -24324,7 +24324,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="amount" type="int"> </argument> <description> - Set total amount of particles in the system. + Set total amount of particles in the system. </description> </method> <method name="set_color_phase_color"> @@ -24333,7 +24333,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="color" type="Color"> </argument> <description> - Set the color of a color phase. + Set the color of a color phase. </description> </method> <method name="set_color_phase_pos"> @@ -24342,7 +24342,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="pos" type="float"> </argument> <description> - Set the position of a color phase (0 to 1). + Set the position of a color phase (0 to 1). </description> </method> <method name="set_color_phases"> @@ -24361,7 +24361,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="half_extents" type="Vector3"> </argument> <description> - Set the half extents for the emission box. + Set the half extents for the emission box. </description> </method> <method name="set_emission_points"> @@ -24380,14 +24380,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate. + Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate. </description> </method> <method name="set_gravity_normal"> <argument index="0" name="normal" type="Vector3"> </argument> <description> - Set the normal vector towards where gravity is pulling (by default, negative Y). + Set the normal vector towards where gravity is pulling (by default, negative Y). </description> </method> <method name="set_height_from_velocity"> @@ -24400,7 +24400,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="material" type="Material"> </argument> <description> - Set the material used to draw particles. + Set the material used to draw particles. </description> </method> <method name="set_randomness"> @@ -24409,7 +24409,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="randomness" type="float"> </argument> <description> - Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. + Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. </description> </method> <method name="set_use_local_coordinates"> @@ -24424,14 +24424,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="value" type="float"> </argument> <description> - Set a specific variable for the particle system (see VAR_* enum). + Set a specific variable for the particle system (see VAR_* enum). </description> </method> <method name="set_visibility_aabb"> <argument index="0" name="aabb" type="AABB"> </argument> <description> - Set the visibility AABB for the particle system, since the default one will not work properly most of the time. + Set the visibility AABB for the particle system, since the default one will not work properly most of the time. </description> </method> </methods> @@ -24468,24 +24468,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Particles2D" inherits="Node2D" category="Core"> <brief_description> - 2D Particle emitter + 2D Particle emitter </brief_description> <description> - Particles2D is a particle system 2D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist). + Particles2D is a particle system 2D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist). </description> <methods> <method name="get_amount" qualifiers="const"> <return type="int"> </return> <description> - Returns the amount of particles spawned at each emission + Returns the amount of particles spawned at each emission </description> </method> <method name="get_color" qualifiers="const"> <return type="Color"> </return> <description> - Returns the tint color for each particle. + Returns the tint color for each particle. </description> </method> <method name="get_color_phase_color" qualifiers="const"> @@ -24514,14 +24514,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="ColorRamp"> </return> <description> - Returns the [ColorRamp] used to tint each particle + Returns the [ColorRamp] used to tint each particle </description> </method> <method name="get_emission_half_extents" qualifiers="const"> <return type="Vector2"> </return> <description> - Returns the half extents of the emission box. + Returns the half extents of the emission box. </description> </method> <method name="get_emission_points" qualifiers="const"> @@ -24534,14 +24534,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="Vector2"> </return> <description> - Returns the particle spawn origin position relative to the emitter. + Returns the particle spawn origin position relative to the emitter. </description> </method> <method name="get_emit_timeout" qualifiers="const"> <return type="float"> </return> <description> - Returns the amount of seconds during which the emitter will spawn particles + Returns the amount of seconds during which the emitter will spawn particles </description> </method> <method name="get_explosiveness" qualifiers="const"> @@ -24566,7 +24566,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="float"> </return> <description> - Gets the amount of seconds that each particle will be visible. + Gets the amount of seconds that each particle will be visible. </description> </method> <method name="get_param" qualifiers="const"> @@ -24575,7 +24575,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="param" type="int"> </argument> <description> - Returns the value of the specified emitter parameter + Returns the value of the specified emitter parameter </description> </method> <method name="get_pre_process_time" qualifiers="const"> @@ -24590,21 +24590,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="param" type="int"> </argument> <description> - Returns the randomness value of the specified emitter parameter + Returns the randomness value of the specified emitter parameter </description> </method> <method name="get_texture" qualifiers="const"> <return type="Texture"> </return> <description> - Returns the texture for emitted particles + Returns the texture for emitted particles </description> </method> <method name="get_time_scale" qualifiers="const"> <return type="float"> </return> <description> - Returns the emitter time scale + Returns the emitter time scale </description> </method> <method name="get_v_frames" qualifiers="const"> @@ -24617,7 +24617,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <return type="bool"> </return> <description> - Returns whether this emitter is currently emitting or not + Returns whether this emitter is currently emitting or not </description> </method> <method name="is_flipped_h" qualifiers="const"> @@ -24652,14 +24652,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="amount" type="int"> </argument> <description> - Sets the amount of particles spawned at each emission + Sets the amount of particles spawned at each emission </description> </method> <method name="set_color"> <argument index="0" name="color" type="Color"> </argument> <description> - Set the tint color for each particle. + Set the tint color for each particle. </description> </method> <method name="set_color_phase_color"> @@ -24690,14 +24690,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="color_ramp" type="Object"> </argument> <description> - Sets the [ColorRamp] used to tint each particle. Particle will be tinted according to their lifetimes. + Sets the [ColorRamp] used to tint each particle. Particle will be tinted according to their lifetimes. </description> </method> <method name="set_emission_half_extents"> <argument index="0" name="extents" type="Vector2"> </argument> <description> - Sets the half extents of the emission box, particles will be spawned at random inside this box. + Sets the half extents of the emission box, particles will be spawned at random inside this box. </description> </method> <method name="set_emission_points"> @@ -24710,21 +24710,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="offset" type="Vector2"> </argument> <description> - Sets the particle spawn origin position relative to the emitter center. for example if this value is set to (50, 50), the particle will spawn 50 units to the right and 50 units to the bottom of the emitter center. + Sets the particle spawn origin position relative to the emitter center. for example if this value is set to (50, 50), the particle will spawn 50 units to the right and 50 units to the bottom of the emitter center. </description> </method> <method name="set_emit_timeout"> <argument index="0" name="value" type="float"> </argument> <description> - Sets the amount of seconds during which the emitter will spawn particles, after the specified seconds the emitter state will be set to non emitting, so calling [method is_emitting] will return false. If the timeout is 0 the emitter will spawn forever. + Sets the amount of seconds during which the emitter will spawn particles, after the specified seconds the emitter state will be set to non emitting, so calling [method is_emitting] will return false. If the timeout is 0 the emitter will spawn forever. </description> </method> <method name="set_emitting"> <argument index="0" name="active" type="bool"> </argument> <description> - If this is set to true then the particle emitter will emit particles, if its false it will not. + If this is set to true then the particle emitter will emit particles, if its false it will not. </description> </method> <method name="set_explosiveness"> @@ -24761,7 +24761,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="lifetime" type="float"> </argument> <description> - Sets the amount of seconds that each particle will be visible. + Sets the amount of seconds that each particle will be visible. </description> </method> <method name="set_param"> @@ -24770,7 +24770,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="value" type="float"> </argument> <description> - Sets the value of the specified emitter parameter (see the constants secction for the list of parameters) + Sets the value of the specified emitter parameter (see the constants secction for the list of parameters) </description> </method> <method name="set_pre_process_time"> @@ -24785,7 +24785,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="1" name="value" type="float"> </argument> <description> - Sets the randomness value of the specified emitter parameter (see the constants secction for the list of parameters), 0 means no randomness, so every particle will have the parameters specified, 1 means that the parameter will be choosen at random, the closer the randomness value gets to 0 the more conservative the variation of the parameter will be. + Sets the randomness value of the specified emitter parameter (see the constants secction for the list of parameters), 0 means no randomness, so every particle will have the parameters specified, 1 means that the parameter will be choosen at random, the closer the randomness value gets to 0 the more conservative the variation of the parameter will be. </description> </method> <method name="set_texture"> @@ -24794,14 +24794,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) <argument index="0" name="texture" type="Object"> </argument> <description> - Sets the texture for each particle + Sets the texture for each particle </description> </method> <method name="set_time_scale"> <argument index="0" name="time_scale" type="float"> </argument> <description> - Sets the increment or decrement for the particle lifetime. for example: if the time scale is set to 2, the particles will die and move twice as fast. + Sets the increment or decrement for the particle lifetime. for example: if the time scale is set to 2, the particles will die and move twice as fast. </description> </method> <method name="set_use_local_space"> @@ -24948,24 +24948,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Path" inherits="Spatial" category="Core"> <brief_description> - Container for a [Curve3D]. + Container for a [Curve3D]. </brief_description> <description> - This class is a container/Node-ification of a [Curve3D], so it can have [Spatial] properties and [Node] info. + This class is a container/Node-ification of a [Curve3D], so it can have [Spatial] properties and [Node] info. </description> <methods> <method name="get_curve" qualifiers="const"> <return type="Curve3D"> </return> <description> - Returns the [Curve3D] contained. + Returns the [Curve3D] contained. </description> </method> <method name="set_curve"> <argument index="0" name="curve" type="Curve3D"> </argument> <description> - Sets the [Curve3D]. + Sets the [Curve3D]. </description> </method> </methods> @@ -24974,24 +24974,24 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="Path2D" inherits="Node2D" category="Core"> <brief_description> - Container for a [Curve2D]. + Container for a [Curve2D]. </brief_description> <description> - This class is a container/Node-ification of a [Curve2D], so it can have [Node2D] properties and [Node] info. + This class is a container/Node-ification of a [Curve2D], so it can have [Node2D] properties and [Node] info. </description> <methods> <method name="get_curve" qualifiers="const"> <return type="Curve2D"> </return> <description> - Returns the [Curve2D] contained. + Returns the [Curve2D] contained. </description> </method> <method name="set_curve"> <argument index="0" name="curve" type="Curve2D"> </argument> <description> - Sets the [Curve2D]. + Sets the [Curve2D]. </description> </method> </methods> @@ -25000,10 +25000,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8) </class> <class name="PathFollow" inherits="Spatial" category="Core"> <brief_description> - Point sampler for a [Path]. + Point sampler for a [Path]. </brief_description> <description> - This node takes its parent [Path], and returns the coordinates of a point within it, given a distance from the first vertex. + This node takes its parent [Path], and returns the coordinates of a point within it, given a distance from the first vertex. It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. </description> <methods> @@ -25011,56 +25011,56 @@ It is useful for making other nodes follow a path, without coding the movement p <return type="bool"> </return> <description> - This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. + This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. </description> </method> <method name="get_h_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the X displacement this node has from its parent [Path]. + Returns the X displacement this node has from its parent [Path]. </description> </method> <method name="get_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the distance along the path in 3D units. + Returns the distance along the path in 3D units. </description> </method> <method name="get_rotation_mode" qualifiers="const"> <return type="int"> </return> <description> - Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode. + Returns the rotation mode. The constants below list which axes are allowed to rotate for each mode. </description> </method> <method name="get_unit_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). + Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). </description> </method> <method name="get_v_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the Y displacement this node has from its parent [Path]. + Returns the Y displacement this node has from its parent [Path]. </description> </method> <method name="has_loop" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether this node wraps its offsets around, or truncates them to the path ends. + Returns whether this node wraps its offsets around, or truncates them to the path ends. </description> </method> <method name="set_cubic_interpolation"> <argument index="0" name="enable" type="bool"> </argument> <description> - The points along the [Curve3D] of the [Path] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. + The points along the [Curve3D] of the [Path] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. This method controls whether the position between two cached points is interpolated linearly, or cubicly. </description> @@ -25069,7 +25069,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="h_offset" type="float"> </argument> <description> - Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. + Moves this node in the X axis. As this node's position will be set every time its offset is set, this allows many PathFollow to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. A similar effect may be achieved moving the this node's descendants. </description> </method> @@ -25077,35 +25077,35 @@ A similar effect may be achieved moving the this node's descendants. <argument index="0" name="loop" type="bool"> </argument> <description> - If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths. + If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths. </description> </method> <method name="set_offset"> <argument index="0" name="offset" type="float"> </argument> <description> - Sets the distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. + Sets the distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. </description> </method> <method name="set_rotation_mode"> <argument index="0" name="rotation_mode" type="int"> </argument> <description> - Allows or forbids rotation on one or more axes, per the constants below. + Allows or forbids rotation on one or more axes, per the constants below. </description> </method> <method name="set_unit_offset"> <argument index="0" name="unit_offset" type="float"> </argument> <description> - Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. + Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. </description> </method> <method name="set_v_offset"> <argument index="0" name="v_offset" type="float"> </argument> <description> - Moves this node in the Y axis, for the same reasons of [method set_h_offset]. + Moves this node in the Y axis, for the same reasons of [method set_h_offset]. </description> </method> </methods> @@ -25126,10 +25126,10 @@ A similar effect may be achieved moving the this node's descendants. </class> <class name="PathFollow2D" inherits="Node2D" category="Core"> <brief_description> - Point sampler for a [Path2D]. + Point sampler for a [Path2D]. </brief_description> <description> - This node takes its parent [Path2D], and returns the coordinates of a point within it, given a distance from the first vertex. + This node takes its parent [Path2D], and returns the coordinates of a point within it, given a distance from the first vertex. It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly. </description> <methods> @@ -25137,56 +25137,56 @@ It is useful for making other nodes follow a path, without coding the movement p <return type="bool"> </return> <description> - This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. + This method returns whether the position between two cached points (see [method set_cubic_interpolation]) is interpolated linearly, or cubicly. </description> </method> <method name="get_h_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the horizontal displacement this node has from its parent [Path2D]. + Returns the horizontal displacement this node has from its parent [Path2D]. </description> </method> <method name="get_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the distance along the path in pixels. + Returns the distance along the path in pixels. </description> </method> <method name="get_unit_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). + Returns the distance along the path as a number in the range 0.0 (for the first vertex) to 1.0 (for the last). </description> </method> <method name="get_v_offset" qualifiers="const"> <return type="float"> </return> <description> - Returns the vertical displacement this node has from its parent [Path2D]. + Returns the vertical displacement this node has from its parent [Path2D]. </description> </method> <method name="has_loop" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether this node wraps its offsets around, or truncates them to the path ends. + Returns whether this node wraps its offsets around, or truncates them to the path ends. </description> </method> <method name="is_rotating" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether this node rotates to follow the path. + Returns whether this node rotates to follow the path. </description> </method> <method name="set_cubic_interpolation"> <argument index="0" name="enable" type="bool"> </argument> <description> - The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. + The points along the [Curve2D] of the [Path2D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. There are two answers to this problem: Either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations. This method controls whether the position between two cached points is interpolated linearly, or cubicly. </description> @@ -25195,7 +25195,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="h_offset" type="float"> </argument> <description> - Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. + Moves this node horizontally. As this node's position will be set every time its offset is set, this allows many PathFollow2D to share the same curve (and thus the same movement pattern), yet not return the same position for a given path offset. A similar effect may be achieved moving this node's descendants. </description> </method> @@ -25203,35 +25203,35 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="loop" type="bool"> </argument> <description> - If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths. + If set, any offset outside the path's length (whether set by [method set_offset] or [method set_unit_offset] will wrap around, instead of stopping at the ends. Set it for cyclic paths. </description> </method> <method name="set_offset"> <argument index="0" name="offset" type="float"> </argument> <description> - Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path. + Sets the distance from the first vertex, measured in pixels along the path. This sets this node's position to a point within the path. </description> </method> <method name="set_rotate"> <argument index="0" name="enable" type="bool"> </argument> <description> - If set, this node rotates to follow the path, making its descendants rotate. + If set, this node rotates to follow the path, making its descendants rotate. </description> </method> <method name="set_unit_offset"> <argument index="0" name="unit_offset" type="float"> </argument> <description> - Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. + Sets the distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the offset within the path, as the offset supplied is multiplied internally by the path's length. </description> </method> <method name="set_v_offset"> <argument index="0" name="v_offset" type="float"> </argument> <description> - Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset]. + Moves the PathFollow2D vertically, for the same reasons of [method set_h_offset]. </description> </method> </methods> @@ -25240,10 +25240,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="PathRemap" inherits="Object" category="Core"> <brief_description> - Singleton containing the list of remapped resources. + Singleton containing the list of remapped resources. </brief_description> <description> - When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necessary to access to this directly (path remapping happens automatically when opening a file), it's exported just for information. + When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necessary to access to this directly (path remapping happens automatically when opening a file), it's exported just for information. </description> <methods> <method name="add_remap"> @@ -25254,19 +25254,19 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="locale" type="String" default=""""> </argument> <description> - Add a remap from a file to another. + Add a remap from a file to another. </description> </method> <method name="clear_remaps"> <description> - Clear all remaps. + Clear all remaps. </description> </method> <method name="erase_remap"> <argument index="0" name="path" type="String"> </argument> <description> - Erase a remap. + Erase a remap. </description> </method> <method name="get_remap" qualifiers="const"> @@ -25275,7 +25275,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="path" type="String"> </argument> <description> - Return the remapped new path of a file. + Return the remapped new path of a file. </description> </method> <method name="has_remap" qualifiers="const"> @@ -25284,7 +25284,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="path" type="String"> </argument> <description> - Return true if a file is being remapped. + Return true if a file is being remapped. </description> </method> </methods> @@ -25367,17 +25367,17 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Physics2DDirectBodyState" inherits="Object" category="Core"> <brief_description> - Direct access object to a physics body in the [Physics2DServer]. + Direct access object to a physics body in the [Physics2DServer]. </brief_description> <description> - Direct access object to a physics body in the [Physics2DServer]. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body. + Direct access object to a physics body in the [Physics2DServer]. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body. </description> <methods> <method name="get_angular_velocity" qualifiers="const"> <return type="float"> </return> <description> - Return the angular velocity of the body. + Return the angular velocity of the body. </description> </method> <method name="get_contact_collider" qualifiers="const"> @@ -25386,7 +25386,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the [RID] of the collider. + Return the [RID] of the collider. </description> </method> <method name="get_contact_collider_id" qualifiers="const"> @@ -25395,7 +25395,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the object id of the collider. + Return the object id of the collider. </description> </method> <method name="get_contact_collider_object" qualifiers="const"> @@ -25404,7 +25404,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the collider object, this depends on how it was created (will return a scene node if such was used to create it). + Return the collider object, this depends on how it was created (will return a scene node if such was used to create it). </description> </method> <method name="get_contact_collider_pos" qualifiers="const"> @@ -25413,7 +25413,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the contact position in the collider. + Return the contact position in the collider. </description> </method> <method name="get_contact_collider_shape" qualifiers="const"> @@ -25422,7 +25422,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the collider shape index. + Return the collider shape index. </description> </method> <method name="get_contact_collider_shape_metadata" qualifiers="const"> @@ -25431,7 +25431,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the metadata of the collided shape. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. + Return the metadata of the collided shape. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. </description> </method> <method name="get_contact_collider_velocity_at_pos" qualifiers="const"> @@ -25440,14 +25440,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the linear velocity vector at contact point of the collider. + Return the linear velocity vector at contact point of the collider. </description> </method> <method name="get_contact_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. + Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts. </description> </method> <method name="get_contact_local_normal" qualifiers="const"> @@ -25456,7 +25456,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the local normal (of this body) of the contact point. + Return the local normal (of this body) of the contact point. </description> </method> <method name="get_contact_local_pos" qualifiers="const"> @@ -25465,7 +25465,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the local position (of this body) of the contact point. + Return the local position (of this body) of the contact point. </description> </method> <method name="get_contact_local_shape" qualifiers="const"> @@ -25474,110 +25474,110 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="contact_idx" type="int"> </argument> <description> - Return the local shape index of the collision. + Return the local shape index of the collision. </description> </method> <method name="get_inverse_inertia" qualifiers="const"> <return type="float"> </return> <description> - Return the inverse of the inertia of the body. + Return the inverse of the inertia of the body. </description> </method> <method name="get_inverse_mass" qualifiers="const"> <return type="float"> </return> <description> - Return the inverse of the mass of the body. + Return the inverse of the mass of the body. </description> </method> <method name="get_linear_velocity" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the current linear velocity of the body. + Return the current linear velocity of the body. </description> </method> <method name="get_space_state"> <return type="Physics2DDirectSpaceState"> </return> <description> - Return the current state of space, useful for queries. + Return the current state of space, useful for queries. </description> </method> <method name="get_step" qualifiers="const"> <return type="float"> </return> <description> - Return the timestep (delta) used for the simulation. + Return the timestep (delta) used for the simulation. </description> </method> <method name="get_total_angular_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the rate at which the body stops rotating, if there are not any other forces moving it. + Return the rate at which the body stops rotating, if there are not any other forces moving it. </description> </method> <method name="get_total_gravity" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the total gravity vector being currently applied to this body. + Return the total gravity vector being currently applied to this body. </description> </method> <method name="get_total_linear_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the rate at which the body stops moving, if there are not any other forces moving it. + Return the rate at which the body stops moving, if there are not any other forces moving it. </description> </method> <method name="get_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Return the transform matrix of the body. + Return the transform matrix of the body. </description> </method> <method name="integrate_forces"> <description> - Call the built-in force integration code. + Call the built-in force integration code. </description> </method> <method name="is_sleeping" qualifiers="const"> <return type="bool"> </return> <description> - Return true if this body is currently sleeping (not active). + Return true if this body is currently sleeping (not active). </description> </method> <method name="set_angular_velocity"> <argument index="0" name="velocity" type="float"> </argument> <description> - Change the angular velocity of the body. + Change the angular velocity of the body. </description> </method> <method name="set_linear_velocity"> <argument index="0" name="velocity" type="Vector2"> </argument> <description> - Change the linear velocity of the body. + Change the linear velocity of the body. </description> </method> <method name="set_sleep_state"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the sleeping state of the body, only affects character/rigid bodies. + Set the sleeping state of the body, only affects character/rigid bodies. </description> </method> <method name="set_transform"> <argument index="0" name="transform" type="Matrix32"> </argument> <description> - Change the transform matrix of the body. + Change the transform matrix of the body. </description> </method> </methods> @@ -25586,10 +25586,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Physics2DDirectBodyStateSW" inherits="Physics2DDirectBodyState" category="Core"> <brief_description> - Software implementation of [Physics2DDirectBodyState]. + Software implementation of [Physics2DDirectBodyState]. </brief_description> <description> - Software implementation of [Physics2DDirectBodyState]. This object exposes no new methods or properties and should not be used, as [Physics2DDirectBodyState] selects the best implementation available. + Software implementation of [Physics2DDirectBodyState]. This object exposes no new methods or properties and should not be used, as [Physics2DDirectBodyState] selects the best implementation available. </description> <methods> </methods> @@ -25598,10 +25598,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Physics2DDirectSpaceState" inherits="Object" category="Core"> <brief_description> - Direct access object to a space in the [Physics2DServer]. + Direct access object to a space in the [Physics2DServer]. </brief_description> <description> - Direct access object to a space in the [Physics2DServer]. It's used mainly to do queries against objects and areas residing in a given space. + Direct access object to a space in the [Physics2DServer]. It's used mainly to do queries against objects and areas residing in a given space. </description> <methods> <method name="cast_motion"> @@ -25610,7 +25610,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> </argument> <description> - Check whether the shape can travel to a point. If it can, the method will return an array with two floats: The first is the distance the shape can move in that direction without colliding, and the second is the distance at which it will collide. + Check whether the shape can travel to a point. If it can, the method will return an array with two floats: The first is the distance the shape can move in that direction without colliding, and the second is the distance at which it will collide. If the shape can not move, the array will be empty. </description> </method> @@ -25622,7 +25622,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="max_results" type="int" default="32"> </argument> <description> - Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. + Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. </description> </method> <method name="get_rest_info"> @@ -25631,7 +25631,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="shape" type="Physics2DShapeQueryParameters"> </argument> <description> - Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. If it collides with more than a shape, the nearest one is selected. The returned object is a dictionary containing the following fields: + Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. If it collides with more than a shape, the nearest one is selected. The returned object is a dictionary containing the following fields: pointo: Place where the shapes intersect. normal: Normal of the object at the point where the shapes intersect. shape: Shape index within the object against which the shape intersected. @@ -25657,7 +25657,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="4" name="type_mask" type="int" default="15"> </argument> <description> - Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: + Check whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: shape: Shape index within the object the point is in. metadata: Metadata of the shape the point is in. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. collider_id: Id of the object the point is in. @@ -25680,7 +25680,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="4" name="type_mask" type="int" default="15"> </argument> <description> - Intersect a ray in a given space. The returned object is a dictionary with the following fields: + Intersect a ray in a given space. The returned object is a dictionary with the following fields: position: Place where ray is stopped. normal: Normal of the object at the point where the ray was stopped. shape: Shape index within the object against which the ray was stopped. @@ -25700,7 +25700,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="max_results" type="int" default="32"> </argument> <description> - Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: + Check the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: shape: Shape index within the object the shape intersected. metadata: Metadata of the shape intersected by the shape given through the [Physics2DShapeQueryParameters]. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. collider_id: Id of the object the shape intersected. @@ -25733,10 +25733,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Physics2DServer" inherits="Object" category="Core"> <brief_description> - Physics 2D Server. + Physics 2D Server. </brief_description> <description> - Physics 2D Server is the server responsible for all 2D physics. It can create many kinds of physics objects, but does not insert them on the node tree. + Physics 2D Server is the server responsible for all 2D physics. It can create many kinds of physics objects, but does not insert them on the node tree. </description> <methods> <method name="area_add_shape"> @@ -25747,7 +25747,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="transform" type="Matrix32" default="1,0, 0,1, 0,0"> </argument> <description> - Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. + Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> <method name="area_attach_object_instance_ID"> @@ -25756,21 +25756,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="id" type="int"> </argument> <description> - Assign the area to a descendant of [Object], so it can exist in the node tree. + Assign the area to a descendant of [Object], so it can exist in the node tree. </description> </method> <method name="area_clear_shapes"> <argument index="0" name="area" type="RID"> </argument> <description> - Remove all shapes from an area. It does not delete the shapes, so they can be reassigned later. + Remove all shapes from an area. It does not delete the shapes, so they can be reassigned later. </description> </method> <method name="area_create"> <return type="RID"> </return> <description> - Create an [Area2D]. + Create an [Area2D]. </description> </method> <method name="area_get_object_instance_ID" qualifiers="const"> @@ -25779,7 +25779,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="area" type="RID"> </argument> <description> - Get the instance ID of the object the area is assigned to. + Get the instance ID of the object the area is assigned to. </description> </method> <method name="area_get_param" qualifiers="const"> @@ -25788,7 +25788,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="param" type="int"> </argument> <description> - Return an area parameter value. + Return an area parameter value. </description> </method> <method name="area_get_shape" qualifiers="const"> @@ -25799,7 +25799,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the [RID] of the nth shape of an area. + Return the [RID] of the nth shape of an area. </description> </method> <method name="area_get_shape_count" qualifiers="const"> @@ -25808,7 +25808,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="area" type="RID"> </argument> <description> - Return the number of shapes assigned to an area. + Return the number of shapes assigned to an area. </description> </method> <method name="area_get_shape_transform" qualifiers="const"> @@ -25819,7 +25819,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the transform matrix of a shape within an area. + Return the transform matrix of a shape within an area. </description> </method> <method name="area_get_space" qualifiers="const"> @@ -25828,7 +25828,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="area" type="RID"> </argument> <description> - Return the space assigned to the area. + Return the space assigned to the area. </description> </method> <method name="area_get_space_override_mode" qualifiers="const"> @@ -25837,7 +25837,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="area" type="RID"> </argument> <description> - Return the space override mode for the area. + Return the space override mode for the area. </description> </method> <method name="area_get_transform" qualifiers="const"> @@ -25846,7 +25846,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="area" type="RID"> </argument> <description> - Return the transform matrix for an area. + Return the transform matrix for an area. </description> </method> <method name="area_remove_shape"> @@ -25855,7 +25855,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shape_idx" type="int"> </argument> <description> - Remove a shape from an area. It does not delete the shape, so it can be reassigned later. + Remove a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> <method name="area_set_collision_mask"> @@ -25864,7 +25864,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="mask" type="int"> </argument> <description> - Set which physics layers the area will monitor. + Set which physics layers the area will monitor. </description> </method> <method name="area_set_layer_mask"> @@ -25873,7 +25873,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="mask" type="int"> </argument> <description> - Assign the area to one or many physics layers. + Assign the area to one or many physics layers. </description> </method> <method name="area_set_monitor_callback"> @@ -25884,7 +25884,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="method" type="String"> </argument> <description> - Set the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: + Set the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area. 2: [RID] of the object that entered/exited the area. 3: Instance ID of the object that entered/exited the area. @@ -25900,7 +25900,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="value" type="Variant"> </argument> <description> - Set the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants. + Set the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants. </description> </method> <method name="area_set_shape"> @@ -25911,7 +25911,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="shape" type="RID"> </argument> <description> - Substitute a given area shape by another. The old shape is selected by its index, the new one by its [RID]. + Substitute a given area shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> <method name="area_set_shape_transform"> @@ -25922,7 +25922,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="transform" type="Matrix32"> </argument> <description> - Set the transform matrix for an area shape. + Set the transform matrix for an area shape. </description> </method> <method name="area_set_space"> @@ -25931,7 +25931,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="space" type="RID"> </argument> <description> - Assign a space to the area. + Assign a space to the area. </description> </method> <method name="area_set_space_override_mode"> @@ -25940,7 +25940,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="mode" type="int"> </argument> <description> - Set the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*. + Set the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*. </description> </method> <method name="area_set_transform"> @@ -25949,7 +25949,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="transform" type="Matrix32"> </argument> <description> - Set the transform matrix for an area. + Set the transform matrix for an area. </description> </method> <method name="body_add_collision_exception"> @@ -25958,7 +25958,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="excepted_body" type="RID"> </argument> <description> - Add a body to the list of bodies exempt from collisions. + Add a body to the list of bodies exempt from collisions. </description> </method> <method name="body_add_force"> @@ -25969,7 +25969,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="force" type="Vector2"> </argument> <description> - Add a positioned force to the applied force and torque. As with [method body_apply_impulse], both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied. + Add a positioned force to the applied force and torque. As with [method body_apply_impulse], both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied. </description> </method> <method name="body_add_shape"> @@ -25980,7 +25980,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="transform" type="Matrix32" default="1,0, 0,1, 0,0"> </argument> <description> - Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. + Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> <method name="body_apply_impulse"> @@ -25991,7 +25991,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="impulse" type="Vector2"> </argument> <description> - Add a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. + Add a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. </description> </method> <method name="body_attach_object_instance_ID"> @@ -26000,14 +26000,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="id" type="int"> </argument> <description> - Assign the area to a descendant of [Object], so it can exist in the node tree. + Assign the area to a descendant of [Object], so it can exist in the node tree. </description> </method> <method name="body_clear_shapes"> <argument index="0" name="body" type="RID"> </argument> <description> - Remove all shapes from a body. + Remove all shapes from a body. </description> </method> <method name="body_create"> @@ -26018,7 +26018,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="init_sleeping" type="bool" default="false"> </argument> <description> - Create a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. + Create a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. </description> </method> <method name="body_get_collision_mask" qualifiers="const"> @@ -26027,7 +26027,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Return the physics layer or layers a body can collide with. + Return the physics layer or layers a body can collide with. </description> </method> <method name="body_get_continuous_collision_detection_mode" qualifiers="const"> @@ -26036,7 +26036,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Return the continuous collision detection mode. + Return the continuous collision detection mode. </description> </method> <method name="body_get_layer_mask" qualifiers="const"> @@ -26045,7 +26045,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Return the physics layer or layers a body belongs to. + Return the physics layer or layers a body belongs to. </description> </method> <method name="body_get_max_contacts_reported" qualifiers="const"> @@ -26054,7 +26054,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Return the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. + Return the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. </description> </method> <method name="body_get_mode" qualifiers="const"> @@ -26063,7 +26063,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Return the body mode. + Return the body mode. </description> </method> <method name="body_get_object_instance_ID" qualifiers="const"> @@ -26072,7 +26072,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Get the instance ID of the object the area is assigned to. + Get the instance ID of the object the area is assigned to. </description> </method> <method name="body_get_one_way_collision_direction" qualifiers="const"> @@ -26081,7 +26081,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Return the direction used for one-way collision detection. + Return the direction used for one-way collision detection. </description> </method> <method name="body_get_one_way_collision_max_depth" qualifiers="const"> @@ -26090,7 +26090,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Return how far a body can go through the given one, when it allows one-way collisions. + Return how far a body can go through the given one, when it allows one-way collisions. </description> </method> <method name="body_get_param" qualifiers="const"> @@ -26101,7 +26101,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="param" type="int"> </argument> <description> - Return the value of a body parameter. + Return the value of a body parameter. </description> </method> <method name="body_get_shape" qualifiers="const"> @@ -26112,7 +26112,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the [RID] of the nth shape of a body. + Return the [RID] of the nth shape of a body. </description> </method> <method name="body_get_shape_count" qualifiers="const"> @@ -26121,7 +26121,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Return the number of shapes assigned to a body. + Return the number of shapes assigned to a body. </description> </method> <method name="body_get_shape_metadata" qualifiers="const"> @@ -26130,7 +26130,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the metadata of a shape of a body. + Return the metadata of a shape of a body. </description> </method> <method name="body_get_shape_transform" qualifiers="const"> @@ -26141,7 +26141,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the transform matrix of a body shape. + Return the transform matrix of a body shape. </description> </method> <method name="body_get_space" qualifiers="const"> @@ -26150,7 +26150,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Return the [RID] of the space assigned to a body. + Return the [RID] of the space assigned to a body. </description> </method> <method name="body_get_state" qualifiers="const"> @@ -26159,7 +26159,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="state" type="int"> </argument> <description> - Return a body state. + Return a body state. </description> </method> <method name="body_is_omitting_force_integration" qualifiers="const"> @@ -26168,7 +26168,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="RID"> </argument> <description> - Return whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). + Return whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> <method name="body_is_shape_set_as_trigger" qualifiers="const"> @@ -26179,7 +26179,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return whether a body's shape is marked as a trigger. + Return whether a body's shape is marked as a trigger. </description> </method> <method name="body_remove_collision_exception"> @@ -26188,7 +26188,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="excepted_body" type="RID"> </argument> <description> - Remove a body from the list of bodies exempt from collisions. + Remove a body from the list of bodies exempt from collisions. </description> </method> <method name="body_remove_shape"> @@ -26197,7 +26197,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shape_idx" type="int"> </argument> <description> - Remove a shape from a body. The shape is not deleted, so it can be reused afterwards. + Remove a shape from a body. The shape is not deleted, so it can be reused afterwards. </description> </method> <method name="body_set_axis_velocity"> @@ -26206,7 +26206,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="axis_velocity" type="Vector2"> </argument> <description> - Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. + Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="body_set_collision_mask"> @@ -26215,7 +26215,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="mask" type="int"> </argument> <description> - Set the physics layer or layers a body can collide with. + Set the physics layer or layers a body can collide with. </description> </method> <method name="body_set_continuous_collision_detection_mode"> @@ -26224,7 +26224,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="mode" type="int"> </argument> <description> - Set the continuous collision detection mode from any of the CCD_MODE_* constants. + Set the continuous collision detection mode from any of the CCD_MODE_* constants. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. </description> </method> @@ -26238,7 +26238,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="userdata" type="Variant" default="NULL"> </argument> <description> - Set the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). + Set the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). </description> </method> <method name="body_set_layer_mask"> @@ -26247,7 +26247,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="mask" type="int"> </argument> <description> - Set the physics layer or layers a body belongs to. + Set the physics layer or layers a body belongs to. </description> </method> <method name="body_set_max_contacts_reported"> @@ -26256,7 +26256,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="amount" type="int"> </argument> <description> - Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. + Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. </description> </method> <method name="body_set_mode"> @@ -26265,7 +26265,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="mode" type="int"> </argument> <description> - Set the body mode, from one of the constants BODY_MODE*. + Set the body mode, from one of the constants BODY_MODE*. </description> </method> <method name="body_set_omit_force_integration"> @@ -26274,7 +26274,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="enable" type="bool"> </argument> <description> - Set whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). + Set whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> <method name="body_set_one_way_collision_direction"> @@ -26283,7 +26283,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="normal" type="Vector2"> </argument> <description> - Set a direction in which bodies can go through the given one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions. + Set a direction in which bodies can go through the given one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions. </description> </method> <method name="body_set_one_way_collision_max_depth"> @@ -26292,7 +26292,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="depth" type="float"> </argument> <description> - Set how far a body can go through the given one, if it allows one-way collisions (see [method body_set_one_way_collision_direction]). + Set how far a body can go through the given one, if it allows one-way collisions (see [method body_set_one_way_collision_direction]). </description> </method> <method name="body_set_param"> @@ -26303,7 +26303,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="value" type="float"> </argument> <description> - Set a body parameter (see BODY_PARAM* constants). + Set a body parameter (see BODY_PARAM* constants). </description> </method> <method name="body_set_shape"> @@ -26314,7 +26314,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="shape" type="RID"> </argument> <description> - Substitute a given body shape by another. The old shape is selected by its index, the new one by its [RID]. + Substitute a given body shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> <method name="body_set_shape_as_trigger"> @@ -26325,7 +26325,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="enable" type="bool"> </argument> <description> - Mark a body's shape as a trigger. A trigger shape cannot affect other bodies, but detects other shapes entering and exiting it. + Mark a body's shape as a trigger. A trigger shape cannot affect other bodies, but detects other shapes entering and exiting it. </description> </method> <method name="body_set_shape_metadata"> @@ -26336,7 +26336,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="metadata" type="Variant"> </argument> <description> - Set metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries. + Set metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries. </description> </method> <method name="body_set_shape_transform"> @@ -26347,7 +26347,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="transform" type="Matrix32"> </argument> <description> - Set the transform matrix for a body shape. + Set the transform matrix for a body shape. </description> </method> <method name="body_set_space"> @@ -26356,7 +26356,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="space" type="RID"> </argument> <description> - Assign a space to the body (see [method create_space]). + Assign a space to the body (see [method create_space]). </description> </method> <method name="body_set_state"> @@ -26367,7 +26367,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="value" type="Variant"> </argument> <description> - Set a body state (see BODY_STATE* constants). + Set a body state (see BODY_STATE* constants). </description> </method> <method name="body_test_motion"> @@ -26382,7 +26382,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="result" type="Physics2DTestMotionResult" default="NULL"> </argument> <description> - Return whether a body can move in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in. + Return whether a body can move in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in. </description> </method> <method name="damped_spring_joint_create"> @@ -26397,7 +26397,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="body_b" type="RID" default="RID()"> </argument> <description> - Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. + Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. </description> </method> <method name="damped_string_joint_get_param" qualifiers="const"> @@ -26408,7 +26408,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="param" type="int"> </argument> <description> - Return the value of a damped spring joint parameter. + Return the value of a damped spring joint parameter. </description> </method> <method name="damped_string_joint_set_param"> @@ -26419,14 +26419,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="value" type="float"> </argument> <description> - Set a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants. + Set a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants. </description> </method> <method name="free_rid"> <argument index="0" name="rid" type="RID"> </argument> <description> - Destroy any of the objects created by Physics2DServer. If the [RID] passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console. + Destroy any of the objects created by Physics2DServer. If the [RID] passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console. </description> </method> <method name="get_process_info"> @@ -26435,7 +26435,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="process_info" type="int"> </argument> <description> - Return information about the current state of the 2D physics engine. The states are listed under the INFO_* constants. + Return information about the current state of the 2D physics engine. The states are listed under the INFO_* constants. </description> </method> <method name="groove_joint_create"> @@ -26452,7 +26452,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="4" name="body_b" type="RID" default="RID()"> </argument> <description> - Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. + Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. </description> </method> <method name="joint_get_param" qualifiers="const"> @@ -26463,7 +26463,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="param" type="int"> </argument> <description> - Return the value of a joint parameter. + Return the value of a joint parameter. </description> </method> <method name="joint_get_type" qualifiers="const"> @@ -26472,7 +26472,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="joint" type="RID"> </argument> <description> - Return the type of a joint (see JOINT_* constants). + Return the type of a joint (see JOINT_* constants). </description> </method> <method name="joint_set_param"> @@ -26483,7 +26483,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="value" type="float"> </argument> <description> - Set a joint parameter. Parameters are explained in the JOINT_PARAM* constants. + Set a joint parameter. Parameters are explained in the JOINT_PARAM* constants. </description> </method> <method name="pin_joint_create"> @@ -26496,14 +26496,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="body_b" type="RID" default="RID()"> </argument> <description> - Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. + Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. </description> </method> <method name="set_active"> <argument index="0" name="active" type="bool"> </argument> <description> - Activate or deactivate the 2D physics engine. + Activate or deactivate the 2D physics engine. </description> </method> <method name="shape_create"> @@ -26512,14 +26512,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="type" type="int"> </argument> <description> - Create a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape]. + Create a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape]. </description> </method> <method name="shape_get_data" qualifiers="const"> <argument index="0" name="shape" type="RID"> </argument> <description> - Return the shape data. + Return the shape data. </description> </method> <method name="shape_get_type" qualifiers="const"> @@ -26528,7 +26528,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="shape" type="RID"> </argument> <description> - Return the type of shape (see SHAPE_* constants). + Return the type of shape (see SHAPE_* constants). </description> </method> <method name="shape_set_data"> @@ -26537,14 +26537,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="data" type="Variant"> </argument> <description> - Set the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. + Set the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. </description> </method> <method name="space_create"> <return type="RID"> </return> <description> - Create a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space]. + Create a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space]. </description> </method> <method name="space_get_direct_state"> @@ -26553,7 +26553,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="space" type="RID"> </argument> <description> - Return the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries. + Return the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries. </description> </method> <method name="space_get_param" qualifiers="const"> @@ -26564,7 +26564,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="param" type="int"> </argument> <description> - Return the value of a space parameter. + Return the value of a space parameter. </description> </method> <method name="space_is_active" qualifiers="const"> @@ -26573,7 +26573,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="space" type="RID"> </argument> <description> - Return whether the space is active. + Return whether the space is active. </description> </method> <method name="space_set_active"> @@ -26582,7 +26582,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="active" type="bool"> </argument> <description> - Mark a space as active. It will not have an effect, unless it is assigned to an area or body. + Mark a space as active. It will not have an effect, unless it is assigned to an area or body. </description> </method> <method name="space_set_param"> @@ -26593,7 +26593,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="value" type="float"> </argument> <description> - Set the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants. + Set the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants. </description> </method> </methods> @@ -26779,10 +26779,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Physics2DServerSW" inherits="Physics2DServer" category="Core"> <brief_description> - Software implementation of [Physics2DServer]. + Software implementation of [Physics2DServer]. </brief_description> <description> - Software implementation of [Physics2DServer]. This class exposes no new methods or properties and should not be used, as [Physics2DServer] automatically selects the best implementation available. + Software implementation of [Physics2DServer]. This class exposes no new methods or properties and should not be used, as [Physics2DServer] automatically selects the best implementation available. </description> <methods> </methods> @@ -26791,115 +26791,115 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Physics2DShapeQueryParameters" inherits="Reference" category="Core"> <brief_description> - Parameters to be sent to a 2D shape physics query. + Parameters to be sent to a 2D shape physics query. </brief_description> <description> - This class contains the shape and other parameters for intersection/collision queries. + This class contains the shape and other parameters for intersection/collision queries. </description> <methods> <method name="get_exclude" qualifiers="const"> <return type="Array"> </return> <description> - Return the list of objects, or object [RID]s, that will be excluded from collisions. + Return the list of objects, or object [RID]s, that will be excluded from collisions. </description> </method> <method name="get_layer_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the physics layer(s) the shape belongs to. + Return the physics layer(s) the shape belongs to. </description> </method> <method name="get_margin" qualifiers="const"> <return type="float"> </return> <description> - Return the collision margin for the shape. + Return the collision margin for the shape. </description> </method> <method name="get_motion" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the current movement speed of the shape. + Return the current movement speed of the shape. </description> </method> <method name="get_object_type_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the type of object the shape belongs to. + Return the type of object the shape belongs to. </description> </method> <method name="get_shape_rid" qualifiers="const"> <return type="RID"> </return> <description> - Return the [RID] of the shape queried. + Return the [RID] of the shape queried. </description> </method> <method name="get_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Return the transform matrix of the shape queried. + Return the transform matrix of the shape queried. </description> </method> <method name="set_exclude"> <argument index="0" name="exclude" type="Array"> </argument> <description> - Set the list of objects, or object [RID]s, that will be excluded from collisions. + Set the list of objects, or object [RID]s, that will be excluded from collisions. </description> </method> <method name="set_layer_mask"> <argument index="0" name="layer_mask" type="int"> </argument> <description> - Set the physics layer(s) the shape belongs to. + Set the physics layer(s) the shape belongs to. </description> </method> <method name="set_margin"> <argument index="0" name="margin" type="float"> </argument> <description> - Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision. + Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision. </description> </method> <method name="set_motion"> <argument index="0" name="motion" type="Vector2"> </argument> <description> - Set the current movement speed of the shape. + Set the current movement speed of the shape. </description> </method> <method name="set_object_type_mask"> <argument index="0" name="object_type_mask" type="int"> </argument> <description> - Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*). + Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*). </description> </method> <method name="set_shape"> <argument index="0" name="shape" type="Shape2D"> </argument> <description> - Set the [Shape2D] that will be used for collision/intersection queries. + Set the [Shape2D] that will be used for collision/intersection queries. </description> </method> <method name="set_shape_rid"> <argument index="0" name="shape" type="RID"> </argument> <description> - Set the [RID] of the shape to be used in queries. + Set the [RID] of the shape to be used in queries. </description> </method> <method name="set_transform"> <argument index="0" name="transform" type="Matrix32"> </argument> <description> - Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale. + Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale. </description> </method> </methods> @@ -27020,10 +27020,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="PhysicsBody" inherits="CollisionObject" category="Core"> <brief_description> - Base class for different types of Physics bodies. + Base class for different types of Physics bodies. </brief_description> <description> - PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it. + PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it. </description> <methods> <method name="add_collision_exception_with"> @@ -27100,24 +27100,24 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="PhysicsBody2D" inherits="CollisionObject2D" category="Core"> <brief_description> - Base class for all objects affected by physics. + Base class for all objects affected by physics. </brief_description> <description> - PhysicsBody2D is an abstract base class for implementing a physics body. All *Body2D types inherit from it. + PhysicsBody2D is an abstract base class for implementing a physics body. All *Body2D types inherit from it. </description> <methods> <method name="add_collision_exception_with"> <argument index="0" name="body" type="PhysicsBody2D"> </argument> <description> - Adds a body to the collision exception list. This list contains bodies that this body will not collide with. + Adds a body to the collision exception list. This list contains bodies that this body will not collide with. </description> </method> <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the physics layers this area can scan for collisions. + Return the physics layers this area can scan for collisions. </description> </method> <method name="get_collision_mask_bit" qualifiers="const"> @@ -27126,14 +27126,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the collision mask. + Return an individual bit on the collision mask. </description> </method> <method name="get_layer_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the physics layer this area is in. + Return the physics layer this area is in. </description> </method> <method name="get_layer_mask_bit" qualifiers="const"> @@ -27142,35 +27142,35 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bit" type="int"> </argument> <description> - Return an individual bit on the collision mask. + Return an individual bit on the collision mask. </description> </method> <method name="get_one_way_collision_direction" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the direction used for one-way collision detection. + Return the direction used for one-way collision detection. </description> </method> <method name="get_one_way_collision_max_depth" qualifiers="const"> <return type="float"> </return> <description> - Return how far a body can go through this one, when it allows one-way collisions. + Return how far a body can go through this one, when it allows one-way collisions. </description> </method> <method name="remove_collision_exception_with"> <argument index="0" name="body" type="PhysicsBody2D"> </argument> <description> - Removes a body from the collision exception list. + Removes a body from the collision exception list. </description> </method> <method name="set_collision_mask"> <argument index="0" name="mask" type="int"> </argument> <description> - Set the physics layers this area can scan for collisions. + Set the physics layers this area can scan for collisions. </description> </method> <method name="set_collision_mask_bit"> @@ -27179,14 +27179,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="value" type="bool"> </argument> <description> - Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. </description> </method> <method name="set_layer_mask"> <argument index="0" name="mask" type="int"> </argument> <description> - Set the physics layers this area is in. + Set the physics layers this area is in. Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. </description> @@ -27197,21 +27197,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="value" type="bool"> </argument> <description> - Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. + Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. </description> </method> <method name="set_one_way_collision_direction"> <argument index="0" name="dir" type="Vector2"> </argument> <description> - Set a direction in which bodies can go through this one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions. + Set a direction in which bodies can go through this one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions. </description> </method> <method name="set_one_way_collision_max_depth"> <argument index="0" name="depth" type="float"> </argument> <description> - Set how far a body can go through this one, when it allows one-way collisions (see [method set_one_way_collision_direction]). + Set how far a body can go through this one, when it allows one-way collisions (see [method set_one_way_collision_direction]). </description> </method> </methods> @@ -28735,7 +28735,7 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="PhysicsShapeQueryResult" inherits="Reference" category="Core"> <brief_description> - Result of a shape query in Physics2DServer. + Result of a shape query in Physics2DServer. </brief_description> <description> </description> @@ -28816,10 +28816,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="PinJoint2D" inherits="Joint2D" category="Core"> <brief_description> - Pin Joint for 2D Shapes. + Pin Joint for 2D Shapes. </brief_description> <description> - Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space. + Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space. </description> <methods> <method name="get_softness" qualifiers="const"> @@ -28840,10 +28840,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Plane" category="Built-In Types"> <brief_description> - Plane in hessian form. + Plane in hessian form. </brief_description> <description> - Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing. + Plane represents a normalized plane equation. Basically, "normal" is the normal of the plane (a,b,c normalized), and "d" is the distance from the origin to the plane (in the direction of "normal"). "Over" or "Above" the plane is considered the side of the plane towards where the normal is pointing. </description> <methods> <method name="Plane"> @@ -28858,7 +28858,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="d" type="float"> </argument> <description> - Creates a plane from the three parameters "a", "b", "c" and "d". + Creates a plane from the three parameters "a", "b", "c" and "d". </description> </method> <method name="Plane"> @@ -28871,7 +28871,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="v3" type="Vector3"> </argument> <description> - Creates a plane from three points. + Creates a plane from three points. </description> </method> <method name="Plane"> @@ -28882,14 +28882,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="d" type="float"> </argument> <description> - Creates a plane from the normal and the plane's distance to the origin. + Creates a plane from the normal and the plane's distance to the origin. </description> </method> <method name="center"> <return type="Vector3"> </return> <description> - Returns the center of the plane. + Returns the center of the plane. </description> </method> <method name="distance_to"> @@ -28898,14 +28898,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="point" type="Vector3"> </argument> <description> - Returns the shortest distance from the plane to the position "point". + Returns the shortest distance from the plane to the position "point". </description> </method> <method name="get_any_point"> <return type="Vector3"> </return> <description> - Returns a point on the plane. + Returns a point on the plane. </description> </method> <method name="has_point"> @@ -28916,7 +28916,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="epsilon" type="float" default="0.00001"> </argument> <description> - Returns true if "point" is inside the plane (by a very minimum threshold). + Returns true if "point" is inside the plane (by a very minimum threshold). </description> </method> <method name="intersect_3"> @@ -28927,7 +28927,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="c" type="Plane"> </argument> <description> - Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned. + Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned. </description> </method> <method name="intersects_ray"> @@ -28938,7 +28938,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="dir" type="Vector3"> </argument> <description> - Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned. + Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned. </description> </method> <method name="intersects_segment"> @@ -28949,7 +28949,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="end" type="Vector3"> </argument> <description> - Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned. + Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned. </description> </method> <method name="is_point_over"> @@ -28958,14 +28958,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="point" type="Vector3"> </argument> <description> - Returns true if "point" is located above the plane. + Returns true if "point" is located above the plane. </description> </method> <method name="normalized"> <return type="Plane"> </return> <description> - Returns a copy of the plane, normalized. + Returns a copy of the plane, normalized. </description> </method> <method name="project"> @@ -28974,7 +28974,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="point" type="Vector3"> </argument> <description> - Returns the orthogonal projection of point "p" into a point in the plane. + Returns the orthogonal projection of point "p" into a point in the plane. </description> </method> </methods> @@ -29017,164 +29017,164 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Polygon2D" inherits="Node2D" category="Core"> <brief_description> - 2D polygon representation + 2D polygon representation </brief_description> <description> - A Polygon2D is defined by a set of n vertices connected together by line segments, meaning that the vertex 1 will be connected with vertex 2, vertex 2 with vertex 3 ..., vertex n-1 with vertex n and vertex n with vertex 1 in order to close the loop and define a polygon. + A Polygon2D is defined by a set of n vertices connected together by line segments, meaning that the vertex 1 will be connected with vertex 2, vertex 2 with vertex 3 ..., vertex n-1 with vertex n and vertex n with vertex 1 in order to close the loop and define a polygon. </description> <methods> <method name="get_color" qualifiers="const"> <return type="Color"> </return> <description> - Return the polygon fill color. + Return the polygon fill color. </description> </method> <method name="get_invert" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this polygon is inverted or not. + Return whether this polygon is inverted or not. </description> </method> <method name="get_invert_border" qualifiers="const"> <return type="float"> </return> <description> - Return the added padding around the bounding box. + Return the added padding around the bounding box. </description> </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the offset for the polygon vertices. + Return the offset for the polygon vertices. </description> </method> <method name="get_polygon" qualifiers="const"> <return type="Vector2Array"> </return> <description> - Return the set of vertices that defines this polygon. + Return the set of vertices that defines this polygon. </description> </method> <method name="get_texture" qualifiers="const"> <return type="Object"> </return> <description> - Return the polygon texture + Return the polygon texture </description> </method> <method name="get_texture_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the polygon texture offset. + Return the polygon texture offset. </description> </method> <method name="get_texture_rotation" qualifiers="const"> <return type="float"> </return> <description> - Return the rotation in radians of the texture polygon. + Return the rotation in radians of the texture polygon. </description> </method> <method name="get_texture_scale" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the uv coordinate multiplier. + Return the uv coordinate multiplier. </description> </method> <method name="get_uv" qualifiers="const"> <return type="Vector2Array"> </return> <description> - Return the texture coordinates associated with every vertex of the polygon. + Return the texture coordinates associated with every vertex of the polygon. </description> </method> <method name="get_vertex_colors" qualifiers="const"> <return type="ColorArray"> </return> <description> - Return the list of vertex colors. + Return the list of vertex colors. </description> </method> <method name="set_color"> <argument index="0" name="color" type="Color"> </argument> <description> - Set the polygon fill color. If the polygon has a texture defined, the defined texture will be multiplied by the polygon fill color. This, also, is the default color for those vertices that are not defined by [method get_vertex_colors]. + Set the polygon fill color. If the polygon has a texture defined, the defined texture will be multiplied by the polygon fill color. This, also, is the default color for those vertices that are not defined by [method get_vertex_colors]. </description> </method> <method name="set_invert"> <argument index="0" name="invert" type="bool"> </argument> <description> - Set the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on the square that contains the defined polygon). + Set the polygon as the defined polygon bounding box minus the defined polygon (the defined polygon will appear as a hole on the square that contains the defined polygon). </description> </method> <method name="set_invert_border"> <argument index="0" name="invert_border" type="float"> </argument> <description> - Add extra padding around the bounding box, making it bigger. Too small a value can make the polygon triangulate strangely, due to numerical imprecision. + Add extra padding around the bounding box, making it bigger. Too small a value can make the polygon triangulate strangely, due to numerical imprecision. </description> </method> <method name="set_offset"> <argument index="0" name="offset" type="Vector2"> </argument> <description> - Set the an offset that will be added to the vertices' position. E.g. if the offset is set to (10,10) then all the polygon points will move 10 units to the right and 10 units to the bottom. + Set the an offset that will be added to the vertices' position. E.g. if the offset is set to (10,10) then all the polygon points will move 10 units to the right and 10 units to the bottom. </description> </method> <method name="set_polygon"> <argument index="0" name="polygon" type="Vector2Array"> </argument> <description> - Define the set of vertices that will represent the polygon. + Define the set of vertices that will represent the polygon. </description> </method> <method name="set_texture"> <argument index="0" name="texture" type="Object"> </argument> <description> - Set the polygon texture. + Set the polygon texture. </description> </method> <method name="set_texture_offset"> <argument index="0" name="texture_offset" type="Vector2"> </argument> <description> - Set the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top. + Set the offset of the polygon texture. Initially the texture will appear anchored to the polygon position, the offset is used to move the texture location away from that point (notice that the texture origin is set to its top left corner, so when offset is 0,0 the top left corner of the texture is at the polygon position), for example setting the offset to 10, 10 will move the texture 10 units to the left and 10 units to the top. </description> </method> <method name="set_texture_rotation"> <argument index="0" name="texture_rotation" type="float"> </argument> <description> - Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation. + Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation. </description> </method> <method name="set_texture_scale"> <argument index="0" name="texture_scale" type="Vector2"> </argument> <description> - Set the value that will multiply the uv coordinates ([method get_uv]) when applying the texture. Larger values make the texture smaller, and vice versa. + Set the value that will multiply the uv coordinates ([method get_uv]) when applying the texture. Larger values make the texture smaller, and vice versa. </description> </method> <method name="set_uv"> <argument index="0" name="uv" type="Vector2Array"> </argument> <description> - Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored. + Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored. </description> </method> <method name="set_vertex_colors"> <argument index="0" name="vertex_colors" type="ColorArray"> </argument> <description> - Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be [method get_color]. Extra color entries are ignored. + Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be [method get_color]. Extra color entries are ignored. Colors are interpolated between vertices, resulting in smooth gradients when they differ. </description> </method> @@ -29260,62 +29260,62 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Popup" inherits="Control" category="Core"> <brief_description> - Base container control for popups and dialogs. + Base container control for popups and dialogs. </brief_description> <description> - Popup is a base [Control] used to show dialogs and popups. It's a subwindow and modal by default (see [Control]) and has helpers for custom popup behavior. + Popup is a base [Control] used to show dialogs and popups. It's a subwindow and modal by default (see [Control]) and has helpers for custom popup behavior. </description> <methods> <method name="is_exclusive" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether the popup will hide other popups when shown on the screen. + Returns whether the popup will hide other popups when shown on the screen. </description> </method> <method name="popup"> <description> - Popup (show the control in modal form). + Popup (show the control in modal form). </description> </method> <method name="popup_centered"> <argument index="0" name="size" type="Vector2" default="Vector2(0,0)"> </argument> <description> - Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". + Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". </description> </method> <method name="popup_centered_minsize"> <argument index="0" name="minsize" type="Vector2" default="Vector2(0,0)"> </argument> <description> - Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than [code]minsize[/code]. + Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than [code]minsize[/code]. </description> </method> <method name="popup_centered_ratio"> <argument index="0" name="ratio" type="float" default="0.75"> </argument> <description> - Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen. + Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen. </description> </method> <method name="set_exclusive"> <argument index="0" name="enable" type="bool"> </argument> <description> - Make the popup hide other popups when shown on the screen. + Make the popup hide other popups when shown on the screen. </description> </method> </methods> <signals> <signal name="about_to_show"> <description> - This signal is emitted when a popup is about to be shown. (often used in [PopupMenu] for clearing the list of options and creating a new one according to the current context). + This signal is emitted when a popup is about to be shown. (often used in [PopupMenu] for clearing the list of options and creating a new one according to the current context). </description> </signal> <signal name="popup_hide"> <description> - This signal is emitted when a popup is hidden. + This signal is emitted when a popup is hidden. </description> </signal> </signals> @@ -29330,10 +29330,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="PopupDialog" inherits="Popup" category="Core"> <brief_description> - Base class for Popup Dialogs. + Base class for Popup Dialogs. </brief_description> <description> - PopupDialog is a base class for popup dialogs, along with [WindowDialog]. + PopupDialog is a base class for popup dialogs, along with [WindowDialog]. </description> <methods> </methods> @@ -29342,10 +29342,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="PopupMenu" inherits="Popup" category="Core"> <brief_description> - PopupMenu displays a list of options. + PopupMenu displays a list of options. </brief_description> <description> - PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus. + PopupMenu is the typical Control that displays a list of options. They are popular in toolbars or context menus. </description> <methods> <method name="add_check_item"> @@ -29356,7 +29356,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="accel" type="int" default="0"> </argument> <description> - Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="add_check_shortcut"> @@ -29377,7 +29377,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="accel" type="int" default="0"> </argument> <description> - Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Add a new checkable item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="add_icon_check_shortcut"> @@ -29400,7 +29400,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="accel" type="int" default="0"> </argument> <description> - Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. + Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. </description> </method> <method name="add_icon_shortcut"> @@ -29421,12 +29421,12 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="accel" type="int" default="0"> </argument> <description> - Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. + Add a new item with text "label". An id can optionally be provided, as well as an accelerator keybinding. If no id is provided, one will be created from the index. </description> </method> <method name="add_separator"> <description> - Add a separator between items. Separators also occupy an index. + Add a separator between items. Separators also occupy an index. </description> </method> <method name="add_shortcut"> @@ -29445,12 +29445,12 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="id" type="int" default="-1"> </argument> <description> - Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index. + Adds an item with a submenu. The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. An id can optionally be provided, but if is isn't provided, one will be created from the index. </description> </method> <method name="clear"> <description> - Clear the popup menu, in effect removing all items. + Clear the popup menu, in effect removing all items. </description> </method> <method name="get_item_ID" qualifiers="const"> @@ -29459,7 +29459,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="idx" type="int"> </argument> <description> - Return the id of the item at index "idx". + Return the id of the item at index "idx". </description> </method> <method name="get_item_accelerator" qualifiers="const"> @@ -29468,14 +29468,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="idx" type="int"> </argument> <description> - Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. + Return the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. </description> </method> <method name="get_item_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of items. + Return the amount of items. </description> </method> <method name="get_item_icon" qualifiers="const"> @@ -29484,7 +29484,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="idx" type="int"> </argument> <description> - Return the icon of the item at index "idx". + Return the icon of the item at index "idx". </description> </method> <method name="get_item_index" qualifiers="const"> @@ -29493,14 +29493,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Find and return the index of the item containing a given id. + Find and return the index of the item containing a given id. </description> </method> <method name="get_item_metadata" qualifiers="const"> <argument index="0" name="idx" type="int"> </argument> <description> - Return the metadata of an item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items. + Return the metadata of an item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items. </description> </method> <method name="get_item_shortcut" qualifiers="const"> @@ -29517,7 +29517,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="idx" type="int"> </argument> <description> - Return the submenu name of the item at index "idx". + Return the submenu name of the item at index "idx". </description> </method> <method name="get_item_text" qualifiers="const"> @@ -29526,7 +29526,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="idx" type="int"> </argument> <description> - Return the text of the item at index "idx". + Return the text of the item at index "idx". </description> </method> <method name="is_item_checkable" qualifiers="const"> @@ -29535,7 +29535,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Return whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="is_item_checked" qualifiers="const"> @@ -29544,7 +29544,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="idx" type="int"> </argument> <description> - Return the checkstate status of the item at index "idx". + Return the checkstate status of the item at index "idx". </description> </method> <method name="is_item_disabled" qualifiers="const"> @@ -29553,7 +29553,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. + Return whether the item at index "idx" is disabled. When it is disabled it can't be selected, or its action invoked. </description> </method> <method name="is_item_separator" qualifiers="const"> @@ -29562,14 +29562,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="idx" type="int"> </argument> <description> - Return whether the item is a seperator. If it is, it would be displayed as a line. + Return whether the item is a seperator. If it is, it would be displayed as a line. </description> </method> <method name="remove_item"> <argument index="0" name="idx" type="int"> </argument> <description> - Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. + Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. </description> </method> <method name="set_item_ID"> @@ -29578,7 +29578,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="id" type="int"> </argument> <description> - Set the id of the item at index "idx". + Set the id of the item at index "idx". </description> </method> <method name="set_item_accelerator"> @@ -29587,7 +29587,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="accel" type="int"> </argument> <description> - Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. + Set the accelerator of the item at index "idx". Accelerators are special combinations of keys that activate the item, no matter which control is focused. </description> </method> <method name="set_item_as_checkable"> @@ -29596,7 +29596,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="enable" type="bool"> </argument> <description> - Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Set whether the item at index "idx" has a checkbox. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="set_item_as_separator"> @@ -29605,7 +29605,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="enable" type="bool"> </argument> <description> - Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line. + Mark the item at index "idx" as a seperator, which means that it would be displayed as a mere line. </description> </method> <method name="set_item_checked"> @@ -29614,7 +29614,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="checked" type="bool"> </argument> <description> - Set the checkstate status of the item at index "idx". + Set the checkstate status of the item at index "idx". </description> </method> <method name="set_item_disabled"> @@ -29623,7 +29623,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="disabled" type="bool"> </argument> <description> - Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked. + Sets whether the item at index "idx" is disabled or not. When it is disabled it can't be selected, or its action invoked. </description> </method> <method name="set_item_icon"> @@ -29632,7 +29632,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="icon" type="Object"> </argument> <description> - Set the icon of the item at index "idx". + Set the icon of the item at index "idx". </description> </method> <method name="set_item_metadata"> @@ -29641,7 +29641,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="metadata" type="Variant"> </argument> <description> - Sets the metadata of an item, which might be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items. + Sets the metadata of an item, which might be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items. </description> </method> <method name="set_item_shortcut"> @@ -29658,7 +29658,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="submenu" type="String"> </argument> <description> - Sets the submenu of the item at index "idx". The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. + Sets the submenu of the item at index "idx". The submenu is the name of a child PopupMenu node that would be shown when the item is clicked. </description> </method> <method name="set_item_text"> @@ -29667,7 +29667,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="text" type="String"> </argument> <description> - Set the text of the item at index "idx". + Set the text of the item at index "idx". </description> </method> </methods> @@ -29676,7 +29676,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="ID" type="int"> </argument> <description> - This even is emitted when an item is pressed or its accelerator is activated. The id of the item is returned if it exists, else the index. + This even is emitted when an item is pressed or its accelerator is activated. The id of the item is returned if it exists, else the index. </description> </signal> </signals> @@ -29715,10 +29715,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="PopupPanel" inherits="Popup" category="Core"> <brief_description> - Class for displaying popups with a panel background. + Class for displaying popups with a panel background. </brief_description> <description> - Class for displaying popups with a panel background. In some cases it might be simpler to use than [Popup], since it provides a configurable background. If you are making windows, better check [WindowDialog]. + Class for displaying popups with a panel background. In some cases it might be simpler to use than [Popup], since it provides a configurable background. If you are making windows, better check [WindowDialog]. </description> <methods> </methods> @@ -29731,80 +29731,80 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Portal" inherits="VisualInstance" category="Core"> <brief_description> - Portals provide virtual openings to rooms. + Portals provide virtual openings to rooms. </brief_description> <description> - Portals provide virtual openings to [VisualInstance] nodes, so cameras can look at them from the outside. Note that portals are a visibility optimization technique, and are in no way related to the game of the same name (as in, they are not used for teleportation). For more information on how rooms and portals work, see [VisualInstance]. Portals are represented as 2D convex polygon shapes (in the X,Y local plane), and are placed on the surface of the areas occupied by a [VisualInstance], to indicate that the room can be accessed or looked-at through them. If two rooms are next to each other, and two similar portals in each of them share the same world position (and are parallel and opposed to each other), they will automatically "connect" and form "doors" (for example, the portals that connect a kitchen to a living room are placed in the door they share). Portals must always have a [VisualInstance] node as a parent, grandparent or far parent, or else they will not be active. + Portals provide virtual openings to [VisualInstance] nodes, so cameras can look at them from the outside. Note that portals are a visibility optimization technique, and are in no way related to the game of the same name (as in, they are not used for teleportation). For more information on how rooms and portals work, see [VisualInstance]. Portals are represented as 2D convex polygon shapes (in the X,Y local plane), and are placed on the surface of the areas occupied by a [VisualInstance], to indicate that the room can be accessed or looked-at through them. If two rooms are next to each other, and two similar portals in each of them share the same world position (and are parallel and opposed to each other), they will automatically "connect" and form "doors" (for example, the portals that connect a kitchen to a living room are placed in the door they share). Portals must always have a [VisualInstance] node as a parent, grandparent or far parent, or else they will not be active. </description> <methods> <method name="get_connect_range" qualifiers="const"> <return type="float"> </return> <description> - Return the range for auto-connecting two portals from different rooms sharing the same space. + Return the range for auto-connecting two portals from different rooms sharing the same space. </description> </method> <method name="get_disable_distance" qualifiers="const"> <return type="float"> </return> <description> - Return the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [method set_disabled_color]). + Return the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [method set_disabled_color]). </description> </method> <method name="get_disabled_color" qualifiers="const"> <return type="Color"> </return> <description> - Return the color for when the portal goes beyond the disable distance (see [method set_disable_distance]) and becomes disabled. + Return the color for when the portal goes beyond the disable distance (see [method set_disable_distance]) and becomes disabled. </description> </method> <method name="get_shape" qualifiers="const"> <return type="Vector2Array"> </return> <description> - Return the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane. + Return the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane. </description> </method> <method name="is_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the portal is active. When disabled it causes the parent [VisualInstance] to not be visible any longer when looking through the portal. + Return whether the portal is active. When disabled it causes the parent [VisualInstance] to not be visible any longer when looking through the portal. </description> </method> <method name="set_connect_range"> <argument index="0" name="range" type="float"> </argument> <description> - Set the range for auto-connecting two portals from different rooms sharing the same space. + Set the range for auto-connecting two portals from different rooms sharing the same space. </description> </method> <method name="set_disable_distance"> <argument index="0" name="distance" type="float"> </argument> <description> - Set the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [method set_disabled_color]). + Set the distance threshold for disabling the portal. Every time that the portal goes beyond "distance", it disables itself, becoming the opaque color (see [method set_disabled_color]). </description> </method> <method name="set_disabled_color"> <argument index="0" name="color" type="Color"> </argument> <description> - When the portal goes beyond the disable distance (see [method set_disable_distance]), it becomes opaque and displayed with color "color". + When the portal goes beyond the disable distance (see [method set_disable_distance]), it becomes opaque and displayed with color "color". </description> </method> <method name="set_enabled"> <argument index="0" name="enable" type="bool"> </argument> <description> - Enable the portal (it is enabled by default though), disabling it will cause the parent [VisualInstance] to not be visible any longer when looking through the portal. + Enable the portal (it is enabled by default though), disabling it will cause the parent [VisualInstance] to not be visible any longer when looking through the portal. </description> </method> <method name="set_shape"> <argument index="0" name="points" type="Vector2Array"> </argument> <description> - Set the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane. + Set the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane. </description> </method> </methods> @@ -29813,10 +29813,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Position2D" inherits="Node2D" category="Core"> <brief_description> - Generic 2D Position hint for editing. + Generic 2D Position hint for editing. </brief_description> <description> - Generic 2D Position hint for editing. It's just like a plain [Node2D] but displays as a cross in the 2D-Editor at all times. + Generic 2D Position hint for editing. It's just like a plain [Node2D] but displays as a cross in the 2D-Editor at all times. </description> <methods> </methods> @@ -29825,10 +29825,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Position3D" inherits="Spatial" category="Core"> <brief_description> - Generic 3D Position hint for editing + Generic 3D Position hint for editing </brief_description> <description> - Generic 3D Position hint for editing. It's just like a plain [Spatial] but displays as a cross in the 3D-Editor at all times. + Generic 3D Position hint for editing. It's just like a plain [Spatial] but displays as a cross in the 3D-Editor at all times. </description> <methods> </methods> @@ -29837,10 +29837,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="ProgressBar" inherits="Range" category="Core"> <brief_description> - General purpose progress bar. + General purpose progress bar. </brief_description> <description> - General purpose progress bar. Shows fill percentage from right to left. + General purpose progress bar. Shows fill percentage from right to left. </description> <methods> <method name="is_percent_visible" qualifiers="const"> @@ -29873,10 +29873,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="ProximityGroup" inherits="Spatial" category="Core"> <brief_description> - General purpose proximity-detection node. + General purpose proximity-detection node. </brief_description> <description> - General purpose proximity-detection node. + General purpose proximity-detection node. </description> <methods> <method name="broadcast"> @@ -29985,10 +29985,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Quat" category="Built-In Types"> <brief_description> - Quaternion. + Quaternion. </brief_description> <description> - Quaternion is a 4 dimensional vector that is used to represent a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between to rotations obtained by a Matrix3 cheaply. Adding quaternions also cheaply adds the rotations, however quaternions need to be often normalized, or else they suffer from precision issues. + Quaternion is a 4 dimensional vector that is used to represent a rotation. It mainly exists to perform SLERP (spherical-linear interpolation) between to rotations obtained by a Matrix3 cheaply. Adding quaternions also cheaply adds the rotations, however quaternions need to be often normalized, or else they suffer from precision issues. </description> <methods> <method name="Quat"> @@ -30043,35 +30043,35 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="b" type="Quat"> </argument> <description> - Returns the dot product between two quaternions. + Returns the dot product between two quaternions. </description> </method> <method name="inverse"> <return type="Quat"> </return> <description> - Returns the inverse of the quaternion (applies to the inverse rotation too). + Returns the inverse of the quaternion (applies to the inverse rotation too). </description> </method> <method name="length"> <return type="float"> </return> <description> - Returns the length of the quaternion. + Returns the length of the quaternion. </description> </method> <method name="length_squared"> <return type="float"> </return> <description> - Returns the length of the quaternion, squared. + Returns the length of the quaternion, squared. </description> </method> <method name="normalized"> <return type="Quat"> </return> <description> - Returns a copy of the quaternion, normalized to unit length. + Returns a copy of the quaternion, normalized to unit length. </description> </method> <method name="slerp"> @@ -30082,7 +30082,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="t" type="float"> </argument> <description> - Perform a spherical-linear interpolation with another quaternion. + Perform a spherical-linear interpolation with another quaternion. </description> </method> <method name="slerpni"> @@ -30143,52 +30143,52 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Range" inherits="Control" category="Core"> <brief_description> - Abstract base class for range-based controls. + Abstract base class for range-based controls. </brief_description> <description> - Range is a base class for [Control] nodes that change a floating point [i]value[/i] between a [i]minimum[/i] and a [i]maximum[/i], using [i]step[/i] and [i]page[/i], for example a [ScrollBar]. + Range is a base class for [Control] nodes that change a floating point [i]value[/i] between a [i]minimum[/i] and a [i]maximum[/i], using [i]step[/i] and [i]page[/i], for example a [ScrollBar]. </description> <methods> <method name="get_max" qualifiers="const"> <return type="float"> </return> <description> - Return the maximum value. + Return the maximum value. </description> </method> <method name="get_min" qualifiers="const"> <return type="float"> </return> <description> - Return the minimum value. + Return the minimum value. </description> </method> <method name="get_page" qualifiers="const"> <return type="float"> </return> <description> - Return the page size, if page is 0, paging is disabled. + Return the page size, if page is 0, paging is disabled. </description> </method> <method name="get_step" qualifiers="const"> <return type="float"> </return> <description> - Return the stepping, if step is 0, stepping is disabled. + Return the stepping, if step is 0, stepping is disabled. </description> </method> <method name="get_unit_value" qualifiers="const"> <return type="float"> </return> <description> - Return value mapped to 0 to 1 (unit) range. + Return value mapped to 0 to 1 (unit) range. </description> </method> <method name="get_val" qualifiers="const"> <return type="float"> </return> <description> - Return the current value. + Return the current value. </description> </method> <method name="get_value" qualifiers="const"> @@ -30225,14 +30225,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="minimum" type="float"> </argument> <description> - Set minimum value, clamped range value to it if it's less. + Set minimum value, clamped range value to it if it's less. </description> </method> <method name="set_page"> <argument index="0" name="pagesize" type="float"> </argument> <description> - Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. + Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. </description> </method> <method name="set_rounded_values"> @@ -30245,14 +30245,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="step" type="float"> </argument> <description> - Set step value. If step is 0, stepping will be disabled. + Set step value. If step is 0, stepping will be disabled. </description> </method> <method name="set_unit_value"> <argument index="0" name="value" type="float"> </argument> <description> - Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. + Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. </description> </method> <method name="set_val"> @@ -30281,14 +30281,14 @@ A similar effect may be achieved moving this node's descendants. <signals> <signal name="changed"> <description> - This signal is emitted when min, max, range or step change. + This signal is emitted when min, max, range or step change. </description> </signal> <signal name="value_changed"> <argument index="0" name="value" type="float"> </argument> <description> - This signal is emitted when value changes. + This signal is emitted when value changes. </description> </signal> </signals> @@ -30297,10 +30297,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="RawArray" category="Built-In Types"> <brief_description> - Raw byte array. + Raw byte array. </brief_description> <description> - Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. + Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. </description> <methods> <method name="RawArray"> @@ -30309,7 +30309,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="Array"> </argument> <description> - Create from a generic array. + Create from a generic array. </description> </method> <method name="append"> @@ -30322,21 +30322,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="array" type="RawArray"> </argument> <description> - Append an [RawArray] at the end of this array. + Append an [RawArray] at the end of this array. </description> </method> <method name="get_string_from_ascii"> <return type="String"> </return> <description> - Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart). + Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart). </description> </method> <method name="get_string_from_utf8"> <return type="String"> </return> <description> - Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input. + Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input. </description> </method> <method name="insert"> @@ -30347,33 +30347,33 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="byte" type="int"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array (so first element will now be the last). </description> </method> <method name="push_back"> <argument index="0" name="byte" type="int"> </argument> <description> - Append an element at the end of the array. + Append an element at the end of the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Remove an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the [RawArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Set the size of the [RawArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -30382,14 +30382,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="byte" type="int"> </argument> <description> - Change the byte at the given index. + Change the byte at the given index. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the size of the array. + Return the size of the array. </description> </method> </methods> @@ -30514,17 +30514,17 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="RayCast2D" inherits="Node2D" category="Core"> <brief_description> - Query the closest object intersecting a ray + Query the closest object intersecting a ray </brief_description> <description> - A RayCast2D represents a line from its origin to its destination position [code]cast_to[/code], it is used to query the 2D space in order to find the closest object intersecting with the ray. + A RayCast2D represents a line from its origin to its destination position [code]cast_to[/code], it is used to query the 2D space in order to find the closest object intersecting with the ray. </description> <methods> <method name="add_exception"> <argument index="0" name="node" type="Object"> </argument> <description> - Adds a collision exception so the ray does not report collisions with the specified [code]node[/code]. + Adds a collision exception so the ray does not report collisions with the specified [code]node[/code]. </description> </method> <method name="add_exception_rid"> @@ -30535,49 +30535,49 @@ A similar effect may be achieved moving this node's descendants. </method> <method name="clear_exceptions"> <description> - Removes all collision exception for this ray. + Removes all collision exception for this ray. </description> </method> <method name="get_cast_to" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the destination point of this ray object + Return the destination point of this ray object </description> </method> <method name="get_collider" qualifiers="const"> <return type="Object"> </return> <description> - Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use [method is_colliding] to check if the object returned is actually colliding with the ray. + Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use [method is_colliding] to check if the object returned is actually colliding with the ray. </description> </method> <method name="get_collider_shape" qualifiers="const"> <return type="int"> </return> <description> - Returns the collision shape of the closest object the ray is pointing to. + Returns the collision shape of the closest object the ray is pointing to. </description> </method> <method name="get_collision_normal" qualifiers="const"> <return type="Vector2"> </return> <description> - Returns the normal of the intersecting object shape face containing the collision point. + Returns the normal of the intersecting object shape face containing the collision point. </description> </method> <method name="get_collision_point" qualifiers="const"> <return type="Vector2"> </return> <description> - Returns the collision point in which the ray intersects the closest object. + Returns the collision point in which the ray intersects the closest object. </description> </method> <method name="get_layer_mask" qualifiers="const"> <return type="int"> </return> <description> - Returns the layer mask for this ray. + Returns the layer mask for this ray. </description> </method> <method name="get_type_mask" qualifiers="const"> @@ -30590,21 +30590,21 @@ A similar effect may be achieved moving this node's descendants. <return type="bool"> </return> <description> - Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). + Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length). </description> </method> <method name="is_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether this raycast is enabled or not + Returns whether this raycast is enabled or not </description> </method> <method name="remove_exception"> <argument index="0" name="node" type="Object"> </argument> <description> - Removes a collision exception so the ray does report collisions with the specified [code]node[/code]. + Removes a collision exception so the ray does report collisions with the specified [code]node[/code]. </description> </method> <method name="remove_exception_rid"> @@ -30617,14 +30617,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="local_point" type="Vector2"> </argument> <description> - Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] + Sets the ray destination point, so that the ray will test from the ray's origin to [code]local_point[/code] </description> </method> <method name="set_enabled"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. + Enables the RayCast2D. Only enabled raycasts will be able to query the space and report collisions. </description> </method> <method name="set_layer_mask"> @@ -30667,24 +30667,24 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="RayShape2D" inherits="Shape2D" category="Core"> <brief_description> - Ray 2D shape resource for physics. + Ray 2D shape resource for physics. </brief_description> <description> - Ray 2D shape resource for physics. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. + Ray 2D shape resource for physics. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. </description> <methods> <method name="get_length" qualifiers="const"> <return type="float"> </return> <description> - Return the length of the ray. + Return the length of the ray. </description> </method> <method name="set_length"> <argument index="0" name="length" type="float"> </argument> <description> - Set the length of the ray. + Set the length of the ray. </description> </method> </methods> @@ -30693,10 +30693,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="RealArray" category="Built-In Types"> <brief_description> - Real Array . + Real Array . </brief_description> <description> - Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. + Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. </description> <methods> <method name="RealArray"> @@ -30705,21 +30705,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="Array"> </argument> <description> - Create from a generic array. + Create from a generic array. </description> </method> <method name="append"> <argument index="0" name="value" type="float"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Append an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="RealArray"> </argument> <description> - Append an [RealArray] at the end of this array. + Append an [RealArray] at the end of this array. </description> </method> <method name="insert"> @@ -30730,33 +30730,33 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="value" type="float"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array (so first element will now be the last). </description> </method> <method name="push_back"> <argument index="0" name="value" type="float"> </argument> <description> - Append an element at the end of the array. + Append an element at the end of the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Remove an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the [RealArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Set the size of the [RealArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -30765,14 +30765,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="value" type="float"> </argument> <description> - Change the float at the given index. + Change the float at the given index. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the size of the array. + Return the size of the array. </description> </method> </methods> @@ -30781,10 +30781,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Rect2" category="Built-In Types"> <brief_description> - 2D Axis-aligned bounding box. + 2D Axis-aligned bounding box. </brief_description> <description> - Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. + Rect2 provides an 2D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for fast overlap tests. </description> <methods> <method name="Rect2"> @@ -30795,7 +30795,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="size" type="Vector2"> </argument> <description> - Construct a [Rect2] by position and size. + Construct a [Rect2] by position and size. </description> </method> <method name="Rect2"> @@ -30810,7 +30810,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="height" type="float"> </argument> <description> - Construct a [Rect2] by x, y, width and height. + Construct a [Rect2] by x, y, width and height. </description> </method> <method name="clip"> @@ -30819,7 +30819,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="b" type="Rect2"> </argument> <description> - Returns the intersection of this [Rect2] and b. + Returns the intersection of this [Rect2] and b. </description> </method> <method name="encloses"> @@ -30828,7 +30828,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="b" type="Rect2"> </argument> <description> - Returns true if this [Rect2] completely encloses another one. + Returns true if this [Rect2] completely encloses another one. </description> </method> <method name="expand"> @@ -30837,14 +30837,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="to" type="Vector2"> </argument> <description> - Return this [Rect2] expanded to include a given point. + Return this [Rect2] expanded to include a given point. </description> </method> <method name="get_area"> <return type="float"> </return> <description> - Get the area of the [Rect2]. + Get the area of the [Rect2]. </description> </method> <method name="grow"> @@ -30853,14 +30853,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="by" type="float"> </argument> <description> - Return a copy of the [Rect2] grown a given amount of units towards all the sides. + Return a copy of the [Rect2] grown a given amount of units towards all the sides. </description> </method> <method name="has_no_area"> <return type="bool"> </return> <description> - Return true if the [Rect2] is flat or empty. + Return true if the [Rect2] is flat or empty. </description> </method> <method name="has_point"> @@ -30869,7 +30869,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="point" type="Vector2"> </argument> <description> - Return true if the [Rect2] contains a point. + Return true if the [Rect2] contains a point. </description> </method> <method name="intersects"> @@ -30878,7 +30878,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="b" type="Rect2"> </argument> <description> - Return true if the [Rect2] overlaps with another. + Return true if the [Rect2] overlaps with another. </description> </method> <method name="merge"> @@ -30887,7 +30887,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="b" type="Rect2"> </argument> <description> - Combine this [Rect2] with another, a larger one is returned that contains both. + Combine this [Rect2] with another, a larger one is returned that contains both. </description> </method> </methods> @@ -30907,24 +30907,24 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="RectangleShape2D" inherits="Shape2D" category="Core"> <brief_description> - Rectangle Shape for 2D Physics. + Rectangle Shape for 2D Physics. </brief_description> <description> - Rectangle Shape for 2D Physics. This shape is useful for modeling box-like 2D objects. + Rectangle Shape for 2D Physics. This shape is useful for modeling box-like 2D objects. </description> <methods> <method name="get_extents" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the half extents, the actual width and height of this shape is twice the half extents. + Return the half extents, the actual width and height of this shape is twice the half extents. </description> </method> <method name="set_extents"> <argument index="0" name="extents" type="Vector2"> </argument> <description> - Set the half extents, the actual width and height of this shape is twice the half extents. + Set the half extents, the actual width and height of this shape is twice the half extents. </description> </method> </methods> @@ -30933,10 +30933,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Reference" inherits="Object" category="Core"> <brief_description> - Base class for anything that keeps a reference count. + Base class for anything that keeps a reference count. </brief_description> <description> - Base class for anything that keeps a reference count. Resource and many other helper objects inherit this. References keep an internal reference counter so they are only released when no longer in use. + Base class for anything that keeps a reference count. Resource and many other helper objects inherit this. References keep an internal reference counter so they are only released when no longer in use. </description> <methods> <method name="init_ref"> @@ -30947,14 +30947,14 @@ A similar effect may be achieved moving this node's descendants. </method> <method name="reference"> <description> - Increase the internal reference counter. Use this only if you really know what you are doing. + Increase the internal reference counter. Use this only if you really know what you are doing. </description> </method> <method name="unreference"> <return type="bool"> </return> <description> - Decrease the internal reference counter. Use this only if you really know what you are doing. + Decrease the internal reference counter. Use this only if you really know what you are doing. </description> </method> </methods> @@ -30963,10 +30963,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="ReferenceFrame" inherits="Control" category="Core"> <brief_description> - Reference frame for GUI. + Reference frame for GUI. </brief_description> <description> - Reference frame for GUI. It's just like an empty control, except a red box is displayed while editing around its size at all times. + Reference frame for GUI. It's just like an empty control, except a red box is displayed while editing around its size at all times. </description> <methods> </methods> @@ -30979,10 +30979,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="RegEx" inherits="Reference" category="Core"> <brief_description> - Simple regular expression matcher. + Simple regular expression matcher. </brief_description> <description> - Class for finding text patterns in a string using regular expressions. Regular expressions are a way to define patterns of text to be searched. + Class for finding text patterns in a string using regular expressions. Regular expressions are a way to define patterns of text to be searched. This class only finds patterns in a string. It can not perform replacements. Usage of regular expressions is too long to be explained here, but Internet is full of tutorials and detailed explanations. Currently supported features: @@ -31004,7 +31004,7 @@ A similar effect may be achieved moving this node's descendants. <methods> <method name="clear"> <description> - This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object, and forgets all captures made by the last [method find]. + This method resets the state of the object, as it was freshly created. Namely, it unassigns the regular expression of this object, and forgets all captures made by the last [method find]. </description> </method> <method name="compile"> @@ -31015,7 +31015,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="capture" type="int" default="9"> </argument> <description> - Compiles and assign the regular expression pattern to use. The limit on the number of capturing groups can be specified or made unlimited if negative. + Compiles and assign the regular expression pattern to use. The limit on the number of capturing groups can be specified or made unlimited if negative. </description> </method> <method name="find" qualifiers="const"> @@ -31028,7 +31028,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="end" type="int" default="-1"> </argument> <description> - This method tries to find the pattern within the string, and returns the position where it was found. It also stores any capturing group (see [method get_capture]) for further retrieval. + This method tries to find the pattern within the string, and returns the position where it was found. It also stores any capturing group (see [method get_capture]) for further retrieval. </description> </method> <method name="get_capture" qualifiers="const"> @@ -31037,14 +31037,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="capture" type="int"> </argument> <description> - Returns a captured group. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]). + Returns a captured group. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]). </description> </method> <method name="get_capture_count" qualifiers="const"> <return type="int"> </return> <description> - Returns the number of capturing groups. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]). + Returns the number of capturing groups. A captured group is the part of a string that matches a part of the pattern delimited by parentheses (unless they are non-capturing parentheses [i](?:)[/i]). </description> </method> <method name="get_capture_start" qualifiers="const"> @@ -31059,14 +31059,14 @@ A similar effect may be achieved moving this node's descendants. <return type="StringArray"> </return> <description> - Return a list of all the captures made by the regular expression. + Return a list of all the captures made by the regular expression. </description> </method> <method name="is_valid" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether this object has a valid regular expression assigned. + Returns whether this object has a valid regular expression assigned. </description> </method> </methods> @@ -31107,10 +31107,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Resource" inherits="Reference" category="Core"> <brief_description> - Base class for all resources. + Base class for all resources. </brief_description> <description> - Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node], which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. + Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node], which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. </description> <methods> <method name="duplicate"> @@ -31131,21 +31131,21 @@ A similar effect may be achieved moving this node's descendants. <return type="String"> </return> <description> - Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. + Return the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. </description> </method> <method name="get_path" qualifiers="const"> <return type="String"> </return> <description> - Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. + Return the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. </description> </method> <method name="get_rid" qualifiers="const"> <return type="RID"> </return> <description> - Return the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high level abstractions of resources stored in a server, so this function will return the original RID. + Return the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high level abstractions of resources stored in a server, so this function will return the original RID. </description> </method> <method name="set_import_metadata"> @@ -31158,21 +31158,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="name" type="String"> </argument> <description> - Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. + Set the name of the resources, any name is valid (it doesn't have to be unique). Name is for descriptive purposes only. </description> </method> <method name="set_path"> <argument index="0" name="path" type="String"> </argument> <description> - Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [Resource] already has path "path". + Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [Resource] already has path "path". </description> </method> <method name="take_over_path"> <argument index="0" name="path" type="String"> </argument> <description> - Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing. + Set the path of the resource. Differs from set_path(), if another [Resource] exists with "path" it over-takes it, instead of failing. </description> </method> </methods> @@ -31273,38 +31273,38 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="ResourceInteractiveLoader" inherits="Reference" category="Core"> <brief_description> - Interactive Resource Loader. + Interactive Resource Loader. </brief_description> <description> - Interactive Resource Loader. This object is returned by ResourceLoader when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying load bars/percentages. + Interactive Resource Loader. This object is returned by ResourceLoader when performing an interactive load. It allows to load with high granularity, so this is mainly useful for displaying load bars/percentages. </description> <methods> <method name="get_resource"> <return type="Object"> </return> <description> - Return the loaded resource (only if loaded). Otherwise, returns null. + Return the loaded resource (only if loaded). Otherwise, returns null. </description> </method> <method name="get_stage" qualifiers="const"> <return type="int"> </return> <description> - Return the load stage. The total amount of stages can be queried with [method get_stage_count] + Return the load stage. The total amount of stages can be queried with [method get_stage_count] </description> </method> <method name="get_stage_count" qualifiers="const"> <return type="int"> </return> <description> - Return the total amount of stages (calls to [method poll]) needed to completely load this resource. + Return the total amount of stages (calls to [method poll]) needed to completely load this resource. </description> </method> <method name="poll"> <return type="int"> </return> <description> - Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource]. + Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource]. </description> </method> <method name="wait"> @@ -31319,10 +31319,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="ResourceLoader" inherits="Object" category="Core"> <brief_description> - Resource Loader. + Resource Loader. </brief_description> <description> - Resource Loader. This is a static object accessible as [ResourceLoader]. GDScript has a simplified load() function, though. + Resource Loader. This is a static object accessible as [ResourceLoader]. GDScript has a simplified load() function, though. </description> <methods> <method name="get_dependencies"> @@ -31339,7 +31339,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="type" type="String"> </argument> <description> - Return the list of recognized extensions for a resource type. + Return the list of recognized extensions for a resource type. </description> </method> <method name="has"> @@ -31378,14 +31378,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="type_hint" type="String" default=""""> </argument> <description> - Load a resource interactively, the returned object allows to load with high granularity. + Load a resource interactively, the returned object allows to load with high granularity. </description> </method> <method name="set_abort_on_missing_resources"> <argument index="0" name="abort" type="bool"> </argument> <description> - Change the behavior on missing sub-resources. Default is to abort load. + Change the behavior on missing sub-resources. Default is to abort load. </description> </method> </methods> @@ -31394,10 +31394,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="ResourcePreloader" inherits="Node" category="Core"> <brief_description> - Resource Preloader Node. + Resource Preloader Node. </brief_description> <description> - Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resources are ready to use and be retrieved from here. + Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resources are ready to use and be retrieved from here. </description> <methods> <method name="add_resource"> @@ -31406,7 +31406,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="resource" type="Object"> </argument> <description> - Add a resource to the preloader. Set the text-id that will be used to identify it (retrieve it/erase it/etc). + Add a resource to the preloader. Set the text-id that will be used to identify it (retrieve it/erase it/etc). </description> </method> <method name="get_resource" qualifiers="const"> @@ -31415,14 +31415,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="name" type="String"> </argument> <description> - Return the resource given a text-id. + Return the resource given a text-id. </description> </method> <method name="get_resource_list" qualifiers="const"> <return type="StringArray"> </return> <description> - Return the list of resources inside the preloader. + Return the list of resources inside the preloader. </description> </method> <method name="has_resource" qualifiers="const"> @@ -31431,14 +31431,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="name" type="String"> </argument> <description> - Return true if the preloader has a given resource. + Return true if the preloader has a given resource. </description> </method> <method name="remove_resource"> <argument index="0" name="name" type="String"> </argument> <description> - Remove a resource from the preloader by text id. + Remove a resource from the preloader by text id. </description> </method> <method name="rename_resource"> @@ -31447,7 +31447,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="newname" type="String"> </argument> <description> - Rename a resource inside the preloader, from a text-id to a new text-id. + Rename a resource inside the preloader, from a text-id to a new text-id. </description> </method> </methods> @@ -31456,10 +31456,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="ResourceSaver" inherits="Object" category="Core"> <brief_description> - Resource Saving Interface. + Resource Saving Interface. </brief_description> <description> - Resource Saving Interface. This interface is used for saving resources to disk. + Resource Saving Interface. This interface is used for saving resources to disk. </description> <methods> <method name="get_recognized_extensions"> @@ -31468,7 +31468,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="type" type="Object"> </argument> <description> - Return the list of extensions available for saving a resource of a given type. + Return the list of extensions available for saving a resource of a given type. </description> </method> <method name="save"> @@ -31481,7 +31481,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="flags" type="int" default="0"> </argument> <description> - Save a resource to disk, to a given path. + Save a resource to disk, to a given path. </description> </method> </methods> @@ -31502,10 +31502,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="RichTextLabel" inherits="Control" category="Core"> <brief_description> - Label that displays rich text. + Label that displays rich text. </brief_description> <description> - Label that displays rich text. Rich text can contain custom text, fonts, images and some basic formatting. It also adapts itself to given width/heights. + Label that displays rich text. Rich text can contain custom text, fonts, images and some basic formatting. It also adapts itself to given width/heights. </description> <methods> <method name="add_image"> @@ -31584,7 +31584,7 @@ A similar effect may be achieved moving this node's descendants. <return type="bool"> </return> <description> - Return true if selecting the text inside this richtext is allowed. + Return true if selecting the text inside this richtext is allowed. </description> </method> <method name="is_using_bbcode" qualifiers="const"> @@ -31693,7 +31693,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="enabled" type="bool"> </argument> <description> - Set to true if selecting the text inside this richtext is allowed. + Set to true if selecting the text inside this richtext is allowed. </description> </method> <method name="set_tab_size"> @@ -31800,17 +31800,17 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="RigidBody" inherits="PhysicsBody" category="Core"> <brief_description> - Rigid body node. + Rigid body node. </brief_description> <description> - Rigid body node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift mode between regular Rigid body, Kinematic, Character or Static. + Rigid body node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift mode between regular Rigid body, Kinematic, Character or Static. </description> <methods> <method name="_integrate_forces" qualifiers="virtual"> <argument index="0" name="state" type="PhysicsDirectBodyState"> </argument> <description> - Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body. + Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body. </description> </method> <method name="apply_impulse"> @@ -31819,175 +31819,175 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="impulse" type="Vector3"> </argument> <description> - Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. + Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. </description> </method> <method name="get_angular_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the current body angular damp. Default is -1. + Return the current body angular damp. Default is -1. </description> </method> <method name="get_angular_velocity" qualifiers="const"> <return type="Vector3"> </return> <description> - Return the current body angular velocity. + Return the current body angular velocity. </description> </method> <method name="get_axis_lock" qualifiers="const"> <return type="int"> </return> <description> - Return the current axis lock of the body. One of AXIS_LOCK_* enum. + Return the current axis lock of the body. One of AXIS_LOCK_* enum. </description> </method> <method name="get_bounce" qualifiers="const"> <return type="float"> </return> <description> - Return the current body bounciness. + Return the current body bounciness. </description> </method> <method name="get_colliding_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Return a list of the bodies colliding with this one. + Return a list of the bodies colliding with this one. </description> </method> <method name="get_friction" qualifiers="const"> <return type="float"> </return> <description> - Return the current body friction, from 0 (frictionless) to 1 (max friction). + Return the current body friction, from 0 (frictionless) to 1 (max friction). </description> </method> <method name="get_gravity_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the current body gravity scale. + Return the current body gravity scale. </description> </method> <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the current body linear damp. Default is -1. + Return the current body linear damp. Default is -1. </description> </method> <method name="get_linear_velocity" qualifiers="const"> <return type="Vector3"> </return> <description> - Return the current body linear velocity. + Return the current body linear velocity. </description> </method> <method name="get_mass" qualifiers="const"> <return type="float"> </return> <description> - Return the current body mass. + Return the current body mass. </description> </method> <method name="get_max_contacts_reported" qualifiers="const"> <return type="int"> </return> <description> - Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. + Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. </description> </method> <method name="get_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the current body mode, see [method set_mode]. + Return the current body mode, see [method set_mode]. </description> </method> <method name="get_weight" qualifiers="const"> <return type="float"> </return> <description> - Return the current body weight, given standard earth-weight (gravity 9.8). + Return the current body weight, given standard earth-weight (gravity 9.8). </description> </method> <method name="is_able_to_sleep" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the body has the ability to fall asleep when not moving. See [method set_can_sleep]. + Return whether the body has the ability to fall asleep when not moving. See [method set_can_sleep]. </description> </method> <method name="is_contact_monitor_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether contact monitoring is enabled. + Return whether contact monitoring is enabled. </description> </method> <method name="is_sleeping" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the body is sleeping. + Return whether the body is sleeping. </description> </method> <method name="is_using_continuous_collision_detection" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this body is using continuous collision detection. + Return whether this body is using continuous collision detection. </description> </method> <method name="is_using_custom_integrator"> <return type="bool"> </return> <description> - Return whether the body is using a custom integrator. + Return whether the body is using a custom integrator. </description> </method> <method name="set_angular_damp"> <argument index="0" name="angular_damp" type="float"> </argument> <description> - Set the angular damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any angular damp derived from the world or areas will be overridden. + Set the angular damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any angular damp derived from the world or areas will be overridden. </description> </method> <method name="set_angular_velocity"> <argument index="0" name="angular_velocity" type="Vector3"> </argument> <description> - Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. + Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. </description> </method> <method name="set_axis_lock"> <argument index="0" name="axis_lock" type="int"> </argument> <description> - Set the axis lock of the body, from the AXIS_LOCK_* enum. Axis lock stops the body from moving along the specified axis(X/Y/Z) and rotating along the other two axes. + Set the axis lock of the body, from the AXIS_LOCK_* enum. Axis lock stops the body from moving along the specified axis(X/Y/Z) and rotating along the other two axes. </description> </method> <method name="set_axis_velocity"> <argument index="0" name="axis_velocity" type="Vector3"> </argument> <description> - Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. + Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="set_bounce"> <argument index="0" name="bounce" type="float"> </argument> <description> - Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness). + Set the body bounciness, from 0 (no bounciness) to 1 (max bounciness). </description> </method> <method name="set_can_sleep"> <argument index="0" name="able_to_sleep" type="bool"> </argument> <description> - Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. + Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. </description> </method> @@ -31995,70 +31995,70 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="enabled" type="bool"> </argument> <description> - Enable contact monitoring. This allows the body to emit signals when it collides with another. + Enable contact monitoring. This allows the body to emit signals when it collides with another. </description> </method> <method name="set_friction"> <argument index="0" name="friction" type="float"> </argument> <description> - Set the body friction, from 0 (frictionless) to 1 (max friction). + Set the body friction, from 0 (frictionless) to 1 (max friction). </description> </method> <method name="set_gravity_scale"> <argument index="0" name="gravity_scale" type="float"> </argument> <description> - Set the gravity factor. This factor multiplies gravity intensity just for this body. + Set the gravity factor. This factor multiplies gravity intensity just for this body. </description> </method> <method name="set_linear_damp"> <argument index="0" name="linear_damp" type="float"> </argument> <description> - Set the linear damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. + Set the linear damp for this body. Default of -1, cannot be less than -1. If this value is different from -1, any linear damp derived from the world or areas will be overridden. </description> </method> <method name="set_linear_velocity"> <argument index="0" name="linear_velocity" type="Vector3"> </argument> <description> - Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. + Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. </description> </method> <method name="set_mass"> <argument index="0" name="mass" type="float"> </argument> <description> - Set the body mass. + Set the body mass. </description> </method> <method name="set_max_contacts_reported"> <argument index="0" name="amount" type="int"> </argument> <description> - Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. + Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. </description> </method> <method name="set_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. + Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. </description> </method> <method name="set_sleeping"> <argument index="0" name="sleeping" type="bool"> </argument> <description> - Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] wakes them up. Until then, they behave like a static body. + Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] wakes them up. Until then, they behave like a static body. </description> </method> <method name="set_use_continuous_collision_detection"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set the continuous collision detection mode from the enum CCD_MODE_*. + Set the continuous collision detection mode from the enum CCD_MODE_*. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects. </description> </method> @@ -32066,14 +32066,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="enable" type="bool"> </argument> <description> - Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. + Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. </description> </method> <method name="set_weight"> <argument index="0" name="weight" type="float"> </argument> <description> - Set the body weight given standard earth-weight (gravity 9.8). + Set the body weight given standard earth-weight (gravity 9.8). </description> </method> </methods> @@ -32082,7 +32082,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. </description> </signal> <signal name="body_enter_shape"> @@ -32095,7 +32095,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="local_shape" type="int"> </argument> <description> - Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. </description> </signal> @@ -32103,7 +32103,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. </description> </signal> <signal name="body_exit_shape"> @@ -32116,13 +32116,13 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="local_shape" type="int"> </argument> <description> - Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. </description> </signal> <signal name="sleeping_state_changed"> <description> - Emitted when the body changes it's sleeping state. Either by sleeping or waking up. + Emitted when the body changes it's sleeping state. Either by sleeping or waking up. </description> </signal> </signals> @@ -32143,10 +32143,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="RigidBody2D" inherits="PhysicsBody2D" category="Core"> <brief_description> - Rigid body 2D node. + Rigid body 2D node. </brief_description> <description> - Rigid body 2D node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift state between regular Rigid body, Kinematic, Character or Static. + Rigid body 2D node. This node is used for placing rigid bodies in the scene. It can contain a number of shapes, and also shift state between regular Rigid body, Kinematic, Character or Static. Character mode forbids the node from being rotated. This node can have a custom force integrator function, for writing complex physics motion behavior per node. As a warning, don't change this node position every frame or very often. Sporadic changes work fine, but physics runs at a different granularity (fixed hz) than usual rendering (process callback) and maybe even in a separate thread, so changing this from a process loop will yield strange behavior. </description> @@ -32155,7 +32155,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="state" type="Physics2DDirectBodyState"> </argument> <description> - Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body. + Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but [method set_use_custom_integrator] allows you to disable the default behavior and do fully custom force integration for a body. </description> </method> <method name="add_force"> @@ -32164,7 +32164,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="force" type="Vector2"> </argument> <description> - Add a positioned force to the applied force and torque. As with [method apply_impulse], both the force and the offset from the body origin are in global coordinates. + Add a positioned force to the applied force and torque. As with [method apply_impulse], both the force and the offset from the body origin are in global coordinates. </description> </method> <method name="apply_impulse"> @@ -32173,196 +32173,196 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="impulse" type="Vector2"> </argument> <description> - Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. + Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. </description> </method> <method name="get_angular_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the angular damp for this body. + Return the angular damp for this body. </description> </method> <method name="get_angular_velocity" qualifiers="const"> <return type="float"> </return> <description> - Return the body angular velocity. This changes by physics granularity. See [method set_angular_velocity]. + Return the body angular velocity. This changes by physics granularity. See [method set_angular_velocity]. </description> </method> <method name="get_applied_force" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the applied force vector. + Return the applied force vector. </description> </method> <method name="get_applied_torque" qualifiers="const"> <return type="float"> </return> <description> - Return the torque which is being applied to this body. + Return the torque which is being applied to this body. </description> </method> <method name="get_bounce" qualifiers="const"> <return type="float"> </return> <description> - Return the body bounciness. + Return the body bounciness. </description> </method> <method name="get_colliding_bodies" qualifiers="const"> <return type="Array"> </return> <description> - Return a list of the bodies colliding with this one. + Return a list of the bodies colliding with this one. </description> </method> <method name="get_continuous_collision_detection_mode" qualifiers="const"> <return type="int"> </return> <description> - Return whether this body is using continuous collision detection. + Return whether this body is using continuous collision detection. </description> </method> <method name="get_friction" qualifiers="const"> <return type="float"> </return> <description> - Return the body friction. + Return the body friction. </description> </method> <method name="get_gravity_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the gravity factor. + Return the gravity factor. </description> </method> <method name="get_inertia" qualifiers="const"> <return type="float"> </return> <description> - Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet. + Return the body's moment of inertia. This is usually automatically computed from the mass and the shapes. Note that this doesn't seem to work in a [code]_ready[/code] function: it apparently has not been auto-computed yet. </description> </method> <method name="get_linear_damp" qualifiers="const"> <return type="float"> </return> <description> - Return the linear damp for this body. + Return the linear damp for this body. </description> </method> <method name="get_linear_velocity" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity]. + Return the body linear velocity. This changes by physics granularity. See [method set_linear_velocity]. </description> </method> <method name="get_mass" qualifiers="const"> <return type="float"> </return> <description> - Return the body mass. + Return the body mass. </description> </method> <method name="get_max_contacts_reported" qualifiers="const"> <return type="int"> </return> <description> - Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. + Return the maximum contacts that can be reported. See [method set_max_contacts_reported]. </description> </method> <method name="get_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the current body mode, see [method set_mode]. + Return the current body mode, see [method set_mode]. </description> </method> <method name="get_weight" qualifiers="const"> <return type="float"> </return> <description> - Return the body weight given standard earth-weight (gravity 9.8). + Return the body weight given standard earth-weight (gravity 9.8). </description> </method> <method name="is_able_to_sleep" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the body has the ability to fall asleep when not moving. See [method set_can_sleep]. + Return true if the body has the ability to fall asleep when not moving. See [method set_can_sleep]. </description> </method> <method name="is_contact_monitor_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether contact monitoring is enabled. + Return whether contact monitoring is enabled. </description> </method> <method name="is_sleeping" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the body is sleeping. + Return whether the body is sleeping. </description> </method> <method name="is_using_custom_integrator"> <return type="bool"> </return> <description> - Return true if the body is not doing any built-in force integration. + Return true if the body is not doing any built-in force integration. </description> </method> <method name="set_angular_damp"> <argument index="0" name="angular_damp" type="float"> </argument> <description> - Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden. + Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden. </description> </method> <method name="set_angular_velocity"> <argument index="0" name="angular_velocity" type="float"> </argument> <description> - Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. + Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. </description> </method> <method name="set_applied_force"> <argument index="0" name="force" type="Vector2"> </argument> <description> - Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly. + Set the applied force vector. This is the equivalent of pushing a box over the ground: the force applied is applied constantly. </description> </method> <method name="set_applied_torque"> <argument index="0" name="torque" type="float"> </argument> <description> - Set a constant torque which will be applied to this body. + Set a constant torque which will be applied to this body. </description> </method> <method name="set_axis_velocity"> <argument index="0" name="axis_velocity" type="Vector2"> </argument> <description> - Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. + Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="set_bounce"> <argument index="0" name="bounce" type="float"> </argument> <description> - Set the body bounciness, from 0 (no bounce) to 1 (full bounce). + Set the body bounciness, from 0 (no bounce) to 1 (full bounce). </description> </method> <method name="set_can_sleep"> <argument index="0" name="able_to_sleep" type="bool"> </argument> <description> - Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. + Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. </description> </method> @@ -32370,14 +32370,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="enabled" type="bool"> </argument> <description> - Enable contact monitoring. This allows the body to emit signals when it collides with another. + Enable contact monitoring. This allows the body to emit signals when it collides with another. </description> </method> <method name="set_continuous_collision_detection_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set the continuous collision detection mode from the enum CCD_MODE_*. + Set the continuous collision detection mode from the enum CCD_MODE_*. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fast-moving objects. </description> </method> @@ -32385,77 +32385,77 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="friction" type="float"> </argument> <description> - Set the body friction, from 0 (frictionless) to 1 (full friction). + Set the body friction, from 0 (frictionless) to 1 (full friction). </description> </method> <method name="set_gravity_scale"> <argument index="0" name="gravity_scale" type="float"> </argument> <description> - Set the gravity factor. This factor multiplies gravity intensity just for this body. + Set the gravity factor. This factor multiplies gravity intensity just for this body. </description> </method> <method name="set_inertia"> <argument index="0" name="inertia" type="float"> </argument> <description> - Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. + Set the body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. </description> </method> <method name="set_linear_damp"> <argument index="0" name="linear_damp" type="float"> </argument> <description> - Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden. + Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden. </description> </method> <method name="set_linear_velocity"> <argument index="0" name="linear_velocity" type="Vector2"> </argument> <description> - Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. + Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. </description> </method> <method name="set_mass"> <argument index="0" name="mass" type="float"> </argument> <description> - Set the body mass. + Set the body mass. </description> </method> <method name="set_max_contacts_reported"> <argument index="0" name="amount" type="int"> </argument> <description> - Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. + Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. </description> </method> <method name="set_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. + Set the body mode, from the MODE_* enum. This allows to change to a static body or a character body. </description> </method> <method name="set_sleeping"> <argument index="0" name="sleeping" type="bool"> </argument> <description> - Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. + Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. </description> </method> <method name="set_use_custom_integrator"> <argument index="0" name="enable" type="bool"> </argument> <description> - Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. + Pass true to disable the internal force integration (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the [method _integrate_forces] function, if defined. </description> </method> <method name="set_weight"> <argument index="0" name="weight" type="float"> </argument> <description> - Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels. + Set the body weight given standard earth-weight (gravity 9.8). Not really useful for 2D since most measures for this node are in pixels. </description> </method> <method name="test_motion"> @@ -32468,7 +32468,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="result" type="Physics2DTestMotionResult" default="NULL"> </argument> <description> - Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type [Physics2DTestMotionResult], which will store additional information about the collision (should there be one). + Return whether the body would collide, if it tried to move in the given vector. This method allows two extra parameters: A margin, which increases slightly the size of the shapes involved in the collision detection, and an object of type [Physics2DTestMotionResult], which will store additional information about the collision (should there be one). </description> </method> </methods> @@ -32477,7 +32477,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. </description> </signal> <signal name="body_enter_shape"> @@ -32490,7 +32490,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="local_shape" type="int"> </argument> <description> - Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. </description> </signal> @@ -32498,7 +32498,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="body" type="Object"> </argument> <description> - Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. </description> </signal> <signal name="body_exit_shape"> @@ -32511,13 +32511,13 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="local_shape" type="int"> </argument> <description> - Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. This signal not only receives the body that stopped colliding with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body stopped colliding with. </description> </signal> <signal name="sleeping_state_changed"> <description> - Emitted when the body changes it's sleeping state. Either by sleeping or waking up. + Emitted when the body changes it's sleeping state. Either by sleeping or waking up. </description> </signal> </signals> @@ -32547,10 +32547,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Room" inherits="VisualInstance" category="Core"> <brief_description> - Room data resource. + Room data resource. </brief_description> <description> - Room contains the data to define the bounds of a scene (using a BSP Tree). It is instanced by a [VisualInstance] node to create rooms. See that class documentation for more information about rooms. + Room contains the data to define the bounds of a scene (using a BSP Tree). It is instanced by a [VisualInstance] node to create rooms. See that class documentation for more information about rooms. </description> <methods> <method name="compute_room_from_subtree"> @@ -32629,10 +32629,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Sample" inherits="Resource" category="Core"> <brief_description> - Audio sample (sound) class. + Audio sample (sound) class. </brief_description> <description> - Sample provides an audio sample class, containing audio data, together with some information for playback, such as format, mix rate and loop. It is used by sound playback routines. + Sample provides an audio sample class, containing audio data, together with some information for playback, such as format, mix rate and loop. It is used by sound playback routines. </description> <methods> <method name="create"> @@ -32643,7 +32643,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="length" type="int"> </argument> <description> - Create new data for the sample, with format (see FORMAT_* constants), stereo hint, and length in samples (not bytes). + Create new data for the sample, with format (see FORMAT_* constants), stereo hint, and length in samples (not bytes). Calling this method overrides previously existing data. Stereo samples are interleaved pairs of left and right points (in that order), but count as one sample for length purposes. </description> </method> @@ -32651,63 +32651,63 @@ A similar effect may be achieved moving this node's descendants. <return type="RawArray"> </return> <description> - Return sample data as little endian. + Return sample data as little endian. </description> </method> <method name="get_format" qualifiers="const"> <return type="int"> </return> <description> - Return the sample format. + Return the sample format. </description> </method> <method name="get_length" qualifiers="const"> <return type="int"> </return> <description> - Return the sample length in samples. Stereo samples count as one, even if they are made of a left and a right sample. + Return the sample length in samples. Stereo samples count as one, even if they are made of a left and a right sample. </description> </method> <method name="get_loop_begin" qualifiers="const"> <return type="int"> </return> <description> - Return the loop begin position. + Return the loop begin position. </description> </method> <method name="get_loop_end" qualifiers="const"> <return type="int"> </return> <description> - Return the loop end position. + Return the loop end position. </description> </method> <method name="get_loop_format" qualifiers="const"> <return type="int"> </return> <description> - Return the loop format. + Return the loop format. </description> </method> <method name="get_mix_rate" qualifiers="const"> <return type="int"> </return> <description> - Return the mix rate for the sample. + Return the mix rate for the sample. </description> </method> <method name="is_stereo" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the current sample was created as stereo. + Return whether the current sample was created as stereo. </description> </method> <method name="set_data"> <argument index="0" name="data" type="RawArray"> </argument> <description> - Set sample data. Data must be little endian, no matter the host platform, and exactly as long as to fit all samples. The length of this array can be calculated as follows: + Set sample data. Data must be little endian, no matter the host platform, and exactly as long as to fit all samples. The length of this array can be calculated as follows: Get the sample length ([method get_length]). If the sample format is FORMAT_PCM16, multiply it by 2. If the sample format is FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. @@ -32718,28 +32718,28 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="pos" type="int"> </argument> <description> - Set the loop begin position. It must be a valid frame and less than the loop end position. + Set the loop begin position. It must be a valid frame and less than the loop end position. </description> </method> <method name="set_loop_end"> <argument index="0" name="pos" type="int"> </argument> <description> - Set the loop end position. It must be a valid frame and greater than the loop begin position. + Set the loop end position. It must be a valid frame and greater than the loop begin position. </description> </method> <method name="set_loop_format"> <argument index="0" name="format" type="int"> </argument> <description> - Set the loop format (use LOOP_* constants as argument). + Set the loop format (use LOOP_* constants as argument). </description> </method> <method name="set_mix_rate"> <argument index="0" name="hz" type="int"> </argument> <description> - Set the mix rate for the sample (expected playback frequency). + Set the mix rate for the sample (expected playback frequency). </description> </method> </methods> @@ -32766,10 +32766,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SampleLibrary" inherits="Resource" category="Core"> <brief_description> - Library that contains a collection of samples. + Library that contains a collection of samples. </brief_description> <description> - Library that contains a collection of [Sample], each identified by a text ID. This is used as a data container for the majority of the SamplePlayer classes and derivatives. + Library that contains a collection of [Sample], each identified by a text ID. This is used as a data container for the majority of the SamplePlayer classes and derivatives. </description> <methods> <method name="add_sample"> @@ -32778,7 +32778,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="sample" type="Sample"> </argument> <description> - Add a sample to the library, with a given text ID. + Add a sample to the library, with a given text ID. </description> </method> <method name="get_sample" qualifiers="const"> @@ -32787,7 +32787,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="name" type="String"> </argument> <description> - Return the sample from the library matching the given text ID. Return null if the sample is not found. + Return the sample from the library matching the given text ID. Return null if the sample is not found. </description> </method> <method name="has_sample" qualifiers="const"> @@ -32796,14 +32796,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="name" type="String"> </argument> <description> - Return true if the sample text ID exists in the library. + Return true if the sample text ID exists in the library. </description> </method> <method name="remove_sample"> <argument index="0" name="name" type="String"> </argument> <description> - Remove the sample matching the given text ID. + Remove the sample matching the given text ID. </description> </method> <method name="sample_get_pitch_scale" qualifiers="const"> @@ -32812,7 +32812,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="name" type="String"> </argument> <description> - Return the pitch scale for the given sample. + Return the pitch scale for the given sample. </description> </method> <method name="sample_get_volume_db" qualifiers="const"> @@ -32821,7 +32821,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="name" type="String"> </argument> <description> - Return the volume (in dB) for the given sample. + Return the volume (in dB) for the given sample. </description> </method> <method name="sample_set_pitch_scale"> @@ -32830,7 +32830,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="pitch" type="float"> </argument> <description> - Set the pitch scale for the given sample. + Set the pitch scale for the given sample. </description> </method> <method name="sample_set_volume_db"> @@ -32839,7 +32839,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="db" type="float"> </argument> <description> - Set the volume (in dB) for the given sample. + Set the volume (in dB) for the given sample. </description> </method> </methods> @@ -32848,10 +32848,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SamplePlayer" inherits="Node" category="Core"> <brief_description> - Sample Player node. + Sample Player node. </brief_description> <description> - SamplePlayer is a [Node] meant for simple sample playback. A library of samples is loaded and played back "as is", without positioning or anything. + SamplePlayer is a [Node] meant for simple sample playback. A library of samples is loaded and played back "as is", without positioning or anything. </description> <methods> <method name="get_chorus" qualifiers="const"> @@ -32860,98 +32860,98 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current chorus send level for a given voice. + Return the current chorus send level for a given voice. </description> </method> <method name="get_default_chorus" qualifiers="const"> <return type="float"> </return> <description> - Return the default chorus send level of the player. + Return the default chorus send level of the player. </description> </method> <method name="get_default_filter_cutoff" qualifiers="const"> <return type="float"> </return> <description> - Return the default filter cutoff frequency of the player. + Return the default filter cutoff frequency of the player. </description> </method> <method name="get_default_filter_gain" qualifiers="const"> <return type="float"> </return> <description> - Return the default filter gain of the player. + Return the default filter gain of the player. </description> </method> <method name="get_default_filter_resonance" qualifiers="const"> <return type="float"> </return> <description> - Return the default filter resonance of the player. + Return the default filter resonance of the player. </description> </method> <method name="get_default_filter_type" qualifiers="const"> <return type="int"> </return> <description> - Return the default filter type in use (see FILTER_* constants) for the player. + Return the default filter type in use (see FILTER_* constants) for the player. </description> </method> <method name="get_default_pan" qualifiers="const"> <return type="float"> </return> <description> - Return the default panning of the player. + Return the default panning of the player. </description> </method> <method name="get_default_pan_depth" qualifiers="const"> <return type="float"> </return> <description> - Return the default pan depth of the player. + Return the default pan depth of the player. </description> </method> <method name="get_default_pan_height" qualifiers="const"> <return type="float"> </return> <description> - Return the default pan height of the player. + Return the default pan height of the player. </description> </method> <method name="get_default_pitch_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the default pitch scale of the player. + Return the default pitch scale of the player. </description> </method> <method name="get_default_reverb" qualifiers="const"> <return type="float"> </return> <description> - Return the default reverberation send level of the player. + Return the default reverberation send level of the player. </description> </method> <method name="get_default_reverb_room" qualifiers="const"> <return type="int"> </return> <description> - Return the default reverberation room type of the player (see REVERB_* enum). + Return the default reverberation room type of the player (see REVERB_* enum). </description> </method> <method name="get_default_volume" qualifiers="const"> <return type="float"> </return> <description> - Return the default volume (on a linear scale) of the player. + Return the default volume (on a linear scale) of the player. </description> </method> <method name="get_default_volume_db" qualifiers="const"> <return type="float"> </return> <description> - Return the default volume (in dB) of the player. + Return the default volume (in dB) of the player. </description> </method> <method name="get_filter_cutoff" qualifiers="const"> @@ -32960,7 +32960,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current filter cutoff frequency for a given voice. + Return the current filter cutoff frequency for a given voice. </description> </method> <method name="get_filter_gain" qualifiers="const"> @@ -32969,7 +32969,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current filter gain for a given voice. + Return the current filter gain for a given voice. </description> </method> <method name="get_filter_resonance" qualifiers="const"> @@ -32978,7 +32978,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current filter resonance for a given voice. + Return the current filter resonance for a given voice. </description> </method> <method name="get_filter_type" qualifiers="const"> @@ -32987,7 +32987,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current filter type in use (see FILTER_* constants) for a given voice. + Return the current filter type in use (see FILTER_* constants) for a given voice. </description> </method> <method name="get_mix_rate" qualifiers="const"> @@ -32996,7 +32996,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current mix rate for a given voice. + Return the current mix rate for a given voice. </description> </method> <method name="get_pan" qualifiers="const"> @@ -33005,7 +33005,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current panning for a given voice. + Return the current panning for a given voice. </description> </method> <method name="get_pan_depth" qualifiers="const"> @@ -33014,7 +33014,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current pan depth for a given voice. + Return the current pan depth for a given voice. </description> </method> <method name="get_pan_height" qualifiers="const"> @@ -33023,7 +33023,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current pan height for a given voice. + Return the current pan height for a given voice. </description> </method> <method name="get_pitch_scale" qualifiers="const"> @@ -33032,14 +33032,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current pitch scale for a given voice. + Return the current pitch scale for a given voice. </description> </method> <method name="get_polyphony" qualifiers="const"> <return type="int"> </return> <description> - Return the polyphony of the player. + Return the polyphony of the player. </description> </method> <method name="get_reverb" qualifiers="const"> @@ -33048,7 +33048,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current reverberation send level for a given voice. + Return the current reverberation send level for a given voice. </description> </method> <method name="get_reverb_room" qualifiers="const"> @@ -33057,14 +33057,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current reverberation room type for a given voice (see REVERB_* enum). + Return the current reverberation room type for a given voice (see REVERB_* enum). </description> </method> <method name="get_sample_library" qualifiers="const"> <return type="SampleLibrary"> </return> <description> - Return the sample library used by the player. + Return the sample library used by the player. </description> </method> <method name="get_volume" qualifiers="const"> @@ -33073,7 +33073,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current volume (on a linear scale) for a given voice. + Return the current volume (on a linear scale) for a given voice. </description> </method> <method name="get_volume_db" qualifiers="const"> @@ -33082,14 +33082,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return the current volume (in dB) for a given voice. + Return the current volume (in dB) for a given voice. </description> </method> <method name="is_active" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the player is currently active. + Return whether the player is currently active. </description> </method> <method name="is_voice_active" qualifiers="const"> @@ -33098,7 +33098,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return whether the given voice is currently active. + Return whether the given voice is currently active. </description> </method> <method name="play"> @@ -33109,7 +33109,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="unique" type="bool" default="false"> </argument> <description> - Play a sample referenced by its name. + Play a sample referenced by its name. Optionally, the playback can be made "unique" to force stopping all other samples currently played. The voices allocated for playback will then be returned. </description> </method> @@ -33119,14 +33119,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="send" type="float"> </argument> <description> - Set the chorus send level of a voice (from 0 to 1.0). For setting chorus parameters, see [AudioServer]. + Set the chorus send level of a voice (from 0 to 1.0). For setting chorus parameters, see [AudioServer]. </description> </method> <method name="set_default_chorus"> <argument index="0" name="send" type="float"> </argument> <description> - Set the default chorus send level of the player (from 0 to 1.0). For setting chorus parameters, see [AudioServer]. + Set the default chorus send level of the player (from 0 to 1.0). For setting chorus parameters, see [AudioServer]. </description> </method> <method name="set_default_filter"> @@ -33139,7 +33139,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="gain" type="float" default="0"> </argument> <description> - Set the default filter for the player, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). + Set the default filter for the player, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). Optionally, a gain can also be given (from 0 to 2.0). </description> </method> @@ -33151,7 +33151,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="height" type="float" default="0"> </argument> <description> - Set the default panning of the player. Panning goes from -1.0 (left) to +1.0 (right). + Set the default panning of the player. Panning goes from -1.0 (left) to +1.0 (right). Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0). </description> </method> @@ -33159,7 +33159,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="ratio" type="float"> </argument> <description> - Set the default pitch scale of the player. A ratio of 1.0 is the normal scale. + Set the default pitch scale of the player. A ratio of 1.0 is the normal scale. </description> </method> <method name="set_default_reverb"> @@ -33168,14 +33168,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="send" type="float"> </argument> <description> - Set the default reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of the player. + Set the default reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of the player. </description> </method> <method name="set_default_volume"> <argument index="0" name="volume" type="float"> </argument> <description> - Set the default volume of the player using a linear scale. + Set the default volume of the player using a linear scale. The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB). A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output. </description> @@ -33184,7 +33184,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="db" type="float"> </argument> <description> - Set the default volume of the player in dB. + Set the default volume of the player in dB. The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half. </description> </method> @@ -33200,7 +33200,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="4" name="gain" type="float" default="0"> </argument> <description> - Set the filter for a given voice, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). + Set the filter for a given voice, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). Optionally, a gain can also be given (from 0 to 2.0). </description> </method> @@ -33210,7 +33210,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="hz" type="int"> </argument> <description> - Set the mix rate (in Hz) of a given voice. + Set the mix rate (in Hz) of a given voice. </description> </method> <method name="set_pan"> @@ -33223,7 +33223,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="height" type="float" default="0"> </argument> <description> - Set the panning of a voice. Panning goes from -1.0 (left) to +1.0 (right). + Set the panning of a voice. Panning goes from -1.0 (left) to +1.0 (right). Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0). </description> </method> @@ -33233,14 +33233,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="ratio" type="float"> </argument> <description> - Set the pitch scale of a given voice. A ratio of 1.0 is the normal scale. + Set the pitch scale of a given voice. A ratio of 1.0 is the normal scale. </description> </method> <method name="set_polyphony"> <argument index="0" name="max_voices" type="int"> </argument> <description> - Set the polyphony of the player (maximum amount of simultaneous voices). + Set the polyphony of the player (maximum amount of simultaneous voices). </description> </method> <method name="set_reverb"> @@ -33251,14 +33251,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="send" type="float"> </argument> <description> - Set the reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of a voice. + Set the reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of a voice. </description> </method> <method name="set_sample_library"> <argument index="0" name="library" type="SampleLibrary"> </argument> <description> - Set the sample library for the player. + Set the sample library for the player. </description> </method> <method name="set_volume"> @@ -33267,7 +33267,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="volume" type="float"> </argument> <description> - Set the volume of a given voice using a linear scale. + Set the volume of a given voice using a linear scale. The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB). A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output. </description> @@ -33278,7 +33278,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="db" type="float"> </argument> <description> - Set the volume of a given voice in dB. + Set the volume of a given voice in dB. The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half. </description> </method> @@ -33286,12 +33286,12 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Stop a given voice. + Stop a given voice. </description> </method> <method name="stop_all"> <description> - Stop all playing voices. + Stop all playing voices. </description> </method> </methods> @@ -33342,31 +33342,31 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SamplePlayer2D" inherits="SoundPlayer2D" category="Core"> <brief_description> - Sample player for positional 2D Sound. + Sample player for positional 2D Sound. </brief_description> <description> - Sample player for positional 2D Sound. Plays sound samples positionally, left and right depending on the distance/place on the screen. + Sample player for positional 2D Sound. Plays sound samples positionally, left and right depending on the distance/place on the screen. </description> <methods> <method name="get_polyphony" qualifiers="const"> <return type="int"> </return> <description> - Return the polyphony of the player. + Return the polyphony of the player. </description> </method> <method name="get_random_pitch_scale" qualifiers="const"> <return type="float"> </return> <description> - Return the amplitude used for random pitch scale variations. + Return the amplitude used for random pitch scale variations. </description> </method> <method name="get_sample_library" qualifiers="const"> <return type="SampleLibrary"> </return> <description> - Return the sample library used by the player. + Return the sample library used by the player. </description> </method> <method name="is_voice_active" qualifiers="const"> @@ -33375,7 +33375,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="voice" type="int"> </argument> <description> - Return whether a voice is still active or has stopped playing. + Return whether a voice is still active or has stopped playing. </description> </method> <method name="play"> @@ -33386,7 +33386,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="voice" type="int" default="-2"> </argument> <description> - Play a sample. An internal polyphony ID can optionally be passed, or defaults to NEXT_VOICE. + Play a sample. An internal polyphony ID can optionally be passed, or defaults to NEXT_VOICE. Return a voice ID which can be used to modify the voice parameters, or INVALID_VOICE if the voice or sample are invalid. </description> </method> @@ -33394,14 +33394,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="max_voices" type="int"> </argument> <description> - Set the polyphony of the player (maximum amount of simultaneous voices). + Set the polyphony of the player (maximum amount of simultaneous voices). </description> </method> <method name="set_random_pitch_scale"> <argument index="0" name="val" type="float"> </argument> <description> - Set the amplitude for random pitch scale variations. If different from zero, the pitch scale will vary randomly around 1.0 in a range defined by val. + Set the amplitude for random pitch scale variations. If different from zero, the pitch scale will vary randomly around 1.0 in a range defined by val. The actual pitch scale will be, with "variation" ranging from -val to val: * variation > 0: 1.0 + variation * variation < 0: 1.0/(1.0 - variation) @@ -33411,19 +33411,19 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="library" type="SampleLibrary"> </argument> <description> - Set the sample library for the player. + Set the sample library for the player. </description> </method> <method name="stop_all"> <description> - Stop all playing voices. + Stop all playing voices. </description> </method> <method name="stop_voice"> <argument index="0" name="voice" type="int"> </argument> <description> - Stop a given voice. + Stop a given voice. </description> </method> <method name="voice_set_pitch_scale"> @@ -33432,7 +33432,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="ratio" type="float"> </argument> <description> - Change the pitch scale of a currently playing voice. + Change the pitch scale of a currently playing voice. </description> </method> <method name="voice_set_volume_scale_db"> @@ -33441,7 +33441,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="db" type="float"> </argument> <description> - Change the volume scale (in dB) of a currently playing voice. + Change the volume scale (in dB) of a currently playing voice. </description> </method> </methods> @@ -33888,31 +33888,31 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Script" inherits="Resource" category="Core"> <brief_description> - Base class for scripts. + Base class for scripts. </brief_description> <description> - Base class for scripts. Any script that is loaded becomes one of these resources, which can then create instances. + Base class for scripts. Any script that is loaded becomes one of these resources, which can then create instances. </description> <methods> <method name="can_instance" qualifiers="const"> <return type="bool"> </return> <description> - Return true if this script can be instance (ie not a library). + Return true if this script can be instance (ie not a library). </description> </method> <method name="get_source_code" qualifiers="const"> <return type="String"> </return> <description> - Return the script source code (if available). + Return the script source code (if available). </description> </method> <method name="has_source_code" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the script contains source code. + Return true if the script contains source code. </description> </method> <method name="instance_has" qualifiers="const"> @@ -33921,7 +33921,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="base_object" type="Object"> </argument> <description> - Return true if a given object uses an instance of this script. + Return true if a given object uses an instance of this script. </description> </method> <method name="reload"> @@ -33936,7 +33936,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="source" type="String"> </argument> <description> - Set the script source code. + Set the script source code. </description> </method> </methods> @@ -33945,10 +33945,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="ScrollBar" inherits="Range" category="Core"> <brief_description> - Base class for scroll bars. + Base class for scroll bars. </brief_description> <description> - Scrollbars are a [Range] based [Control], that display a draggable area (the size of the page). Horizontal ([HScrollBar]) and Vertical ([VScrollBar]) versions are available. + Scrollbars are a [Range] based [Control], that display a draggable area (the size of the page). Horizontal ([HScrollBar]) and Vertical ([VScrollBar]) versions are available. </description> <methods> <method name="get_custom_step" qualifiers="const"> @@ -33969,66 +33969,66 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="ScrollContainer" inherits="Container" category="Core"> <brief_description> - A helper node for displaying scrollable elements (e.g. lists). + A helper node for displaying scrollable elements (e.g. lists). </brief_description> <description> - A ScrollContainer node with a [Control] child and scrollbar child ([HScrollbar], [VScrollBar], or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a [Panel] control. + A ScrollContainer node with a [Control] child and scrollbar child ([HScrollbar], [VScrollBar], or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a [Panel] control. </description> <methods> <method name="get_h_scroll" qualifiers="const"> <return type="int"> </return> <description> - Return current horizontal scroll value. + Return current horizontal scroll value. </description> </method> <method name="get_v_scroll" qualifiers="const"> <return type="int"> </return> <description> - Return current vertical scroll value. + Return current vertical scroll value. </description> </method> <method name="is_h_scroll_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return true if horizontal scrool is allowed. + Return true if horizontal scrool is allowed. </description> </method> <method name="is_v_scroll_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return true if vertical scrool is allowed. + Return true if vertical scrool is allowed. </description> </method> <method name="set_enable_h_scroll"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set allows horizontal scrool. + Set allows horizontal scrool. </description> </method> <method name="set_enable_v_scroll"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set allows vertical scrool. + Set allows vertical scrool. </description> </method> <method name="set_h_scroll"> <argument index="0" name="val" type="int"> </argument> <description> - Set horizontal scroll value. + Set horizontal scroll value. </description> </method> <method name="set_v_scroll"> <argument index="0" name="val" type="int"> </argument> <description> - Set vertical scroll value. + Set vertical scroll value. </description> </method> </methods> @@ -34037,38 +34037,38 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SegmentShape2D" inherits="Shape2D" category="Core"> <brief_description> - Segment Shape for 2D Collision Detection. + Segment Shape for 2D Collision Detection. </brief_description> <description> - Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'. + Segment Shape for 2D Collision Detection, consists of two points, 'a' and 'b'. </description> <methods> <method name="get_a" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the first point's position. + Return the first point's position. </description> </method> <method name="get_b" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the second point's position. + Return the second point's position. </description> </method> <method name="set_a"> <argument index="0" name="a" type="Vector2"> </argument> <description> - Set the first point's position. + Set the first point's position. </description> </method> <method name="set_b"> <argument index="0" name="b" type="Vector2"> </argument> <description> - Set the second point's position. + Set the second point's position. </description> </method> </methods> @@ -34077,24 +34077,24 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Semaphore" inherits="Reference" category="Core"> <brief_description> - A synchronization Semaphore. + A synchronization Semaphore. </brief_description> <description> - A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation. + A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation. </description> <methods> <method name="post"> <return type="Error"> </return> <description> - Lowers the [Semaphore], allowing one more thread in. + Lowers the [Semaphore], allowing one more thread in. </description> </method> <method name="wait"> <return type="Error"> </return> <description> - Tries to wait for the [Semaphore], if it's value is zero, blocks until non-zero. + Tries to wait for the [Semaphore], if it's value is zero, blocks until non-zero. </description> </method> </methods> @@ -34103,10 +34103,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Separator" inherits="Control" category="Core"> <brief_description> - Base class for separators. + Base class for separators. </brief_description> <description> - Separator is a [Control] used for separating other controls. It's purely a visual decoration. Horizontal ([HSeparator]) and Vertical ([VSeparator]) versions are available. + Separator is a [Control] used for separating other controls. It's purely a visual decoration. Horizontal ([HSeparator]) and Vertical ([VSeparator]) versions are available. </description> <methods> </methods> @@ -34115,10 +34115,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Shader" inherits="Resource" category="Core"> <brief_description> - To be changed, ignore. + To be changed, ignore. </brief_description> <description> - To be changed, ignore. + To be changed, ignore. </description> <methods> <method name="get_default_texture_param" qualifiers="const"> @@ -35113,10 +35113,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Shape2D" inherits="Resource" category="Core"> <brief_description> - Base class for all 2D Shapes. + Base class for all 2D Shapes. </brief_description> <description> - Base class for all 2D Shapes. All 2D shape types inherit from this. + Base class for all 2D Shapes. All 2D shape types inherit from this. </description> <methods> <method name="collide"> @@ -35129,7 +35129,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="shape_xform" type="Matrix32"> </argument> <description> - Return whether this shape is colliding with another. + Return whether this shape is colliding with another. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). </description> </method> @@ -35143,7 +35143,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="shape_xform" type="Matrix32"> </argument> <description> - Return a list of the points where this shape touches another. If there are no collisions, the list is empty. + Return a list of the points where this shape touches another. If there are no collisions, the list is empty. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). </description> </method> @@ -35161,7 +35161,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="4" name="shape_motion" type="Vector2"> </argument> <description> - Return whether this shape would collide with another, if a given movement was applied. + Return whether this shape would collide with another, if a given movement was applied. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). </description> </method> @@ -35179,7 +35179,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="4" name="shape_motion" type="Vector2"> </argument> <description> - Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. + Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). </description> </method> @@ -35187,14 +35187,14 @@ A similar effect may be achieved moving this node's descendants. <return type="float"> </return> <description> - Return the custom solver bias. + Return the custom solver bias. </description> </method> <method name="set_custom_solver_bias"> <argument index="0" name="bias" type="float"> </argument> <description> - Use a custom solver bias. No need to change this unless you really know what you are doing. + Use a custom solver bias. No need to change this unless you really know what you are doing. The solver bias is a factor controlling how much two objects "rebound" off each other, when colliding, to avoid them getting into each other because of numerical imprecision. </description> </method> @@ -35246,17 +35246,17 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Skeleton" inherits="Spatial" category="Core"> <brief_description> - Skeleton for characters and animated objects. + Skeleton for characters and animated objects. </brief_description> <description> - Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future. + Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future. </description> <methods> <method name="add_bone"> <argument index="0" name="name" type="String"> </argument> <description> - Add a bone, with name "name". [method get_bone_count] will become the bone index. + Add a bone, with name "name". [method get_bone_count] will become the bone index. </description> </method> <method name="bind_child_node_to_bone"> @@ -35265,12 +35265,12 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="node" type="Node"> </argument> <description> - Deprecated soon. + Deprecated soon. </description> </method> <method name="clear_bones"> <description> - Clear all the bones in this skeleton. + Clear all the bones in this skeleton. </description> </method> <method name="find_bone" qualifiers="const"> @@ -35279,14 +35279,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="name" type="String"> </argument> <description> - Return the bone index that matches "name" as its name. + Return the bone index that matches "name" as its name. </description> </method> <method name="get_bone_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of bones in the skeleton. + Return the amount of bones in the skeleton. </description> </method> <method name="get_bone_custom_pose" qualifiers="const"> @@ -35311,7 +35311,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the name of the bone at index "index" + Return the name of the bone at index "index" </description> </method> <method name="get_bone_parent" qualifiers="const"> @@ -35320,7 +35320,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". + Return the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx". </description> </method> <method name="get_bone_pose" qualifiers="const"> @@ -35329,7 +35329,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the pose transform for bone "bone_idx". + Return the pose transform for bone "bone_idx". </description> </method> <method name="get_bone_rest" qualifiers="const"> @@ -35338,7 +35338,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bone_idx" type="int"> </argument> <description> - Return the rest transform for a bone "bone_idx". + Return the rest transform for a bone "bone_idx". </description> </method> <method name="get_bone_transform" qualifiers="const"> @@ -35355,7 +35355,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bone_idx" type="int"> </argument> <description> - Deprecated soon. + Deprecated soon. </description> </method> <method name="is_bone_rest_disabled" qualifiers="const"> @@ -35396,7 +35396,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="parent_idx" type="int"> </argument> <description> - Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx". + Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx". </description> </method> <method name="set_bone_pose"> @@ -35405,7 +35405,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="pose" type="Transform"> </argument> <description> - Return the pose transform for bone "bone_idx". + Return the pose transform for bone "bone_idx". </description> </method> <method name="set_bone_rest"> @@ -35414,7 +35414,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="rest" type="Transform"> </argument> <description> - Set the rest transform for bone "bone_idx" + Set the rest transform for bone "bone_idx" </description> </method> <method name="unbind_child_node_from_bone"> @@ -35423,7 +35423,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="node" type="Node"> </argument> <description> - Deprecated soon. + Deprecated soon. </description> </method> <method name="unparent_bone_and_rest"> @@ -35440,38 +35440,38 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Slider" inherits="Range" category="Core"> <brief_description> - Base class for GUI Sliders. + Base class for GUI Sliders. </brief_description> <description> - Base class for GUI Sliders. + Base class for GUI Sliders. </description> <methods> <method name="get_ticks" qualifiers="const"> <return type="int"> </return> <description> - Return amounts of ticks to display on slider. + Return amounts of ticks to display on slider. </description> </method> <method name="get_ticks_on_borders" qualifiers="const"> <return type="bool"> </return> <description> - Return true if ticks are visible on borders. + Return true if ticks are visible on borders. </description> </method> <method name="set_ticks"> <argument index="0" name="count" type="int"> </argument> <description> - Set amount of ticks to display in slider. + Set amount of ticks to display in slider. </description> </method> <method name="set_ticks_on_borders"> <argument index="0" name="ticks_on_border" type="bool"> </argument> <description> - Set true if ticks are visible on borders. + Set true if ticks are visible on borders. </description> </method> </methods> @@ -35552,10 +35552,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SoundPlayer2D" inherits="Node2D" category="Core"> <brief_description> - Base class for playing spatial 2D sound. + Base class for playing spatial 2D sound. </brief_description> <description> - Base class for playing spatial 2D sound. + Base class for playing spatial 2D sound. </description> <methods> <method name="get_param" qualifiers="const"> @@ -35642,10 +35642,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Spatial" inherits="Node" category="Core"> <brief_description> - Base class for all 3D nodes. + Base class for all 3D nodes. </brief_description> <description> - Spatial is the base for every type of 3D [Node]. It contains a 3D [Transform] which can be set or get as local or global. If a Spatial [Node] has Spatial children, their transforms will be relative to the parent. + Spatial is the base for every type of 3D [Node]. It contains a 3D [Transform] which can be set or get as local or global. If a Spatial [Node] has Spatial children, their transforms will be relative to the parent. </description> <methods> <method name="get_gizmo" qualifiers="const"> @@ -35658,14 +35658,14 @@ A similar effect may be achieved moving this node's descendants. <return type="Transform"> </return> <description> - Return the global transform, relative to worldspace. + Return the global transform, relative to worldspace. </description> </method> <method name="get_parent_spatial" qualifiers="const"> <return type="Object"> </return> <description> - Return the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial]. + Return the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial]. </description> </method> <method name="get_rotation" qualifiers="const"> @@ -35690,7 +35690,7 @@ A similar effect may be achieved moving this node's descendants. <return type="Transform"> </return> <description> - Return the local transform, relative to the bone parent. + Return the local transform, relative to the bone parent. </description> </method> <method name="get_translation" qualifiers="const"> @@ -35811,7 +35811,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="global" type="Transform"> </argument> <description> - Set the transform globally, relative to worldspace. + Set the transform globally, relative to worldspace. </description> </method> <method name="set_hidden"> @@ -35858,7 +35858,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="local" type="Transform"> </argument> <description> - Set the transform locally, relative to the parent spatial node. + Set the transform locally, relative to the parent spatial node. </description> </method> <method name="set_translation"> @@ -36036,10 +36036,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SpatialSound2DServer" inherits="Object" category="Core"> <brief_description> - Server for Spatial 2D Sound. + Server for Spatial 2D Sound. </brief_description> <description> - Server for Spatial 2D Sound. + Server for Spatial 2D Sound. </description> <methods> </methods> @@ -36252,10 +36252,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SpinBox" inherits="Range" category="Core"> <brief_description> - Numerical input text field. + Numerical input text field. </brief_description> <description> - SpinBox is a numerical input text field. It allows entering integers and floats. + SpinBox is a numerical input text field. It allows entering integers and floats. </description> <methods> <method name="get_line_edit"> @@ -36274,35 +36274,35 @@ A similar effect may be achieved moving this node's descendants. <return type="String"> </return> <description> - Return the specific suffix. + Return the specific suffix. </description> </method> <method name="is_editable" qualifiers="const"> <return type="bool"> </return> <description> - Return if the spinbox is editable. + Return if the spinbox is editable. </description> </method> <method name="set_editable"> <argument index="0" name="editable" type="bool"> </argument> <description> - Set whether the spinbox is editable. + Set whether the spinbox is editable. </description> </method> <method name="set_prefix"> <argument index="0" name="prefix" type="String"> </argument> <description> - Set a prefix. + Set a prefix. </description> </method> <method name="set_suffix"> <argument index="0" name="suffix" type="String"> </argument> <description> - Set a specific suffix. + Set a specific suffix. </description> </method> </methods> @@ -36315,52 +36315,52 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SplitContainer" inherits="Container" category="Core"> <brief_description> - Container for splitting and adjusting. + Container for splitting and adjusting. </brief_description> <description> - Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio. + Container for splitting two controls vertically or horizontally, with a grabber that allows adjusting the split offset or ratio. </description> <methods> <method name="get_dragger_visibility" qualifiers="const"> <return type="int"> </return> <description> - Return visibility of the split dragger(One of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). + Return visibility of the split dragger(One of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). </description> </method> <method name="get_split_offset" qualifiers="const"> <return type="int"> </return> <description> - Return the split offset. + Return the split offset. </description> </method> <method name="is_collapsed" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the split is collapsed. + Return true if the split is collapsed. </description> </method> <method name="set_collapsed"> <argument index="0" name="collapsed" type="bool"> </argument> <description> - Set if the split must be collapsed. + Set if the split must be collapsed. </description> </method> <method name="set_dragger_visibility"> <argument index="0" name="mode" type="int"> </argument> <description> - Set visibility of the split dragger([i]mode[/i] must be one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). + Set visibility of the split dragger([i]mode[/i] must be one of [DRAGGER_VISIBLE], [DRAGGER_HIDDEN] or [DRAGGER_HIDDEN_COLLAPSED]). </description> </method> <method name="set_split_offset"> <argument index="0" name="offset" type="int"> </argument> <description> - Set the split offset. + Set the split offset. </description> </method> </methods> @@ -36369,7 +36369,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="offset" type="int"> </argument> <description> - Emmited when the dragger is gragged by user. + Emmited when the dragger is gragged by user. </description> </signal> </signals> @@ -36387,10 +36387,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SpotLight" inherits="Light" category="Core"> <brief_description> - Spotlight [Light], such as a reflector spotlight or a lantern. + Spotlight [Light], such as a reflector spotlight or a lantern. </brief_description> <description> - A SpotLight light is a type of [Light] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of a spotlight. + A SpotLight light is a type of [Light] node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of a spotlight. </description> <methods> </methods> @@ -36399,164 +36399,164 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Sprite" inherits="Node2D" category="Core"> <brief_description> - General purpose Sprite node. + General purpose Sprite node. </brief_description> <description> - General purpose Sprite node. This Sprite node can show any texture as a sprite. The texture can be used as a spritesheet for animation, or only a region from a bigger texture can referenced, like an atlas. + General purpose Sprite node. This Sprite node can show any texture as a sprite. The texture can be used as a spritesheet for animation, or only a region from a bigger texture can referenced, like an atlas. </description> <methods> <method name="get_frame" qualifiers="const"> <return type="int"> </return> <description> - Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. + Return the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. </description> </method> <method name="get_hframes" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of horizontal frames. See [method set_hframes]. + Return the amount of horizontal frames. See [method set_hframes]. </description> </method> <method name="get_modulate" qualifiers="const"> <return type="Color"> </return> <description> - Return color modulation for the sprite. All sprite pixels are multiplied by this color. + Return color modulation for the sprite. All sprite pixels are multiplied by this color. </description> </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return sprite draw offset. + Return sprite draw offset. </description> </method> <method name="get_region_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return the region rect to read from. + Return the region rect to read from. </description> </method> <method name="get_texture" qualifiers="const"> <return type="Texture"> </return> <description> - Return the base texture for the sprite. + Return the base texture for the sprite. </description> </method> <method name="get_vframes" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of vertical frames. See [method set_vframes]. + Return the amount of vertical frames. See [method set_vframes]. </description> </method> <method name="is_centered" qualifiers="const"> <return type="bool"> </return> <description> - Return if the sprite is centered at the local origin. + Return if the sprite is centered at the local origin. </description> </method> <method name="is_flipped_h" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the sprite is flipped horizontally. + Return true if the sprite is flipped horizontally. </description> </method> <method name="is_flipped_v" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the sprite is flipped vertically. + Return true if the sprite is flipped vertically. </description> </method> <method name="is_region" qualifiers="const"> <return type="bool"> </return> <description> - Return if the sprite reads from a region. + Return if the sprite reads from a region. </description> </method> <method name="set_centered"> <argument index="0" name="centered" type="bool"> </argument> <description> - Set whether the sprite should be centered on the origin. + Set whether the sprite should be centered on the origin. </description> </method> <method name="set_flip_h"> <argument index="0" name="flip_h" type="bool"> </argument> <description> - Set true to flip the sprite horizontally. + Set true to flip the sprite horizontally. </description> </method> <method name="set_flip_v"> <argument index="0" name="flip_v" type="bool"> </argument> <description> - Set true to flip the sprite vertically. + Set true to flip the sprite vertically. </description> </method> <method name="set_frame"> <argument index="0" name="frame" type="int"> </argument> <description> - Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. + Set the texture frame for a sprite-sheet, works when vframes or hframes are greater than 1. </description> </method> <method name="set_hframes"> <argument index="0" name="hframes" type="int"> </argument> <description> - Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. + Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. </description> </method> <method name="set_modulate"> <argument index="0" name="modulate" type="Color"> </argument> <description> - Set color modulation for the sprite. All sprite pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. + Set color modulation for the sprite. All sprite pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. </description> </method> <method name="set_offset"> <argument index="0" name="offset" type="Vector2"> </argument> <description> - Set the sprite draw offset, useful for setting rotation pivots. + Set the sprite draw offset, useful for setting rotation pivots. </description> </method> <method name="set_region"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. + Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. </description> </method> <method name="set_region_rect"> <argument index="0" name="rect" type="Rect2"> </argument> <description> - Set the region rect to read from. + Set the region rect to read from. </description> </method> <method name="set_texture"> <argument index="0" name="texture" type="Texture"> </argument> <description> - Set the base texture for the sprite. + Set the base texture for the sprite. </description> </method> <method name="set_vframes"> <argument index="0" name="vframes" type="int"> </argument> <description> - Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation. + Set the amount of vertical frames and converts the sprite into a sprite-sheet. This is useful for animation. </description> </method> </methods> @@ -36815,10 +36815,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SpriteFrames" inherits="Resource" category="Core"> <brief_description> - Sprite frame library for AnimatedSprite. + Sprite frame library for AnimatedSprite. </brief_description> <description> - Sprite frame library for [AnimatedSprite]. + Sprite frame library for [AnimatedSprite]. </description> <methods> <method name="add_animation"> @@ -36943,10 +36943,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StaticBody" inherits="PhysicsBody" category="Core"> <brief_description> - Static body for 3D Physics. + Static body for 3D Physics. </brief_description> <description> - Static body for 3D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody3D] so they are great for scenario collision. + Static body for 3D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody3D] so they are great for scenario collision. A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies. Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels). </description> @@ -36955,56 +36955,56 @@ A similar effect may be achieved moving this node's descendants. <return type="float"> </return> <description> - Return the body bounciness. + Return the body bounciness. </description> </method> <method name="get_constant_angular_velocity" qualifiers="const"> <return type="Vector3"> </return> <description> - Return the constant angular velocity for the body. + Return the constant angular velocity for the body. </description> </method> <method name="get_constant_linear_velocity" qualifiers="const"> <return type="Vector3"> </return> <description> - Return the constant linear velocity for the body. + Return the constant linear velocity for the body. </description> </method> <method name="get_friction" qualifiers="const"> <return type="float"> </return> <description> - Return the body friction. + Return the body friction. </description> </method> <method name="set_bounce"> <argument index="0" name="bounce" type="float"> </argument> <description> - Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). + Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). </description> </method> <method name="set_constant_angular_velocity"> <argument index="0" name="vel" type="Vector3"> </argument> <description> - Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. + Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. </description> </method> <method name="set_constant_linear_velocity"> <argument index="0" name="vel" type="Vector3"> </argument> <description> - Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. + Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. </description> </method> <method name="set_friction"> <argument index="0" name="friction" type="float"> </argument> <description> - Set the body friction, from 0 (frictionless) to 1 (full friction). + Set the body friction, from 0 (frictionless) to 1 (full friction). </description> </method> </methods> @@ -37013,10 +37013,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StaticBody2D" inherits="PhysicsBody2D" category="Core"> <brief_description> - Static body for 2D Physics. + Static body for 2D Physics. </brief_description> <description> - Static body for 2D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody2D] so they are great for scenario collision. + Static body for 2D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody2D] so they are great for scenario collision. A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies. Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels). </description> @@ -37025,56 +37025,56 @@ A similar effect may be achieved moving this node's descendants. <return type="float"> </return> <description> - Return the body bounciness. + Return the body bounciness. </description> </method> <method name="get_constant_angular_velocity" qualifiers="const"> <return type="float"> </return> <description> - Return the constant angular velocity for the body. + Return the constant angular velocity for the body. </description> </method> <method name="get_constant_linear_velocity" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the constant linear velocity for the body. + Return the constant linear velocity for the body. </description> </method> <method name="get_friction" qualifiers="const"> <return type="float"> </return> <description> - Return the body friction. + Return the body friction. </description> </method> <method name="set_bounce"> <argument index="0" name="bounce" type="float"> </argument> <description> - Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). + Set the body bounciness, from 0 (not bouncy) to 1 (bouncy). </description> </method> <method name="set_constant_angular_velocity"> <argument index="0" name="vel" type="float"> </argument> <description> - Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. + Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating. </description> </method> <method name="set_constant_linear_velocity"> <argument index="0" name="vel" type="Vector2"> </argument> <description> - Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. + Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving. </description> </method> <method name="set_friction"> <argument index="0" name="friction" type="float"> </argument> <description> - Set the body friction, from 0 (frictionless) to 1 (full friction). + Set the body friction, from 0 (frictionless) to 1 (full friction). </description> </method> </methods> @@ -37083,45 +37083,45 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StreamPeer" inherits="Reference" category="Core"> <brief_description> - Abstraction and base class for stream-based protocols. + Abstraction and base class for stream-based protocols. </brief_description> <description> - StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. + StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. </description> <methods> <method name="get_16"> <return type="int"> </return> <description> - Get a signed 16 bit value from the stream. + Get a signed 16 bit value from the stream. </description> </method> <method name="get_32"> <return type="int"> </return> <description> - Get a signed 32 bit value from the stream. + Get a signed 32 bit value from the stream. </description> </method> <method name="get_64"> <return type="int"> </return> <description> - Get a signed 64 bit value from the stream. + Get a signed 64 bit value from the stream. </description> </method> <method name="get_8"> <return type="int"> </return> <description> - Get a signed byte from the stream. + Get a signed byte from the stream. </description> </method> <method name="get_available_bytes" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of bytes this [StreamPeer] has available. + Return the amount of bytes this [StreamPeer] has available. </description> </method> <method name="get_data"> @@ -37130,21 +37130,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bytes" type="int"> </argument> <description> - Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. + Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. </description> </method> <method name="get_double"> <return type="float"> </return> <description> - Get a double-precision float from the stream. + Get a double-precision float from the stream. </description> </method> <method name="get_float"> <return type="float"> </return> <description> - Get a single-precision float from the stream. + Get a single-precision float from the stream. </description> </method> <method name="get_partial_data"> @@ -37153,7 +37153,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bytes" type="int"> </argument> <description> - Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. + Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. </description> </method> <method name="get_string"> @@ -37162,35 +37162,35 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bytes" type="int"> </argument> <description> - Get a string with byte-length "bytes" from the stream. + Get a string with byte-length "bytes" from the stream. </description> </method> <method name="get_u16"> <return type="int"> </return> <description> - Get an unsigned 16 bit value from the stream. + Get an unsigned 16 bit value from the stream. </description> </method> <method name="get_u32"> <return type="int"> </return> <description> - Get an unsigned 32 bit value from the stream. + Get an unsigned 32 bit value from the stream. </description> </method> <method name="get_u64"> <return type="int"> </return> <description> - Get an unsigned 16 bit value from the stream. + Get an unsigned 16 bit value from the stream. </description> </method> <method name="get_u8"> <return type="int"> </return> <description> - Get an unsigned byte from the stream. + Get an unsigned byte from the stream. </description> </method> <method name="get_utf8_string"> @@ -37199,49 +37199,49 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="bytes" type="int"> </argument> <description> - Get an utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8). + Get an utf8 string with byte-length "bytes" from the stream (this decodes the string sent as utf8). </description> </method> <method name="get_var"> <return type="Variant"> </return> <description> - Get a Variant from the stream. + Get a Variant from the stream. </description> </method> <method name="is_big_endian_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this [StreamPeer] is using big-endian format. + Return whether this [StreamPeer] is using big-endian format. </description> </method> <method name="put_16"> <argument index="0" name="val" type="int"> </argument> <description> - Put a signed 16 bit value into the stream. + Put a signed 16 bit value into the stream. </description> </method> <method name="put_32"> <argument index="0" name="val" type="int"> </argument> <description> - Put a signed 32 bit value into the stream. + Put a signed 32 bit value into the stream. </description> </method> <method name="put_64"> <argument index="0" name="val" type="int"> </argument> <description> - Put a signed 64 bit value into the stream. + Put a signed 64 bit value into the stream. </description> </method> <method name="put_8"> <argument index="0" name="val" type="int"> </argument> <description> - Put a signed byte into the stream. + Put a signed byte into the stream. </description> </method> <method name="put_data"> @@ -37250,21 +37250,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="data" type="RawArray"> </argument> <description> - Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. + Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. </description> </method> <method name="put_double"> <argument index="0" name="val" type="float"> </argument> <description> - Put a double-precision float into the stream. + Put a double-precision float into the stream. </description> </method> <method name="put_float"> <argument index="0" name="val" type="float"> </argument> <description> - Put a single-precision float into the stream. + Put a single-precision float into the stream. </description> </method> <method name="put_partial_data"> @@ -37273,56 +37273,56 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="data" type="RawArray"> </argument> <description> - Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. + Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. </description> </method> <method name="put_u16"> <argument index="0" name="val" type="int"> </argument> <description> - Put an unsigned 16 bit value into the stream. + Put an unsigned 16 bit value into the stream. </description> </method> <method name="put_u32"> <argument index="0" name="val" type="int"> </argument> <description> - Put an unsigned 32 bit value into the stream. + Put an unsigned 32 bit value into the stream. </description> </method> <method name="put_u64"> <argument index="0" name="val" type="int"> </argument> <description> - Put an unsigned 64 bit value into the stream. + Put an unsigned 64 bit value into the stream. </description> </method> <method name="put_u8"> <argument index="0" name="val" type="int"> </argument> <description> - Put an unsigned byte into the stream. + Put an unsigned byte into the stream. </description> </method> <method name="put_utf8_string"> <argument index="0" name="val" type="String"> </argument> <description> - Put a zero-terminated utf8 string into the stream. + Put a zero-terminated utf8 string into the stream. </description> </method> <method name="put_var"> <argument index="0" name="val" type="Variant"> </argument> <description> - Put a Variant into the stream. + Put a Variant into the stream. </description> </method> <method name="set_big_endian"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set this [StreamPeer] to use big-endian format. Default is false. + Set this [StreamPeer] to use big-endian format. Default is false. </description> </method> </methods> @@ -37331,10 +37331,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StreamPeerSSL" inherits="StreamPeer" category="Core"> <brief_description> - SSL Stream peer. + SSL Stream peer. </brief_description> <description> - SSL Stream peer. This object can be used to connect to SSL servers. + SSL Stream peer. This object can be used to connect to SSL servers. </description> <methods> <method name="accept"> @@ -37355,19 +37355,19 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="for_hostname" type="String" default=""""> </argument> <description> - Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname". + Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname". </description> </method> <method name="disconnect"> <description> - Disconnect from host. + Disconnect from host. </description> </method> <method name="get_status" qualifiers="const"> <return type="int"> </return> <description> - Return the status of the connection, one of STATUS_* enum. + Return the status of the connection, one of STATUS_* enum. </description> </method> </methods> @@ -37388,10 +37388,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StreamPeerTCP" inherits="StreamPeer" category="Core"> <brief_description> - TCP Stream peer. + TCP Stream peer. </brief_description> <description> - TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a tcp server. + TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a tcp server. </description> <methods> <method name="connect"> @@ -37402,40 +37402,40 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="port" type="int"> </argument> <description> - Connect to the specified IP:port pair. Returns [OK] on success or [FAILED] on failure. + Connect to the specified IP:port pair. Returns [OK] on success or [FAILED] on failure. </description> </method> <method name="disconnect"> <description> - Disconnect from host. + Disconnect from host. </description> </method> <method name="get_connected_host" qualifiers="const"> <return type="String"> </return> <description> - Return the IP of this peer. + Return the IP of this peer. </description> </method> <method name="get_connected_port" qualifiers="const"> <return type="int"> </return> <description> - Return the port of this peer. + Return the port of this peer. </description> </method> <method name="get_status" qualifiers="const"> <return type="int"> </return> <description> - Return the status of the connection, one of STATUS_* enum. + Return the status of the connection, one of STATUS_* enum. </description> </method> <method name="is_connected" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this peer is connected. Returns true while connecting and connected. + Return whether this peer is connected. Returns true while connecting and connected. </description> </method> </methods> @@ -37456,129 +37456,129 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StreamPlayer" inherits="Node" category="Core"> <brief_description> - Base class for audio stream playback. + Base class for audio stream playback. </brief_description> <description> - Base class for audio stream playback. Audio stream players inherit from it. + Base class for audio stream playback. Audio stream players inherit from it. </description> <methods> <method name="get_buffering_msec" qualifiers="const"> <return type="int"> </return> <description> - Return the size of the audio buffer. + Return the size of the audio buffer. </description> </method> <method name="get_length" qualifiers="const"> <return type="float"> </return> <description> - Return the length of the stream, in seconds. + Return the length of the stream, in seconds. </description> </method> <method name="get_loop_count" qualifiers="const"> <return type="int"> </return> <description> - Return the number of times the playback has looped. + Return the number of times the playback has looped. </description> </method> <method name="get_loop_restart_time" qualifiers="const"> <return type="float"> </return> <description> - Return the point in time the stream will rewind to, when looping. + Return the point in time the stream will rewind to, when looping. </description> </method> <method name="get_pos" qualifiers="const"> <return type="float"> </return> <description> - Return the playback position, in seconds. + Return the playback position, in seconds. </description> </method> <method name="get_stream" qualifiers="const"> <return type="AudioStream"> </return> <description> - Return the currently assigned stream. + Return the currently assigned stream. </description> </method> <method name="get_stream_name" qualifiers="const"> <return type="String"> </return> <description> - Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>". + Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>". </description> </method> <method name="get_volume" qualifiers="const"> <return type="float"> </return> <description> - Return the playback volume for this player. + Return the playback volume for this player. </description> </method> <method name="get_volume_db" qualifiers="const"> <return type="float"> </return> <description> - Return the playback volume for this player, in decibels. + Return the playback volume for this player, in decibels. </description> </method> <method name="has_autoplay" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this player will start playing as soon as it enters the scene tree. + Return whether this player will start playing as soon as it enters the scene tree. </description> </method> <method name="has_loop" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the stream will be restarted at the end. + Return whether the stream will be restarted at the end. </description> </method> <method name="is_paused" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the playback is currently paused. + Return whether the playback is currently paused. </description> </method> <method name="is_playing" qualifiers="const"> <return type="bool"> </return> <description> - Return whether this player is playing. + Return whether this player is playing. </description> </method> <method name="play"> <argument index="0" name="offset" type="float" default="0"> </argument> <description> - Play the currently assigned stream, starting from a given position (in seconds). + Play the currently assigned stream, starting from a given position (in seconds). </description> </method> <method name="seek_pos"> <argument index="0" name="time" type="float"> </argument> <description> - Set the playback position, in seconds. + Set the playback position, in seconds. </description> </method> <method name="set_autoplay"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether this player will start playing as soon as it enters the scene tree. + Set whether this player will start playing as soon as it enters the scene tree. </description> </method> <method name="set_buffering_msec"> <argument index="0" name="msec" type="int"> </argument> <description> - Set the size (in milliseconds) of the audio buffer. A long audio buffer protects better against slowdowns, but responds worse to changes (in volume, stream played...). A shorter buffer takes less time to respond to changes, but may stutter if the application suffers some slowdown. + Set the size (in milliseconds) of the audio buffer. A long audio buffer protects better against slowdowns, but responds worse to changes (in volume, stream played...). A shorter buffer takes less time to respond to changes, but may stutter if the application suffers some slowdown. Default is 500 milliseconds. </description> </method> @@ -37586,54 +37586,54 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether the stream will be restarted at the end. + Set whether the stream will be restarted at the end. </description> </method> <method name="set_loop_restart_time"> <argument index="0" name="secs" type="float"> </argument> <description> - Set the point in time the stream will rewind to, when looping. + Set the point in time the stream will rewind to, when looping. </description> </method> <method name="set_paused"> <argument index="0" name="paused" type="bool"> </argument> <description> - Pause stream playback. + Pause stream playback. </description> </method> <method name="set_stream"> <argument index="0" name="stream" type="AudioStream"> </argument> <description> - Set the [EventStream] this player will play. + Set the [EventStream] this player will play. </description> </method> <method name="set_volume"> <argument index="0" name="volume" type="float"> </argument> <description> - Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 will amplify sound even more, but may introduce distortion. Negative values will just invert the output waveform, which produces no audible difference. + Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 will amplify sound even more, but may introduce distortion. Negative values will just invert the output waveform, which produces no audible difference. </description> </method> <method name="set_volume_db"> <argument index="0" name="db" type="float"> </argument> <description> - Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see [method set_volume]) still apply. + Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see [method set_volume]) still apply. </description> </method> <method name="stop"> <description> - Stop the playback. + Stop the playback. </description> </method> </methods> <signals> <signal name="finished"> <description> - This signal triggers when the player stops playing. It will not trigger on each loop. + This signal triggers when the player stops playing. It will not trigger on each loop. </description> </signal> </signals> @@ -37642,17 +37642,17 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="String" category="Built-In Types"> <brief_description> - Built-in string class. + Built-in string class. </brief_description> <description> - This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. + This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. </description> <methods> <method name="basename"> <return type="String"> </return> <description> - If the string is a path to a file, return the path to the file without the extension. + If the string is a path to a file, return the path to the file without the extension. </description> </method> <method name="begins_with"> @@ -37661,35 +37661,35 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="text" type="String"> </argument> <description> - Return true if the strings begins with the given string. + Return true if the strings begins with the given string. </description> </method> <method name="bigrams"> <return type="StringArray"> </return> <description> - Return the bigrams (pairs of consecutive letters) of this string. + Return the bigrams (pairs of consecutive letters) of this string. </description> </method> <method name="c_escape"> <return type="String"> </return> <description> - Return a copy of the string with special characters escaped using the C language standard. + Return a copy of the string with special characters escaped using the C language standard. </description> </method> <method name="c_unescape"> <return type="String"> </return> <description> - Return a copy of the string with escaped characters replaced by their meanings according to the C language standard. + Return a copy of the string with escaped characters replaced by their meanings according to the C language standard. </description> </method> <method name="capitalize"> <return type="String"> </return> <description> - Change the case of some letters. Replace underscores with spaces, convert all letters to lowercase then capitalize first and every letter following the space character. For [code]capitalize camelCase mixed_with_underscores[/code] it will return [code]Capitalize Camelcase Mixed With Underscores[/code]. + Change the case of some letters. Replace underscores with spaces, convert all letters to lowercase then capitalize first and every letter following the space character. For [code]capitalize camelCase mixed_with_underscores[/code] it will return [code]Capitalize Camelcase Mixed With Underscores[/code]. </description> </method> <method name="casecmp_to"> @@ -37698,14 +37698,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="to" type="String"> </argument> <description> - Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. + Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. </description> </method> <method name="empty"> <return type="bool"> </return> <description> - Return true if the string is empty. + Return true if the string is empty. </description> </method> <method name="ends_with"> @@ -37714,7 +37714,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="text" type="String"> </argument> <description> - Return true if the strings ends with the given string. + Return true if the strings ends with the given string. </description> </method> <method name="erase"> @@ -37723,14 +37723,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="chars" type="int"> </argument> <description> - Erase [code]chars[/code] characters from the string starting from [code]pos[/code]. + Erase [code]chars[/code] characters from the string starting from [code]pos[/code]. </description> </method> <method name="extension"> <return type="String"> </return> <description> - If the string is a path to a file, return the extension. + If the string is a path to a file, return the extension. </description> </method> <method name="find"> @@ -37741,7 +37741,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="from" type="int" default="0"> </argument> <description> - Find the first occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Find the first occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. </description> </method> <method name="find_last"> @@ -37750,7 +37750,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="what" type="String"> </argument> <description> - Find the last occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Find the last occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. </description> </method> <method name="findn"> @@ -37761,35 +37761,35 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="from" type="int" default="0"> </argument> <description> - Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. </description> </method> <method name="get_base_dir"> <return type="String"> </return> <description> - If the string is a path to a file, return the base directory. + If the string is a path to a file, return the base directory. </description> </method> <method name="get_file"> <return type="String"> </return> <description> - If the string is a path to a file, return the file and ignore the base directory. + If the string is a path to a file, return the file and ignore the base directory. </description> </method> <method name="hash"> <return type="int"> </return> <description> - Hash the string and return a 32 bits integer. + Hash the string and return a 32 bits integer. </description> </method> <method name="hex_to_int"> <return type="int"> </return> <description> - Convert a string containing an hexadecimal number into an int. + Convert a string containing an hexadecimal number into an int. </description> </method> <method name="insert"> @@ -37800,21 +37800,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="what" type="String"> </argument> <description> - Insert a substring at a given position. + Insert a substring at a given position. </description> </method> <method name="is_abs_path"> <return type="bool"> </return> <description> - If the string is a path to a file or directory, return true if the path is absolute. + If the string is a path to a file or directory, return true if the path is absolute. </description> </method> <method name="is_rel_path"> <return type="bool"> </return> <description> - If the string is a path to a file or directory, return true if the path is relative. + If the string is a path to a file or directory, return true if the path is relative. </description> </method> <method name="is_subsequence_of"> @@ -37823,7 +37823,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="text" type="String"> </argument> <description> - Check whether this string is a subsequence of the given string. + Check whether this string is a subsequence of the given string. </description> </method> <method name="is_subsequence_ofi"> @@ -37832,49 +37832,49 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="text" type="String"> </argument> <description> - Check whether this string is a subsequence of the given string, without considering case. + Check whether this string is a subsequence of the given string, without considering case. </description> </method> <method name="is_valid_float"> <return type="bool"> </return> <description> - Check whether the string contains a valid float. + Check whether the string contains a valid float. </description> </method> <method name="is_valid_html_color"> <return type="bool"> </return> <description> - Check whether the string contains a valid color in HTML notation. + Check whether the string contains a valid color in HTML notation. </description> </method> <method name="is_valid_identifier"> <return type="bool"> </return> <description> - Check whether the string is a valid identifier. As is common in programming languages, a valid identifier may contain only letters, digits and underscores (_) and the first character may not be a digit. + Check whether the string is a valid identifier. As is common in programming languages, a valid identifier may contain only letters, digits and underscores (_) and the first character may not be a digit. </description> </method> <method name="is_valid_integer"> <return type="bool"> </return> <description> - Check whether the string contains a valid integer. + Check whether the string contains a valid integer. </description> </method> <method name="is_valid_ip_address"> <return type="bool"> </return> <description> - Check whether the string contains a valid IP address. + Check whether the string contains a valid IP address. </description> </method> <method name="json_escape"> <return type="String"> </return> <description> - Return a copy of the string with special characters escaped using the JSON standard. + Return a copy of the string with special characters escaped using the JSON standard. </description> </method> <method name="left"> @@ -37883,14 +37883,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="pos" type="int"> </argument> <description> - Return an amount of characters from the left of the string. + Return an amount of characters from the left of the string. </description> </method> <method name="length"> <return type="int"> </return> <description> - Return the length of the string in characters. + Return the length of the string in characters. </description> </method> <method name="match"> @@ -37899,7 +37899,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="expr" type="String"> </argument> <description> - Do a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'. + Do a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'. </description> </method> <method name="matchn"> @@ -37908,21 +37908,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="expr" type="String"> </argument> <description> - Do a simple case insensitive expression match, using ? and * wildcards (see [method match]). + Do a simple case insensitive expression match, using ? and * wildcards (see [method match]). </description> </method> <method name="md5_buffer"> <return type="RawArray"> </return> <description> - Return the MD5 hash of the string as an array of bytes. + Return the MD5 hash of the string as an array of bytes. </description> </method> <method name="md5_text"> <return type="String"> </return> <description> - Return the MD5 hash of the string as a string. + Return the MD5 hash of the string as a string. </description> </method> <method name="nocasecmp_to"> @@ -37931,7 +37931,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="to" type="String"> </argument> <description> - Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. + Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. </description> </method> <method name="ord_at"> @@ -37940,7 +37940,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="at" type="int"> </argument> <description> - Return the character code at position [code]at[/code]. + Return the character code at position [code]at[/code]. </description> </method> <method name="pad_decimals"> @@ -37949,7 +37949,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="digits" type="int"> </argument> <description> - Format a number to have an exact number of [code]digits[/code] after the decimal point. + Format a number to have an exact number of [code]digits[/code] after the decimal point. </description> </method> <method name="pad_zeros"> @@ -37958,21 +37958,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="digits" type="int"> </argument> <description> - Format a number to have an exact number of [code]digits[/code] before the decimal point. + Format a number to have an exact number of [code]digits[/code] before the decimal point. </description> </method> <method name="percent_decode"> <return type="String"> </return> <description> - Decode a percent-encoded string. See [method percent_encode]. + Decode a percent-encoded string. See [method percent_encode]. </description> </method> <method name="percent_encode"> <return type="String"> </return> <description> - Percent-encode a string. This is meant to encode parameters in a URL when sending a HTTP GET request and bodies of form-urlencoded POST request. + Percent-encode a string. This is meant to encode parameters in a URL when sending a HTTP GET request and bodies of form-urlencoded POST request. </description> </method> <method name="plus_file"> @@ -37981,7 +37981,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="file" type="String"> </argument> <description> - If the string is a path, this concatenates [code]file[/code] at the end of the string as a subpath. E.g. [code]"this/is".plus_file("path") == "this/is/path"[/code]. + If the string is a path, this concatenates [code]file[/code] at the end of the string as a subpath. E.g. [code]"this/is".plus_file("path") == "this/is/path"[/code]. </description> </method> <method name="replace"> @@ -37992,7 +37992,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="forwhat" type="String"> </argument> <description> - Replace occurrences of a substring for different ones inside the string. + Replace occurrences of a substring for different ones inside the string. </description> </method> <method name="replacen"> @@ -38003,7 +38003,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="forwhat" type="String"> </argument> <description> - Replace occurrences of a substring for different ones inside the string, but search case-insensitive. + Replace occurrences of a substring for different ones inside the string, but search case-insensitive. </description> </method> <method name="rfind"> @@ -38014,7 +38014,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="from" type="int" default="-1"> </argument> <description> - Perform a search for a substring, but start from the end of the string instead of the beginning. + Perform a search for a substring, but start from the end of the string instead of the beginning. </description> </method> <method name="rfindn"> @@ -38025,7 +38025,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="from" type="int" default="-1"> </argument> <description> - Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive. + Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive. </description> </method> <method name="right"> @@ -38034,7 +38034,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="pos" type="int"> </argument> <description> - Return the right side of the string from a given position. + Return the right side of the string from a given position. </description> </method> <method name="sha256_buffer"> @@ -38047,7 +38047,7 @@ A similar effect may be achieved moving this node's descendants. <return type="String"> </return> <description> - Return the SHA-256 hash of the string as a string. + Return the SHA-256 hash of the string as a string. </description> </method> <method name="similarity"> @@ -38056,7 +38056,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="text" type="String"> </argument> <description> - Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. + Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. </description> </method> <method name="split"> @@ -38067,7 +38067,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="allow_empty" type="bool" default="True"> </argument> <description> - Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". + Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". </description> </method> <method name="split_floats"> @@ -38078,7 +38078,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="allow_empty" type="bool" default="True"> </argument> <description> - Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". + Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". </description> </method> <method name="strip_edges"> @@ -38089,7 +38089,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="right" type="bool" default="True"> </argument> <description> - Return a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. + Return a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. </description> </method> <method name="substr"> @@ -38100,63 +38100,63 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="len" type="int"> </argument> <description> - Return part of the string from the position [code]from[/code], with length [code]len[/code]. + Return part of the string from the position [code]from[/code], with length [code]len[/code]. </description> </method> <method name="to_ascii"> <return type="RawArray"> </return> <description> - Convert the String (which is a character array) to RawArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. + Convert the String (which is a character array) to RawArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. </description> </method> <method name="to_float"> <return type="float"> </return> <description> - Convert a string, containing a decimal number, into a [code]float[/code]. + Convert a string, containing a decimal number, into a [code]float[/code]. </description> </method> <method name="to_int"> <return type="int"> </return> <description> - Convert a string, containing an integer number, into an [code]int[/code]. + Convert a string, containing an integer number, into an [code]int[/code]. </description> </method> <method name="to_lower"> <return type="String"> </return> <description> - Return the string converted to lowercase. + Return the string converted to lowercase. </description> </method> <method name="to_upper"> <return type="String"> </return> <description> - Return the string converted to uppercase. + Return the string converted to uppercase. </description> </method> <method name="to_utf8"> <return type="RawArray"> </return> <description> - Convert the String (which is an array of characters) to RawArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). + Convert the String (which is an array of characters) to RawArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). </description> </method> <method name="xml_escape"> <return type="String"> </return> <description> - Return a copy of the string with special characters escaped using the XML standard. + Return a copy of the string with special characters escaped using the XML standard. </description> </method> <method name="xml_unescape"> <return type="String"> </return> <description> - Return a copy of the string with escaped characters replaced by their meanings according to the XML standard. + Return a copy of the string with escaped characters replaced by their meanings according to the XML standard. </description> </method> </methods> @@ -38165,10 +38165,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StringArray" category="Built-In Types"> <brief_description> - String Array. + String Array. </brief_description> <description> - String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. + String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. </description> <methods> <method name="StringArray"> @@ -38177,21 +38177,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="Array"> </argument> <description> - Create from a generic array. + Create from a generic array. </description> </method> <method name="append"> <argument index="0" name="string" type="String"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Append an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="StringArray"> </argument> <description> - Append an [StringArray] at the end of this array. + Append an [StringArray] at the end of this array. </description> </method> <method name="insert"> @@ -38202,33 +38202,33 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="string" type="String"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array (so first element will now be the last). </description> </method> <method name="push_back"> <argument index="0" name="string" type="String"> </argument> <description> - Append a string element at end of the array. + Append a string element at end of the array. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Remove an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the [StringArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Set the size of the [StringArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -38237,14 +38237,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="string" type="String"> </argument> <description> - Change the [String] at the given index. + Change the [String] at the given index. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the size of the array. + Return the size of the array. </description> </method> </methods> @@ -38253,10 +38253,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StyleBox" inherits="Resource" category="Core"> <brief_description> - Base class for drawing stylized boxes for the UI. + Base class for drawing stylized boxes for the UI. </brief_description> <description> - StyleBox is [Resource] that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below. + StyleBox is [Resource] that provides an abstract base class for drawing stylized boxes for the UI. StyleBoxes are used for drawing the styles of buttons, line edit backgrounds, tree backgrounds, etc. and also for testing a transparency mask for pointer signals. If mask test fails on a StyleBox assigned as mask to a control, clicks and motion signals will go through it to the one below. </description> <methods> <method name="draw" qualifiers="const"> @@ -38279,7 +38279,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="margin" type="int"> </argument> <description> - Return the default offset of the margin "margin" (see MARGIN_* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. + Return the default offset of the margin "margin" (see MARGIN_* enum) of a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. </description> </method> <method name="get_margin" qualifiers="const"> @@ -38288,21 +38288,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="margin" type="int"> </argument> <description> - Return the offset of margin "margin" (see MARGIN_* enum). + Return the offset of margin "margin" (see MARGIN_* enum). </description> </method> <method name="get_minimum_size" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the minimum size that this stylebox can be shrunk to. + Return the minimum size that this stylebox can be shrunk to. </description> </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. + Return the "offset" of a stylebox, this is a helper function, like writing [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. </description> </method> <method name="set_default_margin"> @@ -38311,7 +38311,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="offset" type="float"> </argument> <description> - Set the default offset "offset" of the margin "margin" (see MARGIN_* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. + Set the default offset "offset" of the margin "margin" (see MARGIN_* enum) for a StyleBox, Controls that draw styleboxes with context inside need to know the margin, so the border of the stylebox is not occluded. </description> </method> <method name="test_mask" qualifiers="const"> @@ -38322,7 +38322,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="rect" type="Rect2"> </argument> <description> - Test a position in a rectangle, return whether it passes the mask test. + Test a position in a rectangle, return whether it passes the mask test. </description> </method> </methods> @@ -38331,10 +38331,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StyleBoxEmpty" inherits="StyleBox" category="Core"> <brief_description> - Empty stylebox (does not display anything). + Empty stylebox (does not display anything). </brief_description> <description> - Empty stylebox (really does not display anything). + Empty stylebox (really does not display anything). </description> <methods> </methods> @@ -38343,10 +38343,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StyleBoxFlat" inherits="StyleBox" category="Core"> <brief_description> - Stylebox of a single color. + Stylebox of a single color. </brief_description> <description> - Stylebox of a single color. Displays the stylebox of a single color, alternatively a border with light/dark colors can be assigned. + Stylebox of a single color. Displays the stylebox of a single color, alternatively a border with light/dark colors can be assigned. </description> <methods> <method name="get_bg_color" qualifiers="const"> @@ -38427,17 +38427,17 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StyleBoxImageMask" inherits="StyleBox" category="Core"> <brief_description> - Image mask based StyleBox, for mask test. + Image mask based StyleBox, for mask test. </brief_description> <description> - This StyleBox is similar to [StyleBoxTexture], but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the point clicked is masked or not. + This StyleBox is similar to [StyleBoxTexture], but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the point clicked is masked or not. </description> <methods> <method name="get_expand" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size. + Return whether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size. </description> </method> <method name="get_expand_margin_size" qualifiers="const"> @@ -38446,21 +38446,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="margin" type="int"> </argument> <description> - Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. + Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. </description> </method> <method name="get_image" qualifiers="const"> <return type="Image"> </return> <description> - Return the image used for mask testing. (see [method set_image]). + Return the image used for mask testing. (see [method set_image]). </description> </method> <method name="set_expand"> <argument index="0" name="expand" type="bool"> </argument> <description> - Set the expand property (default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size. + Set the expand property (default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size. </description> </method> <method name="set_expand_margin_size"> @@ -38469,14 +38469,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="size" type="float"> </argument> <description> - Set an expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. + Set an expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. </description> </method> <method name="set_image"> <argument index="0" name="image" type="Image"> </argument> <description> - Set the image used for mask testing. Pixels (converted to grey) that have a value, less than 0.5 will fail the test. + Set the image used for mask testing. Pixels (converted to grey) that have a value, less than 0.5 will fail the test. </description> </method> </methods> @@ -38485,10 +38485,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="StyleBoxTexture" inherits="StyleBox" category="Core"> <brief_description> - Texture Based 3x3 scale style. + Texture Based 3x3 scale style. </brief_description> <description> - Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles. + Texture Based 3x3 scale style. This stylebox performs a 3x3 scaling of a texture, where only the center cell is fully stretched. This allows for the easy creation of bordered styles. </description> <methods> <method name="get_draw_center" qualifiers="const"> @@ -38571,10 +38571,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="SurfaceTool" inherits="Reference" category="Core"> <brief_description> - Helper tool to create geometry. + Helper tool to create geometry. </brief_description> <description> - Helper tool to create geometry. + Helper tool to create geometry. </description> <methods> <method name="add_bones"> @@ -38689,17 +38689,17 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="TCP_Server" inherits="Reference" category="Core"> <brief_description> - TCP Server. + TCP Server. </brief_description> <description> - TCP Server class. Listens to connections on a port and returns a [StreamPeerTCP] when got a connection. + TCP Server class. Listens to connections on a port and returns a [StreamPeerTCP] when got a connection. </description> <methods> <method name="is_connection_available" qualifiers="const"> <return type="bool"> </return> <description> - Return true if a connection is available for taking. + Return true if a connection is available for taking. </description> </method> <method name="listen"> @@ -38710,19 +38710,19 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="accepted_hosts" type="StringArray" default="StringArray([])"> </argument> <description> - Listen on a port, alternatively give a white-list of accepted hosts. + Listen on a port, alternatively give a white-list of accepted hosts. </description> </method> <method name="stop"> <description> - Stop listening. + Stop listening. </description> </method> <method name="take_connection"> <return type="Object"> </return> <description> - If a connection is available, return a StreamPeerTCP with the connection/ + If a connection is available, return a StreamPeerTCP with the connection/ </description> </method> </methods> @@ -38731,10 +38731,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="TabContainer" inherits="Control" category="Core"> <brief_description> - Tabbed Container. + Tabbed Container. </brief_description> <description> - Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking on the top tabs allows to change the currently visible one. + Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking on the top tabs allows to change the currently visible one. Children controls of this one automatically. </description> <methods> @@ -38742,14 +38742,14 @@ A similar effect may be achieved moving this node's descendants. <return type="bool"> </return> <description> - Return whether the tabs should be visible or hidden. + Return whether the tabs should be visible or hidden. </description> </method> <method name="get_current_tab" qualifiers="const"> <return type="int"> </return> <description> - Return the current tab that is being showed. + Return the current tab that is being showed. </description> </method> <method name="get_current_tab_control" qualifiers="const"> @@ -38768,7 +38768,7 @@ A similar effect may be achieved moving this node's descendants. <return type="int"> </return> <description> - Return tab alignment, from the ALIGN_* enum. + Return tab alignment, from the ALIGN_* enum. </description> </method> <method name="get_tab_control" qualifiers="const"> @@ -38783,7 +38783,7 @@ A similar effect may be achieved moving this node's descendants. <return type="int"> </return> <description> - Return the amount of tabs. + Return the amount of tabs. </description> </method> <method name="get_tab_icon" qualifiers="const"> @@ -38800,14 +38800,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="tab_idx" type="int"> </argument> <description> - Return the title for the tab. Tab titles are by default the children node name, but this can be overridden. + Return the title for the tab. Tab titles are by default the children node name, but this can be overridden. </description> </method> <method name="set_current_tab"> <argument index="0" name="tab_idx" type="int"> </argument> <description> - Bring a tab (and the Control it represents) to the front, and hide the rest. + Bring a tab (and the Control it represents) to the front, and hide the rest. </description> </method> <method name="set_popup"> @@ -38820,7 +38820,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="align" type="int"> </argument> <description> - Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center. + Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center. </description> </method> <method name="set_tab_icon"> @@ -38829,7 +38829,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="icon" type="Texture"> </argument> <description> - Set an icon for a tab. + Set an icon for a tab. </description> </method> <method name="set_tab_title"> @@ -38838,14 +38838,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="title" type="String"> </argument> <description> - Set a title for the tab. Tab titles are by default the children node name, but this can be overridden. + Set a title for the tab. Tab titles are by default the children node name, but this can be overridden. </description> </method> <method name="set_tabs_visible"> <argument index="0" name="visible" type="bool"> </argument> <description> - Set whether the tabs should be visible or hidden. + Set whether the tabs should be visible or hidden. </description> </method> </methods> @@ -38858,7 +38858,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="tab" type="int"> </argument> <description> - Emitted when the current tab changes. + Emitted when the current tab changes. </description> </signal> </signals> @@ -38903,10 +38903,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Tabs" inherits="Control" category="Core"> <brief_description> - Tabs Control. + Tabs Control. </brief_description> <description> - Simple tabs control, similar to [TabContainer] but is only in charge of drawing tabs, not interact with children. + Simple tabs control, similar to [TabContainer] but is only in charge of drawing tabs, not interact with children. </description> <methods> <method name="add_tab"> @@ -39065,10 +39065,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="TestCube" inherits="GeometryInstance" category="Core"> <brief_description> - A simple cube used for testing in 3D. + A simple cube used for testing in 3D. </brief_description> <description> - The TestCube is a simple 2x2x2 cube with a basic texture. It can be used as a placeholder, to verify how the lighting looks, to test shaders, or any other task you may need a textured model to test with. + The TestCube is a simple 2x2x2 cube with a basic texture. It can be used as a placeholder, to verify how the lighting looks, to test shaders, or any other task you may need a textured model to test with. </description> <methods> </methods> @@ -39077,10 +39077,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="TextEdit" inherits="Control" category="Core"> <brief_description> - Multiline text editing control. + Multiline text editing control. </brief_description> <description> - TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo. + TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo. </description> <methods> <method name="add_color_region"> @@ -39093,7 +39093,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="line_only" type="bool" default="false"> </argument> <description> - Add color region (given the delimiters) and its colors. + Add color region (given the delimiters) and its colors. </description> </method> <method name="add_keyword_color"> @@ -39102,64 +39102,64 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="color" type="Color"> </argument> <description> - Add a keyword and its color. + Add a keyword and its color. </description> </method> <method name="clear_colors"> <description> - Clear all the syntax coloring information. + Clear all the syntax coloring information. </description> </method> <method name="clear_undo_history"> <description> - Clear the undo history. + Clear the undo history. </description> </method> <method name="copy"> <description> - Copy the current selection. + Copy the current selection. </description> </method> <method name="cursor_get_blink_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Gets whether the text editor caret is blinking. + Gets whether the text editor caret is blinking. </description> </method> <method name="cursor_get_blink_speed" qualifiers="const"> <return type="float"> </return> <description> - Gets the text editor caret blink speed. + Gets the text editor caret blink speed. </description> </method> <method name="cursor_get_column" qualifiers="const"> <return type="int"> </return> <description> - Return the column the editing cursor is at. + Return the column the editing cursor is at. </description> </method> <method name="cursor_get_line" qualifiers="const"> <return type="int"> </return> <description> - Return the line the editing cursor is at. + Return the line the editing cursor is at. </description> </method> <method name="cursor_set_blink_enabled"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set the text editor caret to blink. + Set the text editor caret to blink. </description> </method> <method name="cursor_set_blink_speed"> <argument index="0" name="blink_speed" type="float"> </argument> <description> - Set the text editor caret blink speed. Cannot be less then or equal to 0. + Set the text editor caret blink speed. Cannot be less then or equal to 0. </description> </method> <method name="cursor_set_column"> @@ -39180,7 +39180,7 @@ A similar effect may be achieved moving this node's descendants. </method> <method name="cut"> <description> - Cut the current selection. + Cut the current selection. </description> </method> <method name="get_line" qualifiers="const"> @@ -39189,14 +39189,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="line" type="int"> </argument> <description> - Return the text of a specific line. + Return the text of a specific line. </description> </method> <method name="get_line_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of total lines in the text. + Return the amount of total lines in the text. </description> </method> <method name="get_menu" qualifiers="const"> @@ -39209,42 +39209,42 @@ A similar effect may be achieved moving this node's descendants. <return type="int"> </return> <description> - Return the selection begin column. + Return the selection begin column. </description> </method> <method name="get_selection_from_line" qualifiers="const"> <return type="int"> </return> <description> - Return the selection begin line. + Return the selection begin line. </description> </method> <method name="get_selection_text" qualifiers="const"> <return type="String"> </return> <description> - Return the text inside the selection. + Return the text inside the selection. </description> </method> <method name="get_selection_to_column" qualifiers="const"> <return type="int"> </return> <description> - Return the selection end column. + Return the selection end column. </description> </method> <method name="get_selection_to_line" qualifiers="const"> <return type="int"> </return> <description> - Return the selection end line. + Return the selection end line. </description> </method> <method name="get_text"> <return type="String"> </return> <description> - Return the whole text. + Return the whole text. </description> </method> <method name="get_word_under_cursor" qualifiers="const"> @@ -39257,21 +39257,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="text" type="String"> </argument> <description> - Insert a given text at the cursor position. + Insert a given text at the cursor position. </description> </method> <method name="is_selection_active" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the selection is active. + Return true if the selection is active. </description> </method> <method name="is_syntax_coloring_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return true if the syntax coloring is enabled. + Return true if the syntax coloring is enabled. </description> </method> <method name="menu_option"> @@ -39282,12 +39282,12 @@ A similar effect may be achieved moving this node's descendants. </method> <method name="paste"> <description> - Paste the current selection. + Paste the current selection. </description> </method> <method name="redo"> <description> - Perform redo operation. + Perform redo operation. </description> </method> <method name="search" qualifiers="const"> @@ -39302,7 +39302,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="to_line" type="int"> </argument> <description> - Perform a search inside the text. Search flags can be specified in the SEARCH_* enum. + Perform a search inside the text. Search flags can be specified in the SEARCH_* enum. </description> </method> <method name="select"> @@ -39315,73 +39315,73 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="to_column" type="int"> </argument> <description> - Perform selection, from line/column to line/column. + Perform selection, from line/column to line/column. </description> </method> <method name="select_all"> <description> - Select all the text. + Select all the text. </description> </method> <method name="set_custom_bg_color"> <argument index="0" name="color" type="Color"> </argument> <description> - Set a custom background color. A background color with alpha==0 disables this. + Set a custom background color. A background color with alpha==0 disables this. </description> </method> <method name="set_max_chars"> <argument index="0" name="amount" type="int"> </argument> <description> - Set the maximum amount of characters editable. + Set the maximum amount of characters editable. </description> </method> <method name="set_readonly"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set the text editor as read-only. Text can be displayed but not edited. + Set the text editor as read-only. Text can be displayed but not edited. </description> </method> <method name="set_symbol_color"> <argument index="0" name="color" type="Color"> </argument> <description> - Set the color for symbols. + Set the color for symbols. </description> </method> <method name="set_syntax_coloring"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set to enable the syntax coloring. + Set to enable the syntax coloring. </description> </method> <method name="set_text"> <argument index="0" name="text" type="String"> </argument> <description> - Set the entire text. + Set the entire text. </description> </method> <method name="set_wrap"> <argument index="0" name="enable" type="bool"> </argument> <description> - Enable text wrapping when it goes beyond he edge of what is visible. + Enable text wrapping when it goes beyond he edge of what is visible. </description> </method> <method name="undo"> <description> - Perform undo operation. + Perform undo operation. </description> </method> </methods> <signals> <signal name="cursor_changed"> <description> - Emitted when the cursor changes. + Emitted when the cursor changes. </description> </signal> <signal name="request_completion"> @@ -39390,7 +39390,7 @@ A similar effect may be achieved moving this node's descendants. </signal> <signal name="text_changed"> <description> - Emitted when the text changes. + Emitted when the text changes. </description> </signal> </signals> @@ -39468,10 +39468,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Texture" inherits="Resource" category="Core"> <brief_description> - Texture for 2D and 3D. + Texture for 2D and 3D. </brief_description> <description> - A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite] or GUI [Control]. + A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite] or GUI [Control]. </description> <methods> <method name="draw" qualifiers="const"> @@ -39518,35 +39518,35 @@ A similar effect may be achieved moving this node's descendants. <return type="int"> </return> <description> - Return the current texture flags. + Return the current texture flags. </description> </method> <method name="get_height" qualifiers="const"> <return type="int"> </return> <description> - Return the texture height. + Return the texture height. </description> </method> <method name="get_rid" qualifiers="const"> <return type="RID"> </return> <description> - Return the texture RID as used in the [VisualServer]. + Return the texture RID as used in the [VisualServer]. </description> </method> <method name="get_size" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the texture size. + Return the texture size. </description> </method> <method name="get_width" qualifiers="const"> <return type="int"> </return> <description> - Return the texture width. + Return the texture width. </description> </method> <method name="has_alpha" qualifiers="const"> @@ -39559,7 +39559,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="flags" type="int"> </argument> <description> - Change the texture flags. + Change the texture flags. </description> </method> </methods> @@ -39589,10 +39589,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="TextureButton" inherits="BaseButton" category="Core"> <brief_description> - Button that can be themed with textures. + Button that can be themed with textures. </brief_description> <description> - Button that can be themed with textures. This is like a regular [Button] but can be themed by assigning textures to it. This button is intended to be easy to theme, however a regular button can expand (that uses styleboxes) and still be better if the interface is expect to have internationalization of texts. + Button that can be themed with textures. This is like a regular [Button] but can be themed by assigning textures to it. This button is intended to be easy to theme, however a regular button can expand (that uses styleboxes) and still be better if the interface is expect to have internationalization of texts. Only the normal texture is required, the others are optional. </description> <methods> @@ -39698,10 +39698,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="TextureFrame" inherits="Control" category="Core"> <brief_description> - Control Frame that draws a texture. + Control Frame that draws a texture. </brief_description> <description> - Control frame that simply draws an assigned texture. It can stretch or not. It's a simple way to just show an image in a UI. + Control frame that simply draws an assigned texture. It can stretch or not. It's a simple way to just show an image in a UI. </description> <methods> <method name="get_modulate" qualifiers="const"> @@ -39772,10 +39772,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="TextureProgress" inherits="Range" category="Core"> <brief_description> - Textured progress bar implementation. + Textured progress bar implementation. </brief_description> <description> - [ProgressBar] implementation that is easier to theme (by just passing a few textures). + [ProgressBar] implementation that is easier to theme (by just passing a few textures). </description> <methods> <method name="get_fill_degrees"> @@ -39880,10 +39880,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Theme" inherits="Resource" category="Core"> <brief_description> - Theme for controls. + Theme for controls. </brief_description> <description> - Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any [Control], and it and its children will automatically use it. + Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any [Control], and it and its children will automatically use it. Theme resources can be alternatively loaded by writing them in a .theme file, see wiki for more info. </description> <methods> @@ -40153,24 +40153,24 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Thread" inherits="Reference" category="Core"> <brief_description> - A unit of execution in a process. + A unit of execution in a process. </brief_description> <description> - A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects. + A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects. </description> <methods> <method name="get_id" qualifiers="const"> <return type="String"> </return> <description> - Return the id of the thread, uniquely identifying it among all threads. + Return the id of the thread, uniquely identifying it among all threads. </description> </method> <method name="is_active" qualifiers="const"> <return type="bool"> </return> <description> - Whether this thread is currently active, an active Thread cannot start work on a new method but can be joined with [method wait_to_finish]. + Whether this thread is currently active, an active Thread cannot start work on a new method but can be joined with [method wait_to_finish]. </description> </method> <method name="start"> @@ -40185,7 +40185,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="priority" type="int" default="1"> </argument> <description> - Start a new [Thread], it will run "method" on object "instance" using "userdata" as an argument and running with "priority", one of PRIORITY_* enum. + Start a new [Thread], it will run "method" on object "instance" using "userdata" as an argument and running with "priority", one of PRIORITY_* enum. Returns OK on success, or ERR_CANT_CREATE on failure. </description> </method> @@ -40193,7 +40193,7 @@ A similar effect may be achieved moving this node's descendants. <return type="Variant"> </return> <description> - Joins the [Thread] and waits for it to finish. Returns what the method called returned. + Joins the [Thread] and waits for it to finish. Returns what the method called returned. </description> </method> </methods> @@ -40208,16 +40208,16 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="TileMap" inherits="Node2D" category="Core"> <brief_description> - Node for 2D tile-based games. + Node for 2D tile-based games. </brief_description> <description> - Node for 2D tile-based games. Tilemaps use a [TileSet] which contain a list of tiles (textures, their rect and a collision) and are used to create complex grid-based maps. + Node for 2D tile-based games. Tilemaps use a [TileSet] which contain a list of tiles (textures, their rect and a collision) and are used to create complex grid-based maps. To optimize drawing and culling (sort of like [GridMap]), you can specify a quadrant size, so chunks of the map will be batched together at drawing time. </description> <methods> <method name="clear"> <description> - Clear all cells. + Clear all cells. </description> </method> <method name="get_cell" qualifiers="const"> @@ -40228,14 +40228,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="y" type="int"> </argument> <description> - Return the tile index of the referenced cell. + Return the tile index of the referenced cell. </description> </method> <method name="get_cell_size" qualifiers="const"> <return type="Vector2"> </return> <description> - Return the cell size. + Return the cell size. </description> </method> <method name="get_cellv" qualifiers="const"> @@ -40244,77 +40244,77 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="pos" type="Vector2"> </argument> <description> - Return the tile index of the cell referenced by a Vector2. + Return the tile index of the cell referenced by a Vector2. </description> </method> <method name="get_center_x" qualifiers="const"> <return type="bool"> </return> <description> - Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner). + Return true if tiles are to be centered in x coordinate (by default this is false and they are drawn from upper left cell corner). </description> </method> <method name="get_center_y" qualifiers="const"> <return type="bool"> </return> <description> - Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner). + Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner). </description> </method> <method name="get_collision_bounce" qualifiers="const"> <return type="float"> </return> <description> - Return the collision bounce parameter. + Return the collision bounce parameter. </description> </method> <method name="get_collision_friction" qualifiers="const"> <return type="float"> </return> <description> - Return the collision friction parameter. + Return the collision friction parameter. </description> </method> <method name="get_collision_layer" qualifiers="const"> <return type="int"> </return> <description> - Return the collision layer. + Return the collision layer. </description> </method> <method name="get_collision_mask" qualifiers="const"> <return type="int"> </return> <description> - Return the collision mask. + Return the collision mask. </description> </method> <method name="get_collision_use_kinematic" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the tilemap handles collisions as a kinematic body. + Return whether the tilemap handles collisions as a kinematic body. </description> </method> <method name="get_custom_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Return the custom transform matrix. + Return the custom transform matrix. </description> </method> <method name="get_half_offset" qualifiers="const"> <return type="int"> </return> <description> - Return the current half offset configuration. + Return the current half offset configuration. </description> </method> <method name="get_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the orientation mode. + Return the orientation mode. </description> </method> <method name="get_occluder_light_mask" qualifiers="const"> @@ -40327,28 +40327,28 @@ A similar effect may be achieved moving this node's descendants. <return type="int"> </return> <description> - Return the quadrant size. + Return the quadrant size. </description> </method> <method name="get_tile_origin" qualifiers="const"> <return type="int"> </return> <description> - Return the tile origin configuration. + Return the tile origin configuration. </description> </method> <method name="get_tileset" qualifiers="const"> <return type="TileSet"> </return> <description> - Return the current tileset. + Return the current tileset. </description> </method> <method name="get_used_cells" qualifiers="const"> <return type="Array"> </return> <description> - Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). + Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). </description> </method> <method name="is_cell_transposed" qualifiers="const"> @@ -40359,7 +40359,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="y" type="int"> </argument> <description> - Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector). + Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector). </description> </method> <method name="is_cell_x_flipped" qualifiers="const"> @@ -40370,7 +40370,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="y" type="int"> </argument> <description> - Return whether the referenced cell is flipped over the X axis. + Return whether the referenced cell is flipped over the X axis. </description> </method> <method name="is_cell_y_flipped" qualifiers="const"> @@ -40381,14 +40381,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="y" type="int"> </argument> <description> - Return whether the referenced cell is flipped over the Y axis. + Return whether the referenced cell is flipped over the Y axis. </description> </method> <method name="is_y_sort_mode_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return the Y sort mode. + Return the Y sort mode. </description> </method> <method name="map_to_world" qualifiers="const"> @@ -40399,7 +40399,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="ignore_half_ofs" type="bool" default="false"> </argument> <description> - Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. + Return the absolute world position corresponding to the tilemap (grid-based) coordinates given as an argument. Optionally, the tilemap's potential half offset can be ignored. </description> </method> @@ -40417,7 +40417,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="5" name="transpose" type="bool" default="false"> </argument> <description> - Set the tile index for the cell referenced by its grid-based X and Y coordinates. + Set the tile index for the cell referenced by its grid-based X and Y coordinates. A tile index of -1 clears the cell. Optionally, the tile can also be flipped over the X and Y coordinates or transposed. </description> @@ -40426,7 +40426,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="size" type="Vector2"> </argument> <description> - Set the cell size. + Set the cell size. </description> </method> <method name="set_cellv"> @@ -40441,7 +40441,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="4" name="transpose" type="bool" default="false"> </argument> <description> - Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. + Set the tile index for the cell referenced by a Vector2 of grid-based coordinates. A tile index of -1 clears the cell. Optionally, the tile can also be flipped over the X and Y axes or transposed. </description> @@ -40450,21 +40450,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="enable" type="bool"> </argument> <description> - Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner). + Set tiles to be centered in x coordinate. (by default this is false and they are drawn from upper left cell corner). </description> </method> <method name="set_center_y"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). + Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). </description> </method> <method name="set_collision_bounce"> <argument index="0" name="value" type="float"> </argument> <description> - Set the collision bounce parameter. + Set the collision bounce parameter. Allowable values range from 0 to 1. </description> </method> @@ -40472,7 +40472,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="value" type="float"> </argument> <description> - Set the collision friction parameter. + Set the collision friction parameter. Allowable values range from 0 to 1. </description> </method> @@ -40480,7 +40480,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="mask" type="int"> </argument> <description> - Set the collision layer. + Set the collision layer. Layers are referenced by binary indexes, so allowable values to describe the 20 available layers range from 0 to 2^20-1. </description> </method> @@ -40488,7 +40488,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="mask" type="int"> </argument> <description> - Set the collision masks. + Set the collision masks. Masks are referenced by binary indexes, so allowable values to describe the 20 available masks range from 0 to 2^20-1. </description> </method> @@ -40496,21 +40496,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="use_kinematic" type="bool"> </argument> <description> - Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled). + Set the tilemap to handle collisions as a kinematic body (enabled) or a static body (disabled). </description> </method> <method name="set_custom_transform"> <argument index="0" name="custom_transform" type="Matrix32"> </argument> <description> - Set custom transform matrix, to use in combination with the custom orientation mode. + Set custom transform matrix, to use in combination with the custom orientation mode. </description> </method> <method name="set_half_offset"> <argument index="0" name="half_offset" type="int"> </argument> <description> - Set an half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET_* constants as argument). + Set an half offset on the X coordinate, Y coordinate, or none (use HALF_OFFSET_* constants as argument). Half offset sets every other tile off by a half tile size in the specified direction. </description> </method> @@ -40518,7 +40518,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="mode" type="int"> </argument> <description> - Set the orientation mode as square, isometric or custom (use MODE_* constants as argument). + Set the orientation mode as square, isometric or custom (use MODE_* constants as argument). </description> </method> <method name="set_occluder_light_mask"> @@ -40531,7 +40531,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="size" type="int"> </argument> <description> - Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. + Set the quadrant size, this optimizes drawing by batching chunks of map at draw/cull time. Allowed values are integers ranging from 1 to 128. </description> </method> @@ -40539,21 +40539,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="origin" type="int"> </argument> <description> - Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument). + Set the tile origin to the tile center or its top-left corner (use TILE_ORIGIN_* constants as argument). </description> </method> <method name="set_tileset"> <argument index="0" name="tileset" type="TileSet"> </argument> <description> - Set the current tileset. + Set the current tileset. </description> </method> <method name="set_y_sort_mode"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate. + Set the Y sort mode. Enabled Y sort mode means that children of the tilemap will be drawn in the order defined by their Y coordinate. A tile with a higher Y coordinate will therefore be drawn later, potentially covering up the tile(s) above it if its sprite is higher than its cell size. </description> </method> @@ -40563,14 +40563,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="worldpos" type="Vector2"> </argument> <description> - Return the tilemap (grid-based) coordinates corresponding to the absolute world position given as an argument. + Return the tilemap (grid-based) coordinates corresponding to the absolute world position given as an argument. </description> </method> </methods> <signals> <signal name="settings_changed"> <description> - Signal indicating that a tilemap setting has changed. + Signal indicating that a tilemap setting has changed. </description> </signal> </signals> @@ -40606,23 +40606,23 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="TileSet" inherits="Resource" category="Core"> <brief_description> - Tile library for tilemaps. + Tile library for tilemaps. </brief_description> <description> - A TileSet is a library of tiles for a [TileMap]. It contains a list of tiles, each consisting of a sprite and optional collision shapes. + A TileSet is a library of tiles for a [TileMap]. It contains a list of tiles, each consisting of a sprite and optional collision shapes. Tiles are referenced by a unique integer ID. </description> <methods> <method name="clear"> <description> - Clear all tiles. + Clear all tiles. </description> </method> <method name="create_tile"> <argument index="0" name="id" type="int"> </argument> <description> - Create a new tile which will be referenced by the given ID. + Create a new tile which will be referenced by the given ID. </description> </method> <method name="find_tile_by_name" qualifiers="const"> @@ -40631,28 +40631,28 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="name" type="String"> </argument> <description> - Find the first tile matching the given name. + Find the first tile matching the given name. </description> </method> <method name="get_last_unused_tile_id" qualifiers="const"> <return type="int"> </return> <description> - Return the ID following the last currently used ID, useful when creating a new tile. + Return the ID following the last currently used ID, useful when creating a new tile. </description> </method> <method name="get_tiles_ids" qualifiers="const"> <return type="Array"> </return> <description> - Return an array of all currently used tile IDs. + Return an array of all currently used tile IDs. </description> </method> <method name="remove_tile"> <argument index="0" name="id" type="int"> </argument> <description> - Remove the tile referenced by the given ID. + Remove the tile referenced by the given ID. </description> </method> <method name="tile_get_light_occluder" qualifiers="const"> @@ -40661,7 +40661,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the light occluder of the tile. + Return the light occluder of the tile. </description> </method> <method name="tile_get_material" qualifiers="const"> @@ -40670,7 +40670,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the material of the tile. + Return the material of the tile. </description> </method> <method name="tile_get_name" qualifiers="const"> @@ -40679,7 +40679,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the name of the tile. + Return the name of the tile. </description> </method> <method name="tile_get_navigation_polygon" qualifiers="const"> @@ -40688,7 +40688,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the navigation polygon of the tile. + Return the navigation polygon of the tile. </description> </method> <method name="tile_get_navigation_polygon_offset" qualifiers="const"> @@ -40697,7 +40697,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the offset of the tile's navigation polygon. + Return the offset of the tile's navigation polygon. </description> </method> <method name="tile_get_occluder_offset" qualifiers="const"> @@ -40706,7 +40706,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the offset of the tile's light occluder. + Return the offset of the tile's light occluder. </description> </method> <method name="tile_get_region" qualifiers="const"> @@ -40715,7 +40715,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the tile sub-region in the texture. + Return the tile sub-region in the texture. </description> </method> <method name="tile_get_shape" qualifiers="const"> @@ -40724,7 +40724,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the shape of the tile. + Return the shape of the tile. </description> </method> <method name="tile_get_shape_offset" qualifiers="const"> @@ -40733,7 +40733,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the shape offset of the tile. + Return the shape offset of the tile. </description> </method> <method name="tile_get_shapes" qualifiers="const"> @@ -40742,7 +40742,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the array of shapes of the tile. + Return the array of shapes of the tile. </description> </method> <method name="tile_get_texture" qualifiers="const"> @@ -40751,7 +40751,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the texture of the tile. + Return the texture of the tile. </description> </method> <method name="tile_get_texture_offset" qualifiers="const"> @@ -40760,7 +40760,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="id" type="int"> </argument> <description> - Return the texture offset of the tile. + Return the texture offset of the tile. </description> </method> <method name="tile_set_light_occluder"> @@ -40769,7 +40769,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="light_occluder" type="OccluderPolygon2D"> </argument> <description> - Set a light occluder for the tile. + Set a light occluder for the tile. </description> </method> <method name="tile_set_material"> @@ -40778,7 +40778,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="material" type="CanvasItemMaterial"> </argument> <description> - Set the material of the tile. + Set the material of the tile. </description> </method> <method name="tile_set_name"> @@ -40787,7 +40787,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="name" type="String"> </argument> <description> - Set the name of the tile, for descriptive purposes. + Set the name of the tile, for descriptive purposes. </description> </method> <method name="tile_set_navigation_polygon"> @@ -40796,7 +40796,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="navigation_polygon" type="NavigationPolygon"> </argument> <description> - Set a navigation polygon for the tile. + Set a navigation polygon for the tile. </description> </method> <method name="tile_set_navigation_polygon_offset"> @@ -40805,7 +40805,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="navigation_polygon_offset" type="Vector2"> </argument> <description> - Set an offset for the tile's navigation polygon. + Set an offset for the tile's navigation polygon. </description> </method> <method name="tile_set_occluder_offset"> @@ -40814,7 +40814,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="occluder_offset" type="Vector2"> </argument> <description> - Set an offset for the tile's light occluder. + Set an offset for the tile's light occluder. </description> </method> <method name="tile_set_region"> @@ -40823,7 +40823,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="region" type="Rect2"> </argument> <description> - Set the tile sub-region in the texture. This is common in texture atlases. + Set the tile sub-region in the texture. This is common in texture atlases. </description> </method> <method name="tile_set_shape"> @@ -40832,7 +40832,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shape" type="Shape2D"> </argument> <description> - Set a shape for the tile, enabling physics to collide with it. + Set a shape for the tile, enabling physics to collide with it. </description> </method> <method name="tile_set_shape_offset"> @@ -40841,7 +40841,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shape_offset" type="Vector2"> </argument> <description> - Set the shape offset of the tile. + Set the shape offset of the tile. </description> </method> <method name="tile_set_shapes"> @@ -40850,7 +40850,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="shapes" type="Array"> </argument> <description> - Set an array of shapes for the tile, enabling physics to collide with it. + Set an array of shapes for the tile, enabling physics to collide with it. </description> </method> <method name="tile_set_texture"> @@ -40859,7 +40859,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="texture" type="Texture"> </argument> <description> - Set the texture of the tile. + Set the texture of the tile. </description> </method> <method name="tile_set_texture_offset"> @@ -40868,7 +40868,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="texture_offset" type="Vector2"> </argument> <description> - Set the texture offset of the tile. + Set the texture offset of the tile. </description> </method> </methods> @@ -40877,104 +40877,104 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Timer" inherits="Node" category="Core"> <brief_description> - A simple Timer node. + A simple Timer node. </brief_description> <description> - Timer node. This is a simple node that will emit a timeout callback when the timer runs out. It can optionally be set to loop. + Timer node. This is a simple node that will emit a timeout callback when the timer runs out. It can optionally be set to loop. </description> <methods> <method name="get_time_left" qualifiers="const"> <return type="float"> </return> <description> - Return the time left for timeout in seconds if the timer is active, 0 otherwise. + Return the time left for timeout in seconds if the timer is active, 0 otherwise. </description> </method> <method name="get_timer_process_mode" qualifiers="const"> <return type="int"> </return> <description> - Return the timer's processing mode. + Return the timer's processing mode. </description> </method> <method name="get_wait_time" qualifiers="const"> <return type="float"> </return> <description> - Return the wait time in seconds. + Return the wait time in seconds. </description> </method> <method name="has_autostart" qualifiers="const"> <return type="bool"> </return> <description> - Return true if set to automatically start when entering the scene. + Return true if set to automatically start when entering the scene. </description> </method> <method name="is_active" qualifiers="const"> <return type="bool"> </return> <description> - Return if the timer is active or not. + Return if the timer is active or not. </description> </method> <method name="is_one_shot" qualifiers="const"> <return type="bool"> </return> <description> - Return true if configured as one-shot. + Return true if configured as one-shot. </description> </method> <method name="set_active"> <argument index="0" name="active" type="bool"> </argument> <description> - Set whether the timer is active or not. An inactive timer will be paused until it is activated again. + Set whether the timer is active or not. An inactive timer will be paused until it is activated again. </description> </method> <method name="set_autostart"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set to automatically start when entering the scene. + Set to automatically start when entering the scene. </description> </method> <method name="set_one_shot"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart. + Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart. </description> </method> <method name="set_timer_process_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set the timer's processing mode (fixed or idle, use TIMER_PROCESS_* constants as argument). + Set the timer's processing mode (fixed or idle, use TIMER_PROCESS_* constants as argument). </description> </method> <method name="set_wait_time"> <argument index="0" name="time_sec" type="float"> </argument> <description> - Set wait time in seconds. When the time is over, it will emit the timeout signal. + Set wait time in seconds. When the time is over, it will emit the timeout signal. </description> </method> <method name="start"> <description> - Start the timer. + Start the timer. </description> </method> <method name="stop"> <description> - Stop (cancel) the timer. + Stop (cancel) the timer. </description> </method> </methods> <signals> <signal name="timeout"> <description> - Emitted when the time runs out. + Emitted when the time runs out. </description> </signal> </signals> @@ -41121,10 +41121,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Transform" category="Built-In Types"> <brief_description> - 3D Transformation. + 3D Transformation. </brief_description> <description> - Transform is used to store transformations, including translations. It consists of a Matrix3 "basis" and Vector3 "origin". Transform is used to represent transformations of any object in space. It is similar to a 4x3 matrix. + Transform is used to store transformations, including translations. It consists of a Matrix3 "basis" and Vector3 "origin". Transform is used to represent transformations of any object in space. It is similar to a 4x3 matrix. </description> <methods> <method name="Transform"> @@ -41139,7 +41139,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="origin" type="Vector3"> </argument> <description> - Construct the Transform from four Vector3. Each axis creates the basis. + Construct the Transform from four Vector3. Each axis creates the basis. </description> </method> <method name="Transform"> @@ -41150,7 +41150,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="origin" type="Vector3"> </argument> <description> - Construct the Transform from a Matrix3 and Vector3. + Construct the Transform from a Matrix3 and Vector3. </description> </method> <method name="Transform"> @@ -41159,7 +41159,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="Matrix32"> </argument> <description> - Construct the Transform from a Matrix32. + Construct the Transform from a Matrix32. </description> </method> <method name="Transform"> @@ -41168,7 +41168,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="Quat"> </argument> <description> - Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0) + Construct the Transform from a Quat. The origin will be Vector3(0, 0, 0) </description> </method> <method name="Transform"> @@ -41177,21 +41177,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="Matrix3"> </argument> <description> - Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0) + Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0) </description> </method> <method name="affine_inverse"> <return type="Transform"> </return> <description> - Returns the inverse of the transfrom, even if the transform has scale or the axis vectors are not orthogonal. + Returns the inverse of the transfrom, even if the transform has scale or the axis vectors are not orthogonal. </description> </method> <method name="inverse"> <return type="Transform"> </return> <description> - Returns the inverse of the transform. + Returns the inverse of the transform. </description> </method> <method name="looking_at"> @@ -41202,14 +41202,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="up" type="Vector3"> </argument> <description> - Rotate the transform around the up vector to face the target. + Rotate the transform around the up vector to face the target. </description> </method> <method name="orthonormalized"> <return type="Transform"> </return> <description> - Returns a transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. + Returns a transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. </description> </method> <method name="rotated"> @@ -41220,7 +41220,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="phi" type="float"> </argument> <description> - Rotate the transform locally. + Rotate the transform locally. </description> </method> <method name="scaled"> @@ -41229,7 +41229,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="scale" type="Vector3"> </argument> <description> - Scale the transform locally. + Scale the transform locally. </description> </method> <method name="translated"> @@ -41238,7 +41238,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="ofs" type="Vector3"> </argument> <description> - Translate the transform locally. + Translate the transform locally. </description> </method> <method name="xform"> @@ -41247,7 +41247,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="v" type="var"> </argument> <description> - Transforms vector "v" by this transform. + Transforms vector "v" by this transform. </description> </method> <method name="xform_inv"> @@ -41256,7 +41256,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="v" type="var"> </argument> <description> - Inverse-transforms vector "v" by this transform. + Inverse-transforms vector "v" by this transform. </description> </method> </methods> @@ -41273,10 +41273,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Translation" inherits="Resource" category="Core"> <brief_description> - Language Translation. + Language Translation. </brief_description> <description> - Translations are resources that can be loaded/unloaded on demand. They map a string to another string. + Translations are resources that can be loaded/unloaded on demand. They map a string to another string. </description> <methods> <method name="add_message"> @@ -41285,21 +41285,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="xlated_message" type="String"> </argument> <description> - Add a message for translation. + Add a message for translation. </description> </method> <method name="erase_message"> <argument index="0" name="src_message" type="String"> </argument> <description> - Erase a message. + Erase a message. </description> </method> <method name="get_locale" qualifiers="const"> <return type="String"> </return> <description> - Return the locale of the translation. + Return the locale of the translation. </description> </method> <method name="get_message" qualifiers="const"> @@ -41308,7 +41308,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="src_message" type="String"> </argument> <description> - Return a message for translation. + Return a message for translation. </description> </method> <method name="get_message_count" qualifiers="const"> @@ -41321,14 +41321,14 @@ A similar effect may be achieved moving this node's descendants. <return type="StringArray"> </return> <description> - Return all the messages (keys). + Return all the messages (keys). </description> </method> <method name="set_locale"> <argument index="0" name="locale" type="String"> </argument> <description> - Set the locale of the translation. + Set the locale of the translation. </description> </method> </methods> @@ -41337,7 +41337,7 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="TranslationServer" inherits="Object" category="Core"> <brief_description> - Server that manages all translations. Translations can be set to it and removed from it. + Server that manages all translations. Translations can be set to it and removed from it. </brief_description> <description> </description> @@ -42154,10 +42154,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Tween" inherits="Node" category="Core"> <brief_description> - Node useful for animations with unknown start and end points. + Node useful for animations with unknown start and end points. </brief_description> <description> - Node useful for animations with unknown start and end points, procedural animations, making one node follow another, and other simple behavior. + Node useful for animations with unknown start and end points, procedural animations, making one node follow another, and other simple behavior. Because it is easy to get it wrong, here is a quick usage example: [codeblock] var tween = get_node("Tween") @@ -42190,7 +42190,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="8" name="delay" type="float" default="0"> </argument> <description> - Follow [code]method[/code] of [code]object[/code] and apply the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] later. Methods are animated by calling them with consequitive values. + Follow [code]method[/code] of [code]object[/code] and apply the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] later. Methods are animated by calling them with consequitive values. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. </description> </method> @@ -42216,7 +42216,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="8" name="delay" type="float" default="0"> </argument> <description> - Follow [code]property[/code] of [code]object[/code] and apply it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Note that [code]target:target_property[/code] would equal [code]object:property[/code] at the end of the tween. + Follow [code]property[/code] of [code]object[/code] and apply it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Note that [code]target:target_property[/code] would equal [code]object:property[/code] at the end of the tween. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. </description> </method> @@ -42224,21 +42224,21 @@ A similar effect may be achieved moving this node's descendants. <return type="float"> </return> <description> - Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. + Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. </description> </method> <method name="get_speed" qualifiers="const"> <return type="float"> </return> <description> - Returns the speed that has been set from editor GUI or [method set_repeat]. + Returns the speed that has been set from editor GUI or [method set_repeat]. </description> </method> <method name="get_tween_process_mode" qualifiers="const"> <return type="int"> </return> <description> - Returns the process mode that has been set from editor GUI or [method set_tween_process_mode] + Returns the process mode that has been set from editor GUI or [method set_tween_process_mode] </description> </method> <method name="interpolate_callback"> @@ -42261,7 +42261,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="7" name="arg5" type="Variant" default="NULL"> </argument> <description> - Call [code]callback[/code] of [code]object[/code] after [code]times_in_sec[/code]. [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. + Call [code]callback[/code] of [code]object[/code] after [code]times_in_sec[/code]. [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. </description> </method> <method name="interpolate_deferred_callback"> @@ -42284,7 +42284,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="7" name="arg5" type="Variant" default="NULL"> </argument> <description> - Call [code]callback[/code] of [code]object[/code] after [code]times_in_sec[/code] on the main thread (similar to [methog Object.call_deferred). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. + Call [code]callback[/code] of [code]object[/code] after [code]times_in_sec[/code] on the main thread (similar to [methog Object.call_deferred). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. </description> </method> <method name="interpolate_method"> @@ -42307,7 +42307,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="7" name="delay" type="float" default="0"> </argument> <description> - Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. + Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. </description> </method> @@ -42331,7 +42331,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="7" name="delay" type="float" default="0"> </argument> <description> - Animate [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. + Animate [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. </description> </method> @@ -42339,14 +42339,14 @@ A similar effect may be achieved moving this node's descendants. <return type="bool"> </return> <description> - Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended. + Returns true if any tweens are currently running, and false otherwise. Note that this method doesn't consider tweens that have ended. </description> </method> <method name="is_repeat" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if repeat has been set from editor GUI or [method set_repeat]. + Returns true if repeat has been set from editor GUI or [method set_repeat]. </description> </method> <method name="remove"> @@ -42357,14 +42357,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="key" type="String"> </argument> <description> - Stop animating and completely remove a tween, given its object and property/method pair. + Stop animating and completely remove a tween, given its object and property/method pair. </description> </method> <method name="remove_all"> <return type="bool"> </return> <description> - Stop animating and completely remove all tweens. + Stop animating and completely remove all tweens. </description> </method> <method name="reset"> @@ -42375,14 +42375,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="key" type="String"> </argument> <description> - Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. + Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. </description> </method> <method name="reset_all"> <return type="bool"> </return> <description> - Resets all tweens to their initial values (the ones given, not those before the tween). + Resets all tweens to their initial values (the ones given, not those before the tween). </description> </method> <method name="resume"> @@ -42393,14 +42393,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="key" type="String"> </argument> <description> - Continue animating a stopped tween, given its object and property/method pair. + Continue animating a stopped tween, given its object and property/method pair. </description> </method> <method name="resume_all"> <return type="bool"> </return> <description> - Continue animating all stopped tweens. + Continue animating all stopped tweens. </description> </method> <method name="seek"> @@ -42409,42 +42409,42 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="time" type="float"> </argument> <description> - Seek the animation to the given [code]time[/code] in seconds. + Seek the animation to the given [code]time[/code] in seconds. </description> </method> <method name="set_active"> <argument index="0" name="active" type="bool"> </argument> <description> - Activate/deactivate the tween. You can use this for pausing animations, though [method stop_all] and [method resume_all] might be more fit for this. + Activate/deactivate the tween. You can use this for pausing animations, though [method stop_all] and [method resume_all] might be more fit for this. </description> </method> <method name="set_repeat"> <argument index="0" name="repeat" type="bool"> </argument> <description> - Make the tween repeat after all tweens have finished. + Make the tween repeat after all tweens have finished. </description> </method> <method name="set_speed"> <argument index="0" name="speed" type="float"> </argument> <description> - Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this. + Set the speed multiplier of the tween. Set it to 1 for normal speed, 2 for two times nromal speed, and 0.5 for half of the normal speed. Setting it to 0 would pause the animation, but you might consider using [method set_active] or [method stop_all] and [method resume_all] for this. </description> </method> <method name="set_tween_process_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set whether the Tween uses [code]_process[/code] or [code]_fixed_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_FIXED constants, respectively). + Set whether the Tween uses [code]_process[/code] or [code]_fixed_process[/code] (accepts TWEEN_PROCESS_IDLE and TWEEN_PROCESS_FIXED constants, respectively). </description> </method> <method name="start"> <return type="bool"> </return> <description> - Start the tween node. You can define tweens both before and after this. + Start the tween node. You can define tweens both before and after this. </description> </method> <method name="stop"> @@ -42455,14 +42455,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="key" type="String"> </argument> <description> - Stop animating a tween, given its object and property/method pair. + Stop animating a tween, given its object and property/method pair. </description> </method> <method name="stop_all"> <return type="bool"> </return> <description> - Stop animating all tweens. + Stop animating all tweens. </description> </method> <method name="targeting_method"> @@ -42487,7 +42487,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="8" name="delay" type="float" default="0"> </argument> <description> - Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. + Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. </description> </method> @@ -42513,7 +42513,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="8" name="delay" type="float" default="0"> </argument> <description> - Animate [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. + Animate [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]times_in_sec[/code] seconds, [code]delay[/code] seconds later. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the begining, the end, or both). You can read more about them in the class description. </description> </method> @@ -42521,7 +42521,7 @@ A similar effect may be achieved moving this node's descendants. <return type="float"> </return> <description> - Returns the current time of the tween. + Returns the current time of the tween. </description> </method> </methods> @@ -42532,7 +42532,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="key" type="String"> </argument> <description> - This signal is emitted when a tween ends. + This signal is emitted when a tween ends. </description> </signal> <signal name="tween_start"> @@ -42541,7 +42541,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="key" type="String"> </argument> <description> - This signal is emitted when a tween starts. + This signal is emitted when a tween starts. </description> </signal> <signal name="tween_step"> @@ -42554,7 +42554,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="value" type="Object"> </argument> <description> - This signal is emitted each step of the tweening. + This signal is emitted each step of the tweening. </description> </signal> </signals> @@ -42614,10 +42614,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="UndoRedo" inherits="Object" category="Core"> <brief_description> - Helper to manage UndoRedo in the editor or custom tools. + Helper to manage UndoRedo in the editor or custom tools. </brief_description> <description> - Helper to maange UndoRedo in the editor or custom tools. It works by + Helper to maange UndoRedo in the editor or custom tools. It works by storing calls to functions in both 'do' an 'undo' lists. Common behavior is to create an action, then add do/undo calls to @@ -42640,7 +42640,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="6" name="arg4" type="Variant" default="NULL"> </argument> <description> - Add a call to a method in a given object with custom + Add a call to a method in a given object with custom arguments. </description> </method> @@ -42652,14 +42652,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="value" type="Variant"> </argument> <description> - Set a property with a custom value. + Set a property with a custom value. </description> </method> <method name="add_do_reference"> <argument index="0" name="object" type="Object"> </argument> <description> - Add a 'do' reference that will be erased if the 'do' + Add a 'do' reference that will be erased if the 'do' history is lost. This is useful mostly for new nodes created for the 'do' call. Do not use for resources. </description> @@ -42680,7 +42680,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="6" name="arg4" type="Variant" default="NULL"> </argument> <description> - Add a call to an undo method in a given object with + Add a call to an undo method in a given object with custom arguments. Undo calls are used to revert 'do' calls. </description> @@ -42693,14 +42693,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="value" type="Variant"> </argument> <description> - Undo setting of a property with a custom value. + Undo setting of a property with a custom value. </description> </method> <method name="add_undo_reference"> <argument index="0" name="object" type="Object"> </argument> <description> - Add an 'undo' reference that will be erased if the + Add an 'undo' reference that will be erased if the 'undo' history is lost. This is useful mostly for nodes rmoved with the 'do' call (not the 'undo' call!). @@ -42708,13 +42708,13 @@ A similar effect may be achieved moving this node's descendants. </method> <method name="clear_history"> <description> - Clear the undo/redo history and associated + Clear the undo/redo history and associated references. </description> </method> <method name="commit_action"> <description> - Commit the action. All 'do' methods/properties are + Commit the action. All 'do' methods/properties are called/set when this function is called. </description> </method> @@ -42724,7 +42724,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="mergeable" type="bool" default="false"> </argument> <description> - Create a new action. After this is called, do all + Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property] and [method add_undo_property]. @@ -42734,14 +42734,14 @@ A similar effect may be achieved moving this node's descendants. <return type="String"> </return> <description> - Get the name of the current action. + Get the name of the current action. </description> </method> <method name="get_version" qualifiers="const"> <return type="int"> </return> <description> - Get the version, each time a new action is commited, + Get the version, each time a new action is commited, the version number of the UndoRedo is increased automatically. @@ -42755,10 +42755,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VBoxContainer" inherits="BoxContainer" category="Core"> <brief_description> - Vertical box container. + Vertical box container. </brief_description> <description> - Vertical box container. See [BoxContainer]. + Vertical box container. See [BoxContainer]. </description> <methods> </methods> @@ -42771,10 +42771,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VButtonArray" inherits="ButtonArray" category="Core"> <brief_description> - Vertical button array. + Vertical button array. </brief_description> <description> - Vertical button array. See [ButtonArray]. + Vertical button array. See [ButtonArray]. </description> <methods> </methods> @@ -42805,7 +42805,7 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VScrollBar" inherits="ScrollBar" category="Core"> <brief_description> - Vertical version of [ScrollBar], which goes from left (min) to right (max). + Vertical version of [ScrollBar], which goes from left (min) to right (max). </brief_description> <description> </description> @@ -42834,10 +42834,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VSeparator" inherits="Separator" category="Core"> <brief_description> - Vertical version of [Separator]. + Vertical version of [Separator]. </brief_description> <description> - Vertical version of [Separator]. It is used to separate objects horizontally, though (but it looks vertical!). + Vertical version of [Separator]. It is used to separate objects horizontally, though (but it looks vertical!). </description> <methods> </methods> @@ -42852,10 +42852,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VSlider" inherits="Slider" category="Core"> <brief_description> - Vertical slider. + Vertical slider. </brief_description> <description> - Vertical slider. See [Slider]. This one goes from left (min) to right (max). + Vertical slider. See [Slider]. This one goes from left (min) to right (max). </description> <methods> </methods> @@ -42876,10 +42876,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VSplitContainer" inherits="SplitContainer" category="Core"> <brief_description> - Vertical split container. + Vertical split container. </brief_description> <description> - Vertical split container. See [SplitContainer]. This goes from left to right. + Vertical split container. See [SplitContainer]. This goes from left to right. </description> <methods> </methods> @@ -42908,10 +42908,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Vector2" category="Built-In Types"> <brief_description> - Vector used for 2D Math. + Vector used for 2D Math. </brief_description> <description> - 2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values. + 2-element structure that can be used to represent positions in 2d-space, or any other pair of numeric values. </description> <methods> <method name="Vector2"> @@ -42922,7 +42922,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="y" type="float"> </argument> <description> - Constructs a new Vector2 from the given x and y. + Constructs a new Vector2 from the given x and y. </description> </method> <method name="abs"> @@ -42935,7 +42935,7 @@ A similar effect may be achieved moving this node's descendants. <return type="float"> </return> <description> - Returns the result of atan2 when called with the Vector's x and y as parameters (Math::atan2(x,y)). + Returns the result of atan2 when called with the Vector's x and y as parameters (Math::atan2(x,y)). Be aware that it therefore returns an angle oriented clockwise with regard to the (0, 1) unit vector, and not an angle oriented counter-clockwise with regard to the (1, 0) unit vector (which would be the typical trigonometric representation of the angle when calling Math::atan2(y,x)). </description> </method> @@ -42945,7 +42945,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="to" type="Vector2"> </argument> <description> - Returns the angle in radians between the two vectors. + Returns the angle in radians between the two vectors. </description> </method> <method name="angle_to_point"> @@ -42954,7 +42954,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="to" type="Vector2"> </argument> <description> - Returns the angle in radians between the line connecting the two points and the x coordinate. + Returns the angle in radians between the line connecting the two points and the x coordinate. </description> </method> <method name="cubic_interpolate"> @@ -42969,7 +42969,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="t" type="float"> </argument> <description> - Cubicly interpolates between this Vector and "b", using "pre_a" and "post_b" as handles, and returning the result at position "t". + Cubicly interpolates between this Vector and "b", using "pre_a" and "post_b" as handles, and returning the result at position "t". </description> </method> <method name="distance_squared_to"> @@ -42978,7 +42978,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="to" type="Vector2"> </argument> <description> - Returns the squared distance to vector "b". Prefer this function over "distance_to" if you need to sort vectors or need the squared distance for some formula. + Returns the squared distance to vector "b". Prefer this function over "distance_to" if you need to sort vectors or need the squared distance for some formula. </description> </method> <method name="distance_to"> @@ -42987,7 +42987,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="to" type="Vector2"> </argument> <description> - Returns the distance to vector "b". + Returns the distance to vector "b". </description> </method> <method name="dot"> @@ -42996,42 +42996,42 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="with" type="Vector2"> </argument> <description> - Returns the dot product with vector "b". + Returns the dot product with vector "b". </description> </method> <method name="floor"> <return type="Vector2"> </return> <description> - Remove the fractional part of x and y. + Remove the fractional part of x and y. </description> </method> <method name="floorf"> <return type="Vector2"> </return> <description> - Remove the fractional part of x and y. + Remove the fractional part of x and y. </description> </method> <method name="get_aspect"> <return type="float"> </return> <description> - Returns the ratio of X to Y. + Returns the ratio of X to Y. </description> </method> <method name="length"> <return type="float"> </return> <description> - Returns the length of the vector. + Returns the length of the vector. </description> </method> <method name="length_squared"> <return type="float"> </return> <description> - Returns the squared length of the vector. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. + Returns the squared length of the vector. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. </description> </method> <method name="linear_interpolate"> @@ -43042,14 +43042,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="t" type="float"> </argument> <description> - Returns the result of the linear interpolation between this vector and "b", by amount "t". + Returns the result of the linear interpolation between this vector and "b", by amount "t". </description> </method> <method name="normalized"> <return type="Vector2"> </return> <description> - Returns a normalized vector to unit length. + Returns a normalized vector to unit length. </description> </method> <method name="reflect"> @@ -43058,7 +43058,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="vec" type="Vector2"> </argument> <description> - Like "slide", but reflects the Vector instead of continuing along the wall. + Like "slide", but reflects the Vector instead of continuing along the wall. </description> </method> <method name="rotated"> @@ -43067,7 +43067,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="phi" type="float"> </argument> <description> - Rotates the vector by "phi" radians. + Rotates the vector by "phi" radians. </description> </method> <method name="slide"> @@ -43076,7 +43076,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="vec" type="Vector2"> </argument> <description> - Slides the vector by the other vector. + Slides the vector by the other vector. </description> </method> <method name="snapped"> @@ -43085,14 +43085,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="by" type="Vector2"> </argument> <description> - Snaps the vector to a grid with the given size. + Snaps the vector to a grid with the given size. </description> </method> <method name="tangent"> <return type="Vector2"> </return> <description> - Returns a perpendicular vector. + Returns a perpendicular vector. </description> </method> </methods> @@ -43115,10 +43115,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Vector2Array" category="Built-In Types"> <brief_description> - An Array of Vector2. + An Array of Vector2. </brief_description> <description> - An Array specifically designed to hold Vector2. + An Array specifically designed to hold Vector2. </description> <methods> <method name="Vector2Array"> @@ -43127,21 +43127,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="Array"> </argument> <description> - Construct a new [Vector2Array]. Optionally, you can pass in an Array that will be converted. + Construct a new [Vector2Array]. Optionally, you can pass in an Array that will be converted. </description> </method> <method name="append"> <argument index="0" name="vector2" type="Vector2"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Append an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="Vector2Array"> </argument> <description> - Append an [Vector2Array] at the end of this array. + Append an [Vector2Array] at the end of this array. </description> </method> <method name="insert"> @@ -43152,33 +43152,33 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="vector2" type="Vector2"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array (so first element will now be the last). </description> </method> <method name="push_back"> <argument index="0" name="vector2" type="Vector2"> </argument> <description> - Insert a [Vector2] at the end. + Insert a [Vector2] at the end. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Remove an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Set the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -43187,14 +43187,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="vector2" type="Vector2"> </argument> <description> - Change the [Vector2] at the given index. + Change the [Vector2] at the given index. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the size of the array. + Return the size of the array. </description> </method> </methods> @@ -43203,10 +43203,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Vector3" category="Built-In Types"> <brief_description> - Vector class, which performs basic 3D vector math operations. + Vector class, which performs basic 3D vector math operations. </brief_description> <description> - Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. + Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. </description> <methods> <method name="Vector3"> @@ -43219,21 +43219,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="z" type="float"> </argument> <description> - Returns a Vector3 with the given components. + Returns a Vector3 with the given components. </description> </method> <method name="abs"> <return type="Vector3"> </return> <description> - Returns a new vector with all components in absolute values (e.g. positive). + Returns a new vector with all components in absolute values (e.g. positive). </description> </method> <method name="ceil"> <return type="Vector3"> </return> <description> - Returns a new vector with all components rounded up. + Returns a new vector with all components rounded up. </description> </method> <method name="cross"> @@ -43242,7 +43242,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the cross product with b. + Return the cross product with b. </description> </method> <method name="cubic_interpolate"> @@ -43257,7 +43257,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="3" name="t" type="float"> </argument> <description> - Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t). + Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t). </description> </method> <method name="distance_squared_to"> @@ -43266,7 +43266,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula. + Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula. </description> </method> <method name="distance_to"> @@ -43275,7 +43275,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the distance to b. + Return the distance to b. </description> </method> <method name="dot"> @@ -43284,35 +43284,35 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="b" type="Vector3"> </argument> <description> - Return the dot product with b. + Return the dot product with b. </description> </method> <method name="floor"> <return type="Vector3"> </return> <description> - Returns a new vector with all components rounded down. + Returns a new vector with all components rounded down. </description> </method> <method name="inverse"> <return type="Vector3"> </return> <description> - Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) + Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ) </description> </method> <method name="length"> <return type="float"> </return> <description> - Return the length of the vector. + Return the length of the vector. </description> </method> <method name="length_squared"> <return type="float"> </return> <description> - Return the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. + Return the length of the vector, squared. Prefer this function over "length" if you need to sort vectors or need the squared length for some formula. </description> </method> <method name="linear_interpolate"> @@ -43323,28 +43323,28 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="t" type="float"> </argument> <description> - Linearly interpolates the vector to a given one (b), by the given amount (t). + Linearly interpolates the vector to a given one (b), by the given amount (t). </description> </method> <method name="max_axis"> <return type="int"> </return> <description> - Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest. + Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest. </description> </method> <method name="min_axis"> <return type="int"> </return> <description> - Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest. + Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest. </description> </method> <method name="normalized"> <return type="Vector3"> </return> <description> - Return a copy of the normalized vector to unit length. This is the same as v / v.length(). + Return a copy of the normalized vector to unit length. This is the same as v / v.length(). </description> </method> <method name="reflect"> @@ -43353,7 +43353,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="by" type="Vector3"> </argument> <description> - Like "slide", but reflects the Vector instead of continuing along the wall. + Like "slide", but reflects the Vector instead of continuing along the wall. </description> </method> <method name="rotated"> @@ -43364,7 +43364,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="phi" type="float"> </argument> <description> - Rotates the vector around some axis by phi radians. + Rotates the vector around some axis by phi radians. </description> </method> <method name="slide"> @@ -43373,7 +43373,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="by" type="Vector3"> </argument> <description> - Slides the vector along a wall. + Slides the vector along a wall. </description> </method> <method name="snapped"> @@ -43382,7 +43382,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="by" type="float"> </argument> <description> - Return a copy of the vector, snapped to the lowest neared multiple. + Return a copy of the vector, snapped to the lowest neared multiple. </description> </method> </methods> @@ -43411,10 +43411,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Vector3Array" category="Built-In Types"> <brief_description> - An Array of Vector3. + An Array of Vector3. </brief_description> <description> - An Array specifically designed to hold Vector3. + An Array specifically designed to hold Vector3. </description> <methods> <method name="Vector3Array"> @@ -43423,21 +43423,21 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="Array"> </argument> <description> - Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted. + Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted. </description> </method> <method name="append"> <argument index="0" name="vector3" type="Vector3"> </argument> <description> - Append an element at the end of the array (alias of [method push_back]). + Append an element at the end of the array (alias of [method push_back]). </description> </method> <method name="append_array"> <argument index="0" name="array" type="Vector3Array"> </argument> <description> - Append an [Vector3Array] at the end of this array. + Append an [Vector3Array] at the end of this array. </description> </method> <method name="insert"> @@ -43448,33 +43448,33 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="vector3" type="Vector3"> </argument> <description> - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). </description> </method> <method name="invert"> <description> - Reverse the order of the elements in the array (so first element will now be the last). + Reverse the order of the elements in the array (so first element will now be the last). </description> </method> <method name="push_back"> <argument index="0" name="vector3" type="Vector3"> </argument> <description> - Insert a Vector3 at the end. + Insert a Vector3 at the end. </description> </method> <method name="remove"> <argument index="0" name="idx" type="int"> </argument> <description> - Remove an element from the array by index. + Remove an element from the array by index. </description> </method> <method name="resize"> <argument index="0" name="idx" type="int"> </argument> <description> - Set the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + Set the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. </description> </method> <method name="set"> @@ -43483,14 +43483,14 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="vector3" type="Vector3"> </argument> <description> - Change the [Vector3] at the given index. + Change the [Vector3] at the given index. </description> </method> <method name="size"> <return type="int"> </return> <description> - Return the size of the array. + Return the size of the array. </description> </method> </methods> @@ -43525,7 +43525,7 @@ A similar effect may be achieved moving this node's descendants. <return type="Vector3"> </return> <description> - Returns the VehicleBody's velocity vector. To get the absolute speed in scalar value, get the length of the return vector in pixels/second. Example: + Returns the VehicleBody's velocity vector. To get the absolute speed in scalar value, get the length of the return vector in pixels/second. Example: [codeblock] # vehicle is an instance of VehicleBody var speed = vehicle.get_linear_velocity().length() @@ -43868,10 +43868,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="Viewport" inherits="Node" category="Core"> <brief_description> - Creates a sub-view into the screen. + Creates a sub-view into the screen. </brief_description> <description> - A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will render on it too. + A Viewport creates a different view into the screen, or a sub-view inside another viewport. Children 2D Nodes will display on it, and children Camera 3D nodes will render on it too. Optionally, a viewport can have its own 2D or 3D world, so they don't share what they draw with other viewports. If a viewport is a child of a [Control], it will automatically take up its same rect and position, otherwise they must be set manually. Viewports can also choose to be audio listeners, so they generate positional audio depending on a 2D or 3D camera child of it. @@ -43883,161 +43883,161 @@ A similar effect may be achieved moving this node's descendants. <return type="World"> </return> <description> - Return the 3D world of the viewport, or if no such present, the one of the parent viewport. + Return the 3D world of the viewport, or if no such present, the one of the parent viewport. </description> </method> <method name="find_world_2d" qualifiers="const"> <return type="World2D"> </return> <description> - Return the 2D world of the viewport. + Return the 2D world of the viewport. </description> </method> <method name="get_camera" qualifiers="const"> <return type="Camera"> </return> <description> - Return the active 3D camera. + Return the active 3D camera. </description> </method> <method name="get_canvas_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Get the canvas transform of the viewport. + Get the canvas transform of the viewport. </description> </method> <method name="get_final_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Get the total transform of the viewport. + Get the total transform of the viewport. </description> </method> <method name="get_global_canvas_transform" qualifiers="const"> <return type="Matrix32"> </return> <description> - Get the global canvas transform of the viewport. + Get the global canvas transform of the viewport. </description> </method> <method name="get_mouse_pos" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the mouse position, relative to the viewport. + Get the mouse position, relative to the viewport. </description> </method> <method name="get_physics_object_picking"> <return type="bool"> </return> <description> - Get whether picking for all physics objects inside the viewport is enabled. + Get whether picking for all physics objects inside the viewport is enabled. </description> </method> <method name="get_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space. + Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space. </description> </method> <method name="get_render_target_clear_on_new_frame" qualifiers="const"> <return type="bool"> </return> <description> - Return whether automatic clearing of the render target on each frame is enabled. + Return whether automatic clearing of the render target on each frame is enabled. </description> </method> <method name="get_render_target_filter" qualifiers="const"> <return type="bool"> </return> <description> - Get whether the rendered texture has filters enabled. + Get whether the rendered texture has filters enabled. </description> </method> <method name="get_render_target_gen_mipmaps" qualifiers="const"> <return type="bool"> </return> <description> - Get whether the rendered texture will have mipmaps generated. + Get whether the rendered texture will have mipmaps generated. </description> </method> <method name="get_render_target_texture" qualifiers="const"> <return type="RenderTargetTexture"> </return> <description> - Get the render target's texture, for use with various objects that you want to texture with the viewport. + Get the render target's texture, for use with various objects that you want to texture with the viewport. </description> </method> <method name="get_render_target_update_mode" qualifiers="const"> <return type="int"> </return> <description> - Get when the render target would be updated, will be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. + Get when the render target would be updated, will be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. </description> </method> <method name="get_render_target_vflip" qualifiers="const"> <return type="bool"> </return> <description> - Set whether the render target is flipped on the Y axis. + Set whether the render target is flipped on the Y axis. </description> </method> <method name="get_screen_capture" qualifiers="const"> <return type="Image"> </return> <description> - Return the captured screenshot after [method queue_screen_capture]. You might need to check more than one frame untill the right image is returned. + Return the captured screenshot after [method queue_screen_capture]. You might need to check more than one frame untill the right image is returned. </description> </method> <method name="get_size_override" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the size override set with [method set_size_override]. + Get the size override set with [method set_size_override]. </description> </method> <method name="get_viewport" qualifiers="const"> <return type="RID"> </return> <description> - Get the viewport RID from the visual server. + Get the viewport RID from the visual server. </description> </method> <method name="get_visible_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return the final, visible rect in global screen coordinates. + Return the final, visible rect in global screen coordinates. </description> </method> <method name="get_world" qualifiers="const"> <return type="World"> </return> <description> - Return the 3D world of the viewport. + Return the 3D world of the viewport. </description> </method> <method name="gui_get_drag_data" qualifiers="const"> <return type="Variant"> </return> <description> - Returs the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. + Returs the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. </description> </method> <method name="gui_has_modal_stack" qualifiers="const"> <return type="bool"> </return> <description> - Returs whether there are shown modals on-screen. + Returs whether there are shown modals on-screen. </description> </method> <method name="has_transparent_background" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the viewport lets whatever is behind it to show. + Return whether the viewport lets whatever is behind it to show. </description> </method> <method name="input"> @@ -44050,157 +44050,157 @@ A similar effect may be achieved moving this node's descendants. <return type="bool"> </return> <description> - Returns whether the viewport sends sounds to the speakers. + Returns whether the viewport sends sounds to the speakers. </description> </method> <method name="is_audio_listener_2d" qualifiers="const"> <return type="bool"> </return> <description> - Returns whether the viewport sends soundsfrom 2D emitters to the speakers. + Returns whether the viewport sends soundsfrom 2D emitters to the speakers. </description> </method> <method name="is_input_disabled" qualifiers="const"> <return type="bool"> </return> <description> - Return whether input to the viewport is disabled. + Return whether input to the viewport is disabled. </description> </method> <method name="is_set_as_render_target" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the viewport is set as a render target by [method set_as_render_target]. + Return whether the viewport is set as a render target by [method set_as_render_target]. </description> </method> <method name="is_size_override_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Get the enabled status of the size override set with [method set_size_override]. + Get the enabled status of the size override set with [method set_size_override]. </description> </method> <method name="is_size_override_stretch_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Get the enabled status of the size strech override set with [method set_size_override_stretch]. + Get the enabled status of the size strech override set with [method set_size_override_stretch]. </description> </method> <method name="is_using_own_world" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the viewport is using a world separate from the parent viewport's world. + Return whether the viewport is using a world separate from the parent viewport's world. </description> </method> <method name="queue_screen_capture"> <description> - Queue a multithreaded screenshot, you can retrive it at a later frame via [method get_screen_capture]. + Queue a multithreaded screenshot, you can retrive it at a later frame via [method get_screen_capture]. </description> </method> <method name="render_target_clear"> <description> - Clear the render target manually. + Clear the render target manually. </description> </method> <method name="set_as_audio_listener"> <argument index="0" name="enable" type="bool"> </argument> <description> - Makes the viewport send sounds to the speakers. + Makes the viewport send sounds to the speakers. </description> </method> <method name="set_as_audio_listener_2d"> <argument index="0" name="enable" type="bool"> </argument> <description> - Makes the viewport send sounds from 2D emitters to the speakers. + Makes the viewport send sounds from 2D emitters to the speakers. </description> </method> <method name="set_as_render_target"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set the viewport's render target mode. + Set the viewport's render target mode. </description> </method> <method name="set_canvas_transform"> <argument index="0" name="xform" type="Matrix32"> </argument> <description> - Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport. + Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport. </description> </method> <method name="set_disable_input"> <argument index="0" name="disable" type="bool"> </argument> <description> - Set whether input to the viewport is disabled. + Set whether input to the viewport is disabled. </description> </method> <method name="set_global_canvas_transform"> <argument index="0" name="xform" type="Matrix32"> </argument> <description> - Set the global canvas transform of the viewport. The canvas transform is relative to this. + Set the global canvas transform of the viewport. The canvas transform is relative to this. </description> </method> <method name="set_physics_object_picking"> <argument index="0" name="enable" type="bool"> </argument> <description> - Enable/disable picking for all physics objects inside the viewport. + Enable/disable picking for all physics objects inside the viewport. </description> </method> <method name="set_rect"> <argument index="0" name="rect" type="Rect2"> </argument> <description> - Set the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. + Set the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. </description> </method> <method name="set_render_target_clear_on_new_frame"> <argument index="0" name="enable" type="bool"> </argument> <description> - Enable/disable automatic clearing of the render target on each frame. You might find it better to disable this if you are using the viewport for rarely updated textures. To clear manually, check [method render_target_clear] + Enable/disable automatic clearing of the render target on each frame. You might find it better to disable this if you are using the viewport for rarely updated textures. To clear manually, check [method render_target_clear] </description> </method> <method name="set_render_target_filter"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether the rendered texture should have filters enabled. Disable if you want the texture's pixels be visible. + Set whether the rendered texture should have filters enabled. Disable if you want the texture's pixels be visible. </description> </method> <method name="set_render_target_gen_mipmaps"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether the rendered texture should have mipmaps generated. Mipmaps allow the texture to have better antialiasing from far away. + Set whether the rendered texture should have mipmaps generated. Mipmaps allow the texture to have better antialiasing from far away. </description> </method> <method name="set_render_target_to_screen_rect"> <argument index="0" name="rect" type="Rect2"> </argument> <description> - Map a part of the screen to the render target directly. + Map a part of the screen to the render target directly. </description> </method> <method name="set_render_target_update_mode"> <argument index="0" name="mode" type="int"> </argument> <description> - Set when the render target should be updated, has to be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. + Set when the render target should be updated, has to be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. </description> </method> <method name="set_render_target_vflip"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set whether the render target should be flipped on the Y axis. + Set whether the render target should be flipped on the Y axis. </description> </method> <method name="set_size_override"> @@ -44211,35 +44211,35 @@ A similar effect may be achieved moving this node's descendants. <argument index="2" name="margin" type="Vector2" default="Vector2(0,0)"> </argument> <description> - Set the size of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size. + Set the size of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size. </description> </method> <method name="set_size_override_stretch"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether the size override affects stretch as well. + Set whether the size override affects stretch as well. </description> </method> <method name="set_transparent_background"> <argument index="0" name="enable" type="bool"> </argument> <description> - If this viewport is a child of another viewport, keep the previously drawn background visible. + If this viewport is a child of another viewport, keep the previously drawn background visible. </description> </method> <method name="set_use_own_world"> <argument index="0" name="enable" type="bool"> </argument> <description> - Make the viewport use a world separate from the parent viewport's world. + Make the viewport use a world separate from the parent viewport's world. </description> </method> <method name="set_world"> <argument index="0" name="world" type="World"> </argument> <description> - Change the 3D world of the viewport. + Change the 3D world of the viewport. </description> </method> <method name="unhandled_input"> @@ -44250,21 +44250,21 @@ A similar effect may be achieved moving this node's descendants. </method> <method name="update_worlds"> <description> - Force update of the 2D and 3D worlds. + Force update of the 2D and 3D worlds. </description> </method> <method name="warp_mouse"> <argument index="0" name="to_pos" type="Vector2"> </argument> <description> - Wrap the mouse to a position, relative to the viewport. + Wrap the mouse to a position, relative to the viewport. </description> </method> </methods> <signals> <signal name="size_changed"> <description> - Emitted when the size of the viewport is changed, whether by [method set_size_override], resize of window, or some other means. + Emitted when the size of the viewport is changed, whether by [method set_size_override], resize of window, or some other means. </description> </signal> </signals> @@ -44285,66 +44285,66 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="ViewportSprite" inherits="Node2D" category="Core"> <brief_description> - Displays a viewport as a sprite. + Displays a viewport as a sprite. </brief_description> <description> - Used to display a [Viewport] node at some position in the world, without having to mess with [RenderTargetTexture]s. + Used to display a [Viewport] node at some position in the world, without having to mess with [RenderTargetTexture]s. </description> <methods> <method name="get_modulate" qualifiers="const"> <return type="Color"> </return> <description> - Get color modulation for the texture. All texture pixels are multiplied by this color. + Get color modulation for the texture. All texture pixels are multiplied by this color. </description> </method> <method name="get_offset" qualifiers="const"> <return type="Vector2"> </return> <description> - get the offset to the origin of the texture. + get the offset to the origin of the texture. </description> </method> <method name="get_viewport_path" qualifiers="const"> <return type="NodePath"> </return> <description> - Return the path to the shown [Viewport] node. + Return the path to the shown [Viewport] node. </description> </method> <method name="is_centered" qualifiers="const"> <return type="bool"> </return> <description> - Return whether the viewport's texture is centered on the origin. + Return whether the viewport's texture is centered on the origin. </description> </method> <method name="set_centered"> <argument index="0" name="centered" type="bool"> </argument> <description> - Set whether the viewport's texture should be centered on the origin. + Set whether the viewport's texture should be centered on the origin. </description> </method> <method name="set_modulate"> <argument index="0" name="modulate" type="Color"> </argument> <description> - Set color modulation for the texture. All texture pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. + Set color modulation for the texture. All texture pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. </description> </method> <method name="set_offset"> <argument index="0" name="offset" type="Vector2"> </argument> <description> - Set the offset to the origin of the texture. + Set the offset to the origin of the texture. </description> </method> <method name="set_viewport_path"> <argument index="0" name="path" type="NodePath"> </argument> <description> - Set the path to the shown [Viewport] node. + Set the path to the shown [Viewport] node. </description> </method> </methods> @@ -44353,10 +44353,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VisibilityEnabler" inherits="VisibilityNotifier" category="Core"> <brief_description> - Enable certain nodes only when visible. + Enable certain nodes only when visible. </brief_description> <description> - The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. + The VisibilityEnabler will disable [RigidBody] and [AnimationPlayer] nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler itself. </description> <methods> <method name="is_enabler_enabled" qualifiers="const"> @@ -44365,7 +44365,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="enabler" type="int"> </argument> <description> - Returns whether the specified enabler was set to true or not. + Returns whether the specified enabler was set to true or not. </description> </method> <method name="set_enabler"> @@ -44374,7 +44374,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="enabled" type="bool"> </argument> <description> - Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler is not in view. See the constants for enablers and what they affect. + Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler is not in view. See the constants for enablers and what they affect. </description> </method> </methods> @@ -44391,10 +44391,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VisibilityEnabler2D" inherits="VisibilityNotifier2D" category="Core"> <brief_description> - Enable certain nodes only when visible. + Enable certain nodes only when visible. </brief_description> <description> - The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself. + The VisibilityEnabler2D will disable [RigidBody2D], [AnimationPlayer], and other nodes when they are not visible. It will only affect other nodes within the same scene as the VisibilityEnabler2D itself. </description> <methods> <method name="is_enabler_enabled" qualifiers="const"> @@ -44403,7 +44403,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="enabler" type="int"> </argument> <description> - Returns whether the specified enabler was set to true or not. + Returns whether the specified enabler was set to true or not. </description> </method> <method name="set_enabler"> @@ -44412,7 +44412,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="1" name="enabled" type="bool"> </argument> <description> - Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect. + Set an enabler to true for all nodes of its type to be disabled when the VisibilityEnabler2D is not in view. See the constants for enablers and what they affect. </description> </method> </methods> @@ -44440,31 +44440,31 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VisibilityNotifier" inherits="Spatial" category="Core"> <brief_description> - Detect when the node is visible on screen. + Detect when the node is visible on screen. </brief_description> <description> - The VisibilityNotifier is used to notify when its bounding box enters the screen, is visible on the screen, or when it exits the screen. + The VisibilityNotifier is used to notify when its bounding box enters the screen, is visible on the screen, or when it exits the screen. </description> <methods> <method name="get_aabb" qualifiers="const"> <return type="AABB"> </return> <description> - Return the visibility bounding box of the VisibilityNotifier. + Return the visibility bounding box of the VisibilityNotifier. </description> </method> <method name="is_on_screen" qualifiers="const"> <return type="bool"> </return> <description> - Return true if any part of the bounding box is on the screen. + Return true if any part of the bounding box is on the screen. </description> </method> <method name="set_aabb"> <argument index="0" name="rect" type="AABB"> </argument> <description> - Set the visibility bounding box of the VisibilityNotifier. + Set the visibility bounding box of the VisibilityNotifier. </description> </method> </methods> @@ -44473,24 +44473,24 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="camera" type="Object"> </argument> <description> - Emitted when the VisibilityNotifier enters a [Camera]'s view. + Emitted when the VisibilityNotifier enters a [Camera]'s view. </description> </signal> <signal name="enter_screen"> <description> - Emitted when the VisibilityNotifier enters the screen. + Emitted when the VisibilityNotifier enters the screen. </description> </signal> <signal name="exit_camera"> <argument index="0" name="camera" type="Object"> </argument> <description> - Emitted when the VisibilityNotifier exits a [Camera]'s view. + Emitted when the VisibilityNotifier exits a [Camera]'s view. </description> </signal> <signal name="exit_screen"> <description> - Emitted when the VisibilityNotifier exits the screen. + Emitted when the VisibilityNotifier exits the screen. </description> </signal> </signals> @@ -44499,57 +44499,57 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VisibilityNotifier2D" inherits="Node2D" category="Core"> <brief_description> - Detect when the node is visible on screen. + Detect when the node is visible on screen. </brief_description> <description> - The VisibilityNotifier2D is used to notify when its bounding rectangle enters the screen, is visible on the screen, or when it exits the screen. + The VisibilityNotifier2D is used to notify when its bounding rectangle enters the screen, is visible on the screen, or when it exits the screen. </description> <methods> <method name="get_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return the visibility bounding rectangle of the VisibilityNotifier2D. + Return the visibility bounding rectangle of the VisibilityNotifier2D. </description> </method> <method name="is_on_screen" qualifiers="const"> <return type="bool"> </return> <description> - Return true if any part of the bounding rectangle is on the screen. + Return true if any part of the bounding rectangle is on the screen. </description> </method> <method name="set_rect"> <argument index="0" name="rect" type="Rect2"> </argument> <description> - Set the visibility bounding rectangle of the VisibilityNotifier2D. + Set the visibility bounding rectangle of the VisibilityNotifier2D. </description> </method> </methods> <signals> <signal name="enter_screen"> <description> - Emitted when the VisibilityNotifier2D enters the screen. + Emitted when the VisibilityNotifier2D enters the screen. </description> </signal> <signal name="enter_viewport"> <argument index="0" name="viewport" type="Object"> </argument> <description> - Emitted when the VisibilityNotifier2D enters a [Viewport]. + Emitted when the VisibilityNotifier2D enters a [Viewport]. </description> </signal> <signal name="exit_screen"> <description> - Emitted when the VisibilityNotifier2D exits the screen. + Emitted when the VisibilityNotifier2D exits the screen. </description> </signal> <signal name="exit_viewport"> <argument index="0" name="viewport" type="Object"> </argument> <description> - Emitted when the VisibilityNotifier2D exits a [Viewport]. + Emitted when the VisibilityNotifier2D exits a [Viewport]. </description> </signal> </signals> @@ -44586,10 +44586,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="VisualServer" inherits="Object" category="Core"> <brief_description> - Server for anything visible. + Server for anything visible. </brief_description> <description> - Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display. + Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display. The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed. </description> <methods> @@ -46221,17 +46221,17 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="WeakRef" inherits="Reference" category="Core"> <brief_description> - Holds an [Object], but does not contribute to the reference count if the object is a reference. + Holds an [Object], but does not contribute to the reference count if the object is a reference. </brief_description> <description> - A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to eachother. Without weakrefs, using these classes could lead to memory leaks, since both references keep eachother from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. + A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to eachother. Without weakrefs, using these classes could lead to memory leaks, since both references keep eachother from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. </description> <methods> <method name="get_ref" qualifiers="const"> <return type="Object"> </return> <description> - Returns the [Object] this weakref is referring to. + Returns the [Object] this weakref is referring to. </description> </method> </methods> @@ -46240,31 +46240,31 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="WindowDialog" inherits="Popup" category="Core"> <brief_description> - Base class for window dialogs. + Base class for window dialogs. </brief_description> <description> - Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [Control] that draws a window decoration and allows motion and resizing. + Windowdialog is the base class for all window-based dialogs. It's a by-default toplevel [Control] that draws a window decoration and allows motion and resizing. </description> <methods> <method name="get_close_button"> <return type="TextureButton"> </return> <description> - Return the close [TextureButton]. + Return the close [TextureButton]. </description> </method> <method name="get_title" qualifiers="const"> <return type="String"> </return> <description> - Return the title of the window. + Return the title of the window. </description> </method> <method name="set_title"> <argument index="0" name="title" type="String"> </argument> <description> - Set the title of the window. + Set the title of the window. </description> </method> </methods> @@ -46293,10 +46293,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="World" inherits="Resource" category="Core"> <brief_description> - Class that has everything pertaining to a world. + Class that has everything pertaining to a world. </brief_description> <description> - Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world. + Class that has everything pertaining to a world. A physics space, a visual scenario and a sound space. Spatial nodes register their resources into the current world. </description> <methods> <method name="get_direct_space_state"> @@ -46341,10 +46341,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="World2D" inherits="Resource" category="Core"> <brief_description> - Class that has everything pertaining to a 2D world. + Class that has everything pertaining to a 2D world. </brief_description> <description> - Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world. + Class that has everything pertaining to a 2D world. A physics space, a visual scenario and a sound space. 2D nodes register their resources into the current 2D world. </description> <methods> <method name="get_canvas"> @@ -46539,24 +46539,24 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="YSort" inherits="Node2D" category="Core"> <brief_description> - Sort all child nodes based on their Y positions. + Sort all child nodes based on their Y positions. </brief_description> <description> - Sort all child nodes based on their Y positions. The child node must inherit from [CanvasItem] for it to be sorted. Nodes that have a higher Y position will be drawn later, so they will appear on top of nodes that have a lower Y position. + Sort all child nodes based on their Y positions. The child node must inherit from [CanvasItem] for it to be sorted. Nodes that have a higher Y position will be drawn later, so they will appear on top of nodes that have a lower Y position. </description> <methods> <method name="is_sort_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Returns true if the children nodes are being sorted. + Returns true if the children nodes are being sorted. </description> </method> <method name="set_sort_enabled"> <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether the children nodes are sorted or not. (default true) + Set whether the children nodes are sorted or not. (default true) </description> </method> </methods> @@ -46565,10 +46565,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="bool" category="Built-In Types"> <brief_description> - Boolean built-in type + Boolean built-in type </brief_description> <description> - Boolean built-in type. + Boolean built-in type. </description> <methods> <method name="bool"> @@ -46577,7 +46577,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="int"> </argument> <description> - Cast an [int] value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case. + Cast an [int] value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case. </description> </method> <method name="bool"> @@ -46586,7 +46586,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="float"> </argument> <description> - Cast a [float] value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case. + Cast a [float] value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case. </description> </method> <method name="bool"> @@ -46595,7 +46595,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="String"> </argument> <description> - Cast a [String] value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: [code]bool('False')[/code] returns true, [code]bool('')[/code]. returns false + Cast a [String] value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: [code]bool('False')[/code] returns true, [code]bool('')[/code]. returns false </description> </method> </methods> @@ -46604,10 +46604,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="float" category="Built-In Types"> <brief_description> - Float built-in type + Float built-in type </brief_description> <description> - Float built-in type. + Float built-in type. </description> <methods> <method name="float"> @@ -46616,7 +46616,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="bool"> </argument> <description> - Cast a [bool] value to a floating point value, [code]float(true)[/code] will be equals to 1.0 and [code]float(false)[/code] will be equals to 0.0. + Cast a [bool] value to a floating point value, [code]float(true)[/code] will be equals to 1.0 and [code]float(false)[/code] will be equals to 0.0. </description> </method> <method name="float"> @@ -46625,7 +46625,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="int"> </argument> <description> - Cast an [int] value to a floating point value, [code]float(1)[/code] will be equals to 1.0. + Cast an [int] value to a floating point value, [code]float(1)[/code] will be equals to 1.0. </description> </method> <method name="float"> @@ -46634,7 +46634,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="String"> </argument> <description> - Cast a [String] value to a floating point value. This method accepts float value strings like [code] '1.23' [/code] and exponential notation strings for its parameter so calling [code] float('1e3') [/code] will return 1000.0 and calling [code] float('1e-3') [/code] will return -0.001. + Cast a [String] value to a floating point value. This method accepts float value strings like [code] '1.23' [/code] and exponential notation strings for its parameter so calling [code] float('1e3') [/code] will return 1000.0 and calling [code] float('1e-3') [/code] will return -0.001. </description> </method> </methods> @@ -46643,10 +46643,10 @@ A similar effect may be achieved moving this node's descendants. </class> <class name="int" category="Built-In Types"> <brief_description> - Integer built-in type. + Integer built-in type. </brief_description> <description> - Integer built-in type. + Integer built-in type. </description> <methods> <method name="int"> @@ -46655,7 +46655,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="bool"> </argument> <description> - Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0. + Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0. </description> </method> <method name="int"> @@ -46664,7 +46664,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="float"> </argument> <description> - Cast a float value to an integer value, this method simply removes the number fractions, so for example [code]int(2.7)[/code] will be equals to 2, [code]int(.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2. + Cast a float value to an integer value, this method simply removes the number fractions, so for example [code]int(2.7)[/code] will be equals to 2, [code]int(.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2. </description> </method> <method name="int"> @@ -46673,7 +46673,7 @@ A similar effect may be achieved moving this node's descendants. <argument index="0" name="from" type="String"> </argument> <description> - Cast a [String] value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like [code]'1.7'[/code]. This method will ignore all non-number characters, so calling [code]int('1e3')[/code] will return 13. + Cast a [String] value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like [code]'1.7'[/code]. This method will ignore all non-number characters, so calling [code]int('1e3')[/code] will return 13. </description> </method> </methods> |