- For the entries related to GDScript which can be accessed in any script see [@GDScript].

- Returns the difference between the two angles, in the range of [code][-PI, +PI][/code]. When [param from] and [param to] are opposite, returns [code]-PI[/code] if [param from] is smaller than [param to], or [code]PI[/code] otherwise.

- Linearly interpolates between two values by the factor defined in [param weight]. To perform interpolation, [param weight] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). However, values outside this range are allowed and can be used to perform [i]extrapolation[/i]. If this is not desired, use [method clamp] on the result of this function.

- Both [param from] and [param to] must be the same type. Supported types: [int], [float], [Vector2], [Vector3], [Vector4], [Color], [Quaternion], [Basis].

- [b]Note:[/b] For better type safety, use [method lerpf], [method Vector2.lerp], [method Vector3.lerp], [method Vector4.lerp], [method Color.lerp], [method Quaternion.slerp] or [method Basis.slerp].

- Converts from linear energy to decibels (audio). This can be used to implement volume sliders that behave as expected (since volume isn't linear).

- [b]Example:[/b]

- # "Slider" refers to a node that inherits Range such as HSlider or VSlider.

- # Its range must be configured to go from 0 to 1.

- # Change the bus name if you'd like to change the volume of a specific bus only.

- [b]Note:[/b] Consider using [method push_error] and [method push_warning] to print error and warning messages instead of [method print] or [method print_rich]. This distinguishes them from print messages used for debugging purposes, while also displaying a stack trace when an error or warning is printed.

- print(a[0]) # Prints 2879024997

- print(a[1]) # Prints 4

- Returns [code]-1[/code] if [param x] is negative, [code]1[/code] if [param x] is positive, and [code]0[/code] if if [param x] is zero.

- Returns the result of smoothly interpolating the value of [param x] between [code]0[/code] and [code]1[/code], based on the where [param x] lies with respect to the edges [param from] and [param to].

- The return value is [code]0[/code] if [code]x <= from[/code], and [code]1[/code] if [code]x >= to[/code]. If [param x] lies between [param from] and [param to], the returned value follows an S-shaped curve that maps [param x] between [code]0[/code] and [code]1[/code].

- Since [constant OK] has value 0, and all other error constants are positive integers, it can also be used in boolean checks.

- [b]Example:[/b]

- Examples:

- <constant name="PROPERTY_HINT_MAX" value="38" enum="PropertyHint">

- The property is serialized and saved in the scene file (default).

- The property is shown in the [EditorInspector] (default).

- The property is an enum, i.e. it only takes named integer constants from its associated enumeration.

- Returns the shortest normaalized axis of this bounding box's [member size], as a [Vector3] ([constant Vector3.RIGHT], [constant Vector3.UP], or [constant Vector3.BACK]).

- <param index="0" name="dir" type="Vector3" />

- Returns [code]true[/code] if this bounding box and [param aabb] are approximately equal, by calling [method Vector2.is_equal_approx] on the [member position] and the [member size].

- Returns [code]true[/code] if this bounding box's values are finite, by calling [method Vector2.is_finite] on the [member position] and the [member size].

- <param index="1" name="to_id" type="int" />

- int[] res = astar.GetIdPath(1, 3); // Returns [1, 2, 3]

- int[] neighbors = astar.GetPointConnections(1); // Returns [2, 3]

- Reserves space internally for [param num_nodes] points, useful if you're adding a known large number of points at once, such as points on a grid. New capacity must be greater or equals to old capacity.

- <param index="1" name="to_id" type="int" />

- int[] res = astar.GetIdPath(1, 3); // Returns [1, 2, 3]

- int[] neighbors = astar.GetPointConnections(1); // Returns [2, 3]

- <param index="1" name="to_id" type="Vector2i" />

- The setter of [member frame] resets the [member frame_progress] to [code]0.0[/code] implicitly, but this method avoids that.

- This is useful when you want to carry over the current [member frame_progress] to another [member frame].

- [b]Example:[/b]

- # Change the animation with keeping the frame index and progress.

- The setter of [member frame] resets the [member frame_progress] to [code]0.0[/code] implicitly, but this method avoids that.

- This is useful when you want to carry over the current [member frame_progress] to another [member frame].

- [b]Example:[/b]

- # Change the animation with keeping the frame index and progress.

- Sets 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 [code]":"[/code].

- <member name="capture_included" type="bool" setter="_set_capture_included" getter="is_capture_included" default="false">

- By using this in combination with [method get_root_motion_position_accumulator], you can apply the root motion position more correctly to account for the rotation of the node.

- var current_root_motion_rotation_accumulator: Quaternion = animation_tree.get_root_motion_Quaternion_accumulator()

- transform.basis *= difference

- The path to the Animation track used for root motion. 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. To specify a track that controls properties or bones, append its name after the path, separated by [code]":"[/code]. For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code].

- If the track has type [constant Animation.TYPE_POSITION_3D], [constant Animation.TYPE_ROTATION_3D] or [constant Animation.TYPE_SCALE_3D] the transformation will be canceled visually, and the animation will appear to stay in place. See also [method get_root_motion_position], [method get_root_motion_rotation], [method get_root_motion_scale] and [RootMotionView].

- If a value track has non-numeric type key values, it is internally converted to use [constant ANIMATION_CALLBACK_MODE_DISCRETE_RECESSIVE] with [constant Animation.UPDATE_DISCRETE].

- <method name="_process" qualifiers="virtual const" deprecated="Currently this is mostly useless as there is a lack of many APIs to extend AnimationNode by GDScript. It is planned that a more flexible API using structures will be provided in the future.">

- [AnimationNodeBlendSpace1D] represents a virtual 2D space on which [AnimationRootNode]s are placed. Outputs the linear blend of the three adjacent animations using a [Vector2] weight. Adjacent in this context means the three [AnimationRootNode]s making up the triangle that contains the current value.

- Updates the position of the point at index [param point] on the blend axis.

- [b]Example:[/b]

- [b]Example:[/b]

- Determines whether the transition should disabled, enabled when using [method AnimationNodeStateMachinePlayback.travel], or traversed automatically if the [member advance_condition] and [member advance_expression] checks are true (if assigned).

- Automatically use this transition if the [member advance_condition] and [member advance_expression] checks are true (if assigned).

- Queues an animation for playback once the current one is done.

- [b]Example of getting the[/b] [CollisionShape2D] [b]node from the shape index:[/b]

- [b]Example of getting the[/b] [CollisionShape2D] [b]node from the shape index:[/b]

- [b]Example of getting the[/b] [CollisionShape3D] [b]node from the shape index:[/b]

- [b]Example of getting the[/b] [CollisionShape3D] [b]node from the shape index:[/b]

- An array data structure that can contain a sequence of elements of any type. Elements are accessed by a numerical index starting at 0. Negative indices are used to count from the back (-1 is the last element, -2 is the second to last, etc.).

- [b]Example:[/b]

- var array = ["One", 2, 3, "Four"]

- print(array[0]) # One.

- print(array[2]) # 3.

- print(array[-1]) # Four.

- array[2] = "Three"

- print(array[-2]) # Three.

- [/gdscript]

- [csharp]

- var array = new Godot.Collections.Array{"One", 2, 3, "Four"};

- GD.Print(array[0]); // One.

- GD.Print(array[2]); // 3.

- GD.Print(array[array.Count - 1]); // Four.

- array[2] = "Three";

- GD.Print(array[array.Count - 2]); // Three.

- [/csharp]

- [/codeblocks]

- Arrays can be concatenated using the [code]+[/code] operator:

- [codeblocks]

- [gdscript]

- var array1 = ["One", 2]

- var array2 = [3, "Four"]

- print(array1 + array2) # ["One", 2, 3, "Four"]

- // Array concatenation is not possible with C# arrays, but is with Godot.Collections.Array.

- var array1 = new Godot.Collections.Array{"One", 2};

- var array2 = new Godot.Collections.Array{3, "Four"};

- GD.Print(array1 + array2); // Prints [One, 2, 3, Four]

- [b]Note:[/b] Arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use [method duplicate].

- Creates a typed array from the [param base] array. All arguments are required.

- - [param type] is the built-in type as a [enum Variant.Type] constant, for example [constant TYPE_INT].

- - [param class_name] is the [b]native[/b] class name, for example [Node]. If [param type] is not [constant TYPE_OBJECT], must be an empty string.

- - [param script] is the associated script. Must be a [Script] instance or [code]null[/code].

- Examples:

- class_name MyNode

- class MyClass:

- var a = Array([], TYPE_INT, &amp;"", null) # Array[int]

- var b = Array([], TYPE_OBJECT, &amp;"Node", null) # Array[Node]

- var c = Array([], TYPE_OBJECT, &amp;"Node", MyNode) # Array[MyNode]

- var d = Array([], TYPE_OBJECT, &amp;"RefCounted", MyClass) # Array[MyClass]

- [b]Note:[/b] This constructor can be useful if you want to create a typed array on the fly, but you are not required to use it. In GDScript you can use a temporary variable with the static type you need and then pass it:

- func _ready():

- var a: Array[int] = []

- some_func(a)

- Calls the provided [Callable] on each element in the array and returns [code]true[/code] if the [Callable] returns [code]true[/code] for [i]all[/i] elements in the array. If the [Callable] returns [code]false[/code] for one array element or more, this method returns [code]false[/code].

- The callable's method should take one [Variant] parameter (the current array element) and return a boolean value.

- [codeblock]

- print([6, 10, 6].all(greater_than_5)) # Prints True (3/3 elements evaluate to `true`).

- print([4, 10, 4].all(greater_than_5)) # Prints False (1/3 elements evaluate to `true`).

- print([4, 4, 4].all(greater_than_5)) # Prints False (0/3 elements evaluate to `true`).

- print([].all(greater_than_5)) # Prints True (0/0 elements evaluate to `true`).

- print([6, 10, 6].all(func(number): return number &gt; 5)) # Prints True. Same as the first line above, but using lambda function.

- func greater_than_5(number):

- return number &gt; 5

- [/codeblock]

- Calls the provided [Callable] on each element in the array and returns [code]true[/code] if the [Callable] returns [code]true[/code] for [i]one or more[/i] elements in the array. If the [Callable] returns [code]false[/code] for all elements in the array, this method returns [code]false[/code].

- The callable's method should take one [Variant] parameter (the current array element) and return a boolean value.

- func _ready():

- print([6, 10, 6].any(greater_than_5)) # Prints True (3 elements evaluate to `true`).

- print([4, 10, 4].any(greater_than_5)) # Prints True (1 elements evaluate to `true`).

- print([4, 4, 4].any(greater_than_5)) # Prints False (0 elements evaluate to `true`).

- print([].any(greater_than_5)) # Prints False (0 elements evaluate to `true`).

-

- print([6, 10, 6].any(func(number): return number &gt; 5)) # Prints True. Same as the first line above, but using lambda function.

-

- Appends an element at the end of the array (alias of [method push_back]).

- Appends another array at the end of this array.

- var array1 = [1, 2, 3]

- var array2 = [4, 5, 6]

- array1.append_array(array2)

- print(array1) # Prints [1, 2, 3, 4, 5, 6].

- Returns the last element of the array. Prints an error and returns [code]null[/code] if the array is empty.

- [b]Note:[/b] Calling this function is not the same as writing [code]array[-1][/code]. If the array is empty, accessing by index will pause project execution when running from the editor.

- Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [param before] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array.

- var array = ["a", "b", "c", "c", "d", "e"]

- print(array.bsearch("c", true)) # Prints 2, at the first matching element.

- print(array.bsearch("c", false)) # Prints 4, after the last matching element, pointing to "d".

- [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.

- Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a [param before] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return [code]true[/code] if the first argument is less than the second, and return [code]false[/code] otherwise.

- [b]Note:[/b] The custom method must accept the two arguments in any order, you cannot rely on that the first argument will always be from the array.

- [b]Note:[/b] Calling [method bsearch_custom] on an unsorted array results in unexpected behavior.

- Clears the array. This is equivalent to using [method resize] with a size of [code]0[/code].

- Returns a copy of the array.

- If [param deep] is [code]true[/code], a deep copy is performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If [code]false[/code], a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array. Note that any [Object]-derived elements will be shallow copied regardless of the [param deep] setting.

- Removes the first occurrence of a value from the array. If the value does not exist in the array, nothing happens. To remove an element by index, use [method remove_at] instead.

- [b]Note:[/b] This method acts in-place and doesn't return a modified array.

- [b]Note:[/b] On large arrays, this method will be slower if the removed element is close to the beginning of the array (index 0). This is because all elements placed after the removed element have to be reindexed.

- [b]Note:[/b] Do not erase entries while iterating over the array.

- Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements:

- array.resize(10)

- array.fill(0) # Initialize the 10 elements to 0.

- array.Resize(10);

- array.Fill(0); // Initialize the 10 elements to 0.

- [b]Note:[/b] If [param value] is of a reference type ([Object]-derived, [Array], [Dictionary], etc.) then the array is filled with the references to the same object, i.e. no duplicates are created.

- Calls the provided [Callable] on each element in the array and returns a new array with the elements for which the method returned [code]true[/code].

- The callable's method should take one [Variant] parameter (the current array element) and return a boolean value.

- print([1, 2, 3].filter(remove_1)) # Prints [2, 3].

- print([1, 2, 3].filter(func(number): return number != 1)) # Same as above, but using lambda function.

- func remove_1(number):

- return number != 1

- Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed.

- Returns the first element of the array. Prints an error and returns [code]null[/code] if the array is empty.

- [b]Note:[/b] Calling this function is not the same as writing [code]array[0][/code]. If the array is empty, accessing by index will pause project execution when running from the editor.

- Returns the built-in type of the typed array as a [enum Variant.Type] constant. If the array is not typed, returns [constant TYPE_NIL].

- Returns the [b]native[/b] class name of the typed array if the built-in type is [constant TYPE_OBJECT]. Otherwise, this method returns an empty string.

- Returns the script associated with the typed array. This method returns a [Script] instance or [code]null[/code].

- Returns [code]true[/code] if the array contains the given value.

- print(["inside", 7].has("inside")) # True

- print(["inside", 7].has("outside")) # False

- print(["inside", 7].has(7)) # True

- print(["inside", 7].has("7")) # False

- // has is renamed to Contains

- GD.Print(arr.Contains("inside")); // True

- GD.Print(arr.Contains("outside")); // False

- GD.Print(arr.Contains(7)); // True

- GD.Print(arr.Contains("7")); // False

- [/csharp]

- [/codeblocks]

- [b]Note:[/b] This is equivalent to using the [code]in[/code] operator as follows:

- [codeblocks]

- [gdscript]

- # Will evaluate to `true`.

- if 2 in [2, 4, 6, 8]:

- print("Contains!")

- [/gdscript]

- [csharp]

- // As there is no "in" keyword in C#, you have to use Contains

- var array = new Godot.Collections.Array { 2, 4, 6, 8 };

- if (array.Contains(2))

- {

- GD.Print("Contains!");

- }

- [b]Note:[/b] [Array]s with equal content will always produce identical hash values. However, the reverse is not true. Returning identical hash values does [i]not[/i] imply the arrays are equal, because different arrays can have identical hash values due to hash collisions.

- Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]pos == size()[/code]). Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed.

- [b]Note:[/b] This method acts in-place and doesn't return a modified array.

- [b]Note:[/b] On large arrays, this method will be slower if the inserted element is close to the beginning of the array (index 0). This is because all elements placed after the newly inserted element have to be reindexed.

- Returns [code]true[/code] if the array is empty.

- Returns [code]true[/code] if the array is read-only. See [method make_read_only]. Arrays are automatically read-only if declared with [code]const[/code] keyword.

- Returns [code]true[/code] if the array is typed the same as [param array].

- Returns [code]true[/code] if the array is typed. Typed arrays can only store elements of their associated type and provide type safety for the [code][][/code] operator. Methods of typed array still return [Variant].

- Makes the array read-only, i.e. disabled modifying of the array's elements. Does not apply to nested content, e.g. content of nested arrays.

- Calls the provided [Callable] for each element in the array and returns a new array filled with values returned by the method.

- The callable's method should take one [Variant] parameter (the current array element) and can return any [Variant].

- print([1, 2, 3].map(negate)) # Prints [-1, -2, -3].

- print([1, 2, 3].map(func(number): return -number)) # Same as above, but using lambda function.

- func negate(number):

- return -number

- Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned.

- To find the maximum value using a custom comparator, you can use [method reduce]. In this example every array element is checked and the first maximum value is returned:

- [codeblock]

- func _ready():

- var arr = [Vector2(0, 1), Vector2(2, 0), Vector2(1, 1), Vector2(1, 0), Vector2(0, 2)]

- # In this example we compare the lengths.

- print(arr.reduce(func(max, val): return val if is_length_greater(val, max) else max))

-

- func is_length_greater(a, b):

- return a.length() &gt; b.length()

- [/codeblock]

- Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned.

- See also [method max] for an example of using a custom comparator.

- Returns a random value from the target array. Prints an error and returns [code]null[/code] if the array is empty.

- var array: Array[int] = [1, 2, 3, 4]

- print(array.pick_random()) # Prints either of the four numbers.

- var array = new Godot.Collections.Array { 1, 2, 3, 4 };

- GD.Print(array.PickRandom()); // Prints either of the four numbers.

- Removes and returns the element of the array at index [param position]. If negative, [param position] is considered relative to the end of the array. Leaves the array unchanged and returns [code]null[/code] if the array is empty or if it's accessed out of bounds. An error message is printed when the array is accessed out of bounds, but not when the array is empty.

- [b]Note:[/b] On large arrays, this method can be slower than [method pop_back] as it will reindex the array's elements that are located after the removed element. The larger the array and the lower the index of the removed element, the slower [method pop_at] will be.

- Removes and returns the last element of the array. Returns [code]null[/code] if the array is empty, without printing an error message. See also [method pop_front].

- Removes and returns the first element of the array. Returns [code]null[/code] if the array is empty, without printing an error message. See also [method pop_back].

- [b]Note:[/b] On large arrays, this method is much slower than [method pop_back] as it will reindex all the array's elements every time it's called. The larger the array, the slower [method pop_front] will be.

- [b]Note:[/b] On large arrays, this method is much slower than [method push_back] as it will reindex all the array's elements every time it's called. The larger the array, the slower [method push_front] will be.

- Calls the provided [Callable] for each element in array and accumulates the result in [param accum].

- The callable's method takes two arguments: the current value of [param accum] and the current array element. If [param accum] is [code]null[/code] (default value), the iteration will start from the second element, with the first one used as initial value of [param accum].

- func _ready():

- print([1, 2, 3].reduce(sum, 10)) # Prints 16.

- print([1, 2, 3].reduce(func(accum, number): return accum + number, 10)) # Same as above, but using lambda function.

-

- Removes an element from the array by index. If the index does not exist in the array, nothing happens. To remove an element by searching for its value, use [method erase] instead.

- [b]Note:[/b] This method acts in-place and doesn't return a modified array.

- [b]Note:[/b] On large arrays, this method will be slower if the removed element is close to the beginning of the array (index 0). This is because all elements placed after the removed element have to be reindexed.

- [b]Note:[/b] [param position] cannot be negative. To remove an element relative to the end of the array, use [code]arr.remove_at(arr.size() - (i + 1))[/code]. To remove the last element from the array without returning the value, use [code]arr.resize(arr.size() - 1)[/code].

- Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are [code]null[/code]. Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed.

- Calling [method resize] once and assigning the new values is faster than adding new elements one by one.

- [b]Note:[/b] This method acts in-place and doesn't return a modified array.

- Reverses the order of the elements in 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.

- Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as [method @GlobalScope.randi]. Call [method @GlobalScope.randomize] to ensure that a new seed will be used each time if you want non-reproducible shuffling.

- Returns the number of elements in the array.

- Returns the slice of the [Array], from [param begin] (inclusive) to [param end] (exclusive), as a new [Array].

- The absolute value of [param begin] and [param end] will be clamped to the array size, so the default value for [param end] makes it slice to the size of the array by default (i.e. [code]arr.slice(1)[/code] is a shorthand for [code]arr.slice(1, arr.size())[/code]).

- If either [param begin] or [param end] are negative, they will be relative to the end of the array (i.e. [code]arr.slice(0, -2)[/code] is a shorthand for [code]arr.slice(0, arr.size() - 2)[/code]).

- If specified, [param step] is the relative index between source elements. It can be negative, then [param begin] must be higher than [param end]. For example, [code][0, 1, 2, 3, 4, 5].slice(5, 1, -2)[/code] returns [code][5, 3][/code].

- If [param deep] is true, each element will be copied by value rather than by reference.

- [b]Note:[/b] To include the first element when [param step] is negative, use [code]arr.slice(begin, -arr.size() - 1, step)[/code] (i.e. [code][0, 1, 2].slice(1, -4, -1)[/code] returns [code][1, 0][/code]).

- Sorts the array.

- [b]Note:[/b] The sorting algorithm used is not [url=https://en.wikipedia.org/wiki/Sorting_algorithm#Stability]stable[/url]. This means that values considered equal may have their order changed when using [method sort].

- [b]Note:[/b] Strings are sorted in alphabetical order (as opposed to natural order). This may lead to unexpected behavior when sorting an array of strings ending with a sequence of numbers. Consider the following example:

- var strings = ["string1", "string2", "string10", "string11"]

- strings.sort()

- print(strings) # Prints [string1, string10, string11, string2]

- var strings = new Godot.Collections.Array { "string1", "string2", "string10", "string11" };

- strings.Sort();

- GD.Print(strings); // Prints [string1, string10, string11, string2]

- To perform natural order sorting, you can use [method sort_custom] with [method String.naturalnocasecmp_to] as follows:

- [codeblock]

- var strings = ["string1", "string2", "string10", "string11"]

- strings.sort_custom(func(a, b): return a.naturalnocasecmp_to(b) &lt; 0)

- print(strings) # Prints [string1, string2, string10, string11]

- [/codeblock]

- Sorts the array using a custom method. The custom method receives two arguments (a pair of elements from the array) and must return either [code]true[/code] or [code]false[/code]. For two elements [code]a[/code] and [code]b[/code], if the given method returns [code]true[/code], element [code]b[/code] will be after element [code]a[/code] in the array.

- [b]Note:[/b] The sorting algorithm used is not [url=https://en.wikipedia.org/wiki/Sorting_algorithm#Stability]stable[/url]. This means that values considered equal may have their order changed when using [method sort_custom].

- [b]Note:[/b] You cannot randomize the return value as the heapsort algorithm expects a deterministic result. Randomizing the return value will result in unexpected behavior.

- [codeblocks]

- [gdscript]

- if a[0] &lt; b[0]:

- var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]]

- print(my_items) # Prints [[4, Tomato], [5, Potato], [9, Rice]].

- # Descending, lambda version.

- my_items.sort_custom(func(a, b): return a[0] &gt; b[0])

- print(my_items) # Prints [[9, Rice], [5, Potato], [4, Tomato]].

- [/gdscript]

- [csharp]

- // There is no custom sort support for Godot.Collections.Array

- [/csharp]

- [/codeblocks]

- Compares the left operand [Array] against the [param right] [Array]. Returns [code]true[/code] if the sizes or contents of the arrays are [i]not[/i] equal, [code]false[/code] otherwise.

- Concatenates two [Array]s together, with the [param right] [Array] being added to the end of the [Array] specified in the left operand. For example, [code][1, 2] + [3, 4][/code] results in [code][1, 2, 3, 4][/code].

- Performs a comparison for each index between the left operand [Array] and the [param right] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is less, or [code]false[/code] if the element is greater. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]false[/code] if the left operand [Array] has fewer elements, otherwise it returns [code]true[/code].

- Performs a comparison for each index between the left operand [Array] and the [param right] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is less, or [code]false[/code] if the element is greater. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]true[/code] if the left operand [Array] has the same number of elements or fewer, otherwise it returns [code]false[/code].

- Performs a comparison for each index between the left operand [Array] and the [param right] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is greater, or [code]false[/code] if the element is less. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]true[/code] if the [param right] [Array] has more elements, otherwise it returns [code]false[/code].

- Performs a comparison for each index between the left operand [Array] and the [param right] [Array], considering the highest common index of both arrays for this comparison: Returns [code]true[/code] on the first occurrence of an element that is greater, or [code]false[/code] if the element is less. Note that depending on the type of data stored, this function may be recursive. If all elements are equal, it compares the length of both arrays and returns [code]true[/code] if the [param right] [Array] has more or the same number of elements, otherwise it returns [code]false[/code].

- Returns a reference to the element of type [Variant] at the specified location. Arrays start at index 0. [param index] can be a zero or positive value to start from the beginning, or a negative value to start from the end. Out-of-bounds array access causes a run-time error, which will result in an error being printed and the project execution pausing if run from the editor.

- An optional mesh which is used for rendering shadows and can be used for the depth prepass. Can be used to increase performance of shadow rendering by using a mesh that only contains vertex position data (without normals, UVs, colors, etc.).

- [b]Note:[/b] [AtlasTexture] cannot be used in an [AnimatedTexture], and may not tile properly in nodes such as [TextureRect], when inside other [AtlasTexture] resources.

- The region used to draw the [member atlas].

- Use the average value as magnitude.

- Use the maximum value as magnitude.

- Values greater than 1.0 increase intensity of any panning on audio passing through this effect, whereas values less than 1.0 will decrease the panning intensity. A value of 0.0 will downmix audio to mono.

- Return true whether the stream associated with an integer ID is still playing. Check [method play_stream] for information on when this ID becomes invalid.

- To use this node, [member stream] needs to be set to a valid [AudioStream] resource. Playing more than one sound at the time is also supported, see [member max_polyphony].

- <member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">

- <member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">

- <member name="playing" type="bool" setter="_set_playing" getter="is_playing" default="false">

- Saves the AudioStreamWAV as a WAV file to [param path]. Samples with IMA ADPCM or QOA formats can't be saved.

- [b]Note:[/b] This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte.

- The loop start point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.

- The loop end point (in number of samples, relative to the beginning of the sample). This information will be imported automatically from the WAV file if present.

- The loop mode. This information will be imported automatically from the WAV file if present. See [enum LoopMode] constants for values.

- 8-bit audio codec.

- 16-bit audio codec.

- Audio is compressed using IMA ADPCM.

- Audio is compressed as QOA ([url=https://qoaformat.org/]Quite OK Audio[/url]).

- [b]Note:[/b] Setting [member button_pressed] will result in [signal toggled] to be emitted. If you want to change the pressed state without emitting that signal, use [method set_pressed_no_signal].

- [b]Note:[/b] Setting the shading mode vertex shading currently has no effect, as vertex shading is not implemented yet.

- The object will be shaded per vertex. Useful when you want cheaper shaders and do not care about visual quality. Not implemented yet (this mode will act like [constant SHADING_MODE_PER_PIXEL]).

- [b]Note:[/b] Godot uses a [url=https://en.wikipedia.org/wiki/Right-hand_rule]right-handed coordinate system[/url], which is a common standard. For directions, the convention for built-in types like [Camera3D] is for -Z to point forward (+X is right, +Y is up, and +Z is back). Other objects may use different direction conventions. For more information, see the [url=$DOCS_URL/tutorials/assets_pipeline/importing_scenes.html#d-asset-direction-conventions]Importing 3D Scenes[/url] tutorial.

- [b]Example:[/b] Smoothly rotate a [Node3D] to the target basis over time, with a [Tween].

- [b]Example of creating a button and assigning an action when pressed by code:[/b]

- button.pressed.connect(self._button_pressed)

- [b]Note:[/b] Buttons do not interpret touch input and therefore don't support multitouch, since mouse emulation can only press one button at a given time. Use [TouchScreenButton] for buttons that trigger gameplay movement or actions.

- This constant acts as a boolean. If [code]true[/code], text and icon are always aligned to the largest stylebox margins, otherwise it's aligned to the current button state stylebox margins.

- Returns the enabled state of the given flag (see [enum ParticleFlags] for options).

- [b]Example:[/b]

- Return the bound arguments (as long as [method get_bound_arguments_count] is greater than zero), or empty (if [method get_bound_arguments_count] is less than or equal to zero).

- Returns the total amount of arguments bound (or unbound) via successive [method bind] or [method unbind] calls. If the amount of arguments unbound is greater than the ones bound, this function returns a value less than zero.

- Returns [code]true[/code] if this [Callable] has no target to call the method on.

- [b]Example:[/b]

- tween.tween_callback(queue_free).set_delay(2) #this will call queue_free() after 2 seconds

- Sensitivity of camera sensors, measured in ISO. A higher sensitivity results in a brighter image. Only available when [member ProjectSettings.rendering/lights_and_shadows/use_physical_light_units] is enabled. When [member auto_exposure_enabled] this can be used as a method of exposure compensation, doubling the value will increase the exposure value (measured in EV100) by 1 stop.

- The minimum luminance luminance (in EV100) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark.

- [b]Note:[/b] This class is currently only implemented on macOS and iOS. To get a [CameraFeed] on iOS, the camera plugin from [url=https://github.com/godotengine/godot-ios-plugins]godot-ios-plugins[/url] is required. On other platforms, no [CameraFeed]s will be available.

- [b]Example using the default project font:[/b]

- <param index="0" name="screen_point" type="Vector2" />

- Assigns [param screen_point] as this node's new local transform.

- If [code]true[/code], this [CanvasItem] is drawn. The node is only visible if all of its ancestors are visible as well (in other words, [method is_visible_in_tree] must return [code]true[/code]).

- If [code]true[/code], this and child [CanvasItem] nodes with a lower Y position are rendered in front of nodes with a higher Y position. If [code]false[/code], this and child [CanvasItem] nodes are rendered normally in scene tree order.

- With Y-sorting enabled on a parent node ('A') but disabled on a child node ('B'), the child node ('B') is sorted but its children ('C1', 'C2', etc) render together on the same Y position as the child node 'B'. This allows you to organize the render order of a scene without changing the scene tree.

- Emitted when becoming hidden.

- Emitted when the item's [Rect2] boundaries (position or size) have changed, or when an action is taking place that may have impacted these boundaries (e.g. changing [member Sprite2D.texture]).

- Emitted when the visibility (hidden/visible) changes.

- <link title="RichTextEffect test project (third-party)">https://github.com/Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project</link>

- [b]Example usage:[/b]

- [b]Note:[/b] in C#, constructs an empty color with all of its components set to [code]0.0[/code] (transparent black).

- This resource defines a custom rendering effect that can be applied to [Viewport]s through the viewports' [Environment]. You can implement a callback that is called during rendering at a given stage of the rendering pipeline and allows you to insert additional passes. Note that this callback happens on the rendering thread.

- The callback is called after our transparent rendering pass, but before any build in post effects and output to our render target.

- return data.VariantType == Variant.Type.Dictionary &amp;&amp; dict.AsGodotDictionary().ContainsKey("color");

- Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See [method accept_event].

- [b]Example usage for clicking a control:[/b]

- The event won't trigger if:

- * clicking outside the control (see [method _has_point]);

- * control has [member mouse_filter] set to [constant MOUSE_FILTER_IGNORE];

- * control is obstructed by another [Control] on top of it, which doesn't have [member mouse_filter] set to [constant MOUSE_FILTER_IGNORE];

- * control's parent has [member mouse_filter] set to [constant MOUSE_FILTER_STOP] or has accepted the event;

- * it happens outside the parent's rectangle and the parent has either [member clip_contents] enabled.

- [b]Note:[/b] Event position is relative to the control origin.

- [b]Note:[/b] The node (and any relevant children) should be [member CanvasItem.visible] when returned, otherwise, the viewport that instantiates it will not be able to calculate its minimum size reliably.

- [b]Example of usage with a custom-constructed node:[/b]

- [b]Example of usage with a custom scene instance:[/b]

- [b]Example of overriding a label's color and resetting it later:[/b]

- [b]Example of modifying a property in a StyleBox by duplicating it:[/b]

- # The snippet below assumes the child node MyButton has a StyleBoxFlat assigned.

- // The snippet below assumes the child node MyButton has a StyleBoxFlat assigned.

- [b]Example usage for showing a popup:[/b]

- Creates an [InputEventMouseButton] that attempts to click the control. If the event is received, the control acquires focus.

- Forwards the handling of this control's [method _get_drag_data], [method _can_drop_data] and [method _drop_data] virtual functions to delegate callables.

- For each argument, if not empty, the delegate callable is used, otherwise the local (virtual) function is used.

- The function format for each callable should be exactly the same as the virtual functions described above.

- When enabled, scroll wheel events processed by [method _gui_input] will be passed to the parent control even if [member mouse_filter] is set to [constant MOUSE_FILTER_STOP]. As it defaults to true, this allows nested scrollable containers to work out of the box.

- The control will receive mouse movement input events and mouse button input events if clicked on through [method _gui_input]. And the control will receive the [signal mouse_entered] and [signal mouse_exited] signals. These events are automatically marked as handled, and they will not propagate further to other controls. This also results in blocking signals in other controls.

- The control will receive mouse movement input events and mouse button input events if clicked on through [method _gui_input]. And the control will receive the [signal mouse_entered] and [signal mouse_exited] signals. If this control does not handle the event, the parent control (if any) will be considered, and so on until there is no more parent control to potentially handle it. This also allows signals to fire in other controls. If no control handled it, the event will be passed to [method Node._shortcut_input] for further processing.

- The control will not receive mouse movement input events and mouse button input events if clicked on through [method _gui_input]. The control will also not receive the [signal mouse_entered] nor [signal mouse_exited] signals. This will not block other controls from receiving these events or firing the signals. Ignored events will not be handled automatically.

- <constant name="LAYOUT_DIRECTION_LOCALE" value="1" enum="LayoutDirection">

- To create such a texture file yourself, reimport your image files using the Godot Editor import presets.

- [b]Note:[/b] Godot doesn't support using cubemaps in a [PanoramaSkyMaterial]. You can use [url=https://danilw.github.io/GLSL-howto/cubemap_to_panorama_js/cubemap_to_panorama.html]this tool[/url] to convert a cubemap to an equirectangular sky map.

- Returns the position between the vertex [param idx] and the vertex [code]idx + 1[/code], where [param t] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [param t] outside the range ([code]0.0 &gt;= t &lt;=1[/code]) give strange, but predictable results.

- See also [method merge].

- [b]Note:[/b] This method is implemented if the display server has the [constant FEATURE_NATIVE_DIALOG_INPUT] feature. Supported platforms include macOS and Windows.

- Callbacks have the following arguments: [code]status: bool, selected_paths: PackedStringArray, selected_filter_index: int[/code].

- [b]Note:[/b] This method is implemented if the display server has the [constant FEATURE_NATIVE_DIALOG_FILE] feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS.

- [b]Note:[/b] On Linux, [param show_hidden] is ignored.

- [b]Note:[/b] On macOS, native file dialogs have no title.

- [b]Note:[/b] This method is implemented if the display server has the [constant FEATURE_NATIVE_DIALOG_FILE] feature. Supported platforms include Linux (X11/Wayland), Windows, and macOS.

- [b]Note:[/b] This method is implemented on macOS and Windows.

- Sets window transient parent. Transient window is will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can't enter full-screen mode.

- Display server supports spawning dialogs for selecting files or directories using the operating system's native look-and-feel. See [method file_dialog_show] and [method file_dialog_with_options_show]. [b]Windows, macOS, Linux (X11/Wayland)[/b]

- <constant name="WINDOW_FLAG_MAX" value="8" enum="WindowFlags">

- func _has_capture(prefix):

- # Return true if you wish to handle message with this prefix.

- return prefix == "my_plugin"

- label.name = "Example plugin"

- Override this method to process incoming messages. The [param session_id] is the ID of the [EditorDebuggerSession] that received the message (which you can retrieve via [method get_session]).

- Override this method to be notified whenever a new [EditorDebuggerSession] is created (the session may be inactive during this stage).

- Adds the given [param control] to the debug session UI in the debugger bottom panel.

- When enabled, [method _get_customization_configuration_hash], [method _customize_resource] and [method _customize_scene] will be called and must be implemented.

- Return true if this plugin will customize scenes based on the platform and features used.