diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 03bccbea10e..7488d93fe18 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -8,7 +8,7 @@
This contains the list of built-in gdscript functions. Mostly math functions and other utilities. Everything else is expanded by objects.
-
+
@@ -17,7 +17,7 @@
Standard sine function.
-
+
@@ -26,7 +26,7 @@
Standard cosine function.
-
+
@@ -35,7 +35,7 @@
Standard tangent function.
-
+
@@ -44,7 +44,7 @@
Hyperbolic sine.
-
+
@@ -53,7 +53,7 @@
Hyperbolic cosine.
-
+
@@ -62,7 +62,7 @@
Hyperbolic tangent.
-
+
@@ -71,7 +71,7 @@
Arc-sine.
-
+
@@ -80,7 +80,7 @@
Arc-cosine.
-
+
@@ -89,7 +89,7 @@
Arc-tangent.
-
+
@@ -100,7 +100,7 @@
Arc-tangent that takes a 2D vector as argument, retuns the full -pi to +pi range.
-
+
@@ -109,7 +109,7 @@
Square root.
-
+
@@ -120,7 +120,7 @@
Module (remainder of x/y).
-
+
@@ -131,7 +131,7 @@
Module (remainder of x/y) that wraps equally in positive and negative.
-
+
@@ -140,7 +140,7 @@
Floor (rounds down to nearest integer).
-
+
@@ -149,7 +149,7 @@
Ceiling (rounds up to nearest integer).
-
+
@@ -158,16 +158,16 @@
Round to nearest integer.
-
+
- Remove sign (works for integer and float).
+ Remove sign (works for integer and float).
-
+
@@ -176,7 +176,7 @@
Return sign (-1 or +1).
-
+
@@ -187,7 +187,7 @@
Power function, x elevate to y.
-
+
@@ -196,7 +196,7 @@
Natural logarithm.
-
+
@@ -205,7 +205,7 @@
Exponential logarithm.
-
+
@@ -214,7 +214,7 @@
Return true if the float is not a number.
-
+
@@ -223,7 +223,7 @@
Return true if the float is infinite.
-
+
@@ -234,7 +234,7 @@
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.
-
+
@@ -243,7 +243,7 @@
Return the amount of decimals in the floating point value.
-
+
@@ -254,7 +254,7 @@
Snap float value to a given step.
-
+
@@ -267,7 +267,7 @@
Linear interpolates between two values by a normalized value.
-
+
@@ -280,32 +280,28 @@
Decreases time by a specified amount.
-
+
- 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.
-
+
- 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.
-
+
Random value (0 to 1 float).
-
+
@@ -313,11 +309,10 @@
- Random range, any floating point value between
- 'from' and 'to'
+ Random range, any floating point value between 'from' and 'to'
-
+
@@ -326,7 +321,7 @@
Random from seed, pass a seed and an array with both number and new seed is returned.
-
+
@@ -335,7 +330,7 @@
Convert from degrees to radians.
-
+
@@ -344,7 +339,7 @@
Convert from radias to degrees.
-
+
@@ -353,7 +348,7 @@
Convert from linear energy to decibels (audio).
-
+
@@ -362,7 +357,7 @@
Convert from decibels to linear energy (audio).
-
+
@@ -373,7 +368,7 @@
Return the maximum of two values.
-
+
@@ -384,7 +379,7 @@
Return the minimum of two values.
-
+
@@ -397,7 +392,7 @@
Clamp both values to a range.
-
+
@@ -406,7 +401,7 @@
Return the nearest larger power of 2 for an integer.
-
+
@@ -415,7 +410,7 @@
Return a weak reference to an object.
-
+
@@ -426,7 +421,7 @@
Returns a reference to the specified function
-
+
@@ -437,7 +432,7 @@
Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in Global Scope.
-
+
@@ -448,7 +443,7 @@
Convert one or more arguments to strings in the best way possible.
-
+
@@ -459,7 +454,7 @@
Convert one or more arguments to strings in the best way possible.
-
+
@@ -470,7 +465,7 @@
Print one or more arguments to strings in the best way possible to a console line.
-
+
@@ -481,7 +476,7 @@
Print one or more arguments to the console with a tab between each argument.
-
+
@@ -492,7 +487,7 @@
Print one or more arguments to strings in the best way possible to standard error line.
-
+
@@ -503,7 +498,7 @@
Print one or more arguments to strings in the best way possible to console. No newline is added at the end.
-
+
@@ -512,7 +507,7 @@
Converts the value of a variable to a String.
-
+
@@ -521,7 +516,7 @@
Converts the value of a String to a variable.
-
+
@@ -530,37 +525,34 @@
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).
-
+
- Load a resource from the filesystem, pass a valid
- path as argument.
+ Load a resource from the filesystem, pass a valid path as argument.
-
+
- Convert a script class instance to a dictionary
- (useful for serializing).
+ Convert a script class instance to a dictionary (useful for serializing).
-
+
- 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.
-
+
@@ -569,19 +561,17 @@
Hashes the variable passed and returns an integer.
-
+
- 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.
- Constant that represents how many times the diameter of a
- circumference fits around it's perimeter.
+ Constant that represents how many times the diameter of a circumference fits around it's perimeter.
@@ -591,7 +581,7 @@
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.
+ Singletons are also documented here, since they can be accessed from anywhere.
@@ -1357,7 +1347,7 @@
Functions that return [Error] return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout.
- Generic fail return error;
+ Generic fail return error.
@@ -1439,13 +1429,13 @@
No hint for edited property.
- Hint string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
+ Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
- Hint string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
+ Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
- Property hint is an enumerated value, like "Hello,Something,Else". This is valid for integers, floats and strings properties.
+ Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
@@ -1454,9 +1444,10 @@
- Property hint is a bitmask description, for bits 0,1,2,3 abd 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
+ Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
+ Property hint for a bitmask description that covers all 32 bits. Valid only for integers.
String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc".
@@ -1482,9 +1473,6 @@
Property will be used as storage (default).
-
- Property will be used as storage (default).
-
Property will be visible in editor (default).
@@ -1582,39 +1570,35 @@
Axis-Aligned Bounding Box.
- AABB provides an 3D Axis-Aligned Bounding Box. It consists of a
- position and 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 and a size, and several utility functions. It is typically used for simple (fast) overlap tests.
-
+
- Return true if this [AABB] completely encloses another
- one.
+ Return true if this [AABB] completely encloses another one.
-
+
- Return this [AABB] expanded to include a given
- point.
+ Return this [AABB] expanded to include a given point.
-
+
- Get the area inside the [AABB]
+ Get the area inside the [AABB].
-
+
@@ -1623,87 +1607,81 @@
Get the position of the 8 endpoints of the [AABB] in space.
-
+
- Return the normalized longest axis of the [AABB]
+ Return the normalized longest axis of the [AABB].
-
+
- 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).
-
+
- Return the scalar length of the longest axis of the
- [AABB].
+ Return the scalar length of the longest axis of the [AABB].
-
+
- Return the normalized shortest axis of the [AABB]
+ Return the normalized shortest axis of the [AABB].
-
+
- 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).
-
+
- Return the scalar length of the shortest axis of the
- [AABB].
+ Return the scalar length of the shortest axis of the [AABB].
-
+
- 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.
-
+
- Return a copy of the AABB grown a given a mount of
- units towards all the sides.
+ Return a copy of the AABB grown a given a mount of units towards all the sides.
-
+
Return true if the [AABB] is flat or empty.
-
+
Return true if the [AABB] is empty.
-
+
@@ -1712,17 +1690,16 @@
Return true if the [AABB] contains a point.
-
+
- Return the intersection between two [AABB]s. An
- empty AABB (size 0,0,0) is returned on failure.
+ Return the intersection between two [AABB]s. An empty AABB (size 0,0,0) is returned on failure.
-
+
@@ -1731,7 +1708,7 @@
Return true if the [AABB] overlaps with another.
-
+
@@ -1740,7 +1717,7 @@
Return true if the AABB is at both sides of a plane.
-
+
@@ -1750,17 +1727,16 @@
-
+
- Combine this [AABB] with another one, a larger one
- is returned that contains both.
+ Combine this [AABB] with another one, a larger one is returned that contains both.
-
+
@@ -1786,41 +1762,38 @@
Base dialog for user notification.
- 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.
-
+
Return the OK Button.
-
+
Return the label used for built-in text.
-
+
- Set whether the dialog is hidden when accepted
- (default true).
+ Set whether the dialog is hidden when accepted (default true).
-
+
- Return true if the dialog will be hidden when
- accepted (default true).
+ Return true if the dialog will be hidden when accepted (default true).
-
+
@@ -1832,7 +1805,7 @@
-
+
@@ -1840,22 +1813,21 @@
-
+
- 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.
-
+
Set the built-in label text.
-
+
@@ -1888,104 +1860,98 @@
Sprite node that can use multiple textures for animation.
-
+
- Set the [SpriteFrames] resource, which contains all
- frames.
+ Set the [SpriteFrames] resource, which contains all frames.
-
+
- Get the [SpriteFrames] resource, which contains all
- frames.
+ Get the [SpriteFrames] resource, which contains all frames.
-
+
- 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.
-
+
Return true when centered. See [set_centered].
-
+
- 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.
-
+
Return the offset of the sprite in the node origin.
-
+
If true, sprite is flipped horizontally.
-
+
Return true if sprite is flipped horizontally.
-
+
If true, sprite is flipped vertically.
-
+
Return true if sprite is flipped vertically.
-
+
- 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).
-
+
Return the visible frame index.
-
+
Change the color modulation (multiplication) for this sprite.
-
+
@@ -2002,25 +1968,25 @@
-
+
-
+
-
+
-
+
@@ -2038,7 +2004,7 @@
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. [br] Animations are just data containers, and must be added to odes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back.
-
+
@@ -2049,21 +2015,21 @@
Add a track to the Animation. The track type must be specified as any of the values in te TYPE_* enumeration.
-
+
Remove a track by specifying the track index.
-
+
Return the amount of tracks in the animation.
-
+
@@ -2072,7 +2038,7 @@
Get the type of a track.
-
+
@@ -2081,16 +2047,16 @@
Get the path of a track. for more information on the path format, see [method track_set_path]
-
+
- 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"
-
+
@@ -2098,21 +2064,21 @@
-
+
Move a track up.
-
+
Nove a track down.
-
+
@@ -2129,7 +2095,7 @@
Insert a transform key for a transform track.
-
+
@@ -2142,7 +2108,7 @@
Insert a generic key in a given track.
-
+
@@ -2151,7 +2117,7 @@
Remove a key by index in a given track.
-
+
@@ -2160,7 +2126,7 @@
Remove a key by position (seconds) in a given track.
-
+
@@ -2171,7 +2137,7 @@
Set the value of an existing key.
-
+
@@ -2179,11 +2145,10 @@
- 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").
-
+
@@ -2191,11 +2156,10 @@
- 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").
-
+
@@ -2204,7 +2168,7 @@
Return the amount of keys in a given track.
-
+
@@ -2213,7 +2177,7 @@
Return the value of a given key in a given track.
-
+
@@ -2224,7 +2188,7 @@
Return the time at which the key is located.
-
+
@@ -2237,7 +2201,7 @@
Find the key index by time in a given track. Optionally, only find it if the exact time is given.
-
+
@@ -2246,7 +2210,7 @@
Set the interpolation type of a given track, from the INTERPOLATION_* enum.
-
+
@@ -2255,7 +2219,7 @@
Return the interpolation type of a given track, from the INTERPOLATION_* enum.
-
+
@@ -2266,7 +2230,7 @@
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]).
-
+
@@ -2275,7 +2239,7 @@
Enable or disable interpolation for a whole track. By default tracks are interpolated.
-
+
@@ -2284,7 +2248,7 @@
Return wether interpolation is enabled or disabled for a whole track. By default tracks are interpolated.
-
+
@@ -2297,7 +2261,7 @@
Return all the key indices of a value track, given a position and delta time.
-
+
@@ -2310,7 +2274,7 @@
Return all the key indices of a method track, given a position and delta time.
-
+
@@ -2321,7 +2285,7 @@
Return the method name of a method track.
-
+
@@ -2332,47 +2296,47 @@
Return the arguments values to be called on a method track for a given key in a given track.
-
+
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.
-
+
Return the total length of the animation (in seconds).
-
+
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.
-
+
Return wether the animation has the loop flag set.
-
+
-
+
-
+
Clear the animation (clear all tracks and reset all).
@@ -2407,7 +2371,7 @@
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 diferent channels.
-
+
@@ -2418,14 +2382,14 @@
Add an animation resource to the player, which will be later referenced by the "name" argument.
-
+
Remove an animation from the player (by supplying the same name used to add it).
-
+
@@ -2434,7 +2398,7 @@
Rename an existing animation.
-
+
@@ -2443,7 +2407,7 @@
Request wether an [Animation] name exist within the player.
-
+
@@ -2452,14 +2416,14 @@
Get an [Animation] resource by requesting a name.
-
+
Get the list of names of the animations stored in the player.
-
+
@@ -2470,7 +2434,7 @@
Specify a blend time (in seconds) between two animations, referemced by their names.
-
+
@@ -2481,21 +2445,21 @@
Get the blend time between two animations, referemced by their names.
-
+
Set the default blend time between animations.
-
+
Return the default blend time between animations.
-
+
@@ -2505,56 +2469,53 @@
- 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.
-
+
Stop the currently played animation.
-
+
Stop playback of animations (deprecated).
-
+
Return wether an animation is playing.
-
+
- Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to claling play().
+ Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
-
+
Return the name of the animation being played.
-
+
Queue an animation for playback once the current one is done.
-
+
If animations are queued to play, clear them.
-
+
@@ -2562,77 +2523,72 @@
will do nothing.
-
+
Return true if the player is active.
-
+
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).
-
+
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).
-
+
Set 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.
-
+
- 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.
-
+
Return path to root node (see [set_root]).
-
+
- 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.
-
+
- 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).
-
+
@@ -2641,42 +2597,40 @@
Find an animation name by resource.
-
+
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.
-
+
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_*.
-
+
Return the mode in which the animation player processes. See [method set_animation_process_mode].
-
+
- Get the position (in seconds) of the currently being
- played animation.
+ Get the position (in seconds) of the currently being played animation.
-
+
- Get the length (in seconds) of the currently being
- played animation.
+ Get the length (in seconds) of the currently being played animation.
-
+
@@ -2690,8 +2644,7 @@
- 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.
@@ -2702,8 +2655,7 @@
- Process animation on fixed process. This is specially useful
- when animating kinematic bodies.
+ Process animation on fixed process. This is specially useful when animating kinematic bodies.
Process animation on idle process.
@@ -2715,23 +2667,19 @@
Animation Player that uses a node graph for the blending.
- 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.
-
+
- 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.
-
+
@@ -2740,7 +2688,7 @@
Check if a node exists (by name).
-
+
@@ -2751,7 +2699,7 @@
Rename a node in the graph.
-
+
@@ -2760,17 +2708,16 @@
Get the node type, will return from NODE_* enum.
-
+
- 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.
-
+
@@ -2781,7 +2728,7 @@
Return the input source for a given node input.
-
+
@@ -2790,7 +2737,7 @@
Set the animation for an animation node.
-
+
@@ -2798,7 +2745,7 @@
-
+
@@ -2806,7 +2753,7 @@
-
+
@@ -2814,7 +2761,7 @@
-
+
@@ -2822,7 +2769,7 @@
-
+
@@ -2830,7 +2777,7 @@
-
+
@@ -2838,7 +2785,7 @@
-
+
@@ -2846,7 +2793,7 @@
-
+
@@ -2854,7 +2801,7 @@
-
+
@@ -2862,7 +2809,7 @@
-
+
@@ -2870,7 +2817,7 @@
-
+
@@ -2878,7 +2825,7 @@
-
+
@@ -2886,7 +2833,7 @@
-
+
@@ -2894,19 +2841,19 @@
-
+
-
+
-
+
@@ -2914,7 +2861,7 @@
-
+
@@ -2924,7 +2871,7 @@
-
+
@@ -2932,7 +2879,7 @@
-
+
@@ -2940,7 +2887,7 @@
-
+
@@ -2948,7 +2895,7 @@
-
+
@@ -2956,7 +2903,7 @@
-
+
@@ -2966,7 +2913,7 @@
-
+
@@ -2974,7 +2921,7 @@
-
+
@@ -2982,7 +2929,7 @@
-
+
@@ -2990,7 +2937,7 @@
-
+
@@ -2998,7 +2945,7 @@
-
+
@@ -3006,7 +2953,7 @@
-
+
@@ -3014,7 +2961,7 @@
-
+
@@ -3022,7 +2969,7 @@
-
+
@@ -3030,7 +2977,7 @@
-
+
@@ -3038,7 +2985,7 @@
-
+
@@ -3046,7 +2993,7 @@
-
+
@@ -3056,7 +3003,7 @@
-
+
@@ -3066,7 +3013,7 @@
-
+
@@ -3074,7 +3021,7 @@
-
+
@@ -3082,7 +3029,7 @@
-
+
@@ -3090,7 +3037,7 @@
-
+
@@ -3098,7 +3045,7 @@
-
+
@@ -3106,7 +3053,7 @@
-
+
@@ -3114,13 +3061,13 @@
-
+
-
+
@@ -3132,7 +3079,7 @@
-
+
@@ -3144,7 +3091,7 @@
-
+
@@ -3152,41 +3099,41 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3220,91 +3167,91 @@
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3360,94 +3307,94 @@
General purpose area detection for 2D Phisics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). An Area2D can be set as a children to a RigidBody2D to generate a custom gravity field. For this, use SPACE_OVERRIDE_COMBINE and point gravity at the center of mass.
-
+
-
+
-
+
When overriding space parameters, areas can have a center of gravity as a point.
-
+
Return if gravity is a point. When overriding space parameters, areas can have a center of gravity as a point.
-
+
- Set gravity vector. If gravity is a point, this will be the attraction center
+ Set gravity vector. If gravity is a point, this will be the attraction center.
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3503,31 +3450,31 @@
Generic array, contains several elements of any type, accessible by numerical index starting at 0. Arrays are always passed by reference.
-
+
-
+
Clear the array (resize to 0).
-
+
Return true if the array is empty (size==0).
-
+
-
+
@@ -3535,14 +3482,14 @@
-
+
Return a hashed integer value representing the array contents.
-
+
@@ -3551,43 +3498,43 @@
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()).
-
+
-
+
Append an element at the end of the array.
-
+
Remove an element from the array by index.
-
+
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.
-
+
Return the amount of elements in the array.
-
+
-
+
@@ -3595,49 +3542,49 @@
-
+
Construct an array from a [RawArray].
-
+
Construct an array from a [RawArray].
-
+
Construct an array from a [RawArray].
-
+
Construct an array from a [RawArray].
-
+
Construct an array from a [RawArray].
-
+
Construct an array from a [RawArray].
-
+
@@ -3654,37 +3601,37 @@
-
+
-
+
-
+
-
+
-
+
-
+
@@ -3699,10 +3646,10 @@
Server interface for low level audio access.
- AudioServer is a low level server interface for audio access. It is"#10;"#9;in charge of creating sample data (playable audio) as well as it's"#10;"#9;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.
-
+
@@ -3712,19 +3659,19 @@
- Create an audio sample, return a [RID] referencing"#10;"#9;"#9;"#9;it. The sample will be created with a given format"#10;"#9;"#9;"#9;(from the SAMPLE_FORMAT_* enum), a total length (in"#10;"#9;"#9;"#9;frames, not samples or bytes), in either stereo or"#10;"#9;"#9;"#9;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 frames, not samples or bytes), in either stereo or mono.
-
+
- Set the description of an audio sample. Mainly used"#10;"#9;"#9;"#9;for organization.
+ Set the description of an audio sample. Mainly used for organization.
-
+
@@ -3732,19 +3679,19 @@
- Return the description of an audio sample. Mainly"#10;"#9;"#9;"#9;used for organization.
+ Return the description of an audio sample. Mainly used for organization.
-
+
- Return the format of the audio sample, in the form"#10;"#9;"#9;"#9;of the SAMPLE_FORMAT_* enum.
+ Return the format of the audio sample, in the form of the SAMPLE_FORMAT_* enum.
-
+
@@ -3753,43 +3700,43 @@
Return wether the sample is stereo (2 channels)
-
+
- Return the length in frames of the audio sample (not"#10;"#9;"#9;"#9;samples or bytes).
+ Return the length in frames of the audio sample (not samples or bytes).
-
+
- Set the sample data for a given sample as an array"#10;"#9;"#9;"#9;of floats. The length must be equal to the sample"#10;"#9;"#9;"#9;lenght 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 lenght or an error will be produced.
-
+
- Set the sample data for a given sample as an array"#10;"#9;"#9;"#9;of bytes. The length must be equal to the sample"#10;"#9;"#9;"#9;lenght expected in bytes or an error will be produced.
+ Set the sample data for a given sample as an array of bytes. The length must be equal to the sample lenght expected in bytes or an error will be produced.
-
+
- Return the sample data as an array of bytes. The"#10;"#9;"#9;"#9;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.
-
+
@@ -3798,7 +3745,7 @@
Change the default mix rate of a given sample.
-
+
@@ -3807,86 +3754,86 @@
Return the mix rate of the given sample.
-
+
- Set the loop format for a sample from the"#10;"#9;"#9;"#9;SAMPLE_LOOP_* enum. As a warning, Ping Pong loops"#10;"#9;"#9;"#9;may not be available on some hardware-mixing"#10;"#9;"#9;"#9;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.
-
+
- Return the loop format for a sample, as a value from"#10;"#9;"#9;"#9;the SAMPLE_LOOP_* enum.
+ Return the loop format for a sample, as a value from the SAMPLE_LOOP_* enum.
-
+
- Set the initial loop point of a sample. Only has"#10;"#9;"#9;"#9;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].
-
+
- Return the initial loop point of a sample. Only has"#10;"#9;"#9;"#9;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].
-
+
- Set the final loop point of a sample. Only has"#10;"#9;"#9;"#9;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].
-
+
- Return the final loop point of a sample. Only has"#10;"#9;"#9;"#9;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].
-
+
- Allocate a voice for playback. Voices are"#10;"#9;"#9;"#9;persistent. A voice can play a single sample at the"#10;"#9;"#9;"#9;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].
-
+
- Start playback of a given voice using a given"#10;"#9;"#9;"#9;sample. If the voice was already playing it will be"#10;"#9;"#9;"#9;restarted.
+ Start playback of a given voice using a given sample. If the voice was already playing it will be restarted.
-
+
- Change the volume of a currently playing voice."#10;"#9;"#9;"#9;Volume is expressed as linear gain where 0.0 is mute"#10;"#9;"#9;"#9;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.
-
+
@@ -3896,10 +3843,10 @@
- Change the pan of a currently playing voice and,"#10;"#9;"#9;"#9;optionally, the depth and height for a positional/3D"#10;"#9;"#9;"#9;sound. Panning values are expressed within the -1 to"#10;"#9;"#9;"#9;+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.
-
+
@@ -3911,19 +3858,19 @@
- Set a resonant filter post processing for the voice."#10;"#9;"#9;"#9;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.
-
+
- Set chorus send post processing for the voice (from"#10;"#9;"#9;"#9;0 to 1).
+ Set chorus send post processing for the voice (from 0 to 1).
-
+
@@ -3931,28 +3878,28 @@
- Set the reverb send post processing for the voice (from"#10;"#9;"#9;"#9;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.
-
+
- Set a different playback mix rate for the given"#10;"#9;"#9;"#9;voice.
+ Set a different playback mix rate for the given voice.
-
+
- Set wether a given voice is positional. This is only"#10;"#9;"#9;"#9;interpreted as a hint and used for backends that may"#10;"#9;"#9;"#9;support binaural encoding.
+ Set wether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding.
-
+
@@ -3961,88 +3908,88 @@
Return the current volume for a given voice.
-
+