godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Use self-closing tags for `return` and `argument` 

For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
This commit is contained in:
Rémi Verschelde 2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
No known key found for this signature in database
GPG Key ID: C3336907360768E1
408 changed files with 14025 additions and 28050 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

576
doc/classes/@GlobalScope.xml
View File

File diff suppressed because it is too large Load Diff

150
doc/classes/AABB.xml
View File

@ -15,243 +15,193 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="AABB" qualifiers="constructor"> <method name="AABB" qualifiers="constructor">
<return type="AABB"> <return type="AABB" />
</return>
<description> <description>
Constructs a default-initialized [AABB] with default (zero) values of [member position] and [member size]. Constructs a default-initialized [AABB] with default (zero) values of [member position] and [member size].
</description> </description>
</method> </method>
<method name="AABB" qualifiers="constructor"> <method name="AABB" qualifiers="constructor">
<return type="AABB"> <return type="AABB" />
</return> <argument index="0" name="from" type="AABB" />
<argument index="0" name="from" type="AABB">
</argument>
<description> <description>
Constructs an [AABB] as a copy of the given [AABB]. Constructs an [AABB] as a copy of the given [AABB].
</description> </description>
</method> </method>
<method name="AABB" qualifiers="constructor"> <method name="AABB" qualifiers="constructor">
<return type="AABB"> <return type="AABB" />
</return> <argument index="0" name="position" type="Vector3" />
<argument index="0" name="position" type="Vector3"> <argument index="1" name="size" type="Vector3" />
</argument>
<argument index="1" name="size" type="Vector3">
</argument>
<description> <description>
Constructs an [AABB] from a position and size. Constructs an [AABB] from a position and size.
</description> </description>
</method> </method>
<method name="abs" qualifiers="const"> <method name="abs" qualifiers="const">
<return type="AABB"> <return type="AABB" />
</return>
<description> <description>
Returns an AABB with equivalent position and size, modified so that the most-negative corner is the origin and the size is positive. Returns an AABB with equivalent position and size, modified so that the most-negative corner is the origin and the size is positive.
</description> </description>
</method> </method>
<method name="encloses" qualifiers="const"> <method name="encloses" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="with" type="AABB" />
<argument index="0" name="with" type="AABB">
</argument>
<description> <description>
Returns [code]true[/code] if this [AABB] completely encloses another one. Returns [code]true[/code] if this [AABB] completely encloses another one.
</description> </description>
</method> </method>
<method name="expand" qualifiers="const"> <method name="expand" qualifiers="const">
<return type="AABB"> <return type="AABB" />
</return> <argument index="0" name="to_point" type="Vector3" />
<argument index="0" name="to_point" type="Vector3">
</argument>
<description> <description>
Returns this [AABB] expanded to include a given point. Returns this [AABB] expanded to include a given point.
</description> </description>
</method> </method>
<method name="get_area" qualifiers="const"> <method name="get_area" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the volume of the [AABB]. Returns the volume of the [AABB].
</description> </description>
</method> </method>
<method name="get_endpoint" qualifiers="const"> <method name="get_endpoint" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Gets the position of the 8 endpoints of the [AABB] in space. Gets the position of the 8 endpoints of the [AABB] in space.
</description> </description>
</method> </method>
<method name="get_longest_axis" qualifiers="const"> <method name="get_longest_axis" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return>
<description> <description>
Returns the normalized longest axis of the [AABB]. Returns the normalized longest axis of the [AABB].
</description> </description>
</method> </method>
<method name="get_longest_axis_index" qualifiers="const"> <method name="get_longest_axis_index" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the index of the longest axis of the [AABB] (according to [Vector3]'s [code]AXIS_*[/code] constants). Returns the index of the longest axis of the [AABB] (according to [Vector3]'s [code]AXIS_*[/code] constants).
</description> </description>
</method> </method>
<method name="get_longest_axis_size" qualifiers="const"> <method name="get_longest_axis_size" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the scalar length of the longest axis of the [AABB]. Returns the scalar length of the longest axis of the [AABB].
</description> </description>
</method> </method>
<method name="get_shortest_axis" qualifiers="const"> <method name="get_shortest_axis" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return>
<description> <description>
Returns the normalized shortest axis of the [AABB]. Returns the normalized shortest axis of the [AABB].
</description> </description>
</method> </method>
<method name="get_shortest_axis_index" qualifiers="const"> <method name="get_shortest_axis_index" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum). Returns the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum).
</description> </description>
</method> </method>
<method name="get_shortest_axis_size" qualifiers="const"> <method name="get_shortest_axis_size" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the scalar length of the shortest axis of the [AABB]. Returns the scalar length of the shortest axis of the [AABB].
</description> </description>
</method> </method>
<method name="get_support" qualifiers="const"> <method name="get_support" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="dir" type="Vector3" />
<argument index="0" name="dir" type="Vector3">
</argument>
<description> <description>
Returns the support point in a given direction. This is useful for collision detection algorithms. Returns the support point in a given direction. This is useful for collision detection algorithms.
</description> </description>
</method> </method>
<method name="grow" qualifiers="const"> <method name="grow" qualifiers="const">
<return type="AABB"> <return type="AABB" />
</return> <argument index="0" name="by" type="float" />
<argument index="0" name="by" type="float">
</argument>
<description> <description>
Returns a copy of the [AABB] grown a given amount of units towards all the sides. Returns a copy of the [AABB] grown a given amount of units towards all the sides.
</description> </description>
</method> </method>
<method name="has_no_area" qualifiers="const"> <method name="has_no_area" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the [AABB] is flat or empty. Returns [code]true[/code] if the [AABB] is flat or empty.
</description> </description>
</method> </method>
<method name="has_no_surface" qualifiers="const"> <method name="has_no_surface" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the [AABB] is empty. Returns [code]true[/code] if the [AABB] is empty.
</description> </description>
</method> </method>
<method name="has_point" qualifiers="const"> <method name="has_point" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="point" type="Vector3" />
<argument index="0" name="point" type="Vector3">
</argument>
<description> <description>
Returns [code]true[/code] if the [AABB] contains a point. Returns [code]true[/code] if the [AABB] contains a point.
</description> </description>
</method> </method>
<method name="intersection" qualifiers="const"> <method name="intersection" qualifiers="const">
<return type="AABB"> <return type="AABB" />
</return> <argument index="0" name="with" type="AABB" />
<argument index="0" name="with" type="AABB">
</argument>
<description> <description>
Returns the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure. Returns the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure.
</description> </description>
</method> </method>
<method name="intersects" qualifiers="const"> <method name="intersects" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="with" type="AABB" />
<argument index="0" name="with" type="AABB">
</argument>
<description> <description>
Returns [code]true[/code] if the [AABB] overlaps with another. Returns [code]true[/code] if the [AABB] overlaps with another.
</description> </description>
</method> </method>
<method name="intersects_plane" qualifiers="const"> <method name="intersects_plane" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="plane" type="Plane" />
<argument index="0" name="plane" type="Plane">
</argument>
<description> <description>
Returns [code]true[/code] if the [AABB] is on both sides of a plane. Returns [code]true[/code] if the [AABB] is on both sides of a plane.
</description> </description>
</method> </method>
<method name="intersects_ray" qualifiers="const"> <method name="intersects_ray" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="from" type="Vector3" />
<argument index="0" name="from" type="Vector3"> <argument index="1" name="dir" type="Vector3" />
</argument>
<argument index="1" name="dir" type="Vector3">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="intersects_segment" qualifiers="const"> <method name="intersects_segment" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="from" type="Vector3" />
<argument index="0" name="from" type="Vector3"> <argument index="1" name="to" type="Vector3" />
</argument>
<argument index="1" name="to" type="Vector3">
</argument>
<description> <description>
Returns [code]true[/code] if the [AABB] intersects the line segment between [code]from[/code] and [code]to[/code]. Returns [code]true[/code] if the [AABB] intersects the line segment between [code]from[/code] and [code]to[/code].
</description> </description>
</method> </method>
<method name="is_equal_approx" qualifiers="const"> <method name="is_equal_approx" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="aabb" type="AABB" />
<argument index="0" name="aabb" type="AABB">
</argument>
<description> <description>
Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GlobalScope.is_equal_approx] on each component. Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GlobalScope.is_equal_approx] on each component.
</description> </description>
</method> </method>
<method name="merge" qualifiers="const"> <method name="merge" qualifiers="const">
<return type="AABB"> <return type="AABB" />
</return> <argument index="0" name="with" type="AABB" />
<argument index="0" name="with" type="AABB">
</argument>
<description> <description>
Returns a larger [AABB] that contains both this [AABB] and [code]with[/code]. Returns a larger [AABB] that contains both this [AABB] and [code]with[/code].
</description> </description>
</method> </method>
<method name="operator !=" qualifiers="operator"> <method name="operator !=" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="AABB" />
<argument index="0" name="right" type="AABB">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator *" qualifiers="operator"> <method name="operator *" qualifiers="operator">
<return type="AABB"> <return type="AABB" />
</return> <argument index="0" name="right" type="Transform3D" />
<argument index="0" name="right" type="Transform3D">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator ==" qualifiers="operator"> <method name="operator ==" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="AABB" />
<argument index="0" name="right" type="AABB">
</argument>
<description> <description>
</description> </description>
</method> </method>

24
doc/classes/AESContext.xml
View File

@ -80,38 +80,30 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="finish"> <method name="finish">
<return type="void"> <return type="void" />
</return>
<description> <description>
Close this AES context so it can be started again. See [method start]. Close this AES context so it can be started again. See [method start].
</description> </description>
</method> </method>
<method name="get_iv_state"> <method name="get_iv_state">
<return type="PackedByteArray"> <return type="PackedByteArray" />
</return>
<description> <description>
Get the current IV state for this context (IV gets updated when calling [method update]). You normally don't need this function. Get the current IV state for this context (IV gets updated when calling [method update]). You normally don't need this function.
Note: This function only makes sense when the context is started with [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT]. Note: This function only makes sense when the context is started with [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT].
</description> </description>
</method> </method>
<method name="start"> <method name="start">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="mode" type="int" enum="AESContext.Mode" />
<argument index="0" name="mode" type="int" enum="AESContext.Mode"> <argument index="1" name="key" type="PackedByteArray" />
</argument> <argument index="2" name="iv" type="PackedByteArray" default="PackedByteArray()" />
<argument index="1" name="key" type="PackedByteArray">
</argument>
<argument index="2" name="iv" type="PackedByteArray" default="PackedByteArray()">
</argument>
<description> <description>
Start the AES context in the given [code]mode[/code]. A [code]key[/code] of either 16 or 32 bytes must always be provided, while an [code]iv[/code] (initialization vector) of exactly 16 bytes, is only needed when [code]mode[/code] is either [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT]. Start the AES context in the given [code]mode[/code]. A [code]key[/code] of either 16 or 32 bytes must always be provided, while an [code]iv[/code] (initialization vector) of exactly 16 bytes, is only needed when [code]mode[/code] is either [constant MODE_CBC_ENCRYPT] or [constant MODE_CBC_DECRYPT].
</description> </description>
</method> </method>
<method name="update"> <method name="update">
<return type="PackedByteArray"> <return type="PackedByteArray" />
</return> <argument index="0" name="src" type="PackedByteArray" />
<argument index="0" name="src" type="PackedByteArray">
</argument>
<description> <description>
Run the desired operation for this AES context. Will return a [PackedByteArray] containing the result of encrypting (or decrypting) the given [code]src[/code]. See [method start] for mode of operation. Run the desired operation for this AES context. Will return a [PackedByteArray] containing the result of encrypting (or decrypting) the given [code]src[/code]. See [method start] for mode of operation.
Note: The size of [code]src[/code] must be a multiple of 16. Apply some padding if needed. Note: The size of [code]src[/code] must be a multiple of 16. Apply some padding if needed.

183
doc/classes/AStar.xml
View File

@ -39,38 +39,28 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_compute_cost" qualifiers="virtual"> <method name="_compute_cost" qualifiers="virtual">
<return type="float"> <return type="float" />
</return> <argument index="0" name="from_id" type="int" />
<argument index="0" name="from_id" type="int"> <argument index="1" name="to_id" type="int" />
</argument>
<argument index="1" name="to_id" type="int">
</argument>
<description> <description>
Called when computing the cost between two connected points. Called when computing the cost between two connected points.
Note that this function is hidden in the default [code]AStar[/code] class. Note that this function is hidden in the default [code]AStar[/code] class.
</description> </description>
</method> </method>
<method name="_estimate_cost" qualifiers="virtual"> <method name="_estimate_cost" qualifiers="virtual">
<return type="float"> <return type="float" />
</return> <argument index="0" name="from_id" type="int" />
<argument index="0" name="from_id" type="int"> <argument index="1" name="to_id" type="int" />
</argument>
<argument index="1" name="to_id" type="int">
</argument>
<description> <description>
Called when estimating the cost between a point and the path's ending point. Called when estimating the cost between a point and the path's ending point.
Note that this function is hidden in the default [code]AStar[/code] class. Note that this function is hidden in the default [code]AStar[/code] class.
</description> </description>
</method> </method>
<method name="add_point"> <method name="add_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="position" type="Vector3" />
</argument> <argument index="2" name="weight_scale" type="float" default="1.0" />
<argument index="1" name="position" type="Vector3">
</argument>
<argument index="2" name="weight_scale" type="float" default="1.0">
</argument>
<description> <description>
Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger. Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger.
The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path.
@ -88,34 +78,25 @@
</description> </description>
</method> </method>
<method name="are_points_connected" qualifiers="const"> <method name="are_points_connected" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="to_id" type="int" />
</argument> <argument index="2" name="bidirectional" type="bool" default="true" />
<argument index="1" name="to_id" type="int">
</argument>
<argument index="2" name="bidirectional" type="bool" default="true">
</argument>
<description> <description>
Returns whether the two given points are directly connected by a segment. If [code]bidirectional[/code] is [code]false[/code], returns whether movement from [code]id[/code] to [code]to_id[/code] is possible through this segment. Returns whether the two given points are directly connected by a segment. If [code]bidirectional[/code] is [code]false[/code], returns whether movement from [code]id[/code] to [code]to_id[/code] is possible through this segment.
</description> </description>
</method> </method>
<method name="clear"> <method name="clear">
<return type="void"> <return type="void" />
</return>
<description> <description>
Clears all the points and segments. Clears all the points and segments.
</description> </description>
</method> </method>
<method name="connect_points"> <method name="connect_points">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="to_id" type="int" />
</argument> <argument index="2" name="bidirectional" type="bool" default="true" />
<argument index="1" name="to_id" type="int">
</argument>
<argument index="2" name="bidirectional" type="bool" default="true">
</argument>
<description> <description>
Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction. Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction.
[codeblocks] [codeblocks]
@ -135,42 +116,32 @@
</description> </description>
</method> </method>
<method name="disconnect_points"> <method name="disconnect_points">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="to_id" type="int" />
</argument> <argument index="2" name="bidirectional" type="bool" default="true" />
<argument index="1" name="to_id" type="int">
</argument>
<argument index="2" name="bidirectional" type="bool" default="true">
</argument>
<description> <description>
Deletes the segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is prevented, and a unidirectional segment possibly remains. Deletes the segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is prevented, and a unidirectional segment possibly remains.
</description> </description>
</method> </method>
<method name="get_available_point_id" qualifiers="const"> <method name="get_available_point_id" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the next available point ID with no point associated to it. Returns the next available point ID with no point associated to it.
</description> </description>
</method> </method>
<method name="get_closest_point" qualifiers="const"> <method name="get_closest_point" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="to_position" type="Vector3" />
<argument index="0" name="to_position" type="Vector3"> <argument index="1" name="include_disabled" type="bool" default="false" />
</argument>
<argument index="1" name="include_disabled" type="bool" default="false">
</argument>
<description> <description>
Returns the ID of the closest point to [code]to_position[/code], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool. Returns the ID of the closest point to [code]to_position[/code], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool.
[b]Note:[/b] If several points are the closest to [code]to_position[/code], the one with the smallest ID will be returned, ensuring a deterministic result. [b]Note:[/b] If several points are the closest to [code]to_position[/code], the one with the smallest ID will be returned, ensuring a deterministic result.
</description> </description>
</method> </method>
<method name="get_closest_position_in_segment" qualifiers="const"> <method name="get_closest_position_in_segment" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="to_position" type="Vector3" />
<argument index="0" name="to_position" type="Vector3">
</argument>
<description> <description>
Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points.
[codeblocks] [codeblocks]
@ -193,12 +164,9 @@
</description> </description>
</method> </method>
<method name="get_id_path"> <method name="get_id_path">
<return type="PackedInt32Array"> <return type="PackedInt32Array" />
</return> <argument index="0" name="from_id" type="int" />
<argument index="0" name="from_id" type="int"> <argument index="1" name="to_id" type="int" />
</argument>
<argument index="1" name="to_id" type="int">
</argument>
<description> <description>
Returns an array with the IDs of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. Returns an array with the IDs of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
[codeblocks] [codeblocks]
@ -233,17 +201,14 @@
</description> </description>
</method> </method>
<method name="get_point_capacity" qualifiers="const"> <method name="get_point_capacity" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the capacity of the structure backing the points, useful in conjunction with [code]reserve_space[/code]. Returns the capacity of the structure backing the points, useful in conjunction with [code]reserve_space[/code].
</description> </description>
</method> </method>
<method name="get_point_connections"> <method name="get_point_connections">
<return type="PackedInt32Array"> <return type="PackedInt32Array" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Returns an array with the IDs of the points that form the connection with the given point. Returns an array with the IDs of the points that form the connection with the given point.
[codeblocks] [codeblocks]
@ -274,114 +239,88 @@
</description> </description>
</method> </method>
<method name="get_point_count" qualifiers="const"> <method name="get_point_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of points currently in the points pool. Returns the number of points currently in the points pool.
</description> </description>
</method> </method>
<method name="get_point_path"> <method name="get_point_path">
<return type="PackedVector3Array"> <return type="PackedVector3Array" />
</return> <argument index="0" name="from_id" type="int" />
<argument index="0" name="from_id" type="int"> <argument index="1" name="to_id" type="int" />
</argument>
<argument index="1" name="to_id" type="int">
</argument>
<description> <description>
Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path.
[b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PackedVector3Array] and will print an error message. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PackedVector3Array] and will print an error message.
</description> </description>
</method> </method>
<method name="get_point_position" qualifiers="const"> <method name="get_point_position" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Returns the position of the point associated with the given [code]id[/code]. Returns the position of the point associated with the given [code]id[/code].
</description> </description>
</method> </method>
<method name="get_point_weight_scale" qualifiers="const"> <method name="get_point_weight_scale" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Returns the weight scale of the point associated with the given [code]id[/code]. Returns the weight scale of the point associated with the given [code]id[/code].
</description> </description>
</method> </method>
<method name="get_points"> <method name="get_points">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns an array of all points. Returns an array of all points.
</description> </description>
</method> </method>
<method name="has_point" qualifiers="const"> <method name="has_point" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Returns whether a point associated with the given [code]id[/code] exists. Returns whether a point associated with the given [code]id[/code] exists.
</description> </description>
</method> </method>
<method name="is_point_disabled" qualifiers="const"> <method name="is_point_disabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. Returns whether a point is disabled or not for pathfinding. By default, all points are enabled.
</description> </description>
</method> </method>
<method name="remove_point"> <method name="remove_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Removes the point associated with the given [code]id[/code] from the points pool. Removes the point associated with the given [code]id[/code] from the points pool.
</description> </description>
</method> </method>
<method name="reserve_space"> <method name="reserve_space">
<return type="void"> <return type="void" />
</return> <argument index="0" name="num_nodes" type="int" />
<argument index="0" name="num_nodes" type="int">
</argument>
<description> <description>
Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity.
</description> </description>
</method> </method>
<method name="set_point_disabled"> <method name="set_point_disabled">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="disabled" type="bool" default="true" />
</argument>
<argument index="1" name="disabled" type="bool" default="true">
</argument>
<description> <description>
Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle.
</description> </description>
</method> </method>
<method name="set_point_position"> <method name="set_point_position">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="position" type="Vector3" />
</argument>
<argument index="1" name="position" type="Vector3">
</argument>
<description> <description>
Sets the [code]position[/code] for the point with the given [code]id[/code]. Sets the [code]position[/code] for the point with the given [code]id[/code].
</description> </description>
</method> </method>
<method name="set_point_weight_scale"> <method name="set_point_weight_scale">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="weight_scale" type="float" />
</argument>
<argument index="1" name="weight_scale" type="float">
</argument>
<description> <description>
Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point.
</description> </description>

177
doc/classes/AStar2D.xml
View File

@ -10,38 +10,28 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_compute_cost" qualifiers="virtual"> <method name="_compute_cost" qualifiers="virtual">
<return type="float"> <return type="float" />
</return> <argument index="0" name="from_id" type="int" />
<argument index="0" name="from_id" type="int"> <argument index="1" name="to_id" type="int" />
</argument>
<argument index="1" name="to_id" type="int">
</argument>
<description> <description>
Called when computing the cost between two connected points. Called when computing the cost between two connected points.
Note that this function is hidden in the default [code]AStar2D[/code] class. Note that this function is hidden in the default [code]AStar2D[/code] class.
</description> </description>
</method> </method>
<method name="_estimate_cost" qualifiers="virtual"> <method name="_estimate_cost" qualifiers="virtual">
<return type="float"> <return type="float" />
</return> <argument index="0" name="from_id" type="int" />
<argument index="0" name="from_id" type="int"> <argument index="1" name="to_id" type="int" />
</argument>
<argument index="1" name="to_id" type="int">
</argument>
<description> <description>
Called when estimating the cost between a point and the path's ending point. Called when estimating the cost between a point and the path's ending point.
Note that this function is hidden in the default [code]AStar2D[/code] class. Note that this function is hidden in the default [code]AStar2D[/code] class.
</description> </description>
</method> </method>
<method name="add_point"> <method name="add_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="position" type="Vector2" />
</argument> <argument index="2" name="weight_scale" type="float" default="1.0" />
<argument index="1" name="position" type="Vector2">
</argument>
<argument index="2" name="weight_scale" type="float" default="1.0">
</argument>
<description> <description>
Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger. Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger.
The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path.
@ -59,32 +49,24 @@
</description> </description>
</method> </method>
<method name="are_points_connected" qualifiers="const"> <method name="are_points_connected" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="to_id" type="int" />
</argument>
<argument index="1" name="to_id" type="int">
</argument>
<description> <description>
Returns whether there is a connection/segment between the given points. Returns whether there is a connection/segment between the given points.
</description> </description>
</method> </method>
<method name="clear"> <method name="clear">
<return type="void"> <return type="void" />
</return>
<description> <description>
Clears all the points and segments. Clears all the points and segments.
</description> </description>
</method> </method>
<method name="connect_points"> <method name="connect_points">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="to_id" type="int" />
</argument> <argument index="2" name="bidirectional" type="bool" default="true" />
<argument index="1" name="to_id" type="int">
</argument>
<argument index="2" name="bidirectional" type="bool" default="true">
</argument>
<description> <description>
Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction. Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction.
[codeblocks] [codeblocks]
@ -104,40 +86,31 @@
</description> </description>
</method> </method>
<method name="disconnect_points"> <method name="disconnect_points">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="to_id" type="int" />
</argument>
<argument index="1" name="to_id" type="int">
</argument>
<description> <description>
Deletes the segment between the given points. Deletes the segment between the given points.
</description> </description>
</method> </method>
<method name="get_available_point_id" qualifiers="const"> <method name="get_available_point_id" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the next available point ID with no point associated to it. Returns the next available point ID with no point associated to it.
</description> </description>
</method> </method>
<method name="get_closest_point" qualifiers="const"> <method name="get_closest_point" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="to_position" type="Vector2" />
<argument index="0" name="to_position" type="Vector2"> <argument index="1" name="include_disabled" type="bool" default="false" />
</argument>
<argument index="1" name="include_disabled" type="bool" default="false">
</argument>
<description> <description>
Returns the ID of the closest point to [code]to_position[/code], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool. Returns the ID of the closest point to [code]to_position[/code], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool.
[b]Note:[/b] If several points are the closest to [code]to_position[/code], the one with the smallest ID will be returned, ensuring a deterministic result. [b]Note:[/b] If several points are the closest to [code]to_position[/code], the one with the smallest ID will be returned, ensuring a deterministic result.
</description> </description>
</method> </method>
<method name="get_closest_position_in_segment" qualifiers="const"> <method name="get_closest_position_in_segment" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="to_position" type="Vector2" />
<argument index="0" name="to_position" type="Vector2">
</argument>
<description> <description>
Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points.
[codeblocks] [codeblocks]
@ -160,12 +133,9 @@
</description> </description>
</method> </method>
<method name="get_id_path"> <method name="get_id_path">
<return type="PackedInt32Array"> <return type="PackedInt32Array" />
</return> <argument index="0" name="from_id" type="int" />
<argument index="0" name="from_id" type="int"> <argument index="1" name="to_id" type="int" />
</argument>
<argument index="1" name="to_id" type="int">
</argument>
<description> <description>
Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path.
[codeblocks] [codeblocks]
@ -201,17 +171,14 @@
</description> </description>
</method> </method>
<method name="get_point_capacity" qualifiers="const"> <method name="get_point_capacity" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the capacity of the structure backing the points, useful in conjunction with [code]reserve_space[/code]. Returns the capacity of the structure backing the points, useful in conjunction with [code]reserve_space[/code].
</description> </description>
</method> </method>
<method name="get_point_connections"> <method name="get_point_connections">
<return type="PackedInt32Array"> <return type="PackedInt32Array" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Returns an array with the IDs of the points that form the connection with the given point. Returns an array with the IDs of the points that form the connection with the given point.
[codeblocks] [codeblocks]
@ -243,114 +210,88 @@
</description> </description>
</method> </method>
<method name="get_point_count" qualifiers="const"> <method name="get_point_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of points currently in the points pool. Returns the number of points currently in the points pool.
</description> </description>
</method> </method>
<method name="get_point_path"> <method name="get_point_path">
<return type="PackedVector2Array"> <return type="PackedVector2Array" />
</return> <argument index="0" name="from_id" type="int" />
<argument index="0" name="from_id" type="int"> <argument index="1" name="to_id" type="int" />
</argument>
<argument index="1" name="to_id" type="int">
</argument>
<description> <description>
Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path.
[b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PackedVector2Array] and will print an error message. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PackedVector2Array] and will print an error message.
</description> </description>
</method> </method>
<method name="get_point_position" qualifiers="const"> <method name="get_point_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Returns the position of the point associated with the given [code]id[/code]. Returns the position of the point associated with the given [code]id[/code].
</description> </description>
</method> </method>
<method name="get_point_weight_scale" qualifiers="const"> <method name="get_point_weight_scale" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Returns the weight scale of the point associated with the given [code]id[/code]. Returns the weight scale of the point associated with the given [code]id[/code].
</description> </description>
</method> </method>
<method name="get_points"> <method name="get_points">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns an array of all points. Returns an array of all points.
</description> </description>
</method> </method>
<method name="has_point" qualifiers="const"> <method name="has_point" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Returns whether a point associated with the given [code]id[/code] exists. Returns whether a point associated with the given [code]id[/code] exists.
</description> </description>
</method> </method>
<method name="is_point_disabled" qualifiers="const"> <method name="is_point_disabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. Returns whether a point is disabled or not for pathfinding. By default, all points are enabled.
</description> </description>
</method> </method>
<method name="remove_point"> <method name="remove_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Removes the point associated with the given [code]id[/code] from the points pool. Removes the point associated with the given [code]id[/code] from the points pool.
</description> </description>
</method> </method>
<method name="reserve_space"> <method name="reserve_space">
<return type="void"> <return type="void" />
</return> <argument index="0" name="num_nodes" type="int" />
<argument index="0" name="num_nodes" type="int">
</argument>
<description> <description>
Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity.
</description> </description>
</method> </method>
<method name="set_point_disabled"> <method name="set_point_disabled">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="disabled" type="bool" default="true" />
</argument>
<argument index="1" name="disabled" type="bool" default="true">
</argument>
<description> <description>
Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle.
</description> </description>
</method> </method>
<method name="set_point_position"> <method name="set_point_position">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="position" type="Vector2" />
</argument>
<argument index="1" name="position" type="Vector2">
</argument>
<description> <description>
Sets the [code]position[/code] for the point with the given [code]id[/code]. Sets the [code]position[/code] for the point with the given [code]id[/code].
</description> </description>
</method> </method>
<method name="set_point_weight_scale"> <method name="set_point_weight_scale">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="weight_scale" type="float" />
</argument>
<argument index="1" name="weight_scale" type="float">
</argument>
<description> <description>
Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point.
</description> </description>

39
doc/classes/AcceptDialog.xml
View File

@ -10,14 +10,10 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_button"> <method name="add_button">
<return type="Button"> <return type="Button" />
</return> <argument index="0" name="text" type="String" />
<argument index="0" name="text" type="String"> <argument index="1" name="right" type="bool" default="false" />
</argument> <argument index="2" name="action" type="String" default="&quot;&quot;" />
<argument index="1" name="right" type="bool" default="false">
</argument>
<argument index="2" name="action" type="String" default="&quot;&quot;">
</argument>
<description> <description>
Adds a button with label [code]text[/code] and a custom [code]action[/code] to the dialog and returns the created button. [code]action[/code] will be passed to the [signal custom_action] signal when pressed. Adds a button with label [code]text[/code] and a custom [code]action[/code] to the dialog and returns the created button. [code]action[/code] will be passed to the [signal custom_action] signal when pressed.
If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons. If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons.
@ -25,43 +21,35 @@
</description> </description>
</method> </method>
<method name="add_cancel_button"> <method name="add_cancel_button">
<return type="Button"> <return type="Button" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
Adds a button with label [code]name[/code] and a cancel action to the dialog and returns the created button. Adds a button with label [code]name[/code] and a cancel action to the dialog and returns the created button.
You can use [method remove_button] method to remove a button created with this method from the dialog. You can use [method remove_button] method to remove a button created with this method from the dialog.
</description> </description>
</method> </method>
<method name="get_label"> <method name="get_label">
<return type="Label"> <return type="Label" />
</return>
<description> <description>
Returns the label used for built-in text. Returns the label used for built-in text.
</description> </description>
</method> </method>
<method name="get_ok_button"> <method name="get_ok_button">
<return type="Button"> <return type="Button" />
</return>
<description> <description>
Returns the OK [Button] instance. Returns the OK [Button] instance.
</description> </description>
</method> </method>
<method name="register_text_enter"> <method name="register_text_enter">
<return type="void"> <return type="void" />
</return> <argument index="0" name="line_edit" type="Control" />
<argument index="0" name="line_edit" type="Control">
</argument>
<description> <description>
Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted.
</description> </description>
</method> </method>
<method name="remove_button"> <method name="remove_button">
<return type="void"> <return type="void" />
</return> <argument index="0" name="button" type="Control" />
<argument index="0" name="button" type="Control">
</argument>
<description> <description>
Removes the [code]button[/code] from the dialog. Does NOT free the [code]button[/code]. The [code]button[/code] must be a [Button] added with [method add_button] or [method add_cancel_button] method. After removal, pressing the [code]button[/code] will no longer emit this dialog's [signal custom_action] or [signal cancelled] signals. Removes the [code]button[/code] from the dialog. Does NOT free the [code]button[/code]. The [code]button[/code] must be a [Button] added with [method add_button] or [method add_cancel_button] method. After removal, pressing the [code]button[/code] will no longer emit this dialog's [signal custom_action] or [signal cancelled] signals.
</description> </description>
@ -96,8 +84,7 @@
</description> </description>
</signal> </signal>
<signal name="custom_action"> <signal name="custom_action">
<argument index="0" name="action" type="StringName"> <argument index="0" name="action" type="StringName" />
</argument>
<description> <description>
Emitted when a custom button is pressed. See [method add_button]. Emitted when a custom button is pressed. See [method add_button].
</description> </description>

15
doc/classes/AnimatedSprite2D.xml
View File

@ -13,26 +13,21 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="is_playing" qualifiers="const"> <method name="is_playing" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if an animation is currently being played. Returns [code]true[/code] if an animation is currently being played.
</description> </description>
</method> </method>
<method name="play"> <method name="play">
<return type="void"> <return type="void" />
</return> <argument index="0" name="anim" type="StringName" default="&amp;&quot;&quot;" />
<argument index="0" name="anim" type="StringName" default="&amp;&quot;&quot;"> <argument index="1" name="backwards" type="bool" default="false" />
</argument>
<argument index="1" name="backwards" type="bool" default="false">
</argument>
<description> <description>
Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. If [code]backwards[/code] is [code]true[/code], the animation will be played in reverse. Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. If [code]backwards[/code] is [code]true[/code], the animation will be played in reverse.
</description> </description>
</method> </method>
<method name="stop"> <method name="stop">
<return type="void"> <return type="void" />
</return>
<description> <description>
Stops the current animation (does not reset the frame counter). Stops the current animation (does not reset the frame counter).
</description> </description>

12
doc/classes/AnimatedSprite3D.xml
View File

@ -11,24 +11,20 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="is_playing" qualifiers="const"> <method name="is_playing" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if an animation is currently being played. Returns [code]true[/code] if an animation is currently being played.
</description> </description>
</method> </method>
<method name="play"> <method name="play">
<return type="void"> <return type="void" />
</return> <argument index="0" name="anim" type="StringName" default="&amp;&quot;&quot;" />
<argument index="0" name="anim" type="StringName" default="&amp;&quot;&quot;">
</argument>
<description> <description>
Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played.
</description> </description>
</method> </method>
<method name="stop"> <method name="stop">
<return type="void"> <return type="void" />
</return>
<description> <description>
Stops the current animation (does not reset the frame counter). Stops the current animation (does not reset the frame counter).
</description> </description>

30
doc/classes/AnimatedTexture.xml
View File

@ -13,30 +13,23 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_frame_delay" qualifiers="const"> <method name="get_frame_delay" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="frame" type="int" />
<argument index="0" name="frame" type="int">
</argument>
<description> <description>
Returns the given frame's delay value. Returns the given frame's delay value.
</description> </description>
</method> </method>
<method name="get_frame_texture" qualifiers="const"> <method name="get_frame_texture" qualifiers="const">
<return type="Texture2D"> <return type="Texture2D" />
</return> <argument index="0" name="frame" type="int" />
<argument index="0" name="frame" type="int">
</argument>
<description> <description>
Returns the given frame's [Texture2D]. Returns the given frame's [Texture2D].
</description> </description>
</method> </method>
<method name="set_frame_delay"> <method name="set_frame_delay">
<return type="void"> <return type="void" />
</return> <argument index="0" name="frame" type="int" />
<argument index="0" name="frame" type="int"> <argument index="1" name="delay" type="float" />
</argument>
<argument index="1" name="delay" type="float">
</argument>
<description> <description>
Sets an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by [member fps]. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be [code]1.0 / fps + delay[/code]. Sets an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by [member fps]. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be [code]1.0 / fps + delay[/code].
For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be: For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be:
@ -49,12 +42,9 @@
</description> </description>
</method> </method>
<method name="set_frame_texture"> <method name="set_frame_texture">
<return type="void"> <return type="void" />
</return> <argument index="0" name="frame" type="int" />
<argument index="0" name="frame" type="int"> <argument index="1" name="texture" type="Texture2D" />
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
<description> <description>
Assigns a [Texture2D] to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID [member frames] - 1. Assigns a [Texture2D] to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID [member frames] - 1.
You can define any number of textures up to [constant MAX_FRAMES], but keep in mind that only frames from 0 to [member frames] - 1 will be part of the animation. You can define any number of textures up to [constant MAX_FRAMES], but keep in mind that only frames from 0 to [member frames] - 1 will be part of the animation.

558
doc/classes/Animation.xml
View File

@ -32,673 +32,487 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_track"> <method name="add_track">
<return type="int"> <return type="int" />
</return> <argument index="0" name="type" type="int" enum="Animation.TrackType" />
<argument index="0" name="type" type="int" enum="Animation.TrackType"> <argument index="1" name="at_position" type="int" default="-1" />
</argument>
<argument index="1" name="at_position" type="int" default="-1">
</argument>
<description> <description>
Adds a track to the Animation. Adds a track to the Animation.
</description> </description>
</method> </method>
<method name="animation_track_get_key_animation" qualifiers="const"> <method name="animation_track_get_key_animation" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the animation name at the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Animation Track. Returns the animation name at the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Animation Track.
</description> </description>
</method> </method>
<method name="animation_track_insert_key"> <method name="animation_track_insert_key">
<return type="int"> <return type="int" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time" type="float" />
</argument> <argument index="2" name="animation" type="StringName" />
<argument index="1" name="time" type="float">
</argument>
<argument index="2" name="animation" type="StringName">
</argument>
<description> <description>
Inserts a key with value [code]animation[/code] at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of an Animation Track. Inserts a key with value [code]animation[/code] at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of an Animation Track.
</description> </description>
</method> </method>
<method name="animation_track_set_key_animation"> <method name="animation_track_set_key_animation">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument> <argument index="2" name="animation" type="StringName" />
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="animation" type="StringName">
</argument>
<description> <description>
Sets the key identified by [code]key_idx[/code] to value [code]animation[/code]. The [code]track_idx[/code] must be the index of an Animation Track. Sets the key identified by [code]key_idx[/code] to value [code]animation[/code]. The [code]track_idx[/code] must be the index of an Animation Track.
</description> </description>
</method> </method>
<method name="audio_track_get_key_end_offset" qualifiers="const"> <method name="audio_track_get_key_end_offset" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the end offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. Returns the end offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
End offset is the number of seconds cut off at the ending of the audio stream. End offset is the number of seconds cut off at the ending of the audio stream.
</description> </description>
</method> </method>
<method name="audio_track_get_key_start_offset" qualifiers="const"> <method name="audio_track_get_key_start_offset" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the start offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. Returns the start offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
Start offset is the number of seconds cut off at the beginning of the audio stream. Start offset is the number of seconds cut off at the beginning of the audio stream.
</description> </description>
</method> </method>
<method name="audio_track_get_key_stream" qualifiers="const"> <method name="audio_track_get_key_stream" qualifiers="const">
<return type="Resource"> <return type="Resource" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the audio stream of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. Returns the audio stream of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
</description> </description>
</method> </method>
<method name="audio_track_insert_key"> <method name="audio_track_insert_key">
<return type="int"> <return type="int" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time" type="float" />
</argument> <argument index="2" name="stream" type="Resource" />
<argument index="1" name="time" type="float"> <argument index="3" name="start_offset" type="float" default="0" />
</argument> <argument index="4" name="end_offset" type="float" default="0" />
<argument index="2" name="stream" type="Resource">
</argument>
<argument index="3" name="start_offset" type="float" default="0">
</argument>
<argument index="4" name="end_offset" type="float" default="0">
</argument>
<description> <description>
Inserts an Audio Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of an Audio Track. Inserts an Audio Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of an Audio Track.
[code]stream[/code] is the [AudioStream] resource to play. [code]start_offset[/code] is the number of seconds cut off at the beginning of the audio stream, while [code]end_offset[/code] is at the ending. [code]stream[/code] is the [AudioStream] resource to play. [code]start_offset[/code] is the number of seconds cut off at the beginning of the audio stream, while [code]end_offset[/code] is at the ending.
</description> </description>
</method> </method>
<method name="audio_track_set_key_end_offset"> <method name="audio_track_set_key_end_offset">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument> <argument index="2" name="offset" type="float" />
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="offset" type="float">
</argument>
<description> <description>
Sets the end offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. Sets the end offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
</description> </description>
</method> </method>
<method name="audio_track_set_key_start_offset"> <method name="audio_track_set_key_start_offset">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument> <argument index="2" name="offset" type="float" />
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="offset" type="float">
</argument>
<description> <description>
Sets the start offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. Sets the start offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
</description> </description>
</method> </method>
<method name="audio_track_set_key_stream"> <method name="audio_track_set_key_stream">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument> <argument index="2" name="stream" type="Resource" />
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="stream" type="Resource">
</argument>
<description> <description>
Sets the stream of the key identified by [code]key_idx[/code] to value [code]stream[/code]. The [code]track_idx[/code] must be the index of an Audio Track. Sets the stream of the key identified by [code]key_idx[/code] to value [code]stream[/code]. The [code]track_idx[/code] must be the index of an Audio Track.
</description> </description>
</method> </method>
<method name="bezier_track_get_key_in_handle" qualifiers="const"> <method name="bezier_track_get_key_in_handle" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the in handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. Returns the in handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.
</description> </description>
</method> </method>
<method name="bezier_track_get_key_out_handle" qualifiers="const"> <method name="bezier_track_get_key_out_handle" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the out handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. Returns the out handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.
</description> </description>
</method> </method>
<method name="bezier_track_get_key_value" qualifiers="const"> <method name="bezier_track_get_key_value" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the value of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. Returns the value of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.
</description> </description>
</method> </method>
<method name="bezier_track_insert_key"> <method name="bezier_track_insert_key">
<return type="int"> <return type="int" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time" type="float" />
</argument> <argument index="2" name="value" type="float" />
<argument index="1" name="time" type="float"> <argument index="3" name="in_handle" type="Vector2" default="Vector2(0, 0)" />
</argument> <argument index="4" name="out_handle" type="Vector2" default="Vector2(0, 0)" />
<argument index="2" name="value" type="float">
</argument>
<argument index="3" name="in_handle" type="Vector2" default="Vector2(0, 0)">
</argument>
<argument index="4" name="out_handle" type="Vector2" default="Vector2(0, 0)">
</argument>
<description> <description>
Inserts a Bezier Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of a Bezier Track. Inserts a Bezier Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of a Bezier Track.
[code]in_handle[/code] is the left-side weight of the added Bezier curve point, [code]out_handle[/code] is the right-side one, while [code]value[/code] is the actual value at this point. [code]in_handle[/code] is the left-side weight of the added Bezier curve point, [code]out_handle[/code] is the right-side one, while [code]value[/code] is the actual value at this point.
</description> </description>
</method> </method>
<method name="bezier_track_interpolate" qualifiers="const"> <method name="bezier_track_interpolate" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time" type="float" />
</argument>
<argument index="1" name="time" type="float">
</argument>
<description> <description>
Returns the interpolated value at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of a Bezier Track. Returns the interpolated value at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of a Bezier Track.
</description> </description>
</method> </method>
<method name="bezier_track_set_key_in_handle"> <method name="bezier_track_set_key_in_handle">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument> <argument index="2" name="in_handle" type="Vector2" />
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="in_handle" type="Vector2">
</argument>
<description> <description>
Sets the in handle of the key identified by [code]key_idx[/code] to value [code]in_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. Sets the in handle of the key identified by [code]key_idx[/code] to value [code]in_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.
</description> </description>
</method> </method>
<method name="bezier_track_set_key_out_handle"> <method name="bezier_track_set_key_out_handle">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument> <argument index="2" name="out_handle" type="Vector2" />
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="out_handle" type="Vector2">
</argument>
<description> <description>
Sets the out handle of the key identified by [code]key_idx[/code] to value [code]out_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. Sets the out handle of the key identified by [code]key_idx[/code] to value [code]out_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track.
</description> </description>
</method> </method>
<method name="bezier_track_set_key_value"> <method name="bezier_track_set_key_value">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument> <argument index="2" name="value" type="float" />
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="value" type="float">
</argument>
<description> <description>
Sets the value of the key identified by [code]key_idx[/code] to the given value. The [code]track_idx[/code] must be the index of a Bezier Track. Sets the value of the key identified by [code]key_idx[/code] to the given value. The [code]track_idx[/code] must be the index of a Bezier Track.
</description> </description>
</method> </method>
<method name="clear"> <method name="clear">
<return type="void"> <return type="void" />
</return>
<description> <description>
Clear the animation (clear all tracks and reset all). Clear the animation (clear all tracks and reset all).
</description> </description>
</method> </method>
<method name="copy_track"> <method name="copy_track">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="to_animation" type="Animation" />
</argument>
<argument index="1" name="to_animation" type="Animation">
</argument>
<description> <description>
Adds a new track that is a copy of the given track from [code]to_animation[/code]. Adds a new track that is a copy of the given track from [code]to_animation[/code].
</description> </description>
</method> </method>
<method name="find_track" qualifiers="const"> <method name="find_track" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="path" type="NodePath" />
<argument index="0" name="path" type="NodePath">
</argument>
<description> <description>
Returns the index of the specified track. If the track is not found, return -1. Returns the index of the specified track. If the track is not found, return -1.
</description> </description>
</method> </method>
<method name="get_track_count" qualifiers="const"> <method name="get_track_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the amount of tracks in the animation. Returns the amount of tracks in the animation.
</description> </description>
</method> </method>
<method name="method_track_get_key_indices" qualifiers="const"> <method name="method_track_get_key_indices" qualifiers="const">
<return type="PackedInt32Array"> <return type="PackedInt32Array" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time_sec" type="float" />
</argument> <argument index="2" name="delta" type="float" />
<argument index="1" name="time_sec" type="float">
</argument>
<argument index="2" name="delta" type="float">
</argument>
<description> <description>
Returns all the key indices of a method track, given a position and delta time. Returns all the key indices of a method track, given a position and delta time.
</description> </description>
</method> </method>
<method name="method_track_get_name" qualifiers="const"> <method name="method_track_get_name" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the method name of a method track. Returns the method name of a method track.
</description> </description>
</method> </method>
<method name="method_track_get_params" qualifiers="const"> <method name="method_track_get_params" qualifiers="const">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the arguments values to be called on a method track for a given key in a given track. Returns the arguments values to be called on a method track for a given key in a given track.
</description> </description>
</method> </method>
<method name="remove_track"> <method name="remove_track">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Removes a track by specifying the track index. Removes a track by specifying the track index.
</description> </description>
</method> </method>
<method name="track_find_key" qualifiers="const"> <method name="track_find_key" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time" type="float" />
</argument> <argument index="2" name="exact" type="bool" default="false" />
<argument index="1" name="time" type="float">
</argument>
<argument index="2" name="exact" type="bool" default="false">
</argument>
<description> <description>
Finds the key index by time in a given track. Optionally, only find it if the exact time is given. Finds the key index by time in a given track. Optionally, only find it if the exact time is given.
</description> </description>
</method> </method>
<method name="track_get_interpolation_loop_wrap" qualifiers="const"> <method name="track_get_interpolation_loop_wrap" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. New tracks wrap the interpolation loop by default. Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. New tracks wrap the interpolation loop by default.
</description> </description>
</method> </method>
<method name="track_get_interpolation_type" qualifiers="const"> <method name="track_get_interpolation_type" qualifiers="const">
<return type="int" enum="Animation.InterpolationType"> <return type="int" enum="Animation.InterpolationType" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Returns the interpolation type of a given track. Returns the interpolation type of a given track.
</description> </description>
</method> </method>
<method name="track_get_key_count" qualifiers="const"> <method name="track_get_key_count" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Returns the amount of keys in a given track. Returns the amount of keys in a given track.
</description> </description>
</method> </method>
<method name="track_get_key_time" qualifiers="const"> <method name="track_get_key_time" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the time at which the key is located. Returns the time at which the key is located.
</description> </description>
</method> </method>
<method name="track_get_key_transition" qualifiers="const"> <method name="track_get_key_transition" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the transition curve (easing) for a specific key (see the built-in math function [method @GlobalScope.ease]). Returns the transition curve (easing) for a specific key (see the built-in math function [method @GlobalScope.ease]).
</description> </description>
</method> </method>
<method name="track_get_key_value" qualifiers="const"> <method name="track_get_key_value" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Returns the value of a given key in a given track. Returns the value of a given key in a given track.
</description> </description>
</method> </method>
<method name="track_get_path" qualifiers="const"> <method name="track_get_path" qualifiers="const">
<return type="NodePath"> <return type="NodePath" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Gets the path of a track. For more information on the path format, see [method track_set_path]. Gets the path of a track. For more information on the path format, see [method track_set_path].
</description> </description>
</method> </method>
<method name="track_get_type" qualifiers="const"> <method name="track_get_type" qualifiers="const">
<return type="int" enum="Animation.TrackType"> <return type="int" enum="Animation.TrackType" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Gets the type of a track. Gets the type of a track.
</description> </description>
</method> </method>
<method name="track_insert_key"> <method name="track_insert_key">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time" type="float" />
</argument> <argument index="2" name="key" type="Variant" />
<argument index="1" name="time" type="float"> <argument index="3" name="transition" type="float" default="1" />
</argument>
<argument index="2" name="key" type="Variant">
</argument>
<argument index="3" name="transition" type="float" default="1">
</argument>
<description> <description>
Insert a generic key in a given track. Insert a generic key in a given track.
</description> </description>
</method> </method>
<method name="track_is_enabled" qualifiers="const"> <method name="track_is_enabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Returns [code]true[/code] if the track at index [code]idx[/code] is enabled. Returns [code]true[/code] if the track at index [code]idx[/code] is enabled.
</description> </description>
</method> </method>
<method name="track_is_imported" qualifiers="const"> <method name="track_is_imported" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Returns [code]true[/code] if the given track is imported. Else, return [code]false[/code]. Returns [code]true[/code] if the given track is imported. Else, return [code]false[/code].
</description> </description>
</method> </method>
<method name="track_move_down"> <method name="track_move_down">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Moves a track down. Moves a track down.
</description> </description>
</method> </method>
<method name="track_move_to"> <method name="track_move_to">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="to_idx" type="int" />
</argument>
<argument index="1" name="to_idx" type="int">
</argument>
<description> <description>
Changes the index position of track [code]idx[/code] to the one defined in [code]to_idx[/code]. Changes the index position of track [code]idx[/code] to the one defined in [code]to_idx[/code].
</description> </description>
</method> </method>
<method name="track_move_up"> <method name="track_move_up">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Moves a track up. Moves a track up.
</description> </description>
</method> </method>
<method name="track_remove_key"> <method name="track_remove_key">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument>
<argument index="1" name="key_idx" type="int">
</argument>
<description> <description>
Removes a key by index in a given track. Removes a key by index in a given track.
</description> </description>
</method> </method>
<method name="track_remove_key_at_time"> <method name="track_remove_key_at_time">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time" type="float" />
</argument>
<argument index="1" name="time" type="float">
</argument>
<description> <description>
Removes a key at [code]time[/code] in a given track. Removes a key at [code]time[/code] in a given track.
</description> </description>
</method> </method>
<method name="track_set_enabled"> <method name="track_set_enabled">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="enabled" type="bool" />
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description> <description>
Enables/disables the given track. Tracks are enabled by default. Enables/disables the given track. Tracks are enabled by default.
</description> </description>
</method> </method>
<method name="track_set_imported"> <method name="track_set_imported">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="imported" type="bool" />
</argument>
<argument index="1" name="imported" type="bool">
</argument>
<description> <description>
Sets the given track as imported or not. Sets the given track as imported or not.
</description> </description>
</method> </method>
<method name="track_set_interpolation_loop_wrap"> <method name="track_set_interpolation_loop_wrap">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="interpolation" type="bool" />
</argument>
<argument index="1" name="interpolation" type="bool">
</argument>
<description> <description>
If [code]true[/code], the track at [code]idx[/code] wraps the interpolation loop. If [code]true[/code], the track at [code]idx[/code] wraps the interpolation loop.
</description> </description>
</method> </method>
<method name="track_set_interpolation_type"> <method name="track_set_interpolation_type">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="interpolation" type="int" enum="Animation.InterpolationType" />
</argument>
<argument index="1" name="interpolation" type="int" enum="Animation.InterpolationType">
</argument>
<description> <description>
Sets the interpolation type of a given track. Sets the interpolation type of a given track.
</description> </description>
</method> </method>
<method name="track_set_key_time"> <method name="track_set_key_time">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument> <argument index="2" name="time" type="float" />
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="time" type="float">
</argument>
<description> <description>
Sets the time of an existing key. Sets the time of an existing key.
</description> </description>
</method> </method>
<method name="track_set_key_transition"> <method name="track_set_key_transition">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key_idx" type="int" />
</argument> <argument index="2" name="transition" type="float" />
<argument index="1" name="key_idx" type="int">
</argument>
<argument index="2" name="transition" type="float">
</argument>
<description> <description>
Sets the transition curve (easing) for a specific key (see the built-in math function [method @GlobalScope.ease]). Sets the transition curve (easing) for a specific key (see the built-in math function [method @GlobalScope.ease]).
</description> </description>
</method> </method>
<method name="track_set_key_value"> <method name="track_set_key_value">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="key" type="int" />
</argument> <argument index="2" name="value" type="Variant" />
<argument index="1" name="key" type="int">
</argument>
<argument index="2" name="value" type="Variant">
</argument>
<description> <description>
Sets the value of an existing key. Sets the value of an existing key.
</description> </description>
</method> </method>
<method name="track_set_path"> <method name="track_set_path">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="path" type="NodePath" />
</argument>
<argument index="1" name="path" type="NodePath">
</argument>
<description> <description>
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]. 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].
For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code]. For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code].
</description> </description>
</method> </method>
<method name="track_swap"> <method name="track_swap">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="with_idx" type="int" />
</argument>
<argument index="1" name="with_idx" type="int">
</argument>
<description> <description>
Swaps the track [code]idx[/code]'s index position with the track [code]with_idx[/code]. Swaps the track [code]idx[/code]'s index position with the track [code]with_idx[/code].
</description> </description>
</method> </method>
<method name="transform_track_insert_key"> <method name="transform_track_insert_key">
<return type="int"> <return type="int" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time" type="float" />
</argument> <argument index="2" name="location" type="Vector3" />
<argument index="1" name="time" type="float"> <argument index="3" name="rotation" type="Quaternion" />
</argument> <argument index="4" name="scale" type="Vector3" />
<argument index="2" name="location" type="Vector3">
</argument>
<argument index="3" name="rotation" type="Quaternion">
</argument>
<argument index="4" name="scale" type="Vector3">
</argument>
<description> <description>
Insert a transform key for a transform track. Insert a transform key for a transform track.
</description> </description>
</method> </method>
<method name="transform_track_interpolate" qualifiers="const"> <method name="transform_track_interpolate" qualifiers="const">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time_sec" type="float" />
</argument>
<argument index="1" name="time_sec" type="float">
</argument>
<description> <description>
Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quaternion]) and scale ([Vector3]). Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quaternion]) and scale ([Vector3]).
</description> </description>
</method> </method>
<method name="value_track_get_key_indices" qualifiers="const"> <method name="value_track_get_key_indices" qualifiers="const">
<return type="PackedInt32Array"> <return type="PackedInt32Array" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time_sec" type="float" />
</argument> <argument index="2" name="delta" type="float" />
<argument index="1" name="time_sec" type="float">
</argument>
<argument index="2" name="delta" type="float">
</argument>
<description> <description>
Returns all the key indices of a value track, given a position and delta time. Returns all the key indices of a value track, given a position and delta time.
</description> </description>
</method> </method>
<method name="value_track_get_update_mode" qualifiers="const"> <method name="value_track_get_update_mode" qualifiers="const">
<return type="int" enum="Animation.UpdateMode"> <return type="int" enum="Animation.UpdateMode" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int">
</argument>
<description> <description>
Returns the update mode of a value track. Returns the update mode of a value track.
</description> </description>
</method> </method>
<method name="value_track_interpolate" qualifiers="const"> <method name="value_track_interpolate" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="time_sec" type="float" />
</argument>
<argument index="1" name="time_sec" type="float">
</argument>
<description> <description>
Returns the interpolated value at the given time (in seconds). The [code]track_idx[/code] must be the index of a value track. Returns the interpolated value at the given time (in seconds). The [code]track_idx[/code] must be the index of a value track.
</description> </description>
</method> </method>
<method name="value_track_set_update_mode"> <method name="value_track_set_update_mode">
<return type="void"> <return type="void" />
</return> <argument index="0" name="track_idx" type="int" />
<argument index="0" name="track_idx" type="int"> <argument index="1" name="mode" type="int" enum="Animation.UpdateMode" />
</argument>
<argument index="1" name="mode" type="int" enum="Animation.UpdateMode">
</argument>
<description> <description>
Sets the update mode (see [enum UpdateMode]) of a value track. Sets the update mode (see [enum UpdateMode]) of a value track.
</description> </description>

147
doc/classes/AnimationNode.xml
View File

@ -12,58 +12,47 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_get_caption" qualifiers="virtual"> <method name="_get_caption" qualifiers="virtual">
<return type="String"> <return type="String" />
</return>
<description> <description>
Gets the text caption for this node (used by some editors). Gets the text caption for this node (used by some editors).
</description> </description>
</method> </method>
<method name="_get_child_by_name" qualifiers="virtual"> <method name="_get_child_by_name" qualifiers="virtual">
<return type="Object"> <return type="Object" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
Gets a child node by index (used by editors inheriting from [AnimationRootNode]). Gets a child node by index (used by editors inheriting from [AnimationRootNode]).
</description> </description>
</method> </method>
<method name="_get_child_nodes" qualifiers="virtual"> <method name="_get_child_nodes" qualifiers="virtual">
<return type="Dictionary"> <return type="Dictionary" />
</return>
<description> <description>
Gets all children nodes in order as a [code]name: node[/code] dictionary. Only useful when inheriting [AnimationRootNode]. Gets all children nodes in order as a [code]name: node[/code] dictionary. Only useful when inheriting [AnimationRootNode].
</description> </description>
</method> </method>
<method name="_get_parameter_default_value" qualifiers="virtual"> <method name="_get_parameter_default_value" qualifiers="virtual">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
</description> </description>
</method> </method>
<method name="_get_parameter_list" qualifiers="virtual"> <method name="_get_parameter_list" qualifiers="virtual">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Gets the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to [method Object.get_property_list]. Gets the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to [method Object.get_property_list].
</description> </description>
</method> </method>
<method name="_has_filter" qualifiers="virtual"> <method name="_has_filter" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] whether you want the blend tree editor to display filter editing on this node. Returns [code]true[/code] whether you want the blend tree editor to display filter editing on this node.
</description> </description>
</method> </method>
<method name="_process" qualifiers="virtual"> <method name="_process" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="time" type="float" />
<argument index="0" name="time" type="float"> <argument index="1" name="seek" type="bool" />
</argument>
<argument index="1" name="seek" type="bool">
</argument>
<description> <description>
User-defined callback called when a custom node is processed. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. User-defined callback called when a custom node is processed. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute.
Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] to modify local memory. Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] to modify local memory.
@ -71,132 +60,94 @@
</description> </description>
</method> </method>
<method name="add_input"> <method name="add_input">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
Adds an input to the node. This is only useful for nodes created for use in an [AnimationNodeBlendTree]. Adds an input to the node. This is only useful for nodes created for use in an [AnimationNodeBlendTree].
</description> </description>
</method> </method>
<method name="blend_animation"> <method name="blend_animation">
<return type="void"> <return type="void" />
</return> <argument index="0" name="animation" type="StringName" />
<argument index="0" name="animation" type="StringName"> <argument index="1" name="time" type="float" />
</argument> <argument index="2" name="delta" type="float" />
<argument index="1" name="time" type="float"> <argument index="3" name="seeked" type="bool" />
</argument> <argument index="4" name="blend" type="float" />
<argument index="2" name="delta" type="float">
</argument>
<argument index="3" name="seeked" type="bool">
</argument>
<argument index="4" name="blend" type="float">
</argument>
<description> <description>
Blend an animation by [code]blend[/code] amount (name must be valid in the linked [AnimationPlayer]). A [code]time[/code] and [code]delta[/code] may be passed, as well as whether [code]seek[/code] happened. Blend an animation by [code]blend[/code] amount (name must be valid in the linked [AnimationPlayer]). A [code]time[/code] and [code]delta[/code] may be passed, as well as whether [code]seek[/code] happened.
</description> </description>
</method> </method>
<method name="blend_input"> <method name="blend_input">
<return type="float"> <return type="float" />
</return> <argument index="0" name="input_index" type="int" />
<argument index="0" name="input_index" type="int"> <argument index="1" name="time" type="float" />
</argument> <argument index="2" name="seek" type="bool" />
<argument index="1" name="time" type="float"> <argument index="3" name="blend" type="float" />
</argument> <argument index="4" name="filter" type="int" enum="AnimationNode.FilterAction" default="0" />
<argument index="2" name="seek" type="bool"> <argument index="5" name="optimize" type="bool" default="true" />
</argument>
<argument index="3" name="blend" type="float">
</argument>
<argument index="4" name="filter" type="int" enum="AnimationNode.FilterAction" default="0">
</argument>
<argument index="5" name="optimize" type="bool" default="true">
</argument>
<description> <description>
Blend an input. This is only useful for nodes created for an [AnimationNodeBlendTree]. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. A filter mode may be optionally passed (see [enum FilterAction] for options). Blend an input. This is only useful for nodes created for an [AnimationNodeBlendTree]. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. A filter mode may be optionally passed (see [enum FilterAction] for options).
</description> </description>
</method> </method>
<method name="blend_node"> <method name="blend_node">
<return type="float"> <return type="float" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="node" type="AnimationNode" />
</argument> <argument index="2" name="time" type="float" />
<argument index="1" name="node" type="AnimationNode"> <argument index="3" name="seek" type="bool" />
</argument> <argument index="4" name="blend" type="float" />
<argument index="2" name="time" type="float"> <argument index="5" name="filter" type="int" enum="AnimationNode.FilterAction" default="0" />
</argument> <argument index="6" name="optimize" type="bool" default="true" />
<argument index="3" name="seek" type="bool">
</argument>
<argument index="4" name="blend" type="float">
</argument>
<argument index="5" name="filter" type="int" enum="AnimationNode.FilterAction" default="0">
</argument>
<argument index="6" name="optimize" type="bool" default="true">
</argument>
<description> <description>
Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from [AnimationRootNode] instead, else editors will not display your node for addition. Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from [AnimationRootNode] instead, else editors will not display your node for addition.
</description> </description>
</method> </method>
<method name="get_input_count" qualifiers="const"> <method name="get_input_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Amount of inputs in this node, only useful for nodes that go into [AnimationNodeBlendTree]. Amount of inputs in this node, only useful for nodes that go into [AnimationNodeBlendTree].
</description> </description>
</method> </method>
<method name="get_input_name"> <method name="get_input_name">
<return type="String"> <return type="String" />
</return> <argument index="0" name="input" type="int" />
<argument index="0" name="input" type="int">
</argument>
<description> <description>
Gets the name of an input by index. Gets the name of an input by index.
</description> </description>
</method> </method>
<method name="get_parameter" qualifiers="const"> <method name="get_parameter" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
</description> </description>
</method> </method>
<method name="is_path_filtered" qualifiers="const"> <method name="is_path_filtered" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="path" type="NodePath" />
<argument index="0" name="path" type="NodePath">
</argument>
<description> <description>
Returns [code]true[/code] whether a given path is filtered. Returns [code]true[/code] whether a given path is filtered.
</description> </description>
</method> </method>
<method name="remove_input"> <method name="remove_input">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Removes an input, call this only when inactive. Removes an input, call this only when inactive.
</description> </description>
</method> </method>
<method name="set_filter_path"> <method name="set_filter_path">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="NodePath" />
<argument index="0" name="path" type="NodePath"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
Adds or removes a path for the filter. Adds or removes a path for the filter.
</description> </description>
</method> </method>
<method name="set_parameter"> <method name="set_parameter">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="value" type="Variant" />
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<description> <description>
Sets a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes. Sets a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes.
</description> </description>

51
doc/classes/AnimationNodeBlendSpace1D.xml
View File

@ -14,70 +14,53 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_blend_point"> <method name="add_blend_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="node" type="AnimationRootNode" />
<argument index="0" name="node" type="AnimationRootNode"> <argument index="1" name="pos" type="float" />
</argument> <argument index="2" name="at_index" type="int" default="-1" />
<argument index="1" name="pos" type="float">
</argument>
<argument index="2" name="at_index" type="int" default="-1">
</argument>
<description> <description>
Adds a new point that represents a [code]node[/code] on the virtual axis at a given position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. Adds a new point that represents a [code]node[/code] on the virtual axis at a given position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array.
</description> </description>
</method> </method>
<method name="get_blend_point_count" qualifiers="const"> <method name="get_blend_point_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of points on the blend axis. Returns the number of points on the blend axis.
</description> </description>
</method> </method>
<method name="get_blend_point_node" qualifiers="const"> <method name="get_blend_point_node" qualifiers="const">
<return type="AnimationRootNode"> <return type="AnimationRootNode" />
</return> <argument index="0" name="point" type="int" />
<argument index="0" name="point" type="int">
</argument>
<description> <description>
Returns the [AnimationNode] referenced by the point at index [code]point[/code]. Returns the [AnimationNode] referenced by the point at index [code]point[/code].
</description> </description>
</method> </method>
<method name="get_blend_point_position" qualifiers="const"> <method name="get_blend_point_position" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="point" type="int" />
<argument index="0" name="point" type="int">
</argument>
<description> <description>
Returns the position of the point at index [code]point[/code]. Returns the position of the point at index [code]point[/code].
</description> </description>
</method> </method>
<method name="remove_blend_point"> <method name="remove_blend_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="point" type="int" />
<argument index="0" name="point" type="int">
</argument>
<description> <description>
Removes the point at index [code]point[/code] from the blend axis. Removes the point at index [code]point[/code] from the blend axis.
</description> </description>
</method> </method>
<method name="set_blend_point_node"> <method name="set_blend_point_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="point" type="int" />
<argument index="0" name="point" type="int"> <argument index="1" name="node" type="AnimationRootNode" />
</argument>
<argument index="1" name="node" type="AnimationRootNode">
</argument>
<description> <description>
Changes the [AnimationNode] referenced by the point at index [code]point[/code]. Changes the [AnimationNode] referenced by the point at index [code]point[/code].
</description> </description>
</method> </method>
<method name="set_blend_point_position"> <method name="set_blend_point_position">
<return type="void"> <return type="void" />
</return> <argument index="0" name="point" type="int" />
<argument index="0" name="point" type="int"> <argument index="1" name="pos" type="float" />
</argument>
<argument index="1" name="pos" type="float">
</argument>
<description> <description>
Updates the position of the point at index [code]point[/code] on the blend axis. Updates the position of the point at index [code]point[/code] on the blend axis.
</description> </description>

84
doc/classes/AnimationNodeBlendSpace2D.xml
View File

@ -14,112 +14,84 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_blend_point"> <method name="add_blend_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="node" type="AnimationRootNode" />
<argument index="0" name="node" type="AnimationRootNode"> <argument index="1" name="pos" type="Vector2" />
</argument> <argument index="2" name="at_index" type="int" default="-1" />
<argument index="1" name="pos" type="Vector2">
</argument>
<argument index="2" name="at_index" type="int" default="-1">
</argument>
<description> <description>
Adds a new point that represents a [code]node[/code] at the position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. Adds a new point that represents a [code]node[/code] at the position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array.
</description> </description>
</method> </method>
<method name="add_triangle"> <method name="add_triangle">
<return type="void"> <return type="void" />
</return> <argument index="0" name="x" type="int" />
<argument index="0" name="x" type="int"> <argument index="1" name="y" type="int" />
</argument> <argument index="2" name="z" type="int" />
<argument index="1" name="y" type="int"> <argument index="3" name="at_index" type="int" default="-1" />
</argument>
<argument index="2" name="z" type="int">
</argument>
<argument index="3" name="at_index" type="int" default="-1">
</argument>
<description> <description>
Creates a new triangle using three points [code]x[/code], [code]y[/code], and [code]z[/code]. Triangles can overlap. You can insert the triangle at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. Creates a new triangle using three points [code]x[/code], [code]y[/code], and [code]z[/code]. Triangles can overlap. You can insert the triangle at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array.
</description> </description>
</method> </method>
<method name="get_blend_point_count" qualifiers="const"> <method name="get_blend_point_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of points in the blend space. Returns the number of points in the blend space.
</description> </description>
</method> </method>
<method name="get_blend_point_node" qualifiers="const"> <method name="get_blend_point_node" qualifiers="const">
<return type="AnimationRootNode"> <return type="AnimationRootNode" />
</return> <argument index="0" name="point" type="int" />
<argument index="0" name="point" type="int">
</argument>
<description> <description>
Returns the [AnimationRootNode] referenced by the point at index [code]point[/code]. Returns the [AnimationRootNode] referenced by the point at index [code]point[/code].
</description> </description>
</method> </method>
<method name="get_blend_point_position" qualifiers="const"> <method name="get_blend_point_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="point" type="int" />
<argument index="0" name="point" type="int">
</argument>
<description> <description>
Returns the position of the point at index [code]point[/code]. Returns the position of the point at index [code]point[/code].
</description> </description>
</method> </method>
<method name="get_triangle_count" qualifiers="const"> <method name="get_triangle_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of triangles in the blend space. Returns the number of triangles in the blend space.
</description> </description>
</method> </method>
<method name="get_triangle_point"> <method name="get_triangle_point">
<return type="int"> <return type="int" />
</return> <argument index="0" name="triangle" type="int" />
<argument index="0" name="triangle" type="int"> <argument index="1" name="point" type="int" />
</argument>
<argument index="1" name="point" type="int">
</argument>
<description> <description>
Returns the position of the point at index [code]point[/code] in the triangle of index [code]triangle[/code]. Returns the position of the point at index [code]point[/code] in the triangle of index [code]triangle[/code].
</description> </description>
</method> </method>
<method name="remove_blend_point"> <method name="remove_blend_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="point" type="int" />
<argument index="0" name="point" type="int">
</argument>
<description> <description>
Removes the point at index [code]point[/code] from the blend space. Removes the point at index [code]point[/code] from the blend space.
</description> </description>
</method> </method>
<method name="remove_triangle"> <method name="remove_triangle">
<return type="void"> <return type="void" />
</return> <argument index="0" name="triangle" type="int" />
<argument index="0" name="triangle" type="int">
</argument>
<description> <description>
Removes the triangle at index [code]triangle[/code] from the blend space. Removes the triangle at index [code]triangle[/code] from the blend space.
</description> </description>
</method> </method>
<method name="set_blend_point_node"> <method name="set_blend_point_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="point" type="int" />
<argument index="0" name="point" type="int"> <argument index="1" name="node" type="AnimationRootNode" />
</argument>
<argument index="1" name="node" type="AnimationRootNode">
</argument>
<description> <description>
Changes the [AnimationNode] referenced by the point at index [code]point[/code]. Changes the [AnimationNode] referenced by the point at index [code]point[/code].
</description> </description>
</method> </method>
<method name="set_blend_point_position"> <method name="set_blend_point_position">
<return type="void"> <return type="void" />
</return> <argument index="0" name="point" type="int" />
<argument index="0" name="point" type="int"> <argument index="1" name="pos" type="Vector2" />
</argument>
<argument index="1" name="pos" type="Vector2">
</argument>
<description> <description>
Updates the position of the point at index [code]point[/code] on the blend axis. Updates the position of the point at index [code]point[/code] on the blend axis.
</description> </description>

75
doc/classes/AnimationNodeBlendTree.xml
View File

@ -11,96 +11,71 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_node"> <method name="add_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="node" type="AnimationNode" />
</argument> <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" />
<argument index="1" name="node" type="AnimationNode">
</argument>
<argument index="2" name="position" type="Vector2" default="Vector2(0, 0)">
</argument>
<description> <description>
Adds an [AnimationNode] at the given [code]position[/code]. The [code]name[/code] is used to identify the created sub-node later. Adds an [AnimationNode] at the given [code]position[/code]. The [code]name[/code] is used to identify the created sub-node later.
</description> </description>
</method> </method>
<method name="connect_node"> <method name="connect_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="input_node" type="StringName" />
<argument index="0" name="input_node" type="StringName"> <argument index="1" name="input_index" type="int" />
</argument> <argument index="2" name="output_node" type="StringName" />
<argument index="1" name="input_index" type="int">
</argument>
<argument index="2" name="output_node" type="StringName">
</argument>
<description> <description>
Connects the output of an [AnimationNode] as input for another [AnimationNode], at the input port specified by [code]input_index[/code]. Connects the output of an [AnimationNode] as input for another [AnimationNode], at the input port specified by [code]input_index[/code].
</description> </description>
</method> </method>
<method name="disconnect_node"> <method name="disconnect_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="input_node" type="StringName" />
<argument index="0" name="input_node" type="StringName"> <argument index="1" name="input_index" type="int" />
</argument>
<argument index="1" name="input_index" type="int">
</argument>
<description> <description>
Disconnects the node connected to the specified input. Disconnects the node connected to the specified input.
</description> </description>
</method> </method>
<method name="get_node" qualifiers="const"> <method name="get_node" qualifiers="const">
<return type="AnimationNode"> <return type="AnimationNode" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns the sub-node with the specified [code]name[/code]. Returns the sub-node with the specified [code]name[/code].
</description> </description>
</method> </method>
<method name="get_node_position" qualifiers="const"> <method name="get_node_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns the position of the sub-node with the specified [code]name[/code]. Returns the position of the sub-node with the specified [code]name[/code].
</description> </description>
</method> </method>
<method name="has_node" qualifiers="const"> <method name="has_node" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if a sub-node with specified [code]name[/code] exists. Returns [code]true[/code] if a sub-node with specified [code]name[/code] exists.
</description> </description>
</method> </method>
<method name="remove_node"> <method name="remove_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Removes a sub-node. Removes a sub-node.
</description> </description>
</method> </method>
<method name="rename_node"> <method name="rename_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="new_name" type="StringName" />
</argument>
<argument index="1" name="new_name" type="StringName">
</argument>
<description> <description>
Changes the name of a sub-node. Changes the name of a sub-node.
</description> </description>
</method> </method>
<method name="set_node_position"> <method name="set_node_position">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="position" type="Vector2" />
</argument>
<argument index="1" name="position" type="Vector2">
</argument>
<description> <description>
Modifies the position of a sub-node. Modifies the position of a sub-node.
</description> </description>

9
doc/classes/AnimationNodeOneShot.xml
View File

@ -12,16 +12,13 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_mix_mode" qualifiers="const"> <method name="get_mix_mode" qualifiers="const">
<return type="int" enum="AnimationNodeOneShot.MixMode"> <return type="int" enum="AnimationNodeOneShot.MixMode" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="set_mix_mode"> <method name="set_mix_mode">
<return type="void"> <return type="void" />
</return> <argument index="0" name="mode" type="int" enum="AnimationNodeOneShot.MixMode" />
<argument index="0" name="mode" type="int" enum="AnimationNodeOneShot.MixMode">
</argument>
<description> <description>
</description> </description>
</method> </method>

153
doc/classes/AnimationNodeStateMachine.xml
View File

@ -22,217 +22,166 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_node"> <method name="add_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="node" type="AnimationNode" />
</argument> <argument index="2" name="position" type="Vector2" default="Vector2(0, 0)" />
<argument index="1" name="node" type="AnimationNode">
</argument>
<argument index="2" name="position" type="Vector2" default="Vector2(0, 0)">
</argument>
<description> <description>
Adds a new node to the graph. The [code]position[/code] is used for display in the editor. Adds a new node to the graph. The [code]position[/code] is used for display in the editor.
</description> </description>
</method> </method>
<method name="add_transition"> <method name="add_transition">
<return type="void"> <return type="void" />
</return> <argument index="0" name="from" type="StringName" />
<argument index="0" name="from" type="StringName"> <argument index="1" name="to" type="StringName" />
</argument> <argument index="2" name="transition" type="AnimationNodeStateMachineTransition" />
<argument index="1" name="to" type="StringName">
</argument>
<argument index="2" name="transition" type="AnimationNodeStateMachineTransition">
</argument>
<description> <description>
Adds a transition between the given nodes. Adds a transition between the given nodes.
</description> </description>
</method> </method>
<method name="get_end_node" qualifiers="const"> <method name="get_end_node" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
Returns the graph's end node. Returns the graph's end node.
</description> </description>
</method> </method>
<method name="get_graph_offset" qualifiers="const"> <method name="get_graph_offset" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns the draw offset of the graph. Used for display in the editor. Returns the draw offset of the graph. Used for display in the editor.
</description> </description>
</method> </method>
<method name="get_node" qualifiers="const"> <method name="get_node" qualifiers="const">
<return type="AnimationNode"> <return type="AnimationNode" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns the animation node with the given name. Returns the animation node with the given name.
</description> </description>
</method> </method>
<method name="get_node_name" qualifiers="const"> <method name="get_node_name" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="node" type="AnimationNode" />
<argument index="0" name="node" type="AnimationNode">
</argument>
<description> <description>
Returns the given animation node's name. Returns the given animation node's name.
</description> </description>
</method> </method>
<method name="get_node_position" qualifiers="const"> <method name="get_node_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns the given node's coordinates. Used for display in the editor. Returns the given node's coordinates. Used for display in the editor.
</description> </description>
</method> </method>
<method name="get_start_node" qualifiers="const"> <method name="get_start_node" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
Returns the graph's end node. Returns the graph's end node.
</description> </description>
</method> </method>
<method name="get_transition" qualifiers="const"> <method name="get_transition" qualifiers="const">
<return type="AnimationNodeStateMachineTransition"> <return type="AnimationNodeStateMachineTransition" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the given transition. Returns the given transition.
</description> </description>
</method> </method>
<method name="get_transition_count" qualifiers="const"> <method name="get_transition_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of connections in the graph. Returns the number of connections in the graph.
</description> </description>
</method> </method>
<method name="get_transition_from" qualifiers="const"> <method name="get_transition_from" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the given transition's start node. Returns the given transition's start node.
</description> </description>
</method> </method>
<method name="get_transition_to" qualifiers="const"> <method name="get_transition_to" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the given transition's end node. Returns the given transition's end node.
</description> </description>
</method> </method>
<method name="has_node" qualifiers="const"> <method name="has_node" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if the graph contains the given node. Returns [code]true[/code] if the graph contains the given node.
</description> </description>
</method> </method>
<method name="has_transition" qualifiers="const"> <method name="has_transition" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="from" type="StringName" />
<argument index="0" name="from" type="StringName"> <argument index="1" name="to" type="StringName" />
</argument>
<argument index="1" name="to" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if there is a transition between the given nodes. Returns [code]true[/code] if there is a transition between the given nodes.
</description> </description>
</method> </method>
<method name="remove_node"> <method name="remove_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Deletes the given node from the graph. Deletes the given node from the graph.
</description> </description>
</method> </method>
<method name="remove_transition"> <method name="remove_transition">
<return type="void"> <return type="void" />
</return> <argument index="0" name="from" type="StringName" />
<argument index="0" name="from" type="StringName"> <argument index="1" name="to" type="StringName" />
</argument>
<argument index="1" name="to" type="StringName">
</argument>
<description> <description>
Deletes the transition between the two specified nodes. Deletes the transition between the two specified nodes.
</description> </description>
</method> </method>
<method name="remove_transition_by_index"> <method name="remove_transition_by_index">
<return type="void"> <return type="void" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Deletes the given transition by index. Deletes the given transition by index.
</description> </description>
</method> </method>
<method name="rename_node"> <method name="rename_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="new_name" type="StringName" />
</argument>
<argument index="1" name="new_name" type="StringName">
</argument>
<description> <description>
Renames the given node. Renames the given node.
</description> </description>
</method> </method>
<method name="replace_node"> <method name="replace_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="node" type="AnimationNode" />
</argument>
<argument index="1" name="node" type="AnimationNode">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_end_node"> <method name="set_end_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Sets the given node as the graph end point. Sets the given node as the graph end point.
</description> </description>
</method> </method>
<method name="set_graph_offset"> <method name="set_graph_offset">
<return type="void"> <return type="void" />
</return> <argument index="0" name="offset" type="Vector2" />
<argument index="0" name="offset" type="Vector2">
</argument>
<description> <description>
Sets the draw offset of the graph. Used for display in the editor. Sets the draw offset of the graph. Used for display in the editor.
</description> </description>
</method> </method>
<method name="set_node_position"> <method name="set_node_position">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="position" type="Vector2" />
</argument>
<argument index="1" name="position" type="Vector2">
</argument>
<description> <description>
Sets the node's coordinates. Used for display in the editor. Sets the node's coordinates. Used for display in the editor.
</description> </description>
</method> </method>
<method name="set_start_node"> <method name="set_start_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Sets the given node as the graph start point. Sets the given node as the graph start point.
</description> </description>

30
doc/classes/AnimationNodeStateMachinePlayback.xml
View File

@ -22,60 +22,50 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_current_length" qualifiers="const"> <method name="get_current_length" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="get_current_node" qualifiers="const"> <method name="get_current_node" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return>
<description> <description>
Returns the currently playing animation state. Returns the currently playing animation state.
</description> </description>
</method> </method>
<method name="get_current_play_position" qualifiers="const"> <method name="get_current_play_position" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the playback position within the current animation state. Returns the playback position within the current animation state.
</description> </description>
</method> </method>
<method name="get_travel_path" qualifiers="const"> <method name="get_travel_path" qualifiers="const">
<return type="PackedStringArray"> <return type="PackedStringArray" />
</return>
<description> <description>
Returns the current travel path as computed internally by the A* algorithm. Returns the current travel path as computed internally by the A* algorithm.
</description> </description>
</method> </method>
<method name="is_playing" qualifiers="const"> <method name="is_playing" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if an animation is playing. Returns [code]true[/code] if an animation is playing.
</description> </description>
</method> </method>
<method name="start"> <method name="start">
<return type="void"> <return type="void" />
</return> <argument index="0" name="node" type="StringName" />
<argument index="0" name="node" type="StringName">
</argument>
<description> <description>
Starts playing the given animation. Starts playing the given animation.
</description> </description>
</method> </method>
<method name="stop"> <method name="stop">
<return type="void"> <return type="void" />
</return>
<description> <description>
Stops the currently playing animation. Stops the currently playing animation.
</description> </description>
</method> </method>
<method name="travel"> <method name="travel">
<return type="void"> <return type="void" />
</return> <argument index="0" name="to_node" type="StringName" />
<argument index="0" name="to_node" type="StringName">
</argument>
<description> <description>
Transitions from the current state to another one, following the shortest path. Transitions from the current state to another one, following the shortest path.
</description> </description>

30
doc/classes/AnimationNodeTransition.xml
View File

@ -13,38 +13,28 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_input_caption" qualifiers="const"> <method name="get_input_caption" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="input" type="int" />
<argument index="0" name="input" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="is_input_set_as_auto_advance" qualifiers="const"> <method name="is_input_set_as_auto_advance" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="input" type="int" />
<argument index="0" name="input" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_input_as_auto_advance"> <method name="set_input_as_auto_advance">
<return type="void"> <return type="void" />
</return> <argument index="0" name="input" type="int" />
<argument index="0" name="input" type="int"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_input_caption"> <method name="set_input_caption">
<return type="void"> <return type="void" />
</return> <argument index="0" name="input" type="int" />
<argument index="0" name="input" type="int"> <argument index="1" name="caption" type="String" />
</argument>
<argument index="1" name="caption" type="String">
</argument>
<description> <description>
</description> </description>
</method> </method>

159
doc/classes/AnimationPlayer.xml
View File

@ -15,136 +15,106 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_animation"> <method name="add_animation">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="animation" type="Animation" />
</argument>
<argument index="1" name="animation" type="Animation">
</argument>
<description> <description>
Adds [code]animation[/code] to the player accessible with the key [code]name[/code]. Adds [code]animation[/code] to the player accessible with the key [code]name[/code].
</description> </description>
</method> </method>
<method name="advance"> <method name="advance">
<return type="void"> <return type="void" />
</return> <argument index="0" name="delta" type="float" />
<argument index="0" name="delta" type="float">
</argument>
<description> <description>
Shifts position in the animation timeline and immediately updates the animation. [code]delta[/code] is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled. Shifts position in the animation timeline and immediately updates the animation. [code]delta[/code] is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled.
</description> </description>
</method> </method>
<method name="animation_get_next" qualifiers="const"> <method name="animation_get_next" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="anim_from" type="StringName" />
<argument index="0" name="anim_from" type="StringName">
</argument>
<description> <description>
Returns the name of the next animation in the queue. Returns the name of the next animation in the queue.
</description> </description>
</method> </method>
<method name="animation_set_next"> <method name="animation_set_next">
<return type="void"> <return type="void" />
</return> <argument index="0" name="anim_from" type="StringName" />
<argument index="0" name="anim_from" type="StringName"> <argument index="1" name="anim_to" type="StringName" />
</argument>
<argument index="1" name="anim_to" type="StringName">
</argument>
<description> <description>
Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes. Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes.
</description> </description>
</method> </method>
<method name="clear_caches"> <method name="clear_caches">
<return type="void"> <return type="void" />
</return>
<description> <description>
[AnimationPlayer] caches animated nodes. It may not notice if a node disappears; [method clear_caches] forces it to update the cache again. [AnimationPlayer] caches animated nodes. It may not notice if a node disappears; [method clear_caches] forces it to update the cache again.
</description> </description>
</method> </method>
<method name="clear_queue"> <method name="clear_queue">
<return type="void"> <return type="void" />
</return>
<description> <description>
Clears all queued, unplayed animations. Clears all queued, unplayed animations.
</description> </description>
</method> </method>
<method name="find_animation" qualifiers="const"> <method name="find_animation" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="animation" type="Animation" />
<argument index="0" name="animation" type="Animation">
</argument>
<description> <description>
Returns the name of [code]animation[/code] or an empty string if not found. Returns the name of [code]animation[/code] or an empty string if not found.
</description> </description>
</method> </method>
<method name="get_animation" qualifiers="const"> <method name="get_animation" qualifiers="const">
<return type="Animation"> <return type="Animation" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found. Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found.
</description> </description>
</method> </method>
<method name="get_animation_list" qualifiers="const"> <method name="get_animation_list" qualifiers="const">
<return type="PackedStringArray"> <return type="PackedStringArray" />
</return>
<description> <description>
Returns the list of stored animation names. Returns the list of stored animation names.
</description> </description>
</method> </method>
<method name="get_blend_time" qualifiers="const"> <method name="get_blend_time" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="anim_from" type="StringName" />
<argument index="0" name="anim_from" type="StringName"> <argument index="1" name="anim_to" type="StringName" />
</argument>
<argument index="1" name="anim_to" type="StringName">
</argument>
<description> <description>
Gets the blend time (in seconds) between two animations, referenced by their names. Gets the blend time (in seconds) between two animations, referenced by their names.
</description> </description>
</method> </method>
<method name="get_playing_speed" qualifiers="const"> <method name="get_playing_speed" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Gets the actual playing speed of current animation or 0 if not playing. This speed is the [member playback_speed] property multiplied by [code]custom_speed[/code] argument specified when calling the [method play] method. Gets the actual playing speed of current animation or 0 if not playing. This speed is the [member playback_speed] property multiplied by [code]custom_speed[/code] argument specified when calling the [method play] method.
</description> </description>
</method> </method>
<method name="get_queue"> <method name="get_queue">
<return type="PackedStringArray"> <return type="PackedStringArray" />
</return>
<description> <description>
Returns a list of the animation names that are currently queued to play. Returns a list of the animation names that are currently queued to play.
</description> </description>
</method> </method>
<method name="has_animation" qualifiers="const"> <method name="has_animation" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code]. Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code].
</description> </description>
</method> </method>
<method name="is_playing" qualifiers="const"> <method name="is_playing" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if playing an animation. Returns [code]true[/code] if playing an animation.
</description> </description>
</method> </method>
<method name="play"> <method name="play">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" default="&quot;&quot;" />
<argument index="0" name="name" type="StringName" default="&quot;&quot;"> <argument index="1" name="custom_blend" type="float" default="-1" />
</argument> <argument index="2" name="custom_speed" type="float" default="1.0" />
<argument index="1" name="custom_blend" type="float" default="-1"> <argument index="3" name="from_end" type="bool" default="false" />
</argument>
<argument index="2" name="custom_speed" type="float" default="1.0">
</argument>
<argument index="3" name="from_end" type="bool" default="false">
</argument>
<description> <description>
Plays the animation with key [code]name[/code]. Custom blend times and speed can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]). Plays the animation with key [code]name[/code]. Custom blend times and speed can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]).
The [AnimationPlayer] keeps track of its current or last played animation with [member assigned_animation]. If this method is called with that same animation [code]name[/code], or with no [code]name[/code] parameter, the assigned animation will resume playing if it was paused, or restart if it was stopped (see [method stop] for both pause and stop). If the animation was already playing, it will keep playing. The [AnimationPlayer] keeps track of its current or last played animation with [member assigned_animation]. If this method is called with that same animation [code]name[/code], or with no [code]name[/code] parameter, the assigned animation will resume playing if it was paused, or restart if it was stopped (see [method stop] for both pause and stop). If the animation was already playing, it will keep playing.
@ -152,76 +122,57 @@
</description> </description>
</method> </method>
<method name="play_backwards"> <method name="play_backwards">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" default="&quot;&quot;" />
<argument index="0" name="name" type="StringName" default="&quot;&quot;"> <argument index="1" name="custom_blend" type="float" default="-1" />
</argument>
<argument index="1" name="custom_blend" type="float" default="-1">
</argument>
<description> <description>
Plays the animation with key [code]name[/code] in reverse. Plays the animation with key [code]name[/code] in reverse.
This method is a shorthand for [method play] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], so see its description for more information. This method is a shorthand for [method play] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], so see its description for more information.
</description> </description>
</method> </method>
<method name="queue"> <method name="queue">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Queues an animation for playback once the current one is done. Queues an animation for playback once the current one is done.
[b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow. [b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow.
</description> </description>
</method> </method>
<method name="remove_animation"> <method name="remove_animation">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Removes the animation with key [code]name[/code]. Removes the animation with key [code]name[/code].
</description> </description>
</method> </method>
<method name="rename_animation"> <method name="rename_animation">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="newname" type="StringName" />
</argument>
<argument index="1" name="newname" type="StringName">
</argument>
<description> <description>
Renames an existing animation with key [code]name[/code] to [code]newname[/code]. Renames an existing animation with key [code]name[/code] to [code]newname[/code].
</description> </description>
</method> </method>
<method name="seek"> <method name="seek">
<return type="void"> <return type="void" />
</return> <argument index="0" name="seconds" type="float" />
<argument index="0" name="seconds" type="float"> <argument index="1" name="update" type="bool" default="false" />
</argument>
<argument index="1" name="update" type="bool" default="false">
</argument>
<description> <description>
Seeks the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped. Seeks the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped.
</description> </description>
</method> </method>
<method name="set_blend_time"> <method name="set_blend_time">
<return type="void"> <return type="void" />
</return> <argument index="0" name="anim_from" type="StringName" />
<argument index="0" name="anim_from" type="StringName"> <argument index="1" name="anim_to" type="StringName" />
</argument> <argument index="2" name="sec" type="float" />
<argument index="1" name="anim_to" type="StringName">
</argument>
<argument index="2" name="sec" type="float">
</argument>
<description> <description>
Specifies a blend time (in seconds) between two animations, referenced by their names. Specifies a blend time (in seconds) between two animations, referenced by their names.
</description> </description>
</method> </method>
<method name="stop"> <method name="stop">
<return type="void"> <return type="void" />
</return> <argument index="0" name="reset" type="bool" default="true" />
<argument index="0" name="reset" type="bool" default="true">
</argument>
<description> <description>
Stops or pauses the currently playing animation. If [code]reset[/code] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. Stops or pauses the currently playing animation. If [code]reset[/code] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code].
If [code]reset[/code] is [code]false[/code], the [member current_animation_position] will be kept and calling [method play] or [method play_backwards] without arguments or with the same animation name as [member assigned_animation] will resume the animation. If [code]reset[/code] is [code]false[/code], the [member current_animation_position] will be kept and calling [method play] or [method play_backwards] without arguments or with the same animation name as [member assigned_animation] will resume the animation.
@ -270,25 +221,21 @@
</members> </members>
<signals> <signals>
<signal name="animation_changed"> <signal name="animation_changed">
<argument index="0" name="old_name" type="StringName"> <argument index="0" name="old_name" type="StringName" />
</argument> <argument index="1" name="new_name" type="StringName" />
<argument index="1" name="new_name" type="StringName">
</argument>
<description> <description>
Emitted when a queued animation plays after the previous animation was finished. See [method queue]. Emitted when a queued animation plays after the previous animation was finished. See [method queue].
[b]Note:[/b] The signal is not emitted when the animation is changed via [method play] or from [AnimationTree]. [b]Note:[/b] The signal is not emitted when the animation is changed via [method play] or from [AnimationTree].
</description> </description>
</signal> </signal>
<signal name="animation_finished"> <signal name="animation_finished">
<argument index="0" name="anim_name" type="StringName"> <argument index="0" name="anim_name" type="StringName" />
</argument>
<description> <description>
Notifies when an animation finished playing. Notifies when an animation finished playing.
</description> </description>
</signal> </signal>
<signal name="animation_started"> <signal name="animation_started">
<argument index="0" name="anim_name" type="StringName"> <argument index="0" name="anim_name" type="StringName" />
</argument>
<description> <description>
Notifies when an animation starts playing. Notifies when an animation starts playing.
</description> </description>

18
doc/classes/AnimationTree.xml
View File

@ -12,28 +12,22 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="advance"> <method name="advance">
<return type="void"> <return type="void" />
</return> <argument index="0" name="delta" type="float" />
<argument index="0" name="delta" type="float">
</argument>
<description> <description>
Manually advance the animations by the specified time (in seconds). Manually advance the animations by the specified time (in seconds).
</description> </description>
</method> </method>
<method name="get_root_motion_transform" qualifiers="const"> <method name="get_root_motion_transform" qualifiers="const">
<return type="Transform3D"> <return type="Transform3D" />
</return>
<description> <description>
Retrieve the motion of the [member root_motion_track] as a [Transform3D] that can be used elsewhere. If [member root_motion_track] is not a path to a track of type [constant Animation.TYPE_TRANSFORM3D], returns an identity transformation. See also [member root_motion_track] and [RootMotionView]. Retrieve the motion of the [member root_motion_track] as a [Transform3D] that can be used elsewhere. If [member root_motion_track] is not a path to a track of type [constant Animation.TYPE_TRANSFORM3D], returns an identity transformation. See also [member root_motion_track] and [RootMotionView].
</description> </description>
</method> </method>
<method name="rename_parameter"> <method name="rename_parameter">
<return type="void"> <return type="void" />
</return> <argument index="0" name="old_name" type="String" />
<argument index="0" name="old_name" type="String"> <argument index="1" name="new_name" type="String" />
</argument>
<argument index="1" name="new_name" type="String">
</argument>
<description> <description>
</description> </description>
</method> </method>

78
doc/classes/Area2D.xml
View File

@ -14,34 +14,28 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_overlapping_areas" qualifiers="const"> <method name="get_overlapping_areas" qualifiers="const">
<return type="Area2D[]"> <return type="Area2D[]" />
</return>
<description> <description>
Returns a list of intersecting [Area2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. Returns a list of intersecting [Area2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
</description> </description>
</method> </method>
<method name="get_overlapping_bodies" qualifiers="const"> <method name="get_overlapping_bodies" qualifiers="const">
<return type="Node2D[]"> <return type="Node2D[]" />
</return>
<description> <description>
Returns a list of intersecting [PhysicsBody2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. Returns a list of intersecting [PhysicsBody2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
</description> </description>
</method> </method>
<method name="overlaps_area" qualifiers="const"> <method name="overlaps_area" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="area" type="Node" />
<argument index="0" name="area" type="Node">
</argument>
<description> <description>
If [code]true[/code], the given area overlaps the Area2D. If [code]true[/code], the given area overlaps the Area2D.
[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, the list of overlaps is updated once per frame and before the physics step. Consider using signals instead. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, the list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
</description> </description>
</method> </method>
<method name="overlaps_body" qualifiers="const"> <method name="overlaps_body" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="body" type="Node" />
<argument index="0" name="body" type="Node">
</argument>
<description> <description>
If [code]true[/code], the given physics body overlaps the Area2D. If [code]true[/code], the given physics body overlaps the Area2D.
[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
@ -91,30 +85,24 @@
</members> </members>
<signals> <signals>
<signal name="area_entered"> <signal name="area_entered">
<argument index="0" name="area" type="Area2D"> <argument index="0" name="area" type="Area2D" />
</argument>
<description> <description>
Emitted when another Area2D enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. Emitted when another Area2D enters this Area2D. Requires [member monitoring] to be set to [code]true[/code].
[code]area[/code] the other Area2D. [code]area[/code] the other Area2D.
</description> </description>
</signal> </signal>
<signal name="area_exited"> <signal name="area_exited">
<argument index="0" name="area" type="Area2D"> <argument index="0" name="area" type="Area2D" />
</argument>
<description> <description>
Emitted when another Area2D exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. Emitted when another Area2D exits this Area2D. Requires [member monitoring] to be set to [code]true[/code].
[code]area[/code] the other Area2D. [code]area[/code] the other Area2D.
</description> </description>
</signal> </signal>
<signal name="area_shape_entered"> <signal name="area_shape_entered">
<argument index="0" name="area_rid" type="RID"> <argument index="0" name="area_rid" type="RID" />
</argument> <argument index="1" name="area" type="Area2D" />
<argument index="1" name="area" type="Area2D"> <argument index="2" name="area_shape" type="int" />
</argument> <argument index="3" name="local_shape" type="int" />
<argument index="2" name="area_shape" type="int">
</argument>
<argument index="3" name="local_shape" type="int">
</argument>
<description> <description>
Emitted when one of another Area2D's [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. Emitted when one of another Area2D's [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code].
[code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. [code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D].
@ -124,14 +112,10 @@
</description> </description>
</signal> </signal>
<signal name="area_shape_exited"> <signal name="area_shape_exited">
<argument index="0" name="area_rid" type="RID"> <argument index="0" name="area_rid" type="RID" />
</argument> <argument index="1" name="area" type="Area2D" />
<argument index="1" name="area" type="Area2D"> <argument index="2" name="area_shape" type="int" />
</argument> <argument index="3" name="local_shape" type="int" />
<argument index="2" name="area_shape" type="int">
</argument>
<argument index="3" name="local_shape" type="int">
</argument>
<description> <description>
Emitted when one of another Area2D's [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. Emitted when one of another Area2D's [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code].
[code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. [code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D].
@ -141,30 +125,24 @@
</description> </description>
</signal> </signal>
<signal name="body_entered"> <signal name="body_entered">
<argument index="0" name="body" type="Node2D"> <argument index="0" name="body" type="Node2D" />
</argument>
<description> <description>
Emitted when a [PhysicsBody2D] or [TileMap] enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. Emitted when a [PhysicsBody2D] or [TileMap] enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s.
[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap].
</description> </description>
</signal> </signal>
<signal name="body_exited"> <signal name="body_exited">
<argument index="0" name="body" type="Node2D"> <argument index="0" name="body" type="Node2D" />
</argument>
<description> <description>
Emitted when a [PhysicsBody2D] or [TileMap] exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. Emitted when a [PhysicsBody2D] or [TileMap] exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s.
[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap].
</description> </description>
</signal> </signal>
<signal name="body_shape_entered"> <signal name="body_shape_entered">
<argument index="0" name="body_rid" type="RID"> <argument index="0" name="body_rid" type="RID" />
</argument> <argument index="1" name="body" type="Node2D" />
<argument index="1" name="body" type="Node2D"> <argument index="2" name="body_shape" type="int" />
</argument> <argument index="3" name="local_shape" type="int" />
<argument index="2" name="body_shape" type="int">
</argument>
<argument index="3" name="local_shape" type="int">
</argument>
<description> <description>
Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s.
[code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. [code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D].
@ -174,14 +152,10 @@
</description> </description>
</signal> </signal>
<signal name="body_shape_exited"> <signal name="body_shape_exited">
<argument index="0" name="body_rid" type="RID"> <argument index="0" name="body_rid" type="RID" />
</argument> <argument index="1" name="body" type="Node2D" />
<argument index="1" name="body" type="Node2D"> <argument index="2" name="body_shape" type="int" />
</argument> <argument index="3" name="local_shape" type="int" />
<argument index="2" name="body_shape" type="int">
</argument>
<argument index="3" name="local_shape" type="int">
</argument>
<description> <description>
Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s.
[code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. [code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D].

78
doc/classes/Area3D.xml
View File

@ -12,34 +12,28 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_overlapping_areas" qualifiers="const"> <method name="get_overlapping_areas" qualifiers="const">
<return type="Area3D[]"> <return type="Area3D[]" />
</return>
<description> <description>
Returns a list of intersecting [Area3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. Returns a list of intersecting [Area3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
</description> </description>
</method> </method>
<method name="get_overlapping_bodies" qualifiers="const"> <method name="get_overlapping_bodies" qualifiers="const">
<return type="Node3D[]"> <return type="Node3D[]" />
</return>
<description> <description>
Returns a list of intersecting [PhysicsBody3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. Returns a list of intersecting [PhysicsBody3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
</description> </description>
</method> </method>
<method name="overlaps_area" qualifiers="const"> <method name="overlaps_area" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="area" type="Node" />
<argument index="0" name="area" type="Node">
</argument>
<description> <description>
If [code]true[/code], the given area overlaps the Area3D. If [code]true[/code], the given area overlaps the Area3D.
[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
</description> </description>
</method> </method>
<method name="overlaps_body" qualifiers="const"> <method name="overlaps_body" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="body" type="Node" />
<argument index="0" name="body" type="Node">
</argument>
<description> <description>
If [code]true[/code], the given physics body overlaps the Area3D. If [code]true[/code], the given physics body overlaps the Area3D.
[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
@ -101,30 +95,24 @@
</members> </members>
<signals> <signals>
<signal name="area_entered"> <signal name="area_entered">
<argument index="0" name="area" type="Area3D"> <argument index="0" name="area" type="Area3D" />
</argument>
<description> <description>
Emitted when another Area3D enters this Area3D. Requires [member monitoring] to be set to [code]true[/code]. Emitted when another Area3D enters this Area3D. Requires [member monitoring] to be set to [code]true[/code].
[code]area[/code] the other Area3D. [code]area[/code] the other Area3D.
</description> </description>
</signal> </signal>
<signal name="area_exited"> <signal name="area_exited">
<argument index="0" name="area" type="Area3D"> <argument index="0" name="area" type="Area3D" />
</argument>
<description> <description>
Emitted when another Area3D exits this Area3D. Requires [member monitoring] to be set to [code]true[/code]. Emitted when another Area3D exits this Area3D. Requires [member monitoring] to be set to [code]true[/code].
[code]area[/code] the other Area3D. [code]area[/code] the other Area3D.
</description> </description>
</signal> </signal>
<signal name="area_shape_entered"> <signal name="area_shape_entered">
<argument index="0" name="area_rid" type="RID"> <argument index="0" name="area_rid" type="RID" />
</argument> <argument index="1" name="area" type="Area3D" />
<argument index="1" name="area" type="Area3D"> <argument index="2" name="area_shape" type="int" />
</argument> <argument index="3" name="local_shape" type="int" />
<argument index="2" name="area_shape" type="int">
</argument>
<argument index="3" name="local_shape" type="int">
</argument>
<description> <description>
Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code].
[code]area_id[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. [code]area_id[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D].
@ -134,14 +122,10 @@
</description> </description>
</signal> </signal>
<signal name="area_shape_exited"> <signal name="area_shape_exited">
<argument index="0" name="area_rid" type="RID"> <argument index="0" name="area_rid" type="RID" />
</argument> <argument index="1" name="area" type="Area3D" />
<argument index="1" name="area" type="Area3D"> <argument index="2" name="area_shape" type="int" />
</argument> <argument index="3" name="local_shape" type="int" />
<argument index="2" name="area_shape" type="int">
</argument>
<argument index="3" name="local_shape" type="int">
</argument>
<description> <description>
Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. Emitted when one of another Area3D's [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code].
[code]area_id[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D]. [code]area_id[/code] the [RID] of the other Area3D's [CollisionObject3D] used by the [PhysicsServer3D].
@ -151,30 +135,24 @@
</description> </description>
</signal> </signal>
<signal name="body_entered"> <signal name="body_entered">
<argument index="0" name="body" type="Node3D"> <argument index="0" name="body" type="Node3D" />
</argument>
<description> <description>
Emitted when a [PhysicsBody3D] or [GridMap] enters this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. Emitted when a [PhysicsBody3D] or [GridMap] enters this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s.
[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap].
</description> </description>
</signal> </signal>
<signal name="body_exited"> <signal name="body_exited">
<argument index="0" name="body" type="Node3D"> <argument index="0" name="body" type="Node3D" />
</argument>
<description> <description>
Emitted when a [PhysicsBody3D] or [GridMap] exits this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. Emitted when a [PhysicsBody3D] or [GridMap] exits this Area3D. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s.
[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap]. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody3D] or [GridMap].
</description> </description>
</signal> </signal>
<signal name="body_shape_entered"> <signal name="body_shape_entered">
<argument index="0" name="body_rid" type="RID"> <argument index="0" name="body_rid" type="RID" />
</argument> <argument index="1" name="body" type="Node3D" />
<argument index="1" name="body" type="Node3D"> <argument index="2" name="body_shape" type="int" />
</argument> <argument index="3" name="local_shape" type="int" />
<argument index="2" name="body_shape" type="int">
</argument>
<argument index="3" name="local_shape" type="int">
</argument>
<description> <description>
Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s.
[code]body_id[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [code]body_id[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D].
@ -184,14 +162,10 @@
</description> </description>
</signal> </signal>
<signal name="body_shape_exited"> <signal name="body_shape_exited">
<argument index="0" name="body_rid" type="RID"> <argument index="0" name="body_rid" type="RID" />
</argument> <argument index="1" name="body" type="Node3D" />
<argument index="1" name="body" type="Node3D"> <argument index="2" name="body_shape" type="int" />
</argument> <argument index="3" name="local_shape" type="int" />
<argument index="2" name="body_shape" type="int">
</argument>
<argument index="3" name="local_shape" type="int">
</argument>
<description> <description>
Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s. Emitted when one of a [PhysicsBody3D] or [GridMap]'s [Shape3D]s enters one of this Area3D's [Shape3D]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape3D]s.
[code]body_id[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D]. [code]body_id[/code] the [RID] of the [PhysicsBody3D] or [MeshLibrary]'s [CollisionObject3D] used by the [PhysicsServer3D].

312
doc/classes/Array.xml
View File

@ -46,116 +46,91 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Constructs an empty [Array]. Constructs an empty [Array].
</description> </description>
</method> </method>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="from" type="Array" />
<argument index="0" name="from" type="Array">
</argument>
<description> <description>
Constructs an [Array] as a copy of the given [Array]. Constructs an [Array] as a copy of the given [Array].
</description> </description>
</method> </method>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="from" type="PackedByteArray" />
<argument index="0" name="from" type="PackedByteArray">
</argument>
<description> <description>
Constructs an array from a [PackedByteArray]. Constructs an array from a [PackedByteArray].
</description> </description>
</method> </method>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="from" type="PackedColorArray" />
<argument index="0" name="from" type="PackedColorArray">
</argument>
<description> <description>
Constructs an array from a [PackedColorArray]. Constructs an array from a [PackedColorArray].
</description> </description>
</method> </method>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="from" type="PackedFloat32Array" />
<argument index="0" name="from" type="PackedFloat32Array">
</argument>
<description> <description>
Constructs an array from a [PackedFloat32Array]. Constructs an array from a [PackedFloat32Array].
</description> </description>
</method> </method>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="from" type="PackedFloat64Array" />
<argument index="0" name="from" type="PackedFloat64Array">
</argument>
<description> <description>
Constructs an array from a [PackedFloat64Array]. Constructs an array from a [PackedFloat64Array].
</description> </description>
</method> </method>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="from" type="PackedInt32Array" />
<argument index="0" name="from" type="PackedInt32Array">
</argument>
<description> <description>
Constructs an array from a [PackedInt32Array]. Constructs an array from a [PackedInt32Array].
</description> </description>
</method> </method>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="from" type="PackedInt64Array" />
<argument index="0" name="from" type="PackedInt64Array">
</argument>
<description> <description>
Constructs an array from a [PackedInt64Array]. Constructs an array from a [PackedInt64Array].
</description> </description>
</method> </method>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="from" type="PackedStringArray" />
<argument index="0" name="from" type="PackedStringArray">
</argument>
<description> <description>
Constructs an array from a [PackedStringArray]. Constructs an array from a [PackedStringArray].
</description> </description>
</method> </method>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="from" type="PackedVector2Array" />
<argument index="0" name="from" type="PackedVector2Array">
</argument>
<description> <description>
Constructs an array from a [PackedVector2Array]. Constructs an array from a [PackedVector2Array].
</description> </description>
</method> </method>
<method name="Array" qualifiers="constructor"> <method name="Array" qualifiers="constructor">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="from" type="PackedVector3Array" />
<argument index="0" name="from" type="PackedVector3Array">
</argument>
<description> <description>
Constructs an array from a [PackedVector3Array]. Constructs an array from a [PackedVector3Array].
</description> </description>
</method> </method>
<method name="append"> <method name="append">
<return type="void"> <return type="void" />
</return> <argument index="0" name="value" type="Variant" />
<argument index="0" name="value" type="Variant">
</argument>
<description> <description>
Appends an element at the end of the array (alias of [method push_back]). Appends an element at the end of the array (alias of [method push_back]).
</description> </description>
</method> </method>
<method name="append_array"> <method name="append_array">
<return type="void"> <return type="void" />
</return> <argument index="0" name="array" type="Array" />
<argument index="0" name="array" type="Array">
</argument>
<description> <description>
Appends another array at the end of this array. Appends another array at the end of this array.
[codeblock] [codeblock]
@ -167,70 +142,55 @@
</description> </description>
</method> </method>
<method name="back" qualifiers="const"> <method name="back" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return>
<description> <description>
Returns the last element of the array. Prints an error and returns [code]null[/code] if the array is empty. 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. [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.
</description> </description>
</method> </method>
<method name="bsearch"> <method name="bsearch">
<return type="int"> <return type="int" />
</return> <argument index="0" name="value" type="Variant" />
<argument index="0" name="value" type="Variant"> <argument index="1" name="before" type="bool" default="true" />
</argument>
<argument index="1" name="before" type="bool" default="true">
</argument>
<description> <description>
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 [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. 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 [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array.
[b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior.
</description> </description>
</method> </method>
<method name="bsearch_custom"> <method name="bsearch_custom">
<return type="int"> <return type="int" />
</return> <argument index="0" name="value" type="Variant" />
<argument index="0" name="value" type="Variant"> <argument index="1" name="func" type="Callable" />
</argument> <argument index="2" name="before" type="bool" default="true" />
<argument index="1" name="func" type="Callable">
</argument>
<argument index="2" name="before" type="bool" default="true">
</argument>
<description> <description>
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 [code]before[/code] 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. 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 [code]before[/code] 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] Calling [method bsearch_custom] on an unsorted array results in unexpected behavior. [b]Note:[/b] Calling [method bsearch_custom] on an unsorted array results in unexpected behavior.
</description> </description>
</method> </method>
<method name="clear"> <method name="clear">
<return type="void"> <return type="void" />
</return>
<description> <description>
Clears the array. This is equivalent to using [method resize] with a size of [code]0[/code]. Clears the array. This is equivalent to using [method resize] with a size of [code]0[/code].
</description> </description>
</method> </method>
<method name="count" qualifiers="const"> <method name="count" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="value" type="Variant" />
<argument index="0" name="value" type="Variant">
</argument>
<description> <description>
Returns the number of times an element is in the array. Returns the number of times an element is in the array.
</description> </description>
</method> </method>
<method name="duplicate" qualifiers="const"> <method name="duplicate" qualifiers="const">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="deep" type="bool" default="false" />
<argument index="0" name="deep" type="bool" default="false">
</argument>
<description> <description>
Returns a copy of the array. Returns a copy of the array.
If [code]deep[/code] 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. If [code]deep[/code] 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.
</description> </description>
</method> </method>
<method name="erase"> <method name="erase">
<return type="void"> <return type="void" />
</return> <argument index="0" name="value" type="Variant" />
<argument index="0" name="value" type="Variant">
</argument>
<description> <description>
Removes the first occurrence of a value from the array. To remove an element by index, use [method remove] instead. Removes the first occurrence of a value from the array. To remove an element by index, use [method remove] instead.
[b]Note:[/b] This method acts in-place and doesn't return a value. [b]Note:[/b] This method acts in-place and doesn't return a value.
@ -238,10 +198,8 @@
</description> </description>
</method> </method>
<method name="fill"> <method name="fill">
<return type="void"> <return type="void" />
</return> <argument index="0" name="value" type="Variant" />
<argument index="0" name="value" type="Variant">
</argument>
<description> <description>
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: 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:
[codeblocks] [codeblocks]
@ -259,10 +217,8 @@
</description> </description>
</method> </method>
<method name="filter" qualifiers="const"> <method name="filter" qualifiers="const">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="method" type="Callable" />
<argument index="0" name="method" type="Callable">
</argument>
<description> <description>
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]. 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. The callable's method should take one [Variant] parameter (the current array element) and return a boolean value.
@ -277,38 +233,30 @@
</description> </description>
</method> </method>
<method name="find" qualifiers="const"> <method name="find" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="what" type="Variant" />
<argument index="0" name="what" type="Variant"> <argument index="1" name="from" type="int" default="0" />
</argument>
<argument index="1" name="from" type="int" default="0">
</argument>
<description> <description>
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. 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.
</description> </description>
</method> </method>
<method name="find_last" qualifiers="const"> <method name="find_last" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="value" type="Variant" />
<argument index="0" name="value" type="Variant">
</argument>
<description> <description>
Searches the array in reverse order for a value and returns its index or [code]-1[/code] if not found. Searches the array in reverse order for a value and returns its index or [code]-1[/code] if not found.
</description> </description>
</method> </method>
<method name="front" qualifiers="const"> <method name="front" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return>
<description> <description>
Returns the first element of the array. Prints an error and returns [code]null[/code] if the array is empty. 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. [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.
</description> </description>
</method> </method>
<method name="has" qualifiers="const"> <method name="has" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="value" type="Variant" />
<argument index="0" name="value" type="Variant">
</argument>
<description> <description>
Returns [code]true[/code] if the array contains the given value. Returns [code]true[/code] if the array contains the given value.
[codeblocks] [codeblocks]
@ -347,20 +295,16 @@
</description> </description>
</method> </method>
<method name="hash" qualifiers="const"> <method name="hash" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns a hashed integer value representing the array and its contents. Returns a hashed integer value representing the array and its contents.
[b]Note:[/b] Arrays with equal contents can still produce different hashes. Only the exact same arrays will produce the same hashed integer value. [b]Note:[/b] Arrays with equal contents can still produce different hashes. Only the exact same arrays will produce the same hashed integer value.
</description> </description>
</method> </method>
<method name="insert"> <method name="insert">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="int" />
<argument index="0" name="position" type="int"> <argument index="1" name="value" type="Variant" />
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<description> <description>
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]). 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]).
[b]Note:[/b] This method acts in-place and doesn't return a value. [b]Note:[/b] This method acts in-place and doesn't return a value.
@ -368,17 +312,14 @@
</description> </description>
</method> </method>
<method name="is_empty" qualifiers="const"> <method name="is_empty" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the array is empty. Returns [code]true[/code] if the array is empty.
</description> </description>
</method> </method>
<method name="map" qualifiers="const"> <method name="map" qualifiers="const">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="method" type="Callable" />
<argument index="0" name="method" type="Callable">
</argument>
<description> <description>
Calls the provided [Callable] for each element in the array and returns a new array filled with values returned by the method. 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]. The callable's method should take one [Variant] parameter (the current array element) and can return any [Variant].
@ -393,124 +334,97 @@
</description> </description>
</method> </method>
<method name="max" qualifiers="const"> <method name="max" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return>
<description> <description>
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. 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.
</description> </description>
</method> </method>
<method name="min" qualifiers="const"> <method name="min" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return>
<description> <description>
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. 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.
</description> </description>
</method> </method>
<method name="operator !=" qualifiers="operator"> <method name="operator !=" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Array" />
<argument index="0" name="right" type="Array">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator +" qualifiers="operator"> <method name="operator +" qualifiers="operator">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="right" type="Array" />
<argument index="0" name="right" type="Array">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator &lt;" qualifiers="operator"> <method name="operator &lt;" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Array" />
<argument index="0" name="right" type="Array">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator &lt;=" qualifiers="operator"> <method name="operator &lt;=" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Array" />
<argument index="0" name="right" type="Array">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator ==" qualifiers="operator"> <method name="operator ==" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Array" />
<argument index="0" name="right" type="Array">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator &gt;" qualifiers="operator"> <method name="operator &gt;" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Array" />
<argument index="0" name="right" type="Array">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator &gt;=" qualifiers="operator"> <method name="operator &gt;=" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Array" />
<argument index="0" name="right" type="Array">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator []" qualifiers="operator"> <method name="operator []" qualifiers="operator">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="pop_back"> <method name="pop_back">
<return type="Variant"> <return type="Variant" />
</return>
<description> <description>
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 last element of the array. Returns [code]null[/code] if the array is empty, without printing an error message. See also [method pop_front].
</description> </description>
</method> </method>
<method name="pop_front"> <method name="pop_front">
<return type="Variant"> <return type="Variant" />
</return>
<description> <description>
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]. 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 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.
</description> </description>
</method> </method>
<method name="push_back"> <method name="push_back">
<return type="void"> <return type="void" />
</return> <argument index="0" name="value" type="Variant" />
<argument index="0" name="value" type="Variant">
</argument>
<description> <description>
Appends an element at the end of the array. See also [method push_front]. Appends an element at the end of the array. See also [method push_front].
</description> </description>
</method> </method>
<method name="push_front"> <method name="push_front">
<return type="void"> <return type="void" />
</return> <argument index="0" name="value" type="Variant" />
<argument index="0" name="value" type="Variant">
</argument>
<description> <description>
Adds an element at the beginning of the array. See also [method push_back]. Adds an element at the beginning of the array. See also [method push_back].
[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. [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.
</description> </description>
</method> </method>
<method name="reduce" qualifiers="const"> <method name="reduce" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="method" type="Callable" />
<argument index="0" name="method" type="Callable"> <argument index="1" name="accum" type="Variant" default="null" />
</argument>
<argument index="1" name="accum" type="Variant" default="null">
</argument>
<description> <description>
Calls the provided [Callable] for each element in array and accumulates the result in [code]accum[/code]. Calls the provided [Callable] for each element in array and accumulates the result in [code]accum[/code].
The callable's method takes two arguments: the current value of [code]accum[/code] and the current array element. If [code]accum[/code] is [code]null[/code] (default value), the iteration will start from the second element, with the first one used as initial value of [code]accum[/code]. The callable's method takes two arguments: the current value of [code]accum[/code] and the current array element. If [code]accum[/code] is [code]null[/code] (default value), the iteration will start from the second element, with the first one used as initial value of [code]accum[/code].
@ -525,10 +439,8 @@
</description> </description>
</method> </method>
<method name="remove"> <method name="remove">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="int" />
<argument index="0" name="position" type="int">
</argument>
<description> <description>
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. 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 value. [b]Note:[/b] This method acts in-place and doesn't return a value.
@ -536,64 +448,50 @@
</description> </description>
</method> </method>
<method name="resize"> <method name="resize">
<return type="int"> <return type="int" />
</return> <argument index="0" name="size" type="int" />
<argument index="0" name="size" type="int">
</argument>
<description> <description>
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]. 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].
</description> </description>
</method> </method>
<method name="reverse"> <method name="reverse">
<return type="void"> <return type="void" />
</return>
<description> <description>
Reverses the order of the elements in the array. Reverses the order of the elements in the array.
</description> </description>
</method> </method>
<method name="rfind" qualifiers="const"> <method name="rfind" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="what" type="Variant" />
<argument index="0" name="what" type="Variant"> <argument index="1" name="from" type="int" default="-1" />
</argument>
<argument index="1" name="from" type="int" default="-1">
</argument>
<description> <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> </description>
</method> </method>
<method name="shuffle"> <method name="shuffle">
<return type="void"> <return type="void" />
</return>
<description> <description>
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. 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.
</description> </description>
</method> </method>
<method name="size" qualifiers="const"> <method name="size" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of elements in the array. Returns the number of elements in the array.
</description> </description>
</method> </method>
<method name="slice" qualifiers="const"> <method name="slice" qualifiers="const">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="begin" type="int" />
<argument index="0" name="begin" type="int"> <argument index="1" name="end" type="int" />
</argument> <argument index="2" name="step" type="int" default="1" />
<argument index="1" name="end" type="int"> <argument index="3" name="deep" type="bool" default="false" />
</argument>
<argument index="2" name="step" type="int" default="1">
</argument>
<argument index="3" name="deep" type="bool" default="false">
</argument>
<description> <description>
Duplicates the subset described in the function and returns it in an array, deeply copying the array if [code]deep[/code] is [code]true[/code]. Lower and upper index are inclusive, with the [code]step[/code] describing the change between indices while slicing. Duplicates the subset described in the function and returns it in an array, deeply copying the array if [code]deep[/code] is [code]true[/code]. Lower and upper index are inclusive, with the [code]step[/code] describing the change between indices while slicing.
</description> </description>
</method> </method>
<method name="sort"> <method name="sort">
<return type="void"> <return type="void" />
</return>
<description> <description>
Sorts the array. Sorts the array.
[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: [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:
@ -610,10 +508,8 @@
</description> </description>
</method> </method>
<method name="sort_custom"> <method name="sort_custom">
<return type="void"> <return type="void" />
</return> <argument index="0" name="func" type="Callable" />
<argument index="0" name="func" type="Callable">
</argument>
<description> <description>
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. 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] you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. [b]Note:[/b] you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior.

141
doc/classes/ArrayMesh.xml
View File

@ -51,28 +51,20 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_blend_shape"> <method name="add_blend_shape">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added. Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added.
</description> </description>
</method> </method>
<method name="add_surface_from_arrays"> <method name="add_surface_from_arrays">
<return type="void"> <return type="void" />
</return> <argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" />
<argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType"> <argument index="1" name="arrays" type="Array" />
</argument> <argument index="2" name="blend_shapes" type="Array" default="[]" />
<argument index="1" name="arrays" type="Array">
</argument>
<argument index="2" name="blend_shapes" type="Array" default="[]">
</argument>
<argument index="3" name="lods" type="Dictionary" default="{ <argument index="3" name="lods" type="Dictionary" default="{
}"> }" />
</argument> <argument index="4" name="compress_flags" type="int" default="0" />
<argument index="4" name="compress_flags" type="int" default="0">
</argument>
<description> <description>
Creates a new surface. Creates a new surface.
Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface. Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface.
@ -80,161 +72,122 @@
</description> </description>
</method> </method>
<method name="clear_blend_shapes"> <method name="clear_blend_shapes">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all blend shapes from this [ArrayMesh]. Removes all blend shapes from this [ArrayMesh].
</description> </description>
</method> </method>
<method name="clear_surfaces"> <method name="clear_surfaces">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all surfaces from this [ArrayMesh]. Removes all surfaces from this [ArrayMesh].
</description> </description>
</method> </method>
<method name="get_blend_shape_count" qualifiers="const"> <method name="get_blend_shape_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of blend shapes that the [ArrayMesh] holds. Returns the number of blend shapes that the [ArrayMesh] holds.
</description> </description>
</method> </method>
<method name="get_blend_shape_name" qualifiers="const"> <method name="get_blend_shape_name" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Returns the name of the blend shape at this index. Returns the name of the blend shape at this index.
</description> </description>
</method> </method>
<method name="lightmap_unwrap"> <method name="lightmap_unwrap">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="transform" type="Transform3D" />
<argument index="0" name="transform" type="Transform3D"> <argument index="1" name="texel_size" type="float" />
</argument>
<argument index="1" name="texel_size" type="float">
</argument>
<description> <description>
Will perform a UV unwrap on the [ArrayMesh] to prepare the mesh for lightmapping. Will perform a UV unwrap on the [ArrayMesh] to prepare the mesh for lightmapping.
</description> </description>
</method> </method>
<method name="regen_normal_maps"> <method name="regen_normal_maps">
<return type="void"> <return type="void" />
</return>
<description> <description>
Will regenerate normal maps for the [ArrayMesh]. Will regenerate normal maps for the [ArrayMesh].
</description> </description>
</method> </method>
<method name="set_blend_shape_name"> <method name="set_blend_shape_name">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int"> <argument index="1" name="name" type="StringName" />
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="surface_find_by_name" qualifiers="const"> <method name="surface_find_by_name" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found, -1 is returned. Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found, -1 is returned.
</description> </description>
</method> </method>
<method name="surface_get_array_index_len" qualifiers="const"> <method name="surface_get_array_index_len" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="surf_idx" type="int" />
<argument index="0" name="surf_idx" type="int">
</argument>
<description> <description>
Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]). Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]).
</description> </description>
</method> </method>
<method name="surface_get_array_len" qualifiers="const"> <method name="surface_get_array_len" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="surf_idx" type="int" />
<argument index="0" name="surf_idx" type="int">
</argument>
<description> <description>
Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]). Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]).
</description> </description>
</method> </method>
<method name="surface_get_format" qualifiers="const"> <method name="surface_get_format" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="surf_idx" type="int" />
<argument index="0" name="surf_idx" type="int">
</argument>
<description> <description>
Returns the format mask of the requested surface (see [method add_surface_from_arrays]). Returns the format mask of the requested surface (see [method add_surface_from_arrays]).
</description> </description>
</method> </method>
<method name="surface_get_name" qualifiers="const"> <method name="surface_get_name" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="surf_idx" type="int" />
<argument index="0" name="surf_idx" type="int">
</argument>
<description> <description>
Gets the name assigned to this surface. Gets the name assigned to this surface.
</description> </description>
</method> </method>
<method name="surface_get_primitive_type" qualifiers="const"> <method name="surface_get_primitive_type" qualifiers="const">
<return type="int" enum="Mesh.PrimitiveType"> <return type="int" enum="Mesh.PrimitiveType" />
</return> <argument index="0" name="surf_idx" type="int" />
<argument index="0" name="surf_idx" type="int">
</argument>
<description> <description>
Returns the primitive type of the requested surface (see [method add_surface_from_arrays]). Returns the primitive type of the requested surface (see [method add_surface_from_arrays]).
</description> </description>
</method> </method>
<method name="surface_set_name"> <method name="surface_set_name">
<return type="void"> <return type="void" />
</return> <argument index="0" name="surf_idx" type="int" />
<argument index="0" name="surf_idx" type="int"> <argument index="1" name="name" type="String" />
</argument>
<argument index="1" name="name" type="String">
</argument>
<description> <description>
Sets a name for a given surface. Sets a name for a given surface.
</description> </description>
</method> </method>
<method name="surface_update_attribute_region"> <method name="surface_update_attribute_region">
<return type="void"> <return type="void" />
</return> <argument index="0" name="surf_idx" type="int" />
<argument index="0" name="surf_idx" type="int"> <argument index="1" name="offset" type="int" />
</argument> <argument index="2" name="data" type="PackedByteArray" />
<argument index="1" name="offset" type="int">
</argument>
<argument index="2" name="data" type="PackedByteArray">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="surface_update_skin_region"> <method name="surface_update_skin_region">
<return type="void"> <return type="void" />
</return> <argument index="0" name="surf_idx" type="int" />
<argument index="0" name="surf_idx" type="int"> <argument index="1" name="offset" type="int" />
</argument> <argument index="2" name="data" type="PackedByteArray" />
<argument index="1" name="offset" type="int">
</argument>
<argument index="2" name="data" type="PackedByteArray">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="surface_update_vertex_region"> <method name="surface_update_vertex_region">
<return type="void"> <return type="void" />
</return> <argument index="0" name="surf_idx" type="int" />
<argument index="0" name="surf_idx" type="int"> <argument index="1" name="offset" type="int" />
</argument> <argument index="2" name="data" type="PackedByteArray" />
<argument index="1" name="offset" type="int">
</argument>
<argument index="2" name="data" type="PackedByteArray">
</argument>
<description> <description>
</description> </description>
</method> </method>

27
doc/classes/AudioEffectCapture.xml
View File

@ -11,55 +11,46 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="can_get_buffer" qualifiers="const"> <method name="can_get_buffer" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="frames" type="int" />
<argument index="0" name="frames" type="int">
</argument>
<description> <description>
Returns [code]true[/code] if at least [code]frames[/code] audio frames are available to read in the internal ring buffer. Returns [code]true[/code] if at least [code]frames[/code] audio frames are available to read in the internal ring buffer.
</description> </description>
</method> </method>
<method name="clear_buffer"> <method name="clear_buffer">
<return type="void"> <return type="void" />
</return>
<description> <description>
Clears the internal ring buffer. Clears the internal ring buffer.
</description> </description>
</method> </method>
<method name="get_buffer"> <method name="get_buffer">
<return type="PackedVector2Array"> <return type="PackedVector2Array" />
</return> <argument index="0" name="frames" type="int" />
<argument index="0" name="frames" type="int">
</argument>
<description> <description>
Gets the next [code]frames[/code] audio samples from the internal ring buffer. Gets the next [code]frames[/code] audio samples from the internal ring buffer.
Returns a [PackedVector2Array] containing exactly [code]frames[/code] audio samples if available, or an empty [PackedVector2Array] if insufficient data was available. Returns a [PackedVector2Array] containing exactly [code]frames[/code] audio samples if available, or an empty [PackedVector2Array] if insufficient data was available.
</description> </description>
</method> </method>
<method name="get_buffer_length_frames" qualifiers="const"> <method name="get_buffer_length_frames" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the total size of the internal ring buffer in frames. Returns the total size of the internal ring buffer in frames.
</description> </description>
</method> </method>
<method name="get_discarded_frames" qualifiers="const"> <method name="get_discarded_frames" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of audio frames discarded from the audio bus due to full buffer. Returns the number of audio frames discarded from the audio bus due to full buffer.
</description> </description>
</method> </method>
<method name="get_frames_available" qualifiers="const"> <method name="get_frames_available" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of frames available to read using [method get_buffer]. Returns the number of frames available to read using [method get_buffer].
</description> </description>
</method> </method>
<method name="get_pushed_frames" qualifiers="const"> <method name="get_pushed_frames" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of audio frames inserted from the audio bus. Returns the number of audio frames inserted from the audio bus.
</description> </description>

90
doc/classes/AudioEffectChorus.xml
View File

@ -10,110 +10,80 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_voice_cutoff_hz" qualifiers="const"> <method name="get_voice_cutoff_hz" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="get_voice_delay_ms" qualifiers="const"> <method name="get_voice_delay_ms" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="get_voice_depth_ms" qualifiers="const"> <method name="get_voice_depth_ms" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="get_voice_level_db" qualifiers="const"> <method name="get_voice_level_db" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="get_voice_pan" qualifiers="const"> <method name="get_voice_pan" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="get_voice_rate_hz" qualifiers="const"> <method name="get_voice_rate_hz" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_voice_cutoff_hz"> <method name="set_voice_cutoff_hz">
<return type="void"> <return type="void" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int"> <argument index="1" name="cutoff_hz" type="float" />
</argument>
<argument index="1" name="cutoff_hz" type="float">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_voice_delay_ms"> <method name="set_voice_delay_ms">
<return type="void"> <return type="void" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int"> <argument index="1" name="delay_ms" type="float" />
</argument>
<argument index="1" name="delay_ms" type="float">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_voice_depth_ms"> <method name="set_voice_depth_ms">
<return type="void"> <return type="void" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int"> <argument index="1" name="depth_ms" type="float" />
</argument>
<argument index="1" name="depth_ms" type="float">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_voice_level_db"> <method name="set_voice_level_db">
<return type="void"> <return type="void" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int"> <argument index="1" name="level_db" type="float" />
</argument>
<argument index="1" name="level_db" type="float">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_voice_pan"> <method name="set_voice_pan">
<return type="void"> <return type="void" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int"> <argument index="1" name="pan" type="float" />
</argument>
<argument index="1" name="pan" type="float">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_voice_rate_hz"> <method name="set_voice_rate_hz">
<return type="void"> <return type="void" />
</return> <argument index="0" name="voice_idx" type="int" />
<argument index="0" name="voice_idx" type="int"> <argument index="1" name="rate_hz" type="float" />
</argument>
<argument index="1" name="rate_hz" type="float">
</argument>
<description> <description>
</description> </description>
</method> </method>

18
doc/classes/AudioEffectEQ.xml
View File

@ -11,28 +11,22 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_band_count" qualifiers="const"> <method name="get_band_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of bands of the equalizer. Returns the number of bands of the equalizer.
</description> </description>
</method> </method>
<method name="get_band_gain_db" qualifiers="const"> <method name="get_band_gain_db" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="band_idx" type="int" />
<argument index="0" name="band_idx" type="int">
</argument>
<description> <description>
Returns the band's gain at the specified index, in dB. Returns the band's gain at the specified index, in dB.
</description> </description>
</method> </method>
<method name="set_band_gain_db"> <method name="set_band_gain_db">
<return type="void"> <return type="void" />
</return> <argument index="0" name="band_idx" type="int" />
<argument index="0" name="band_idx" type="int"> <argument index="1" name="volume_db" type="float" />
</argument>
<argument index="1" name="volume_db" type="float">
</argument>
<description> <description>
Sets band's gain at the specified index, in dB. Sets band's gain at the specified index, in dB.
</description> </description>

12
doc/classes/AudioEffectRecord.xml
View File

@ -12,24 +12,20 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_recording" qualifiers="const"> <method name="get_recording" qualifiers="const">
<return type="AudioStreamSample"> <return type="AudioStreamSample" />
</return>
<description> <description>
Returns the recorded sample. Returns the recorded sample.
</description> </description>
</method> </method>
<method name="is_recording_active" qualifiers="const"> <method name="is_recording_active" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns whether the recording is active or not. Returns whether the recording is active or not.
</description> </description>
</method> </method>
<method name="set_recording_active"> <method name="set_recording_active">
<return type="void"> <return type="void" />
</return> <argument index="0" name="record" type="bool" />
<argument index="0" name="record" type="bool">
</argument>
<description> <description>
If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample. If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.
</description> </description>

12
doc/classes/AudioEffectSpectrumAnalyzerInstance.xml
View File

@ -8,14 +8,10 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_magnitude_for_frequency_range" qualifiers="const"> <method name="get_magnitude_for_frequency_range" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="from_hz" type="float" />
<argument index="0" name="from_hz" type="float"> <argument index="1" name="to_hz" type="float" />
</argument> <argument index="2" name="mode" type="int" enum="AudioEffectSpectrumAnalyzerInstance.MagnitudeMode" default="1" />
<argument index="1" name="to_hz" type="float">
</argument>
<argument index="2" name="mode" type="int" enum="AudioEffectSpectrumAnalyzerInstance.MagnitudeMode" default="1">
</argument>
<description> <description>
</description> </description>
</method> </method>

267
doc/classes/AudioServer.xml
View File

@ -14,380 +14,291 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_bus"> <method name="add_bus">
<return type="void"> <return type="void" />
</return> <argument index="0" name="at_position" type="int" default="-1" />
<argument index="0" name="at_position" type="int" default="-1">
</argument>
<description> <description>
Adds a bus at [code]at_position[/code]. Adds a bus at [code]at_position[/code].
</description> </description>
</method> </method>
<method name="add_bus_effect"> <method name="add_bus_effect">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="effect" type="AudioEffect" />
</argument> <argument index="2" name="at_position" type="int" default="-1" />
<argument index="1" name="effect" type="AudioEffect">
</argument>
<argument index="2" name="at_position" type="int" default="-1">
</argument>
<description> <description>
Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code]. Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code].
</description> </description>
</method> </method>
<method name="capture_get_device"> <method name="capture_get_device">
<return type="String"> <return type="String" />
</return>
<description> <description>
Name of the current device for audio input (see [method capture_get_device_list]). Name of the current device for audio input (see [method capture_get_device_list]).
</description> </description>
</method> </method>
<method name="capture_get_device_list"> <method name="capture_get_device_list">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns the names of all audio input devices detected on the system. Returns the names of all audio input devices detected on the system.
</description> </description>
</method> </method>
<method name="capture_set_device"> <method name="capture_set_device">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
Sets which audio input device is used for audio capture. Sets which audio input device is used for audio capture.
</description> </description>
</method> </method>
<method name="generate_bus_layout" qualifiers="const"> <method name="generate_bus_layout" qualifiers="const">
<return type="AudioBusLayout"> <return type="AudioBusLayout" />
</return>
<description> <description>
Generates an [AudioBusLayout] using the available buses and effects. Generates an [AudioBusLayout] using the available buses and effects.
</description> </description>
</method> </method>
<method name="get_bus_channels" qualifiers="const"> <method name="get_bus_channels" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int">
</argument>
<description> <description>
Returns the amount of channels of the bus at index [code]bus_idx[/code]. Returns the amount of channels of the bus at index [code]bus_idx[/code].
</description> </description>
</method> </method>
<method name="get_bus_effect"> <method name="get_bus_effect">
<return type="AudioEffect"> <return type="AudioEffect" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="effect_idx" type="int" />
</argument>
<argument index="1" name="effect_idx" type="int">
</argument>
<description> <description>
Returns the [AudioEffect] at position [code]effect_idx[/code] in bus [code]bus_idx[/code]. Returns the [AudioEffect] at position [code]effect_idx[/code] in bus [code]bus_idx[/code].
</description> </description>
</method> </method>
<method name="get_bus_effect_count"> <method name="get_bus_effect_count">
<return type="int"> <return type="int" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int">
</argument>
<description> <description>
Returns the number of effects on the bus at [code]bus_idx[/code]. Returns the number of effects on the bus at [code]bus_idx[/code].
</description> </description>
</method> </method>
<method name="get_bus_effect_instance"> <method name="get_bus_effect_instance">
<return type="AudioEffectInstance"> <return type="AudioEffectInstance" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="effect_idx" type="int" />
</argument> <argument index="2" name="channel" type="int" default="0" />
<argument index="1" name="effect_idx" type="int">
</argument>
<argument index="2" name="channel" type="int" default="0">
</argument>
<description> <description>
Returns the [AudioEffectInstance] assigned to the given bus and effect indices (and optionally channel). Returns the [AudioEffectInstance] assigned to the given bus and effect indices (and optionally channel).
</description> </description>
</method> </method>
<method name="get_bus_index" qualifiers="const"> <method name="get_bus_index" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="bus_name" type="StringName" />
<argument index="0" name="bus_name" type="StringName">
</argument>
<description> <description>
Returns the index of the bus with the name [code]bus_name[/code]. Returns the index of the bus with the name [code]bus_name[/code].
</description> </description>
</method> </method>
<method name="get_bus_name" qualifiers="const"> <method name="get_bus_name" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int">
</argument>
<description> <description>
Returns the name of the bus with the index [code]bus_idx[/code]. Returns the name of the bus with the index [code]bus_idx[/code].
</description> </description>
</method> </method>
<method name="get_bus_peak_volume_left_db" qualifiers="const"> <method name="get_bus_peak_volume_left_db" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="channel" type="int" />
</argument>
<argument index="1" name="channel" type="int">
</argument>
<description> <description>
Returns the peak volume of the left speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code]. Returns the peak volume of the left speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code].
</description> </description>
</method> </method>
<method name="get_bus_peak_volume_right_db" qualifiers="const"> <method name="get_bus_peak_volume_right_db" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="channel" type="int" />
</argument>
<argument index="1" name="channel" type="int">
</argument>
<description> <description>
Returns the peak volume of the right speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code]. Returns the peak volume of the right speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code].
</description> </description>
</method> </method>
<method name="get_bus_send" qualifiers="const"> <method name="get_bus_send" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int">
</argument>
<description> <description>
Returns the name of the bus that the bus at index [code]bus_idx[/code] sends to. Returns the name of the bus that the bus at index [code]bus_idx[/code] sends to.
</description> </description>
</method> </method>
<method name="get_bus_volume_db" qualifiers="const"> <method name="get_bus_volume_db" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int">
</argument>
<description> <description>
Returns the volume of the bus at index [code]bus_idx[/code] in dB. Returns the volume of the bus at index [code]bus_idx[/code] in dB.
</description> </description>
</method> </method>
<method name="get_device_list"> <method name="get_device_list">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns the names of all audio devices detected on the system. Returns the names of all audio devices detected on the system.
</description> </description>
</method> </method>
<method name="get_mix_rate" qualifiers="const"> <method name="get_mix_rate" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the sample rate at the output of the [AudioServer]. Returns the sample rate at the output of the [AudioServer].
</description> </description>
</method> </method>
<method name="get_output_latency" qualifiers="const"> <method name="get_output_latency" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the audio driver's output latency. Returns the audio driver's output latency.
</description> </description>
</method> </method>
<method name="get_speaker_mode" qualifiers="const"> <method name="get_speaker_mode" qualifiers="const">
<return type="int" enum="AudioServer.SpeakerMode"> <return type="int" enum="AudioServer.SpeakerMode" />
</return>
<description> <description>
Returns the speaker configuration. Returns the speaker configuration.
</description> </description>
</method> </method>
<method name="get_time_since_last_mix" qualifiers="const"> <method name="get_time_since_last_mix" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the relative time since the last mix occurred. Returns the relative time since the last mix occurred.
</description> </description>
</method> </method>
<method name="get_time_to_next_mix" qualifiers="const"> <method name="get_time_to_next_mix" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the relative time until the next mix occurs. Returns the relative time until the next mix occurs.
</description> </description>
</method> </method>
<method name="is_bus_bypassing_effects" qualifiers="const"> <method name="is_bus_bypassing_effects" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int">
</argument>
<description> <description>
If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects.
</description> </description>
</method> </method>
<method name="is_bus_effect_enabled" qualifiers="const"> <method name="is_bus_effect_enabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="effect_idx" type="int" />
</argument>
<argument index="1" name="effect_idx" type="int">
</argument>
<description> <description>
If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled. If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled.
</description> </description>
</method> </method>
<method name="is_bus_mute" qualifiers="const"> <method name="is_bus_mute" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int">
</argument>
<description> <description>
If [code]true[/code], the bus at index [code]bus_idx[/code] is muted. If [code]true[/code], the bus at index [code]bus_idx[/code] is muted.
</description> </description>
</method> </method>
<method name="is_bus_solo" qualifiers="const"> <method name="is_bus_solo" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int">
</argument>
<description> <description>
If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode. If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode.
</description> </description>
</method> </method>
<method name="lock"> <method name="lock">
<return type="void"> <return type="void" />
</return>
<description> <description>
Locks the audio driver's main loop. Locks the audio driver's main loop.
[b]Note:[/b] Remember to unlock it afterwards. [b]Note:[/b] Remember to unlock it afterwards.
</description> </description>
</method> </method>
<method name="move_bus"> <method name="move_bus">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int"> <argument index="1" name="to_index" type="int" />
</argument>
<argument index="1" name="to_index" type="int">
</argument>
<description> <description>
Moves the bus from index [code]index[/code] to index [code]to_index[/code]. Moves the bus from index [code]index[/code] to index [code]to_index[/code].
</description> </description>
</method> </method>
<method name="remove_bus"> <method name="remove_bus">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Removes the bus at index [code]index[/code]. Removes the bus at index [code]index[/code].
</description> </description>
</method> </method>
<method name="remove_bus_effect"> <method name="remove_bus_effect">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="effect_idx" type="int" />
</argument>
<argument index="1" name="effect_idx" type="int">
</argument>
<description> <description>
Removes the effect at index [code]effect_idx[/code] from the bus at index [code]bus_idx[/code]. Removes the effect at index [code]effect_idx[/code] from the bus at index [code]bus_idx[/code].
</description> </description>
</method> </method>
<method name="set_bus_bypass_effects"> <method name="set_bus_bypass_effects">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects.
</description> </description>
</method> </method>
<method name="set_bus_effect_enabled"> <method name="set_bus_effect_enabled">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="effect_idx" type="int" />
</argument> <argument index="2" name="enabled" type="bool" />
<argument index="1" name="effect_idx" type="int">
</argument>
<argument index="2" name="enabled" type="bool">
</argument>
<description> <description>
If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled. If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled.
</description> </description>
</method> </method>
<method name="set_bus_layout"> <method name="set_bus_layout">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_layout" type="AudioBusLayout" />
<argument index="0" name="bus_layout" type="AudioBusLayout">
</argument>
<description> <description>
Overwrites the currently used [AudioBusLayout]. Overwrites the currently used [AudioBusLayout].
</description> </description>
</method> </method>
<method name="set_bus_mute"> <method name="set_bus_mute">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
If [code]true[/code], the bus at index [code]bus_idx[/code] is muted. If [code]true[/code], the bus at index [code]bus_idx[/code] is muted.
</description> </description>
</method> </method>
<method name="set_bus_name"> <method name="set_bus_name">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="name" type="String" />
</argument>
<argument index="1" name="name" type="String">
</argument>
<description> <description>
Sets the name of the bus at index [code]bus_idx[/code] to [code]name[/code]. Sets the name of the bus at index [code]bus_idx[/code] to [code]name[/code].
</description> </description>
</method> </method>
<method name="set_bus_send"> <method name="set_bus_send">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="send" type="StringName" />
</argument>
<argument index="1" name="send" type="StringName">
</argument>
<description> <description>
Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code]. Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code].
</description> </description>
</method> </method>
<method name="set_bus_solo"> <method name="set_bus_solo">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode. If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode.
</description> </description>
</method> </method>
<method name="set_bus_volume_db"> <method name="set_bus_volume_db">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="volume_db" type="float" />
</argument>
<argument index="1" name="volume_db" type="float">
</argument>
<description> <description>
Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code]. Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code].
</description> </description>
</method> </method>
<method name="swap_bus_effects"> <method name="swap_bus_effects">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bus_idx" type="int" />
<argument index="0" name="bus_idx" type="int"> <argument index="1" name="effect_idx" type="int" />
</argument> <argument index="2" name="by_effect_idx" type="int" />
<argument index="1" name="effect_idx" type="int">
</argument>
<argument index="2" name="by_effect_idx" type="int">
</argument>
<description> <description>
Swaps the position of two effects in bus [code]bus_idx[/code]. Swaps the position of two effects in bus [code]bus_idx[/code].
</description> </description>
</method> </method>
<method name="unlock"> <method name="unlock">
<return type="void"> <return type="void" />
</return>
<description> <description>
Unlocks the audio driver's main loop. (After locking it, you should always unlock it.) Unlocks the audio driver's main loop. (After locking it, you should always unlock it.)
</description> </description>

3
doc/classes/AudioStream.xml
View File

@ -14,8 +14,7 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_length" qualifiers="const"> <method name="get_length" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the length of the audio stream in seconds. Returns the length of the audio stream in seconds.
</description> </description>

27
doc/classes/AudioStreamGeneratorPlayback.xml
View File

@ -12,48 +12,39 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="can_push_buffer" qualifiers="const"> <method name="can_push_buffer" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="amount" type="int" />
<argument index="0" name="amount" type="int">
</argument>
<description> <description>
Returns [code]true[/code] if a buffer of the size [code]amount[/code] can be pushed to the audio sample data buffer without overflowing it, [code]false[/code] otherwise. Returns [code]true[/code] if a buffer of the size [code]amount[/code] can be pushed to the audio sample data buffer without overflowing it, [code]false[/code] otherwise.
</description> </description>
</method> </method>
<method name="clear_buffer"> <method name="clear_buffer">
<return type="void"> <return type="void" />
</return>
<description> <description>
Clears the audio sample data buffer. Clears the audio sample data buffer.
</description> </description>
</method> </method>
<method name="get_frames_available" qualifiers="const"> <method name="get_frames_available" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of audio data frames left to play. If this returned number reaches [code]0[/code], the audio will stop playing until frames are added again. Therefore, make sure your script can always generate and push new audio frames fast enough to avoid audio cracking. Returns the number of audio data frames left to play. If this returned number reaches [code]0[/code], the audio will stop playing until frames are added again. Therefore, make sure your script can always generate and push new audio frames fast enough to avoid audio cracking.
</description> </description>
</method> </method>
<method name="get_skips" qualifiers="const"> <method name="get_skips" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="push_buffer"> <method name="push_buffer">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="frames" type="PackedVector2Array" />
<argument index="0" name="frames" type="PackedVector2Array">
</argument>
<description> <description>
Pushes several audio data frames to the buffer. This is usually more efficient than [method push_frame] in C# and compiled languages via GDNative, but [method push_buffer] may be [i]less[/i] efficient in GDScript. Pushes several audio data frames to the buffer. This is usually more efficient than [method push_frame] in C# and compiled languages via GDNative, but [method push_buffer] may be [i]less[/i] efficient in GDScript.
</description> </description>
</method> </method>
<method name="push_frame"> <method name="push_frame">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="frame" type="Vector2" />
<argument index="0" name="frame" type="Vector2">
</argument>
<description> <description>
Pushes a single audio data frame to the buffer. This is usually less efficient than [method push_buffer] in C# and compiled languages via GDNative, but [method push_frame] may be [i]more[/i] efficient in GDScript. Pushes a single audio data frame to the buffer. This is usually less efficient than [method push_buffer] in C# and compiled languages via GDNative, but [method push_frame] may be [i]more[/i] efficient in GDScript.
</description> </description>

21
doc/classes/AudioStreamPlayer.xml
View File

@ -17,40 +17,33 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_playback_position"> <method name="get_playback_position">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the position in the [AudioStream] in seconds. Returns the position in the [AudioStream] in seconds.
</description> </description>
</method> </method>
<method name="get_stream_playback"> <method name="get_stream_playback">
<return type="AudioStreamPlayback"> <return type="AudioStreamPlayback" />
</return>
<description> <description>
Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer]. Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer].
</description> </description>
</method> </method>
<method name="play"> <method name="play">
<return type="void"> <return type="void" />
</return> <argument index="0" name="from_position" type="float" default="0.0" />
<argument index="0" name="from_position" type="float" default="0.0">
</argument>
<description> <description>
Plays the audio from the given [code]from_position[/code], in seconds. Plays the audio from the given [code]from_position[/code], in seconds.
</description> </description>
</method> </method>
<method name="seek"> <method name="seek">
<return type="void"> <return type="void" />
</return> <argument index="0" name="to_position" type="float" />
<argument index="0" name="to_position" type="float">
</argument>
<description> <description>
Sets the position from which audio will be played, in seconds. Sets the position from which audio will be played, in seconds.
</description> </description>
</method> </method>
<method name="stop"> <method name="stop">
<return type="void"> <return type="void" />
</return>
<description> <description>
Stops the audio. Stops the audio.
</description> </description>

21
doc/classes/AudioStreamPlayer2D.xml
View File

@ -13,40 +13,33 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_playback_position"> <method name="get_playback_position">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the position in the [AudioStream]. Returns the position in the [AudioStream].
</description> </description>
</method> </method>
<method name="get_stream_playback"> <method name="get_stream_playback">
<return type="AudioStreamPlayback"> <return type="AudioStreamPlayback" />
</return>
<description> <description>
Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer2D]. Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer2D].
</description> </description>
</method> </method>
<method name="play"> <method name="play">
<return type="void"> <return type="void" />
</return> <argument index="0" name="from_position" type="float" default="0.0" />
<argument index="0" name="from_position" type="float" default="0.0">
</argument>
<description> <description>
Plays the audio from the given position [code]from_position[/code], in seconds. Plays the audio from the given position [code]from_position[/code], in seconds.
</description> </description>
</method> </method>
<method name="seek"> <method name="seek">
<return type="void"> <return type="void" />
</return> <argument index="0" name="to_position" type="float" />
<argument index="0" name="to_position" type="float">
</argument>
<description> <description>
Sets the position from which audio will be played, in seconds. Sets the position from which audio will be played, in seconds.
</description> </description>
</method> </method>
<method name="stop"> <method name="stop">
<return type="void"> <return type="void" />
</return>
<description> <description>
Stops the audio. Stops the audio.
</description> </description>

21
doc/classes/AudioStreamPlayer3D.xml
View File

@ -14,40 +14,33 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_playback_position"> <method name="get_playback_position">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the position in the [AudioStream]. Returns the position in the [AudioStream].
</description> </description>
</method> </method>
<method name="get_stream_playback"> <method name="get_stream_playback">
<return type="AudioStreamPlayback"> <return type="AudioStreamPlayback" />
</return>
<description> <description>
Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer3D]. Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer3D].
</description> </description>
</method> </method>
<method name="play"> <method name="play">
<return type="void"> <return type="void" />
</return> <argument index="0" name="from_position" type="float" default="0.0" />
<argument index="0" name="from_position" type="float" default="0.0">
</argument>
<description> <description>
Plays the audio from the given position [code]from_position[/code], in seconds. Plays the audio from the given position [code]from_position[/code], in seconds.
</description> </description>
</method> </method>
<method name="seek"> <method name="seek">
<return type="void"> <return type="void" />
</return> <argument index="0" name="to_position" type="float" />
<argument index="0" name="to_position" type="float">
</argument>
<description> <description>
Sets the position from which audio will be played, in seconds. Sets the position from which audio will be played, in seconds.
</description> </description>
</method> </method>
<method name="stop"> <method name="stop">
<return type="void"> <return type="void" />
</return>
<description> <description>
Stops the audio. Stops the audio.
</description> </description>

6
doc/classes/AudioStreamSample.xml
View File

@ -11,10 +11,8 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="save_to_wav"> <method name="save_to_wav">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Saves the AudioStreamSample as a WAV file to [code]path[/code]. Samples with IMA ADPCM format can't be saved. Saves the AudioStreamSample as a WAV file to [code]path[/code]. Samples with IMA ADPCM format can't be saved.
[b]Note:[/b] A [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing. [b]Note:[/b] A [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing.

24
doc/classes/BaseButton.xml
View File

@ -10,40 +10,33 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_pressed" qualifiers="virtual"> <method name="_pressed" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
Called when the button is pressed. If you need to know the button's pressed state (and [member toggle_mode] is active), use [method _toggled] instead. Called when the button is pressed. If you need to know the button's pressed state (and [member toggle_mode] is active), use [method _toggled] instead.
</description> </description>
</method> </method>
<method name="_toggled" qualifiers="virtual"> <method name="_toggled" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="button_pressed" type="bool" />
<argument index="0" name="button_pressed" type="bool">
</argument>
<description> <description>
Called when the button is toggled (only if [member toggle_mode] is active). Called when the button is toggled (only if [member toggle_mode] is active).
</description> </description>
</method> </method>
<method name="get_draw_mode" qualifiers="const"> <method name="get_draw_mode" qualifiers="const">
<return type="int" enum="BaseButton.DrawMode"> <return type="int" enum="BaseButton.DrawMode" />
</return>
<description> <description>
Returns 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 [enum DrawMode] enum. Returns 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 [enum DrawMode] enum.
</description> </description>
</method> </method>
<method name="is_hovered" qualifiers="const"> <method name="is_hovered" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the mouse has entered the button and has not left it yet. Returns [code]true[/code] if the mouse has entered the button and has not left it yet.
</description> </description>
</method> </method>
<method name="set_pressed_no_signal"> <method name="set_pressed_no_signal">
<return type="void"> <return type="void" />
</return> <argument index="0" name="pressed" type="bool" />
<argument index="0" name="pressed" type="bool">
</argument>
<description> <description>
Changes the [member pressed] state of the button, without emitting [signal toggled]. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if [member toggle_mode] is [code]true[/code]. Changes the [member pressed] state of the button, without emitting [signal toggled]. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if [member toggle_mode] is [code]true[/code].
[b]Note:[/b] This method doesn't unpress other buttons in [member button_group]. [b]Note:[/b] This method doesn't unpress other buttons in [member button_group].
@ -104,8 +97,7 @@
</description> </description>
</signal> </signal>
<signal name="toggled"> <signal name="toggled">
<argument index="0" name="button_pressed" type="bool"> <argument index="0" name="button_pressed" type="bool" />
</argument>
<description> <description>
Emitted when the button was just toggled between pressed and normal states (only if [member toggle_mode] is active). The new state is contained in the [code]button_pressed[/code] argument. Emitted when the button was just toggled between pressed and normal states (only if [member toggle_mode] is active). The new state is contained in the [code]button_pressed[/code] argument.
</description> </description>

45
doc/classes/BaseMaterial3D.xml
View File

@ -11,61 +11,46 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_feature" qualifiers="const"> <method name="get_feature" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" />
<argument index="0" name="feature" type="int" enum="BaseMaterial3D.Feature">
</argument>
<description> <description>
Returns [code]true[/code], if the specified [enum Feature] is enabled. Returns [code]true[/code], if the specified [enum Feature] is enabled.
</description> </description>
</method> </method>
<method name="get_flag" qualifiers="const"> <method name="get_flag" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" />
<argument index="0" name="flag" type="int" enum="BaseMaterial3D.Flags">
</argument>
<description> <description>
Returns [code]true[/code], if the specified flag is enabled. See [enum Flags] enumerator for options. Returns [code]true[/code], if the specified flag is enabled. See [enum Flags] enumerator for options.
</description> </description>
</method> </method>
<method name="get_texture" qualifiers="const"> <method name="get_texture" qualifiers="const">
<return type="Texture2D"> <return type="Texture2D" />
</return> <argument index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam" />
<argument index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam">
</argument>
<description> <description>
Returns the [Texture] associated with the specified [enum TextureParam]. Returns the [Texture] associated with the specified [enum TextureParam].
</description> </description>
</method> </method>
<method name="set_feature"> <method name="set_feature">
<return type="void"> <return type="void" />
</return> <argument index="0" name="feature" type="int" enum="BaseMaterial3D.Feature" />
<argument index="0" name="feature" type="int" enum="BaseMaterial3D.Feature"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
If [code]true[/code], enables the specified [enum Feature]. Many features that are available in [BaseMaterial3D]s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to [code]true[/code]. If [code]true[/code], enables the specified [enum Feature]. Many features that are available in [BaseMaterial3D]s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to [code]true[/code].
</description> </description>
</method> </method>
<method name="set_flag"> <method name="set_flag">
<return type="void"> <return type="void" />
</return> <argument index="0" name="flag" type="int" enum="BaseMaterial3D.Flags" />
<argument index="0" name="flag" type="int" enum="BaseMaterial3D.Flags"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
If [code]true[/code], enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code]. See [enum Flags] enumerator for options. If [code]true[/code], enables the specified flag. Flags are optional behavior that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code]. See [enum Flags] enumerator for options.
</description> </description>
</method> </method>
<method name="set_texture"> <method name="set_texture">
<return type="void"> <return type="void" />
</return> <argument index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam" />
<argument index="0" name="param" type="int" enum="BaseMaterial3D.TextureParam"> <argument index="1" name="texture" type="Texture2D" />
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
<description> <description>
Sets the texture for the slot specified by [code]param[/code]. See [enum TextureParam] for available slots. Sets the texture for the slot specified by [code]param[/code]. See [enum TextureParam] for available slots.
</description> </description>

156
doc/classes/Basis.xml
View File

@ -20,243 +20,191 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="Basis" qualifiers="constructor"> <method name="Basis" qualifiers="constructor">
<return type="Basis"> <return type="Basis" />
</return>
<description> <description>
Constructs a default-initialized [Basis] set to [constant IDENTITY]. Constructs a default-initialized [Basis] set to [constant IDENTITY].
</description> </description>
</method> </method>
<method name="Basis" qualifiers="constructor"> <method name="Basis" qualifiers="constructor">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="from" type="Basis" />
<argument index="0" name="from" type="Basis">
</argument>
<description> <description>
Constructs a [Basis] as a copy of the given [Basis]. Constructs a [Basis] as a copy of the given [Basis].
</description> </description>
</method> </method>
<method name="Basis" qualifiers="constructor"> <method name="Basis" qualifiers="constructor">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="axis" type="Vector3" />
<argument index="0" name="axis" type="Vector3"> <argument index="1" name="phi" type="float" />
</argument>
<argument index="1" name="phi" type="float">
</argument>
<description> <description>
Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]phi[/code], in radians. The axis must be a normalized vector. Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]phi[/code], in radians. The axis must be a normalized vector.
</description> </description>
</method> </method>
<method name="Basis" qualifiers="constructor"> <method name="Basis" qualifiers="constructor">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="euler" type="Vector3" />
<argument index="0" name="euler" type="Vector3">
</argument>
<description> <description>
Constructs a pure rotation basis matrix from the given Euler angles (in the YXZ convention: when *composing*, first Y, then X, and Z last), given in the vector format as (X angle, Y angle, Z angle). Constructs a pure rotation basis matrix from the given Euler angles (in the YXZ convention: when *composing*, first Y, then X, and Z last), given in the vector format as (X angle, Y angle, Z angle).
Consider using the [Quaternion] constructor instead, which uses a quaternion instead of Euler angles. Consider using the [Quaternion] constructor instead, which uses a quaternion instead of Euler angles.
</description> </description>
</method> </method>
<method name="Basis" qualifiers="constructor"> <method name="Basis" qualifiers="constructor">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="from" type="Quaternion" />
<argument index="0" name="from" type="Quaternion">
</argument>
<description> <description>
Constructs a pure rotation basis matrix from the given quaternion. Constructs a pure rotation basis matrix from the given quaternion.
</description> </description>
</method> </method>
<method name="Basis" qualifiers="constructor"> <method name="Basis" qualifiers="constructor">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="x_axis" type="Vector3" />
<argument index="0" name="x_axis" type="Vector3"> <argument index="1" name="y_axis" type="Vector3" />
</argument> <argument index="2" name="z_axis" type="Vector3" />
<argument index="1" name="y_axis" type="Vector3">
</argument>
<argument index="2" name="z_axis" type="Vector3">
</argument>
<description> <description>
Constructs a basis matrix from 3 axis vectors (matrix columns). Constructs a basis matrix from 3 axis vectors (matrix columns).
</description> </description>
</method> </method>
<method name="determinant" qualifiers="const"> <method name="determinant" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the determinant of the basis matrix. If the basis is uniformly scaled, its determinant is the square of the scale. Returns the determinant of the basis matrix. If the basis is uniformly scaled, its determinant is the square of the scale.
A negative determinant means the basis has a negative scale. A zero determinant means the basis isn't invertible, and is usually considered invalid. A negative determinant means the basis has a negative scale. A zero determinant means the basis isn't invertible, and is usually considered invalid.
</description> </description>
</method> </method>
<method name="get_euler" qualifiers="const"> <method name="get_euler" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return>
<description> <description>
Returns the basis's rotation in the form of Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last). The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). Returns the basis's rotation in the form of Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last). The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle).
Consider using the [method get_rotation_quaternion] method instead, which returns a [Quaternion] quaternion instead of Euler angles. Consider using the [method get_rotation_quaternion] method instead, which returns a [Quaternion] quaternion instead of Euler angles.
</description> </description>
</method> </method>
<method name="get_orthogonal_index" qualifiers="const"> <method name="get_orthogonal_index" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the [GridMap] editor. For further details, refer to the Godot source code. This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the [GridMap] editor. For further details, refer to the Godot source code.
</description> </description>
</method> </method>
<method name="get_rotation_quaternion" qualifiers="const"> <method name="get_rotation_quaternion" qualifiers="const">
<return type="Quaternion"> <return type="Quaternion" />
</return>
<description> <description>
Returns the basis's rotation in the form of a quaternion. See [method get_euler] if you need Euler angles, but keep in mind quaternions should generally be preferred to Euler angles. Returns the basis's rotation in the form of a quaternion. See [method get_euler] if you need Euler angles, but keep in mind quaternions should generally be preferred to Euler angles.
</description> </description>
</method> </method>
<method name="get_scale" qualifiers="const"> <method name="get_scale" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return>
<description> <description>
Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis. Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis.
</description> </description>
</method> </method>
<method name="inverse" qualifiers="const"> <method name="inverse" qualifiers="const">
<return type="Basis"> <return type="Basis" />
</return>
<description> <description>
Returns the inverse of the matrix. Returns the inverse of the matrix.
</description> </description>
</method> </method>
<method name="is_equal_approx" qualifiers="const"> <method name="is_equal_approx" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="b" type="Basis" />
<argument index="0" name="b" type="Basis">
</argument>
<description> <description>
Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component.
</description> </description>
</method> </method>
<method name="operator !=" qualifiers="operator"> <method name="operator !=" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Basis" />
<argument index="0" name="right" type="Basis">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator *" qualifiers="operator"> <method name="operator *" qualifiers="operator">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="right" type="Vector3" />
<argument index="0" name="right" type="Vector3">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator *" qualifiers="operator"> <method name="operator *" qualifiers="operator">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="right" type="Basis" />
<argument index="0" name="right" type="Basis">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator *" qualifiers="operator"> <method name="operator *" qualifiers="operator">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="right" type="float" />
<argument index="0" name="right" type="float">
</argument>
<description> <description>
This operator multiplies all components of the [Basis], which scales it uniformly. This operator multiplies all components of the [Basis], which scales it uniformly.
</description> </description>
</method> </method>
<method name="operator *" qualifiers="operator"> <method name="operator *" qualifiers="operator">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="right" type="int" />
<argument index="0" name="right" type="int">
</argument>
<description> <description>
This operator multiplies all components of the [Basis], which scales it uniformly. This operator multiplies all components of the [Basis], which scales it uniformly.
</description> </description>
</method> </method>
<method name="operator ==" qualifiers="operator"> <method name="operator ==" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Basis" />
<argument index="0" name="right" type="Basis">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator []" qualifiers="operator"> <method name="operator []" qualifiers="operator">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="orthonormalized" qualifiers="const"> <method name="orthonormalized" qualifiers="const">
<return type="Basis"> <return type="Basis" />
</return>
<description> <description>
Returns the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. Returns the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix.
</description> </description>
</method> </method>
<method name="rotated" qualifiers="const"> <method name="rotated" qualifiers="const">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="axis" type="Vector3" />
<argument index="0" name="axis" type="Vector3"> <argument index="1" name="phi" type="float" />
</argument>
<argument index="1" name="phi" type="float">
</argument>
<description> <description>
Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector. Introduce an additional rotation around the given axis by phi (radians). The axis must be a normalized vector.
</description> </description>
</method> </method>
<method name="scaled" qualifiers="const"> <method name="scaled" qualifiers="const">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="scale" type="Vector3" />
<argument index="0" name="scale" type="Vector3">
</argument>
<description> <description>
Introduce an additional scaling specified by the given 3D scaling factor. Introduce an additional scaling specified by the given 3D scaling factor.
</description> </description>
</method> </method>
<method name="slerp" qualifiers="const"> <method name="slerp" qualifiers="const">
<return type="Basis"> <return type="Basis" />
</return> <argument index="0" name="to" type="Basis" />
<argument index="0" name="to" type="Basis"> <argument index="1" name="weight" type="float" />
</argument>
<argument index="1" name="weight" type="float">
</argument>
<description> <description>
Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix. Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix.
</description> </description>
</method> </method>
<method name="tdotx" qualifiers="const"> <method name="tdotx" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="with" type="Vector3" />
<argument index="0" name="with" type="Vector3">
</argument>
<description> <description>
Transposed dot product with the X axis of the matrix. Transposed dot product with the X axis of the matrix.
</description> </description>
</method> </method>
<method name="tdoty" qualifiers="const"> <method name="tdoty" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="with" type="Vector3" />
<argument index="0" name="with" type="Vector3">
</argument>
<description> <description>
Transposed dot product with the Y axis of the matrix. Transposed dot product with the Y axis of the matrix.
</description> </description>
</method> </method>
<method name="tdotz" qualifiers="const"> <method name="tdotz" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="with" type="Vector3" />
<argument index="0" name="with" type="Vector3">
</argument>
<description> <description>
Transposed dot product with the Z axis of the matrix. Transposed dot product with the Z axis of the matrix.
</description> </description>
</method> </method>
<method name="transposed" qualifiers="const"> <method name="transposed" qualifiers="const">
<return type="Basis"> <return type="Basis" />
</return>
<description> <description>
Returns the transposed version of the matrix. Returns the transposed version of the matrix.
</description> </description>

63
doc/classes/BitMap.xml
View File

@ -10,66 +10,51 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="create"> <method name="create">
<return type="void"> <return type="void" />
</return> <argument index="0" name="size" type="Vector2" />
<argument index="0" name="size" type="Vector2">
</argument>
<description> <description>
Creates a bitmap with the specified size, filled with [code]false[/code]. Creates a bitmap with the specified size, filled with [code]false[/code].
</description> </description>
</method> </method>
<method name="create_from_image_alpha"> <method name="create_from_image_alpha">
<return type="void"> <return type="void" />
</return> <argument index="0" name="image" type="Image" />
<argument index="0" name="image" type="Image"> <argument index="1" name="threshold" type="float" default="0.1" />
</argument>
<argument index="1" name="threshold" type="float" default="0.1">
</argument>
<description> <description>
Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to [code]false[/code] if the alpha value of the image at that position is equal to [code]threshold[/code] or less, and [code]true[/code] in other case. Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to [code]false[/code] if the alpha value of the image at that position is equal to [code]threshold[/code] or less, and [code]true[/code] in other case.
</description> </description>
</method> </method>
<method name="get_bit" qualifiers="const"> <method name="get_bit" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2">
</argument>
<description> <description>
Returns bitmap's value at the specified position. Returns bitmap's value at the specified position.
</description> </description>
</method> </method>
<method name="get_size" qualifiers="const"> <method name="get_size" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns bitmap's dimensions. Returns bitmap's dimensions.
</description> </description>
</method> </method>
<method name="get_true_bit_count" qualifiers="const"> <method name="get_true_bit_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the amount of bitmap elements that are set to [code]true[/code]. Returns the amount of bitmap elements that are set to [code]true[/code].
</description> </description>
</method> </method>
<method name="grow_mask"> <method name="grow_mask">
<return type="void"> <return type="void" />
</return> <argument index="0" name="pixels" type="int" />
<argument index="0" name="pixels" type="int"> <argument index="1" name="rect" type="Rect2" />
</argument>
<argument index="1" name="rect" type="Rect2">
</argument>
<description> <description>
Applies morphological dilation to the bitmap. The first argument is the dilation amount, Rect2 is the area where the dilation will be applied. Applies morphological dilation to the bitmap. The first argument is the dilation amount, Rect2 is the area where the dilation will be applied.
</description> </description>
</method> </method>
<method name="opaque_to_polygons" qualifiers="const"> <method name="opaque_to_polygons" qualifiers="const">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="rect" type="Rect2" />
<argument index="0" name="rect" type="Rect2"> <argument index="1" name="epsilon" type="float" default="2.0" />
</argument>
<argument index="1" name="epsilon" type="float" default="2.0">
</argument>
<description> <description>
Creates an [Array] of polygons covering a rectangular portion of the bitmap. It uses a marching squares algorithm, followed by Ramer-Douglas-Peucker (RDP) reduction of the number of vertices. Each polygon is described as a [PackedVector2Array] of its vertices. Creates an [Array] of polygons covering a rectangular portion of the bitmap. It uses a marching squares algorithm, followed by Ramer-Douglas-Peucker (RDP) reduction of the number of vertices. Each polygon is described as a [PackedVector2Array] of its vertices.
To get polygons covering the whole bitmap, pass: To get polygons covering the whole bitmap, pass:
@ -80,23 +65,17 @@
</description> </description>
</method> </method>
<method name="set_bit"> <method name="set_bit">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2"> <argument index="1" name="bit" type="bool" />
</argument>
<argument index="1" name="bit" type="bool">
</argument>
<description> <description>
Sets the bitmap's element at the specified position, to the specified value. Sets the bitmap's element at the specified position, to the specified value.
</description> </description>
</method> </method>
<method name="set_bit_rect"> <method name="set_bit_rect">
<return type="void"> <return type="void" />
</return> <argument index="0" name="rect" type="Rect2" />
<argument index="0" name="rect" type="Rect2"> <argument index="1" name="bit" type="bool" />
</argument>
<argument index="1" name="bit" type="bool">
</argument>
<description> <description>
Sets a rectangular portion of the bitmap to the specified value. Sets a rectangular portion of the bitmap to the specified value.
</description> </description>

45
doc/classes/Bone2D.xml
View File

@ -13,88 +13,73 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="apply_rest"> <method name="apply_rest">
<return type="void"> <return type="void" />
</return>
<description> <description>
Stores the node's current transforms in [member rest]. Stores the node's current transforms in [member rest].
</description> </description>
</method> </method>
<method name="get_autocalculate_length_and_angle" qualifiers="const"> <method name="get_autocalculate_length_and_angle" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns whether this [code]Bone2D[/code] node is going to autocalculate its length and bone angle using its first [code]Bone2D[/code] child node, if one exists. If there are no [code]Bone2D[/code] children, then it cannot autocalculate these values and will print a warning. Returns whether this [code]Bone2D[/code] node is going to autocalculate its length and bone angle using its first [code]Bone2D[/code] child node, if one exists. If there are no [code]Bone2D[/code] children, then it cannot autocalculate these values and will print a warning.
</description> </description>
</method> </method>
<method name="get_bone_angle" qualifiers="const"> <method name="get_bone_angle" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the angle of the bone in the [code]Bone2D[/code] node. Returns the angle of the bone in the [code]Bone2D[/code] node.
[b]Note:[/b] This is different from the [code]Bone2D[/code]'s rotation. The bone angle is the rotation of the bone shown by the [code]Bone2D[/code] gizmo, and because [code]Bone2D[/code] bones are based on positions, this can vary from the actual rotation of the [code]Bone2D[/code] node. [b]Note:[/b] This is different from the [code]Bone2D[/code]'s rotation. The bone angle is the rotation of the bone shown by the [code]Bone2D[/code] gizmo, and because [code]Bone2D[/code] bones are based on positions, this can vary from the actual rotation of the [code]Bone2D[/code] node.
</description> </description>
</method> </method>
<method name="get_default_length" qualifiers="const"> <method name="get_default_length" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Deprecated. Please use [code]get_length[/code] instead. Deprecated. Please use [code]get_length[/code] instead.
</description> </description>
</method> </method>
<method name="get_index_in_skeleton" qualifiers="const"> <method name="get_index_in_skeleton" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the node's index as part of the entire skeleton. See [Skeleton2D]. Returns the node's index as part of the entire skeleton. See [Skeleton2D].
</description> </description>
</method> </method>
<method name="get_length" qualifiers="const"> <method name="get_length" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the length of the bone in the [code]Bone2D[/code] node. Returns the length of the bone in the [code]Bone2D[/code] node.
</description> </description>
</method> </method>
<method name="get_skeleton_rest" qualifiers="const"> <method name="get_skeleton_rest" qualifiers="const">
<return type="Transform2D"> <return type="Transform2D" />
</return>
<description> <description>
Returns the node's [member rest] [code]Transform2D[/code] if it doesn't have a parent, or its rest pose relative to its parent. Returns the node's [member rest] [code]Transform2D[/code] if it doesn't have a parent, or its rest pose relative to its parent.
</description> </description>
</method> </method>
<method name="set_autocalculate_length_and_angle"> <method name="set_autocalculate_length_and_angle">
<return type="void"> <return type="void" />
</return> <argument index="0" name="auto_calculate" type="bool" />
<argument index="0" name="auto_calculate" type="bool">
</argument>
<description> <description>
When set to [code]true[/code], the [code]Bone2D[/code] node will attempt to automatically calculate the bone angle and length using the first child [code]Bone2D[/code] node, if one exists. If none exist, the [code]Bone2D[/code] cannot automatically calculate these values and will print a warning. When set to [code]true[/code], the [code]Bone2D[/code] node will attempt to automatically calculate the bone angle and length using the first child [code]Bone2D[/code] node, if one exists. If none exist, the [code]Bone2D[/code] cannot automatically calculate these values and will print a warning.
</description> </description>
</method> </method>
<method name="set_bone_angle"> <method name="set_bone_angle">
<return type="void"> <return type="void" />
</return> <argument index="0" name="angle" type="float" />
<argument index="0" name="angle" type="float">
</argument>
<description> <description>
Sets the bone angle for the [code]Bone2D[/code] node. This is typically set to the rotation from the [code]Bone2D[/code] node to a child [code]Bone2D[/code] node. Sets the bone angle for the [code]Bone2D[/code] node. This is typically set to the rotation from the [code]Bone2D[/code] node to a child [code]Bone2D[/code] node.
[b]Note:[/b] This is different from the [code]Bone2D[/code]'s rotation. The bone angle is the rotation of the bone shown by the [code]Bone2D[/code] gizmo, and because [code]Bone2D[/code] bones are based on positions, this can vary from the actual rotation of the [code]Bone2D[/code] node. [b]Note:[/b] This is different from the [code]Bone2D[/code]'s rotation. The bone angle is the rotation of the bone shown by the [code]Bone2D[/code] gizmo, and because [code]Bone2D[/code] bones are based on positions, this can vary from the actual rotation of the [code]Bone2D[/code] node.
</description> </description>
</method> </method>
<method name="set_default_length"> <method name="set_default_length">
<return type="void"> <return type="void" />
</return> <argument index="0" name="default_length" type="float" />
<argument index="0" name="default_length" type="float">
</argument>
<description> <description>
Deprecated. Please use [code]set_length[/code] instead. Deprecated. Please use [code]set_length[/code] instead.
</description> </description>
</method> </method>
<method name="set_length"> <method name="set_length">
<return type="void"> <return type="void" />
</return> <argument index="0" name="length" type="float" />
<argument index="0" name="length" type="float">
</argument>
<description> <description>
Sets the length of the bone in the [code]Bone2D[/code] node. Sets the length of the bone in the [code]Bone2D[/code] node.
</description> </description>

6
doc/classes/BoxContainer.xml
View File

@ -10,10 +10,8 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_spacer"> <method name="add_spacer">
<return type="Control"> <return type="Control" />
</return> <argument index="0" name="begin" type="bool" />
<argument index="0" name="begin" type="bool">
</argument>
<description> <description>
Adds a [Control] node to the box as a spacer. If [code]begin[/code] is [code]true[/code], it will insert the [Control] node in front of all other children. Adds a [Control] node to the box as a spacer. If [code]begin[/code] is [code]true[/code], it will insert the [Control] node in front of all other children.
</description> </description>

18
doc/classes/Button.xml
View File

@ -42,28 +42,22 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="clear_opentype_features"> <method name="clear_opentype_features">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all OpenType features. Removes all OpenType features.
</description> </description>
</method> </method>
<method name="get_opentype_feature" qualifiers="const"> <method name="get_opentype_feature" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="tag" type="String" />
<argument index="0" name="tag" type="String">
</argument>
<description> <description>
Returns OpenType feature [code]tag[/code]. Returns OpenType feature [code]tag[/code].
</description> </description>
</method> </method>
<method name="set_opentype_feature"> <method name="set_opentype_feature">
<return type="void"> <return type="void" />
</return> <argument index="0" name="tag" type="String" />
<argument index="0" name="tag" type="String"> <argument index="1" name="value" type="int" />
</argument>
<argument index="1" name="value" type="int">
</argument>
<description> <description>
Sets OpenType feature [code]tag[/code]. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url]. Sets OpenType feature [code]tag[/code]. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url].
</description> </description>

9
doc/classes/ButtonGroup.xml
View File

@ -11,15 +11,13 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_buttons"> <method name="get_buttons">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns an [Array] of [Button]s who have this as their [ButtonGroup] (see [member BaseButton.button_group]). Returns an [Array] of [Button]s who have this as their [ButtonGroup] (see [member BaseButton.button_group]).
</description> </description>
</method> </method>
<method name="get_pressed_button"> <method name="get_pressed_button">
<return type="BaseButton"> <return type="BaseButton" />
</return>
<description> <description>
Returns the current pressed button. Returns the current pressed button.
</description> </description>
@ -30,8 +28,7 @@
</members> </members>
<signals> <signals>
<signal name="pressed"> <signal name="pressed">
<argument index="0" name="button" type="Object"> <argument index="0" name="button" type="Object" />
</argument>
<description> <description>
Emitted when one of the buttons of the group is pressed. Emitted when one of the buttons of the group is pressed.
</description> </description>

69
doc/classes/CPUParticles2D.xml
View File

@ -12,97 +12,74 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="convert_from_particles"> <method name="convert_from_particles">
<return type="void"> <return type="void" />
</return> <argument index="0" name="particles" type="Node" />
<argument index="0" name="particles" type="Node">
</argument>
<description> <description>
Sets this node's properties to match a given [GPUParticles2D] node with an assigned [ParticlesMaterial]. Sets this node's properties to match a given [GPUParticles2D] node with an assigned [ParticlesMaterial].
</description> </description>
</method> </method>
<method name="get_param" qualifiers="const"> <method name="get_param" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter">
</argument>
<description> <description>
Returns the base value of the parameter specified by [enum Parameter]. Returns the base value of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="get_param_curve" qualifiers="const"> <method name="get_param_curve" qualifiers="const">
<return type="Curve"> <return type="Curve" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter">
</argument>
<description> <description>
Returns the [Curve] of the parameter specified by [enum Parameter]. Returns the [Curve] of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="get_param_randomness" qualifiers="const"> <method name="get_param_randomness" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter">
</argument>
<description> <description>
Returns the randomness factor of the parameter specified by [enum Parameter]. Returns the randomness factor of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="get_particle_flag" qualifiers="const"> <method name="get_particle_flag" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags" />
<argument index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags">
</argument>
<description> <description>
Returns the enabled state of the given flag (see [enum ParticleFlags] for options). Returns the enabled state of the given flag (see [enum ParticleFlags] for options).
</description> </description>
</method> </method>
<method name="restart"> <method name="restart">
<return type="void"> <return type="void" />
</return>
<description> <description>
Restarts the particle emitter. Restarts the particle emitter.
</description> </description>
</method> </method>
<method name="set_param"> <method name="set_param">
<return type="void"> <return type="void" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter"> <argument index="1" name="value" type="float" />
</argument>
<argument index="1" name="value" type="float">
</argument>
<description> <description>
Sets the base value of the parameter specified by [enum Parameter]. Sets the base value of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="set_param_curve"> <method name="set_param_curve">
<return type="void"> <return type="void" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter"> <argument index="1" name="curve" type="Curve" />
</argument>
<argument index="1" name="curve" type="Curve">
</argument>
<description> <description>
Sets the [Curve] of the parameter specified by [enum Parameter]. Sets the [Curve] of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="set_param_randomness"> <method name="set_param_randomness">
<return type="void"> <return type="void" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles2D.Parameter"> <argument index="1" name="randomness" type="float" />
</argument>
<argument index="1" name="randomness" type="float">
</argument>
<description> <description>
Sets the randomness factor of the parameter specified by [enum Parameter]. Sets the randomness factor of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="set_particle_flag"> <method name="set_particle_flag">
<return type="void"> <return type="void" />
</return> <argument index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags" />
<argument index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
Enables or disables the given flag (see [enum ParticleFlags] for options). Enables or disables the given flag (see [enum ParticleFlags] for options).
</description> </description>

69
doc/classes/CPUParticles3D.xml
View File

@ -11,97 +11,74 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="convert_from_particles"> <method name="convert_from_particles">
<return type="void"> <return type="void" />
</return> <argument index="0" name="particles" type="Node" />
<argument index="0" name="particles" type="Node">
</argument>
<description> <description>
Sets this node's properties to match a given [GPUParticles3D] node with an assigned [ParticlesMaterial]. Sets this node's properties to match a given [GPUParticles3D] node with an assigned [ParticlesMaterial].
</description> </description>
</method> </method>
<method name="get_param" qualifiers="const"> <method name="get_param" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter">
</argument>
<description> <description>
Returns the base value of the parameter specified by [enum Parameter]. Returns the base value of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="get_param_curve" qualifiers="const"> <method name="get_param_curve" qualifiers="const">
<return type="Curve"> <return type="Curve" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter">
</argument>
<description> <description>
Returns the [Curve] of the parameter specified by [enum Parameter]. Returns the [Curve] of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="get_param_randomness" qualifiers="const"> <method name="get_param_randomness" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter">
</argument>
<description> <description>
Returns the randomness factor of the parameter specified by [enum Parameter]. Returns the randomness factor of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="get_particle_flag" qualifiers="const"> <method name="get_particle_flag" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="particle_flag" type="int" enum="CPUParticles3D.ParticleFlags" />
<argument index="0" name="particle_flag" type="int" enum="CPUParticles3D.ParticleFlags">
</argument>
<description> <description>
Returns the enabled state of the given particle flag (see [enum ParticleFlags] for options). Returns the enabled state of the given particle flag (see [enum ParticleFlags] for options).
</description> </description>
</method> </method>
<method name="restart"> <method name="restart">
<return type="void"> <return type="void" />
</return>
<description> <description>
Restarts the particle emitter. Restarts the particle emitter.
</description> </description>
</method> </method>
<method name="set_param"> <method name="set_param">
<return type="void"> <return type="void" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter"> <argument index="1" name="value" type="float" />
</argument>
<argument index="1" name="value" type="float">
</argument>
<description> <description>
Sets the base value of the parameter specified by [enum Parameter]. Sets the base value of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="set_param_curve"> <method name="set_param_curve">
<return type="void"> <return type="void" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter"> <argument index="1" name="curve" type="Curve" />
</argument>
<argument index="1" name="curve" type="Curve">
</argument>
<description> <description>
Sets the [Curve] of the parameter specified by [enum Parameter]. Sets the [Curve] of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="set_param_randomness"> <method name="set_param_randomness">
<return type="void"> <return type="void" />
</return> <argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter" />
<argument index="0" name="param" type="int" enum="CPUParticles3D.Parameter"> <argument index="1" name="randomness" type="float" />
</argument>
<argument index="1" name="randomness" type="float">
</argument>
<description> <description>
Sets the randomness factor of the parameter specified by [enum Parameter]. Sets the randomness factor of the parameter specified by [enum Parameter].
</description> </description>
</method> </method>
<method name="set_particle_flag"> <method name="set_particle_flag">
<return type="void"> <return type="void" />
</return> <argument index="0" name="particle_flag" type="int" enum="CPUParticles3D.ParticleFlags" />
<argument index="0" name="particle_flag" type="int" enum="CPUParticles3D.ParticleFlags"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
Enables or disables the given particle flag (see [enum ParticleFlags] for options). Enables or disables the given particle flag (see [enum ParticleFlags] for options).
</description> </description>

78
doc/classes/Callable.xml
View File

@ -37,148 +37,122 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="Callable" qualifiers="constructor"> <method name="Callable" qualifiers="constructor">
<return type="Callable"> <return type="Callable" />
</return>
<description> <description>
Constructs a null [Callable] with no object nor method bound. Constructs a null [Callable] with no object nor method bound.
</description> </description>
</method> </method>
<method name="Callable" qualifiers="constructor"> <method name="Callable" qualifiers="constructor">
<return type="Callable"> <return type="Callable" />
</return> <argument index="0" name="from" type="Callable" />
<argument index="0" name="from" type="Callable">
</argument>
<description> <description>
Constructs a [Callable] as a copy of the given [Callable]. Constructs a [Callable] as a copy of the given [Callable].
</description> </description>
</method> </method>
<method name="Callable" qualifiers="constructor"> <method name="Callable" qualifiers="constructor">
<return type="Callable"> <return type="Callable" />
</return> <argument index="0" name="object" type="Object" />
<argument index="0" name="object" type="Object"> <argument index="1" name="method" type="StringName" />
</argument>
<argument index="1" name="method" type="StringName">
</argument>
<description> <description>
Creates a new [Callable] for the method called [code]method[/code] in the specified [code]object[/code]. Creates a new [Callable] for the method called [code]method[/code] in the specified [code]object[/code].
</description> </description>
</method> </method>
<method name="bind" qualifiers="vararg const"> <method name="bind" qualifiers="vararg const">
<return type="Callable"> <return type="Callable" />
</return>
<description> <description>
Returns a copy of this [Callable] with the arguments bound. Bound arguments are passed after the arguments supplied by [method call]. Returns a copy of this [Callable] with the arguments bound. Bound arguments are passed after the arguments supplied by [method call].
</description> </description>
</method> </method>
<method name="call" qualifiers="vararg const"> <method name="call" qualifiers="vararg const">
<return type="Variant"> <return type="Variant" />
</return>
<description> <description>
Calls the method represented by this [Callable]. Arguments can be passed and should match the method's signature. Calls the method represented by this [Callable]. Arguments can be passed and should match the method's signature.
</description> </description>
</method> </method>
<method name="call_deferred" qualifiers="vararg const"> <method name="call_deferred" qualifiers="vararg const">
<return type="void"> <return type="void" />
</return>
<description> <description>
Calls the method represented by this [Callable] in deferred mode, i.e. during the idle frame. Arguments can be passed and should match the method's signature. Calls the method represented by this [Callable] in deferred mode, i.e. during the idle frame. Arguments can be passed and should match the method's signature.
</description> </description>
</method> </method>
<method name="get_method" qualifiers="const"> <method name="get_method" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return>
<description> <description>
Returns the name of the method represented by this [Callable]. Returns the name of the method represented by this [Callable].
</description> </description>
</method> </method>
<method name="get_object" qualifiers="const"> <method name="get_object" qualifiers="const">
<return type="Object"> <return type="Object" />
</return>
<description> <description>
Returns the object on which this [Callable] is called. Returns the object on which this [Callable] is called.
</description> </description>
</method> </method>
<method name="get_object_id" qualifiers="const"> <method name="get_object_id" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the ID of this [Callable]'s object (see [method Object.get_instance_id]). Returns the ID of this [Callable]'s object (see [method Object.get_instance_id]).
</description> </description>
</method> </method>
<method name="hash" qualifiers="const"> <method name="hash" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the hash value of this [Callable]'s object. Returns the hash value of this [Callable]'s object.
</description> </description>
</method> </method>
<method name="is_custom" qualifiers="const"> <method name="is_custom" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if this [Callable] is a custom callable whose behavior differs based on implementation details. Custom callables are used in the engine for various reasons. If [code]true[/code], you can't use [method get_method]. Returns [code]true[/code] if this [Callable] is a custom callable whose behavior differs based on implementation details. Custom callables are used in the engine for various reasons. If [code]true[/code], you can't use [method get_method].
</description> </description>
</method> </method>
<method name="is_null" qualifiers="const"> <method name="is_null" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if this [Callable] has no target to call the method on. Returns [code]true[/code] if this [Callable] has no target to call the method on.
</description> </description>
</method> </method>
<method name="is_standard" qualifiers="const"> <method name="is_standard" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if this [Callable] is a standard callable, referencing an object and a method using a [StringName]. Returns [code]true[/code] if this [Callable] is a standard callable, referencing an object and a method using a [StringName].
</description> </description>
</method> </method>
<method name="is_valid" qualifiers="const"> <method name="is_valid" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the object exists and has a valid function assigned, or is a custom callable. Returns [code]true[/code] if the object exists and has a valid function assigned, or is a custom callable.
</description> </description>
</method> </method>
<method name="operator !=" qualifiers="operator"> <method name="operator !=" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Callable" />
<argument index="0" name="right" type="Callable">
</argument>
<description> <description>
Returns [code]true[/code] if both [Callable]s invoke different targets. Returns [code]true[/code] if both [Callable]s invoke different targets.
</description> </description>
</method> </method>
<method name="operator ==" qualifiers="operator"> <method name="operator ==" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Callable" />
<argument index="0" name="right" type="Callable">
</argument>
<description> <description>
Returns [code]true[/code] if both [Callable]s invoke the same custom target. Returns [code]true[/code] if both [Callable]s invoke the same custom target.
</description> </description>
</method> </method>
<method name="rpc" qualifiers="vararg const"> <method name="rpc" qualifiers="vararg const">
<return type="void"> <return type="void" />
</return>
<description> <description>
Perform an RPC (Remote Procedure Call). This is used for multiplayer and is normally not available unless the function being called has been marked as [i]RPC[/i]. Calling it on unsupported functions will result in an error. Perform an RPC (Remote Procedure Call). This is used for multiplayer and is normally not available unless the function being called has been marked as [i]RPC[/i]. Calling it on unsupported functions will result in an error.
</description> </description>
</method> </method>
<method name="rpc_id" qualifiers="vararg const"> <method name="rpc_id" qualifiers="vararg const">
<return type="void"> <return type="void" />
</return> <argument index="0" name="peer_id" type="int" />
<argument index="0" name="peer_id" type="int">
</argument>
<description> <description>
Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer documentation for reference). This is used for multiplayer and is normally not available unless the function being called has been marked as [i]RPC[/i]. Calling it on unsupported functions will result in an error. Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer documentation for reference). This is used for multiplayer and is normally not available unless the function being called has been marked as [i]RPC[/i]. Calling it on unsupported functions will result in an error.
</description> </description>
</method> </method>
<method name="unbind" qualifiers="const"> <method name="unbind" qualifiers="const">
<return type="Callable"> <return type="Callable" />
</return> <argument index="0" name="argcount" type="int" />
<argument index="0" name="argcount" type="int">
</argument>
<description> <description>
Returns a copy of this [Callable] with the arguments unbound. Calling the returned [Callable] will call the method without the extra arguments that are supplied in the [Callable] on which you are calling this method. Returns a copy of this [Callable] with the arguments unbound. Calling the returned [Callable] will call the method without the extra arguments that are supplied in the [Callable] on which you are calling this method.
</description> </description>

6
doc/classes/CallbackTweener.xml
View File

@ -11,10 +11,8 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="set_delay"> <method name="set_delay">
<return type="CallbackTweener"> <return type="CallbackTweener" />
</return> <argument index="0" name="delay" type="float" />
<argument index="0" name="delay" type="float">
</argument>
<description> <description>
Makes the callback call delayed by given time in seconds. Example: Makes the callback call delayed by given time in seconds. Example:
[codeblock] [codeblock]

45
doc/classes/Camera2D.xml
View File

@ -15,77 +15,62 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="align"> <method name="align">
<return type="void"> <return type="void" />
</return>
<description> <description>
Aligns the camera to the tracked node. Aligns the camera to the tracked node.
</description> </description>
</method> </method>
<method name="force_update_scroll"> <method name="force_update_scroll">
<return type="void"> <return type="void" />
</return>
<description> <description>
Forces the camera to update scroll immediately. Forces the camera to update scroll immediately.
</description> </description>
</method> </method>
<method name="get_camera_position" qualifiers="const"> <method name="get_camera_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns the camera position. Returns the camera position.
</description> </description>
</method> </method>
<method name="get_camera_screen_center" qualifiers="const"> <method name="get_camera_screen_center" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns the location of the [Camera2D]'s screen-center, relative to the origin. Returns the location of the [Camera2D]'s screen-center, relative to the origin.
</description> </description>
</method> </method>
<method name="get_drag_margin" qualifiers="const"> <method name="get_drag_margin" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="margin" type="int" enum="Side" />
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description> <description>
Returns the specified [enum Side]'s margin. See also [member drag_bottom_margin], [member drag_top_margin], [member drag_left_margin], and [member drag_right_margin]. Returns the specified [enum Side]'s margin. See also [member drag_bottom_margin], [member drag_top_margin], [member drag_left_margin], and [member drag_right_margin].
</description> </description>
</method> </method>
<method name="get_limit" qualifiers="const"> <method name="get_limit" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="margin" type="int" enum="Side" />
<argument index="0" name="margin" type="int" enum="Side">
</argument>
<description> <description>
Returns the camera limit for the specified [enum Side]. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. Returns the camera limit for the specified [enum Side]. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right].
</description> </description>
</method> </method>
<method name="reset_smoothing"> <method name="reset_smoothing">
<return type="void"> <return type="void" />
</return>
<description> <description>
Sets the camera's position immediately to its current smoothing destination. Sets the camera's position immediately to its current smoothing destination.
This has no effect if smoothing is disabled. This has no effect if smoothing is disabled.
</description> </description>
</method> </method>
<method name="set_drag_margin"> <method name="set_drag_margin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="margin" type="int" enum="Side" />
<argument index="0" name="margin" type="int" enum="Side"> <argument index="1" name="drag_margin" type="float" />
</argument>
<argument index="1" name="drag_margin" type="float">
</argument>
<description> <description>
Sets the specified [enum Side]'s margin. See also [member drag_bottom_margin], [member drag_top_margin], [member drag_left_margin], and [member drag_right_margin]. Sets the specified [enum Side]'s margin. See also [member drag_bottom_margin], [member drag_top_margin], [member drag_left_margin], and [member drag_right_margin].
</description> </description>
</method> </method>
<method name="set_limit"> <method name="set_limit">
<return type="void"> <return type="void" />
</return> <argument index="0" name="margin" type="int" enum="Side" />
<argument index="0" name="margin" type="int" enum="Side"> <argument index="1" name="limit" type="int" />
</argument>
<argument index="1" name="limit" type="int">
</argument>
<description> <description>
Sets the camera limit for the specified [enum Side]. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. Sets the camera limit for the specified [enum Side]. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right].
</description> </description>

117
doc/classes/Camera3D.xml
View File

@ -11,165 +11,126 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="clear_current"> <method name="clear_current">
<return type="void"> <return type="void" />
</return> <argument index="0" name="enable_next" type="bool" default="true" />
<argument index="0" name="enable_next" type="bool" default="true">
</argument>
<description> <description>
If this is the current camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next camera current, if any. If this is the current camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next camera current, if any.
</description> </description>
</method> </method>
<method name="get_camera_rid" qualifiers="const"> <method name="get_camera_rid" qualifiers="const">
<return type="RID"> <return type="RID" />
</return>
<description> <description>
Returns the camera's RID from the [RenderingServer]. Returns the camera's RID from the [RenderingServer].
</description> </description>
</method> </method>
<method name="get_camera_transform" qualifiers="const"> <method name="get_camera_transform" qualifiers="const">
<return type="Transform3D"> <return type="Transform3D" />
</return>
<description> <description>
Gets the camera transform. Subclassed cameras such as [ClippedCamera3D] may provide different transforms than the [Node] transform. Gets the camera transform. Subclassed cameras such as [ClippedCamera3D] may provide different transforms than the [Node] transform.
</description> </description>
</method> </method>
<method name="get_cull_mask_bit" qualifiers="const"> <method name="get_cull_mask_bit" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int">
</argument>
<description> <description>
Returns [code]true[/code] if the given [code]layer[/code] in the [member cull_mask] is enabled, [code]false[/code] otherwise. Returns [code]true[/code] if the given [code]layer[/code] in the [member cull_mask] is enabled, [code]false[/code] otherwise.
</description> </description>
</method> </method>
<method name="get_frustum" qualifiers="const"> <method name="get_frustum" qualifiers="const">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns the camera's frustum planes in world space units as an array of [Plane]s in the following order: near, far, left, top, right, bottom. Not to be confused with [member frustum_offset]. Returns the camera's frustum planes in world space units as an array of [Plane]s in the following order: near, far, left, top, right, bottom. Not to be confused with [member frustum_offset].
</description> </description>
</method> </method>
<method name="is_position_behind" qualifiers="const"> <method name="is_position_behind" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="world_point" type="Vector3" />
<argument index="0" name="world_point" type="Vector3">
</argument>
<description> <description>
Returns [code]true[/code] if the given position is behind the camera (the blue part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods. Returns [code]true[/code] if the given position is behind the camera (the blue part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods.
[b]Note:[/b] A position which returns [code]false[/code] may still be outside the camera's field of view. [b]Note:[/b] A position which returns [code]false[/code] may still be outside the camera's field of view.
</description> </description>
</method> </method>
<method name="is_position_in_frustum" qualifiers="const"> <method name="is_position_in_frustum" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="world_point" type="Vector3" />
<argument index="0" name="world_point" type="Vector3">
</argument>
<description> <description>
Returns [code]true[/code] if the given position is inside the camera's frustum (the green part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods. Returns [code]true[/code] if the given position is inside the camera's frustum (the green part of the linked diagram). [url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/camera3d_position_frustum.png]See this diagram[/url] for an overview of position query methods.
</description> </description>
</method> </method>
<method name="make_current"> <method name="make_current">
<return type="void"> <return type="void" />
</return>
<description> <description>
Makes 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. Makes 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> </description>
</method> </method>
<method name="project_local_ray_normal" qualifiers="const"> <method name="project_local_ray_normal" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="screen_point" type="Vector2" />
<argument index="0" name="screen_point" type="Vector2">
</argument>
<description> <description>
Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc.
</description> </description>
</method> </method>
<method name="project_position" qualifiers="const"> <method name="project_position" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="screen_point" type="Vector2" />
<argument index="0" name="screen_point" type="Vector2"> <argument index="1" name="z_depth" type="float" />
</argument>
<argument index="1" name="z_depth" type="float">
</argument>
<description> <description>
Returns the 3D point in world space that maps to the given 2D coordinate in the [Viewport] rectangle on a plane that is the given [code]z_depth[/code] distance into the scene away from the camera. Returns the 3D point in world space that maps to the given 2D coordinate in the [Viewport] rectangle on a plane that is the given [code]z_depth[/code] distance into the scene away from the camera.
</description> </description>
</method> </method>
<method name="project_ray_normal" qualifiers="const"> <method name="project_ray_normal" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="screen_point" type="Vector2" />
<argument index="0" name="screen_point" type="Vector2">
</argument>
<description> <description>
Returns a normal vector in world space, 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. Returns a normal vector in world space, 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> </description>
</method> </method>
<method name="project_ray_origin" qualifiers="const"> <method name="project_ray_origin" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="screen_point" type="Vector2" />
<argument index="0" name="screen_point" type="Vector2">
</argument>
<description> <description>
Returns a 3D position in world space, 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. Returns a 3D position in world space, 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> </description>
</method> </method>
<method name="set_cull_mask_bit"> <method name="set_cull_mask_bit">
<return type="void"> <return type="void" />
</return> <argument index="0" name="layer" type="int" />
<argument index="0" name="layer" type="int"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
Enables or disables the given [code]layer[/code] in the [member cull_mask]. Enables or disables the given [code]layer[/code] in the [member cull_mask].
</description> </description>
</method> </method>
<method name="set_frustum"> <method name="set_frustum">
<return type="void"> <return type="void" />
</return> <argument index="0" name="size" type="float" />
<argument index="0" name="size" type="float"> <argument index="1" name="offset" type="Vector2" />
</argument> <argument index="2" name="z_near" type="float" />
<argument index="1" name="offset" type="Vector2"> <argument index="3" name="z_far" type="float" />
</argument>
<argument index="2" name="z_near" type="float">
</argument>
<argument index="3" name="z_far" type="float">
</argument>
<description> <description>
Sets the camera projection to frustum mode (see [constant PROJECTION_FRUSTUM]), by specifying a [code]size[/code], an [code]offset[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. Sets the camera projection to frustum mode (see [constant PROJECTION_FRUSTUM]), by specifying a [code]size[/code], an [code]offset[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units.
</description> </description>
</method> </method>
<method name="set_orthogonal"> <method name="set_orthogonal">
<return type="void"> <return type="void" />
</return> <argument index="0" name="size" type="float" />
<argument index="0" name="size" type="float"> <argument index="1" name="z_near" type="float" />
</argument> <argument index="2" name="z_far" type="float" />
<argument index="1" name="z_near" type="float">
</argument>
<argument index="2" name="z_far" type="float">
</argument>
<description> <description>
Sets the camera projection to orthogonal mode (see [constant PROJECTION_ORTHOGONAL]), by specifying a [code]size[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. (As a hint, 2D games often use this projection, with values specified in pixels.) Sets the camera projection to orthogonal mode (see [constant PROJECTION_ORTHOGONAL]), by specifying a [code]size[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. (As a hint, 2D games often use this projection, with values specified in pixels.)
</description> </description>
</method> </method>
<method name="set_perspective"> <method name="set_perspective">
<return type="void"> <return type="void" />
</return> <argument index="0" name="fov" type="float" />
<argument index="0" name="fov" type="float"> <argument index="1" name="z_near" type="float" />
</argument> <argument index="2" name="z_far" type="float" />
<argument index="1" name="z_near" type="float">
</argument>
<argument index="2" name="z_far" type="float">
</argument>
<description> <description>
Sets the camera projection to perspective mode (see [constant PROJECTION_PERSPECTIVE]), by specifying a [code]fov[/code] (field of view) angle in degrees, and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. Sets the camera projection to perspective mode (see [constant PROJECTION_PERSPECTIVE]), by specifying a [code]fov[/code] (field of view) angle in degrees, and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units.
</description> </description>
</method> </method>
<method name="unproject_position" qualifiers="const"> <method name="unproject_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="world_point" type="Vector3" />
<argument index="0" name="world_point" type="Vector3">
</argument>
<description> <description>
Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in world space. Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in world space.
[b]Note:[/b] When using this to position GUI elements over a 3D viewport, use [method is_position_behind] to prevent them from appearing if the 3D point is behind the camera: [b]Note:[/b] When using this to position GUI elements over a 3D viewport, use [method is_position_behind] to prevent them from appearing if the 3D point is behind the camera:

30
doc/classes/CameraServer.xml
View File

@ -12,42 +12,34 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_feed"> <method name="add_feed">
<return type="void"> <return type="void" />
</return> <argument index="0" name="feed" type="CameraFeed" />
<argument index="0" name="feed" type="CameraFeed">
</argument>
<description> <description>
Adds the camera [code]feed[/code] to the camera server. Adds the camera [code]feed[/code] to the camera server.
</description> </description>
</method> </method>
<method name="feeds"> <method name="feeds">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns an array of [CameraFeed]s. Returns an array of [CameraFeed]s.
</description> </description>
</method> </method>
<method name="get_feed"> <method name="get_feed">
<return type="CameraFeed"> <return type="CameraFeed" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Returns the [CameraFeed] corresponding to the camera with the given [code]index[/code]. Returns the [CameraFeed] corresponding to the camera with the given [code]index[/code].
</description> </description>
</method> </method>
<method name="get_feed_count"> <method name="get_feed_count">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of [CameraFeed]s registered. Returns the number of [CameraFeed]s registered.
</description> </description>
</method> </method>
<method name="remove_feed"> <method name="remove_feed">
<return type="void"> <return type="void" />
</return> <argument index="0" name="feed" type="CameraFeed" />
<argument index="0" name="feed" type="CameraFeed">
</argument>
<description> <description>
Removes the specified camera [code]feed[/code]. Removes the specified camera [code]feed[/code].
</description> </description>
@ -55,15 +47,13 @@
</methods> </methods>
<signals> <signals>
<signal name="camera_feed_added"> <signal name="camera_feed_added">
<argument index="0" name="id" type="int"> <argument index="0" name="id" type="int" />
</argument>
<description> <description>
Emitted when a [CameraFeed] is added (e.g. a webcam is plugged in). Emitted when a [CameraFeed] is added (e.g. a webcam is plugged in).
</description> </description>
</signal> </signal>
<signal name="camera_feed_removed"> <signal name="camera_feed_removed">
<argument index="0" name="id" type="int"> <argument index="0" name="id" type="int" />
</argument>
<description> <description>
Emitted when a [CameraFeed] is removed (e.g. a webcam is unplugged). Emitted when a [CameraFeed] is removed (e.g. a webcam is unplugged).
</description> </description>

468
doc/classes/CanvasItem.xml
View File

@ -18,327 +18,217 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_draw" qualifiers="virtual"> <method name="_draw" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
Overridable function called by the engine (if defined) to draw the canvas item. Overridable function called by the engine (if defined) to draw the canvas item.
</description> </description>
</method> </method>
<method name="draw_animation_slice"> <method name="draw_animation_slice">
<return type="void"> <return type="void" />
</return> <argument index="0" name="animation_length" type="float" />
<argument index="0" name="animation_length" type="float"> <argument index="1" name="slice_begin" type="float" />
</argument> <argument index="2" name="slice_end" type="float" />
<argument index="1" name="slice_begin" type="float"> <argument index="3" name="offset" type="float" default="0.0" />
</argument>
<argument index="2" name="slice_end" type="float">
</argument>
<argument index="3" name="offset" type="float" default="0.0">
</argument>
<description> <description>
Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly. Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly.
</description> </description>
</method> </method>
<method name="draw_arc"> <method name="draw_arc">
<return type="void"> <return type="void" />
</return> <argument index="0" name="center" type="Vector2" />
<argument index="0" name="center" type="Vector2"> <argument index="1" name="radius" type="float" />
</argument> <argument index="2" name="start_angle" type="float" />
<argument index="1" name="radius" type="float"> <argument index="3" name="end_angle" type="float" />
</argument> <argument index="4" name="point_count" type="int" />
<argument index="2" name="start_angle" type="float"> <argument index="5" name="color" type="Color" />
</argument> <argument index="6" name="width" type="float" default="1.0" />
<argument index="3" name="end_angle" type="float"> <argument index="7" name="antialiased" type="bool" default="false" />
</argument>
<argument index="4" name="point_count" type="int">
</argument>
<argument index="5" name="color" type="Color">
</argument>
<argument index="6" name="width" type="float" default="1.0">
</argument>
<argument index="7" name="antialiased" type="bool" default="false">
</argument>
<description> <description>
Draws an arc between the given angles. The larger the value of [code]point_count[/code], the smoother the curve. Draws an arc between the given angles. The larger the value of [code]point_count[/code], the smoother the curve.
</description> </description>
</method> </method>
<method name="draw_char" qualifiers="const"> <method name="draw_char" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="font" type="Font" />
<argument index="0" name="font" type="Font"> <argument index="1" name="pos" type="Vector2" />
</argument> <argument index="2" name="char" type="String" />
<argument index="1" name="pos" type="Vector2"> <argument index="3" name="next" type="String" default="&quot;&quot;" />
</argument> <argument index="4" name="size" type="int" default="-1" />
<argument index="2" name="char" type="String"> <argument index="5" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
</argument> <argument index="6" name="outline_size" type="int" default="0" />
<argument index="3" name="next" type="String" default="&quot;&quot;"> <argument index="7" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" />
</argument>
<argument index="4" name="size" type="int" default="-1">
</argument>
<argument index="5" name="modulate" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<argument index="6" name="outline_size" type="int" default="0">
</argument>
<argument index="7" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)">
</argument>
<description> <description>
Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character. Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character.
</description> </description>
</method> </method>
<method name="draw_circle"> <method name="draw_circle">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2"> <argument index="1" name="radius" type="float" />
</argument> <argument index="2" name="color" type="Color" />
<argument index="1" name="radius" type="float">
</argument>
<argument index="2" name="color" type="Color">
</argument>
<description> <description>
Draws a colored circle. Draws a colored circle.
</description> </description>
</method> </method>
<method name="draw_colored_polygon"> <method name="draw_colored_polygon">
<return type="void"> <return type="void" />
</return> <argument index="0" name="points" type="PackedVector2Array" />
<argument index="0" name="points" type="PackedVector2Array"> <argument index="1" name="color" type="Color" />
</argument> <argument index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
<argument index="1" name="color" type="Color"> <argument index="3" name="texture" type="Texture2D" default="null" />
</argument>
<argument index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()">
</argument>
<argument index="3" name="texture" type="Texture2D" default="null">
</argument>
<description> <description>
Draws a colored polygon of any amount of points, convex or concave. Draws a colored polygon of any amount of points, convex or concave.
</description> </description>
</method> </method>
<method name="draw_end_animation"> <method name="draw_end_animation">
<return type="void"> <return type="void" />
</return>
<description> <description>
After submitting all animations slices via [method draw_animation_slice], this function can be used to revert drawing to its default state (all subsequent drawing commands will be visible). If you don't care about this particular use case, usage of this function after submitting the slices is not required. After submitting all animations slices via [method draw_animation_slice], this function can be used to revert drawing to its default state (all subsequent drawing commands will be visible). If you don't care about this particular use case, usage of this function after submitting the slices is not required.
</description> </description>
</method> </method>
<method name="draw_line"> <method name="draw_line">
<return type="void"> <return type="void" />
</return> <argument index="0" name="from" type="Vector2" />
<argument index="0" name="from" type="Vector2"> <argument index="1" name="to" type="Vector2" />
</argument> <argument index="2" name="color" type="Color" />
<argument index="1" name="to" type="Vector2"> <argument index="3" name="width" type="float" default="1.0" />
</argument>
<argument index="2" name="color" type="Color">
</argument>
<argument index="3" name="width" type="float" default="1.0">
</argument>
<description> <description>
Draws a line from a 2D point to another, with a given color and width. Draws a line from a 2D point to another, with a given color and width.
</description> </description>
</method> </method>
<method name="draw_mesh"> <method name="draw_mesh">
<return type="void"> <return type="void" />
</return> <argument index="0" name="mesh" type="Mesh" />
<argument index="0" name="mesh" type="Mesh"> <argument index="1" name="texture" type="Texture2D" />
</argument> <argument index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)" />
<argument index="1" name="texture" type="Texture2D"> <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
</argument>
<argument index="2" name="transform" type="Transform2D" default="Transform2D(1, 0, 0, 1, 0, 0)">
</argument>
<argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<description> <description>
Draws a [Mesh] in 2D, using the provided texture. See [MeshInstance2D] for related documentation. Draws a [Mesh] in 2D, using the provided texture. See [MeshInstance2D] for related documentation.
</description> </description>
</method> </method>
<method name="draw_multiline"> <method name="draw_multiline">
<return type="void"> <return type="void" />
</return> <argument index="0" name="points" type="PackedVector2Array" />
<argument index="0" name="points" type="PackedVector2Array"> <argument index="1" name="color" type="Color" />
</argument> <argument index="2" name="width" type="float" default="1.0" />
<argument index="1" name="color" type="Color">
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
<description> <description>
Draws multiple, parallel lines with a uniform [code]color[/code]. Draws multiple, parallel lines with a uniform [code]color[/code].
</description> </description>
</method> </method>
<method name="draw_multiline_colors"> <method name="draw_multiline_colors">
<return type="void"> <return type="void" />
</return> <argument index="0" name="points" type="PackedVector2Array" />
<argument index="0" name="points" type="PackedVector2Array"> <argument index="1" name="colors" type="PackedColorArray" />
</argument> <argument index="2" name="width" type="float" default="1.0" />
<argument index="1" name="colors" type="PackedColorArray">
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
<description> <description>
Draws multiple, parallel lines with a uniform [code]width[/code] and segment-by-segment coloring. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. Draws multiple, parallel lines with a uniform [code]width[/code] and segment-by-segment coloring. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
</description> </description>
</method> </method>
<method name="draw_multiline_string" qualifiers="const"> <method name="draw_multiline_string" qualifiers="const">
<return type="void"> <return type="void" />
</return> <argument index="0" name="font" type="Font" />
<argument index="0" name="font" type="Font"> <argument index="1" name="pos" type="Vector2" />
</argument> <argument index="2" name="text" type="String" />
<argument index="1" name="pos" type="Vector2"> <argument index="3" name="align" type="int" enum="HAlign" default="0" />
</argument> <argument index="4" name="width" type="float" default="-1" />
<argument index="2" name="text" type="String"> <argument index="5" name="max_lines" type="int" default="-1" />
</argument> <argument index="6" name="size" type="int" default="-1" />
<argument index="3" name="align" type="int" enum="HAlign" default="0"> <argument index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
</argument> <argument index="8" name="outline_size" type="int" default="0" />
<argument index="4" name="width" type="float" default="-1"> <argument index="9" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" />
</argument> <argument index="10" name="flags" type="int" default="51" />
<argument index="5" name="max_lines" type="int" default="-1">
</argument>
<argument index="6" name="size" type="int" default="-1">
</argument>
<argument index="7" name="modulate" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<argument index="8" name="outline_size" type="int" default="0">
</argument>
<argument index="9" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)">
</argument>
<argument index="10" name="flags" type="int" default="51">
</argument>
<description> <description>
Breaks [code]text[/code] to the lines and draws it using the specified [code]font[/code] at the [code]position[/code] (top-left corner). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. Breaks [code]text[/code] to the lines and draws it using the specified [code]font[/code] at the [code]position[/code] (top-left corner). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
</description> </description>
</method> </method>
<method name="draw_multimesh"> <method name="draw_multimesh">
<return type="void"> <return type="void" />
</return> <argument index="0" name="multimesh" type="MultiMesh" />
<argument index="0" name="multimesh" type="MultiMesh"> <argument index="1" name="texture" type="Texture2D" />
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
<description> <description>
Draws a [MultiMesh] in 2D with the provided texture. See [MultiMeshInstance2D] for related documentation. Draws a [MultiMesh] in 2D with the provided texture. See [MultiMeshInstance2D] for related documentation.
</description> </description>
</method> </method>
<method name="draw_polygon"> <method name="draw_polygon">
<return type="void"> <return type="void" />
</return> <argument index="0" name="points" type="PackedVector2Array" />
<argument index="0" name="points" type="PackedVector2Array"> <argument index="1" name="colors" type="PackedColorArray" />
</argument> <argument index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
<argument index="1" name="colors" type="PackedColorArray"> <argument index="3" name="texture" type="Texture2D" default="null" />
</argument>
<argument index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()">
</argument>
<argument index="3" name="texture" type="Texture2D" default="null">
</argument>
<description> <description>
Draws a polygon of any amount of points, convex or concave. Draws a polygon of any amount of points, convex or concave.
</description> </description>
</method> </method>
<method name="draw_polyline"> <method name="draw_polyline">
<return type="void"> <return type="void" />
</return> <argument index="0" name="points" type="PackedVector2Array" />
<argument index="0" name="points" type="PackedVector2Array"> <argument index="1" name="color" type="Color" />
</argument> <argument index="2" name="width" type="float" default="1.0" />
<argument index="1" name="color" type="Color"> <argument index="3" name="antialiased" type="bool" default="false" />
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
<argument index="3" name="antialiased" type="bool" default="false">
</argument>
<description> <description>
Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code]. Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code].
</description> </description>
</method> </method>
<method name="draw_polyline_colors"> <method name="draw_polyline_colors">
<return type="void"> <return type="void" />
</return> <argument index="0" name="points" type="PackedVector2Array" />
<argument index="0" name="points" type="PackedVector2Array"> <argument index="1" name="colors" type="PackedColorArray" />
</argument> <argument index="2" name="width" type="float" default="1.0" />
<argument index="1" name="colors" type="PackedColorArray"> <argument index="3" name="antialiased" type="bool" default="false" />
</argument>
<argument index="2" name="width" type="float" default="1.0">
</argument>
<argument index="3" name="antialiased" type="bool" default="false">
</argument>
<description> <description>
Draws interconnected line segments with a uniform [code]width[/code] and segment-by-segment coloring. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. Draws interconnected line segments with a uniform [code]width[/code] and segment-by-segment coloring. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code].
</description> </description>
</method> </method>
<method name="draw_primitive"> <method name="draw_primitive">
<return type="void"> <return type="void" />
</return> <argument index="0" name="points" type="PackedVector2Array" />
<argument index="0" name="points" type="PackedVector2Array"> <argument index="1" name="colors" type="PackedColorArray" />
</argument> <argument index="2" name="uvs" type="PackedVector2Array" />
<argument index="1" name="colors" type="PackedColorArray"> <argument index="3" name="texture" type="Texture2D" default="null" />
</argument> <argument index="4" name="width" type="float" default="1.0" />
<argument index="2" name="uvs" type="PackedVector2Array">
</argument>
<argument index="3" name="texture" type="Texture2D" default="null">
</argument>
<argument index="4" name="width" type="float" default="1.0">
</argument>
<description> <description>
Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad. Draws 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> </description>
</method> </method>
<method name="draw_rect"> <method name="draw_rect">
<return type="void"> <return type="void" />
</return> <argument index="0" name="rect" type="Rect2" />
<argument index="0" name="rect" type="Rect2"> <argument index="1" name="color" type="Color" />
</argument> <argument index="2" name="filled" type="bool" default="true" />
<argument index="1" name="color" type="Color"> <argument index="3" name="width" type="float" default="1.0" />
</argument>
<argument index="2" name="filled" type="bool" default="true">
</argument>
<argument index="3" name="width" type="float" default="1.0">
</argument>
<description> <description>
Draws a rectangle. If [code]filled[/code] is [code]true[/code], the rectangle will be filled with the [code]color[/code] specified. If [code]filled[/code] is [code]false[/code], the rectangle will be drawn as a stroke with the [code]color[/code] and [code]width[/code] specified. Draws a rectangle. If [code]filled[/code] is [code]true[/code], the rectangle will be filled with the [code]color[/code] specified. If [code]filled[/code] is [code]false[/code], the rectangle will be drawn as a stroke with the [code]color[/code] and [code]width[/code] specified.
[b]Note:[/b] [code]width[/code] is only effective if [code]filled[/code] is [code]false[/code]. [b]Note:[/b] [code]width[/code] is only effective if [code]filled[/code] is [code]false[/code].
</description> </description>
</method> </method>
<method name="draw_set_transform"> <method name="draw_set_transform">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2"> <argument index="1" name="rotation" type="float" default="0.0" />
</argument> <argument index="2" name="scale" type="Vector2" default="Vector2(1, 1)" />
<argument index="1" name="rotation" type="float" default="0.0">
</argument>
<argument index="2" name="scale" type="Vector2" default="Vector2(1, 1)">
</argument>
<description> <description>
Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.
</description> </description>
</method> </method>
<method name="draw_set_transform_matrix"> <method name="draw_set_transform_matrix">
<return type="void"> <return type="void" />
</return> <argument index="0" name="xform" type="Transform2D" />
<argument index="0" name="xform" type="Transform2D">
</argument>
<description> <description>
Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.
</description> </description>
</method> </method>
<method name="draw_string" qualifiers="const"> <method name="draw_string" qualifiers="const">
<return type="void"> <return type="void" />
</return> <argument index="0" name="font" type="Font" />
<argument index="0" name="font" type="Font"> <argument index="1" name="pos" type="Vector2" />
</argument> <argument index="2" name="text" type="String" />
<argument index="1" name="pos" type="Vector2"> <argument index="3" name="align" type="int" enum="HAlign" default="0" />
</argument> <argument index="4" name="width" type="float" default="-1" />
<argument index="2" name="text" type="String"> <argument index="5" name="size" type="int" default="-1" />
</argument> <argument index="6" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
<argument index="3" name="align" type="int" enum="HAlign" default="0"> <argument index="7" name="outline_size" type="int" default="0" />
</argument> <argument index="8" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)" />
<argument index="4" name="width" type="float" default="-1"> <argument index="9" name="flags" type="int" default="3" />
</argument>
<argument index="5" name="size" type="int" default="-1">
</argument>
<argument index="6" name="modulate" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<argument index="7" name="outline_size" type="int" default="0">
</argument>
<argument index="8" name="outline_modulate" type="Color" default="Color(1, 1, 1, 0)">
</argument>
<argument index="9" name="flags" type="int" default="3">
</argument>
<description> <description>
Draws [code]text[/code] using the specified [code]font[/code] at the [code]position[/code] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. Draws [code]text[/code] using the specified [code]font[/code] at the [code]position[/code] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
[b]Example using the default project font:[/b] [b]Example using the default project font:[/b]
@ -364,223 +254,177 @@
</description> </description>
</method> </method>
<method name="draw_style_box"> <method name="draw_style_box">
<return type="void"> <return type="void" />
</return> <argument index="0" name="style_box" type="StyleBox" />
<argument index="0" name="style_box" type="StyleBox"> <argument index="1" name="rect" type="Rect2" />
</argument>
<argument index="1" name="rect" type="Rect2">
</argument>
<description> <description>
Draws a styled rectangle. Draws a styled rectangle.
</description> </description>
</method> </method>
<method name="draw_texture"> <method name="draw_texture">
<return type="void"> <return type="void" />
</return> <argument index="0" name="texture" type="Texture2D" />
<argument index="0" name="texture" type="Texture2D"> <argument index="1" name="position" type="Vector2" />
</argument> <argument index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
<argument index="1" name="position" type="Vector2">
</argument>
<argument index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<description> <description>
Draws a texture at a given position. Draws a texture at a given position.
</description> </description>
</method> </method>
<method name="draw_texture_rect"> <method name="draw_texture_rect">
<return type="void"> <return type="void" />
</return> <argument index="0" name="texture" type="Texture2D" />
<argument index="0" name="texture" type="Texture2D"> <argument index="1" name="rect" type="Rect2" />
</argument> <argument index="2" name="tile" type="bool" />
<argument index="1" name="rect" type="Rect2"> <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
</argument> <argument index="4" name="transpose" type="bool" default="false" />
<argument index="2" name="tile" type="bool">
</argument>
<argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<argument index="4" name="transpose" type="bool" default="false">
</argument>
<description> <description>
Draws a textured rectangle at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped. Draws a textured rectangle at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped.
</description> </description>
</method> </method>
<method name="draw_texture_rect_region"> <method name="draw_texture_rect_region">
<return type="void"> <return type="void" />
</return> <argument index="0" name="texture" type="Texture2D" />
<argument index="0" name="texture" type="Texture2D"> <argument index="1" name="rect" type="Rect2" />
</argument> <argument index="2" name="src_rect" type="Rect2" />
<argument index="1" name="rect" type="Rect2"> <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
</argument> <argument index="4" name="transpose" type="bool" default="false" />
<argument index="2" name="src_rect" type="Rect2"> <argument index="5" name="clip_uv" type="bool" default="true" />
</argument>
<argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<argument index="4" name="transpose" type="bool" default="false">
</argument>
<argument index="5" name="clip_uv" type="bool" default="true">
</argument>
<description> <description>
Draws a textured rectangle region at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped. Draws a textured rectangle region at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped.
</description> </description>
</method> </method>
<method name="force_update_transform"> <method name="force_update_transform">
<return type="void"> <return type="void" />
</return>
<description> <description>
Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations. Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations.
</description> </description>
</method> </method>
<method name="get_canvas" qualifiers="const"> <method name="get_canvas" qualifiers="const">
<return type="RID"> <return type="RID" />
</return>
<description> <description>
Returns the [RID] of the [World2D] canvas where this item is in. Returns the [RID] of the [World2D] canvas where this item is in.
</description> </description>
</method> </method>
<method name="get_canvas_item" qualifiers="const"> <method name="get_canvas_item" qualifiers="const">
<return type="RID"> <return type="RID" />
</return>
<description> <description>
Returns the canvas item RID used by [RenderingServer] for this item. Returns the canvas item RID used by [RenderingServer] for this item.
</description> </description>
</method> </method>
<method name="get_canvas_transform" qualifiers="const"> <method name="get_canvas_transform" qualifiers="const">
<return type="Transform2D"> <return type="Transform2D" />
</return>
<description> <description>
Returns the transform matrix of this item's canvas. Returns the transform matrix of this item's canvas.
</description> </description>
</method> </method>
<method name="get_global_mouse_position" qualifiers="const"> <method name="get_global_mouse_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns the global position of the mouse. Returns the global position of the mouse.
</description> </description>
</method> </method>
<method name="get_global_transform" qualifiers="const"> <method name="get_global_transform" qualifiers="const">
<return type="Transform2D"> <return type="Transform2D" />
</return>
<description> <description>
Returns the global transform matrix of this item. Returns the global transform matrix of this item.
</description> </description>
</method> </method>
<method name="get_global_transform_with_canvas" qualifiers="const"> <method name="get_global_transform_with_canvas" qualifiers="const">
<return type="Transform2D"> <return type="Transform2D" />
</return>
<description> <description>
Returns the global transform matrix of this item in relation to the canvas. Returns the global transform matrix of this item in relation to the canvas.
</description> </description>
</method> </method>
<method name="get_local_mouse_position" qualifiers="const"> <method name="get_local_mouse_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns the mouse position relative to this item's position. Returns the mouse position relative to this item's position.
</description> </description>
</method> </method>
<method name="get_transform" qualifiers="const"> <method name="get_transform" qualifiers="const">
<return type="Transform2D"> <return type="Transform2D" />
</return>
<description> <description>
Returns the transform matrix of this item. Returns the transform matrix of this item.
</description> </description>
</method> </method>
<method name="get_viewport_rect" qualifiers="const"> <method name="get_viewport_rect" qualifiers="const">
<return type="Rect2"> <return type="Rect2" />
</return>
<description> <description>
Returns the viewport's boundaries as a [Rect2]. Returns the viewport's boundaries as a [Rect2].
</description> </description>
</method> </method>
<method name="get_viewport_transform" qualifiers="const"> <method name="get_viewport_transform" qualifiers="const">
<return type="Transform2D"> <return type="Transform2D" />
</return>
<description> <description>
Returns this item's transform in relation to the viewport. Returns this item's transform in relation to the viewport.
</description> </description>
</method> </method>
<method name="get_world_2d" qualifiers="const"> <method name="get_world_2d" qualifiers="const">
<return type="World2D"> <return type="World2D" />
</return>
<description> <description>
Returns the [World2D] where this item is in. Returns the [World2D] where this item is in.
</description> </description>
</method> </method>
<method name="hide"> <method name="hide">
<return type="void"> <return type="void" />
</return>
<description> <description>
Hide the [CanvasItem] if it's currently visible. Hide the [CanvasItem] if it's currently visible.
</description> </description>
</method> </method>
<method name="is_local_transform_notification_enabled" qualifiers="const"> <method name="is_local_transform_notification_enabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if local transform notifications are communicated to children. Returns [code]true[/code] if local transform notifications are communicated to children.
</description> </description>
</method> </method>
<method name="is_transform_notification_enabled" qualifiers="const"> <method name="is_transform_notification_enabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if global transform notifications are communicated to children. Returns [code]true[/code] if global transform notifications are communicated to children.
</description> </description>
</method> </method>
<method name="is_visible_in_tree" qualifiers="const"> <method name="is_visible_in_tree" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree. Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree.
</description> </description>
</method> </method>
<method name="make_canvas_position_local" qualifiers="const"> <method name="make_canvas_position_local" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="screen_point" type="Vector2" />
<argument index="0" name="screen_point" type="Vector2">
</argument>
<description> <description>
Assigns [code]screen_point[/code] as this node's new local transform. Assigns [code]screen_point[/code] as this node's new local transform.
</description> </description>
</method> </method>
<method name="make_input_local" qualifiers="const"> <method name="make_input_local" qualifiers="const">
<return type="InputEvent"> <return type="InputEvent" />
</return> <argument index="0" name="event" type="InputEvent" />
<argument index="0" name="event" type="InputEvent">
</argument>
<description> <description>
Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space. Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space.
</description> </description>
</method> </method>
<method name="set_notify_local_transform"> <method name="set_notify_local_transform">
<return type="void"> <return type="void" />
</return> <argument index="0" name="enable" type="bool" />
<argument index="0" name="enable" type="bool">
</argument>
<description> <description>
If [code]enable[/code] is [code]true[/code], children will be updated with local transform data. If [code]enable[/code] is [code]true[/code], children will be updated with local transform data.
</description> </description>
</method> </method>
<method name="set_notify_transform"> <method name="set_notify_transform">
<return type="void"> <return type="void" />
</return> <argument index="0" name="enable" type="bool" />
<argument index="0" name="enable" type="bool">
</argument>
<description> <description>
If [code]enable[/code] is [code]true[/code], children will be updated with global transform data. If [code]enable[/code] is [code]true[/code], children will be updated with global transform data.
</description> </description>
</method> </method>
<method name="show"> <method name="show">
<return type="void"> <return type="void" />
</return>
<description> <description>
Show the [CanvasItem] if it's currently hidden. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead. Show the [CanvasItem] if it's currently hidden. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead.
</description> </description>
</method> </method>
<method name="update"> <method name="update">
<return type="void"> <return type="void" />
</return>
<description> <description>
Queue the [CanvasItem] for update. [constant NOTIFICATION_DRAW] will be called on idle time to request redraw. Queue the [CanvasItem] for update. [constant NOTIFICATION_DRAW] will be called on idle time to request redraw.
</description> </description>

3
doc/classes/CanvasLayer.xml
View File

@ -13,8 +13,7 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_canvas" qualifiers="const"> <method name="get_canvas" qualifiers="const">
<return type="RID"> <return type="RID" />
</return>
<description> <description>
Returns the RID of the canvas used by this layer. Returns the RID of the canvas used by this layer.
</description> </description>

27
doc/classes/CharacterBody2D.xml
View File

@ -16,24 +16,20 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_floor_normal" qualifiers="const"> <method name="get_floor_normal" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns the surface normal of the floor at the last collision point. Only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code]. Returns the surface normal of the floor at the last collision point. Only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code].
</description> </description>
</method> </method>
<method name="get_floor_velocity" qualifiers="const"> <method name="get_floor_velocity" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns the linear velocity of the floor at the last collision point. Only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code]. Returns the linear velocity of the floor at the last collision point. Only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code].
</description> </description>
</method> </method>
<method name="get_slide_collision"> <method name="get_slide_collision">
<return type="KinematicCollision2D"> <return type="KinematicCollision2D" />
</return> <argument index="0" name="slide_idx" type="int" />
<argument index="0" name="slide_idx" type="int">
</argument>
<description> <description>
Returns a [KinematicCollision2D], which contains information about a collision that occurred during the last call to [method move_and_slide]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). Returns a [KinematicCollision2D], which contains information about a collision that occurred during the last call to [method move_and_slide]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1).
[b]Example usage:[/b] [b]Example usage:[/b]
@ -54,36 +50,31 @@
</description> </description>
</method> </method>
<method name="get_slide_count" qualifiers="const"> <method name="get_slide_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of times the body collided and changed direction during the last call to [method move_and_slide]. Returns the number of times the body collided and changed direction during the last call to [method move_and_slide].
</description> </description>
</method> </method>
<method name="is_on_ceiling" qualifiers="const"> <method name="is_on_ceiling" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the body collided with the ceiling on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. Returns [code]true[/code] if the body collided with the ceiling on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
</description> </description>
</method> </method>
<method name="is_on_floor" qualifiers="const"> <method name="is_on_floor" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the body collided with the floor on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. Returns [code]true[/code] if the body collided with the floor on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
</description> </description>
</method> </method>
<method name="is_on_wall" qualifiers="const"> <method name="is_on_wall" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the body collided with a wall on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. Returns [code]true[/code] if the body collided with a wall on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
</description> </description>
</method> </method>
<method name="move_and_slide"> <method name="move_and_slide">
<return type="void"> <return type="void" />
</return>
<description> <description>
Moves the body based on [member linear_velocity]. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [CharacterBody2D] or [RigidBody2D], it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes. Moves the body based on [member linear_velocity]. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [CharacterBody2D] or [RigidBody2D], it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes.
This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed.

27
doc/classes/CharacterBody3D.xml
View File

@ -17,59 +17,50 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_floor_normal" qualifiers="const"> <method name="get_floor_normal" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return>
<description> <description>
Returns the surface normal of the floor at the last collision point. Only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code]. Returns the surface normal of the floor at the last collision point. Only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code].
</description> </description>
</method> </method>
<method name="get_floor_velocity" qualifiers="const"> <method name="get_floor_velocity" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return>
<description> <description>
Returns the linear velocity of the floor at the last collision point. Only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code]. Returns the linear velocity of the floor at the last collision point. Only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code].
</description> </description>
</method> </method>
<method name="get_slide_collision"> <method name="get_slide_collision">
<return type="KinematicCollision3D"> <return type="KinematicCollision3D" />
</return> <argument index="0" name="slide_idx" type="int" />
<argument index="0" name="slide_idx" type="int">
</argument>
<description> <description>
Returns a [KinematicCollision3D], which contains information about a collision that occurred during the last call to [method move_and_slide]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). Returns a [KinematicCollision3D], which contains information about a collision that occurred during the last call to [method move_and_slide]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1).
</description> </description>
</method> </method>
<method name="get_slide_count" qualifiers="const"> <method name="get_slide_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of times the body collided and changed direction during the last call to [method move_and_slide]. Returns the number of times the body collided and changed direction during the last call to [method move_and_slide].
</description> </description>
</method> </method>
<method name="is_on_ceiling" qualifiers="const"> <method name="is_on_ceiling" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the body collided with the ceiling on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. Returns [code]true[/code] if the body collided with the ceiling on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
</description> </description>
</method> </method>
<method name="is_on_floor" qualifiers="const"> <method name="is_on_floor" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the body collided with the floor on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. Returns [code]true[/code] if the body collided with the floor on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
</description> </description>
</method> </method>
<method name="is_on_wall" qualifiers="const"> <method name="is_on_wall" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the body collided with a wall on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code]. Returns [code]true[/code] if the body collided with a wall on the last call of [method move_and_slide]. Otherwise, returns [code]false[/code].
</description> </description>
</method> </method>
<method name="move_and_slide"> <method name="move_and_slide">
<return type="void"> <return type="void" />
</return>
<description> <description>
Moves the body based on [member linear_velocity]. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [CharacterBody3D] or [RigidBody3D], it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes. Moves the body based on [member linear_velocity]. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [CharacterBody3D] or [RigidBody3D], it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes.
This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed.

159
doc/classes/ClassDB.xml
View File

@ -10,208 +10,155 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="can_instantiate" qualifiers="const"> <method name="can_instantiate" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case. Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case.
</description> </description>
</method> </method>
<method name="class_exists" qualifiers="const"> <method name="class_exists" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName">
</argument>
<description> <description>
Returns whether the specified [code]class[/code] is available or not. Returns whether the specified [code]class[/code] is available or not.
</description> </description>
</method> </method>
<method name="class_get_category" qualifiers="const"> <method name="class_get_category" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName">
</argument>
<description> <description>
Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required.
</description> </description>
</method> </method>
<method name="class_get_integer_constant" qualifiers="const"> <method name="class_get_integer_constant" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName"> <argument index="1" name="name" type="StringName" />
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<description> <description>
Returns the value of the integer constant [code]name[/code] of [code]class[/code] or its ancestry. Always returns 0 when the constant could not be found. Returns the value of the integer constant [code]name[/code] of [code]class[/code] or its ancestry. Always returns 0 when the constant could not be found.
</description> </description>
</method> </method>
<method name="class_get_integer_constant_list" qualifiers="const"> <method name="class_get_integer_constant_list" qualifiers="const">
<return type="PackedStringArray"> <return type="PackedStringArray" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName"> <argument index="1" name="no_inheritance" type="bool" default="false" />
</argument>
<argument index="1" name="no_inheritance" type="bool" default="false">
</argument>
<description> <description>
Returns an array with the names all the integer constants of [code]class[/code] or its ancestry. Returns an array with the names all the integer constants of [code]class[/code] or its ancestry.
</description> </description>
</method> </method>
<method name="class_get_method_list" qualifiers="const"> <method name="class_get_method_list" qualifiers="const">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName"> <argument index="1" name="no_inheritance" type="bool" default="false" />
</argument>
<argument index="1" name="no_inheritance" type="bool" default="false">
</argument>
<description> <description>
Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code].
[b]Note:[/code] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names. [b]Note:[/code] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names.
</description> </description>
</method> </method>
<method name="class_get_property" qualifiers="const"> <method name="class_get_property" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="object" type="Object" />
<argument index="0" name="object" type="Object"> <argument index="1" name="property" type="StringName" />
</argument>
<argument index="1" name="property" type="StringName">
</argument>
<description> <description>
Returns the value of [code]property[/code] of [code]class[/code] or its ancestry. Returns the value of [code]property[/code] of [code]class[/code] or its ancestry.
</description> </description>
</method> </method>
<method name="class_get_property_list" qualifiers="const"> <method name="class_get_property_list" qualifiers="const">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName"> <argument index="1" name="no_inheritance" type="bool" default="false" />
</argument>
<argument index="1" name="no_inheritance" type="bool" default="false">
</argument>
<description> <description>
Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code].
</description> </description>
</method> </method>
<method name="class_get_signal" qualifiers="const"> <method name="class_get_signal" qualifiers="const">
<return type="Dictionary"> <return type="Dictionary" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName"> <argument index="1" name="signal" type="StringName" />
</argument>
<argument index="1" name="signal" type="StringName">
</argument>
<description> <description>
Returns the [code]signal[/code] data of [code]class[/code] or its ancestry. The returned value is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. Returns the [code]signal[/code] data of [code]class[/code] or its ancestry. The returned value is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code].
</description> </description>
</method> </method>
<method name="class_get_signal_list" qualifiers="const"> <method name="class_get_signal_list" qualifiers="const">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName"> <argument index="1" name="no_inheritance" type="bool" default="false" />
</argument>
<argument index="1" name="no_inheritance" type="bool" default="false">
</argument>
<description> <description>
Returns an array with all the signals of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal]. Returns an array with all the signals of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal].
</description> </description>
</method> </method>
<method name="class_has_integer_constant" qualifiers="const"> <method name="class_has_integer_constant" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName"> <argument index="1" name="name" type="StringName" />
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<description> <description>
Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not. Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not.
</description> </description>
</method> </method>
<method name="class_has_method" qualifiers="const"> <method name="class_has_method" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName"> <argument index="1" name="method" type="StringName" />
</argument> <argument index="2" name="no_inheritance" type="bool" default="false" />
<argument index="1" name="method" type="StringName">
</argument>
<argument index="2" name="no_inheritance" type="bool" default="false">
</argument>
<description> <description>
Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is [code]false[/code]) has a method called [code]method[/code] or not. Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is [code]false[/code]) has a method called [code]method[/code] or not.
</description> </description>
</method> </method>
<method name="class_has_signal" qualifiers="const"> <method name="class_has_signal" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName"> <argument index="1" name="signal" type="StringName" />
</argument>
<argument index="1" name="signal" type="StringName">
</argument>
<description> <description>
Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not. Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not.
</description> </description>
</method> </method>
<method name="class_set_property" qualifiers="const"> <method name="class_set_property" qualifiers="const">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="object" type="Object" />
<argument index="0" name="object" type="Object"> <argument index="1" name="property" type="StringName" />
</argument> <argument index="2" name="value" type="Variant" />
<argument index="1" name="property" type="StringName">
</argument>
<argument index="2" name="value" type="Variant">
</argument>
<description> <description>
Sets [code]property[/code] value of [code]class[/code] to [code]value[/code]. Sets [code]property[/code] value of [code]class[/code] to [code]value[/code].
</description> </description>
</method> </method>
<method name="get_class_list" qualifiers="const"> <method name="get_class_list" qualifiers="const">
<return type="PackedStringArray"> <return type="PackedStringArray" />
</return>
<description> <description>
Returns the names of all the classes available. Returns the names of all the classes available.
</description> </description>
</method> </method>
<method name="get_inheriters_from_class" qualifiers="const"> <method name="get_inheriters_from_class" qualifiers="const">
<return type="PackedStringArray"> <return type="PackedStringArray" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName">
</argument>
<description> <description>
Returns the names of all the classes that directly or indirectly inherit from [code]class[/code]. Returns the names of all the classes that directly or indirectly inherit from [code]class[/code].
</description> </description>
</method> </method>
<method name="get_parent_class" qualifiers="const"> <method name="get_parent_class" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName">
</argument>
<description> <description>
Returns the parent class of [code]class[/code]. Returns the parent class of [code]class[/code].
</description> </description>
</method> </method>
<method name="instantiate" qualifiers="const"> <method name="instantiate" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName">
</argument>
<description> <description>
Creates an instance of [code]class[/code]. Creates an instance of [code]class[/code].
</description> </description>
</method> </method>
<method name="is_class_enabled" qualifiers="const"> <method name="is_class_enabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName">
</argument>
<description> <description>
Returns whether this [code]class[/code] is enabled or not. Returns whether this [code]class[/code] is enabled or not.
</description> </description>
</method> </method>
<method name="is_parent_class" qualifiers="const"> <method name="is_parent_class" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="class" type="StringName" />
<argument index="0" name="class" type="StringName"> <argument index="1" name="inherits" type="StringName" />
</argument>
<argument index="1" name="inherits" type="StringName">
</argument>
<description> <description>
Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not. Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not.
</description> </description>

45
doc/classes/ClippedCamera3D.xml
View File

@ -10,72 +10,57 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_exception"> <method name="add_exception">
<return type="void"> <return type="void" />
</return> <argument index="0" name="node" type="Object" />
<argument index="0" name="node" type="Object">
</argument>
<description> <description>
Adds a collision exception so the camera does not collide with the specified node. Adds a collision exception so the camera does not collide with the specified node.
</description> </description>
</method> </method>
<method name="add_exception_rid"> <method name="add_exception_rid">
<return type="void"> <return type="void" />
</return> <argument index="0" name="rid" type="RID" />
<argument index="0" name="rid" type="RID">
</argument>
<description> <description>
Adds a collision exception so the camera does not collide with the specified [RID]. Adds a collision exception so the camera does not collide with the specified [RID].
</description> </description>
</method> </method>
<method name="clear_exceptions"> <method name="clear_exceptions">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all collision exceptions. Removes all collision exceptions.
</description> </description>
</method> </method>
<method name="get_clip_offset" qualifiers="const"> <method name="get_clip_offset" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the distance the camera has been offset due to a collision. Returns the distance the camera has been offset due to a collision.
</description> </description>
</method> </method>
<method name="get_collision_mask_bit" qualifiers="const"> <method name="get_collision_mask_bit" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="bit" type="int" />
<argument index="0" name="bit" type="int">
</argument>
<description> <description>
Returns [code]true[/code] if the specified bit index is on. Returns [code]true[/code] if the specified bit index is on.
[b]Note:[/b] Bit indices range from 0-19. [b]Note:[/b] Bit indices range from 0-19.
</description> </description>
</method> </method>
<method name="remove_exception"> <method name="remove_exception">
<return type="void"> <return type="void" />
</return> <argument index="0" name="node" type="Object" />
<argument index="0" name="node" type="Object">
</argument>
<description> <description>
Removes a collision exception with the specified node. Removes a collision exception with the specified node.
</description> </description>
</method> </method>
<method name="remove_exception_rid"> <method name="remove_exception_rid">
<return type="void"> <return type="void" />
</return> <argument index="0" name="rid" type="RID" />
<argument index="0" name="rid" type="RID">
</argument>
<description> <description>
Removes a collision exception with the specified [RID]. Removes a collision exception with the specified [RID].
</description> </description>
</method> </method>
<method name="set_collision_mask_bit"> <method name="set_collision_mask_bit">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bit" type="int" />
<argument index="0" name="bit" type="int"> <argument index="1" name="value" type="bool" />
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description> <description>
Sets the specified bit index to the [code]value[/code]. Sets the specified bit index to the [code]value[/code].
[b]Note:[/b] Bit indices range from 0-19. [b]Note:[/b] Bit indices range from 0-19.

312
doc/classes/CodeEdit.xml
View File

@ -9,62 +9,45 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_confirm_code_completion" qualifiers="virtual"> <method name="_confirm_code_completion" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="replace" type="bool" />
<argument index="0" name="replace" type="bool">
</argument>
<description> <description>
Override this method to define how the selected entry should be inserted. If [code]replace[/code] is true, any existing text should be replaced. Override this method to define how the selected entry should be inserted. If [code]replace[/code] is true, any existing text should be replaced.
</description> </description>
</method> </method>
<method name="_filter_code_completion_candidates" qualifiers="virtual"> <method name="_filter_code_completion_candidates" qualifiers="virtual">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="candidates" type="Array" />
<argument index="0" name="candidates" type="Array">
</argument>
<description> <description>
Override this method to define what items in [code]candidates[/code] should be displayed. Override this method to define what items in [code]candidates[/code] should be displayed.
Both [code]candidates[/code] and the return is a [Array] of [Dictionary], see [method get_code_completion_option] for [Dictionary] content. Both [code]candidates[/code] and the return is a [Array] of [Dictionary], see [method get_code_completion_option] for [Dictionary] content.
</description> </description>
</method> </method>
<method name="_request_code_completion" qualifiers="virtual"> <method name="_request_code_completion" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="force" type="bool" />
<argument index="0" name="force" type="bool">
</argument>
<description> <description>
Override this method to define what happens when the user requests code completion. If [code]force[/code] is true, any checks should be bypassed. Override this method to define what happens when the user requests code completion. If [code]force[/code] is true, any checks should be bypassed.
</description> </description>
</method> </method>
<method name="add_code_completion_option"> <method name="add_code_completion_option">
<return type="void"> <return type="void" />
</return> <argument index="0" name="type" type="int" enum="CodeEdit.CodeCompletionKind" />
<argument index="0" name="type" type="int" enum="CodeEdit.CodeCompletionKind"> <argument index="1" name="display_text" type="String" />
</argument> <argument index="2" name="insert_text" type="String" />
<argument index="1" name="display_text" type="String"> <argument index="3" name="text_color" type="Color" default="Color(1, 1, 1, 1)" />
</argument> <argument index="4" name="icon" type="Resource" default="null" />
<argument index="2" name="insert_text" type="String"> <argument index="5" name="value" type="Variant" default="0" />
</argument>
<argument index="3" name="text_color" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<argument index="4" name="icon" type="Resource" default="null">
</argument>
<argument index="5" name="value" type="Variant" default="0">
</argument>
<description> <description>
Submits an item to the queue of potential candidates for the autocomplete menu. Call [method update_code_completion_options] to update the list. Submits an item to the queue of potential candidates for the autocomplete menu. Call [method update_code_completion_options] to update the list.
[b]Note[/b]: This list will replace all current candidates. [b]Note[/b]: This list will replace all current candidates.
</description> </description>
</method> </method>
<method name="add_comment_delimiter"> <method name="add_comment_delimiter">
<return type="void"> <return type="void" />
</return> <argument index="0" name="start_key" type="String" />
<argument index="0" name="start_key" type="String"> <argument index="1" name="end_key" type="String" />
</argument> <argument index="2" name="line_only" type="bool" default="false" />
<argument index="1" name="end_key" type="String">
</argument>
<argument index="2" name="line_only" type="bool" default="false">
</argument>
<description> <description>
Adds a comment delimiter. Adds a comment delimiter.
Both the start and end keys must be symbols. Only the start key has to be unique. Both the start and end keys must be symbols. Only the start key has to be unique.
@ -72,14 +55,10 @@
</description> </description>
</method> </method>
<method name="add_string_delimiter"> <method name="add_string_delimiter">
<return type="void"> <return type="void" />
</return> <argument index="0" name="start_key" type="String" />
<argument index="0" name="start_key" type="String"> <argument index="1" name="end_key" type="String" />
</argument> <argument index="2" name="line_only" type="bool" default="false" />
<argument index="1" name="end_key" type="String">
</argument>
<argument index="2" name="line_only" type="bool" default="false">
</argument>
<description> <description>
Adds a string delimiter. Adds a string delimiter.
Both the start and end keys must be symbols. Only the start key has to be unique. Both the start and end keys must be symbols. Only the start key has to be unique.
@ -87,109 +66,90 @@
</description> </description>
</method> </method>
<method name="can_fold_line" qualifiers="const"> <method name="can_fold_line" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int">
</argument>
<description> <description>
Returns if the given line is foldable, that is, it has indented lines right below it or a comment / string block. Returns if the given line is foldable, that is, it has indented lines right below it or a comment / string block.
</description> </description>
</method> </method>
<method name="cancel_code_completion"> <method name="cancel_code_completion">
<return type="void"> <return type="void" />
</return>
<description> <description>
Cancels the autocomplete menu. Cancels the autocomplete menu.
</description> </description>
</method> </method>
<method name="clear_bookmarked_lines"> <method name="clear_bookmarked_lines">
<return type="void"> <return type="void" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="clear_breakpointed_lines"> <method name="clear_breakpointed_lines">
<return type="void"> <return type="void" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="clear_comment_delimiters"> <method name="clear_comment_delimiters">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all comment delimiters. Removes all comment delimiters.
</description> </description>
</method> </method>
<method name="clear_executing_lines"> <method name="clear_executing_lines">
<return type="void"> <return type="void" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="clear_string_delimiters"> <method name="clear_string_delimiters">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all string delimiters. Removes all string delimiters.
</description> </description>
</method> </method>
<method name="confirm_code_completion"> <method name="confirm_code_completion">
<return type="void"> <return type="void" />
</return> <argument index="0" name="replace" type="bool" default="false" />
<argument index="0" name="replace" type="bool" default="false">
</argument>
<description> <description>
Inserts the selected entry into the text. If [code]replace[/code] is true, any existing text is replaced rather then merged. Inserts the selected entry into the text. If [code]replace[/code] is true, any existing text is replaced rather then merged.
</description> </description>
</method> </method>
<method name="do_indent"> <method name="do_indent">
<return type="void"> <return type="void" />
</return>
<description> <description>
Perform an indent as if the user activated the "ui_text_indent" action. Perform an indent as if the user activated the "ui_text_indent" action.
</description> </description>
</method> </method>
<method name="do_unindent"> <method name="do_unindent">
<return type="void"> <return type="void" />
</return>
<description> <description>
Perform an unindent as if the user activated the "ui_text_unindent" action. Perform an unindent as if the user activated the "ui_text_unindent" action.
</description> </description>
</method> </method>
<method name="fold_all_lines"> <method name="fold_all_lines">
<return type="void"> <return type="void" />
</return>
<description> <description>
Folds all lines that are possible to be folded (see [method can_fold_line]). Folds all lines that are possible to be folded (see [method can_fold_line]).
</description> </description>
</method> </method>
<method name="fold_line"> <method name="fold_line">
<return type="void"> <return type="void" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int">
</argument>
<description> <description>
Folds the given line, if possible (see [method can_fold_line]). Folds the given line, if possible (see [method can_fold_line]).
</description> </description>
</method> </method>
<method name="get_bookmarked_lines" qualifiers="const"> <method name="get_bookmarked_lines" qualifiers="const">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="get_breakpointed_lines" qualifiers="const"> <method name="get_breakpointed_lines" qualifiers="const">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="get_code_completion_option" qualifiers="const"> <method name="get_code_completion_option" qualifiers="const">
<return type="Dictionary"> <return type="Dictionary" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Gets the completion option at [code]index[/code]. The return [Dictionary] has the following key-values: Gets the completion option at [code]index[/code]. The return [Dictionary] has the following key-values:
[code]kind[/code]: [enum CodeCompletionKind] [code]kind[/code]: [enum CodeCompletionKind]
@ -201,279 +161,216 @@
</description> </description>
</method> </method>
<method name="get_code_completion_options" qualifiers="const"> <method name="get_code_completion_options" qualifiers="const">
<return type="Dictionary[]"> <return type="Dictionary[]" />
</return>
<description> <description>
Gets all completion options, see [method get_code_completion_option] for return content. Gets all completion options, see [method get_code_completion_option] for return content.
</description> </description>
</method> </method>
<method name="get_code_completion_selected_index" qualifiers="const"> <method name="get_code_completion_selected_index" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Gets the index of the current selected completion option. Gets the index of the current selected completion option.
</description> </description>
</method> </method>
<method name="get_delimiter_end_key" qualifiers="const"> <method name="get_delimiter_end_key" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="delimiter_index" type="int" />
<argument index="0" name="delimiter_index" type="int">
</argument>
<description> <description>
Gets the end key for a string or comment region index. Gets the end key for a string or comment region index.
</description> </description>
</method> </method>
<method name="get_delimiter_end_position" qualifiers="const"> <method name="get_delimiter_end_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int"> <argument index="1" name="column" type="int" />
</argument>
<argument index="1" name="column" type="int">
</argument>
<description> <description>
If [code]line[/code] [code]column[/code] is in a string or comment, returns the end position of the region. If not or no end could be found, both [Vector2] values will be [code]-1[/code]. If [code]line[/code] [code]column[/code] is in a string or comment, returns the end position of the region. If not or no end could be found, both [Vector2] values will be [code]-1[/code].
</description> </description>
</method> </method>
<method name="get_delimiter_start_key" qualifiers="const"> <method name="get_delimiter_start_key" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="delimiter_index" type="int" />
<argument index="0" name="delimiter_index" type="int">
</argument>
<description> <description>
Gets the start key for a string or comment region index. Gets the start key for a string or comment region index.
</description> </description>
</method> </method>
<method name="get_delimiter_start_position" qualifiers="const"> <method name="get_delimiter_start_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int"> <argument index="1" name="column" type="int" />
</argument>
<argument index="1" name="column" type="int">
</argument>
<description> <description>
If [code]line[/code] [code]column[/code] is in a string or comment, returns the start position of the region. If not or no start could be found, both [Vector2] values will be [code]-1[/code]. If [code]line[/code] [code]column[/code] is in a string or comment, returns the start position of the region. If not or no start could be found, both [Vector2] values will be [code]-1[/code].
</description> </description>
</method> </method>
<method name="get_executing_lines" qualifiers="const"> <method name="get_executing_lines" qualifiers="const">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="get_folded_lines" qualifiers="const"> <method name="get_folded_lines" qualifiers="const">
<return type="int[]"> <return type="int[]" />
</return>
<description> <description>
Return all lines that are current folded. Return all lines that are current folded.
</description> </description>
</method> </method>
<method name="get_text_for_code_completion" qualifiers="const"> <method name="get_text_for_code_completion" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
Returns the full text with char [code]0xFFFF[/code] at the caret location. Returns the full text with char [code]0xFFFF[/code] at the caret location.
</description> </description>
</method> </method>
<method name="has_comment_delimiter" qualifiers="const"> <method name="has_comment_delimiter" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="start_key" type="String" />
<argument index="0" name="start_key" type="String">
</argument>
<description> <description>
Returns [code]true[/code] if comment [code]start_key[/code] exists. Returns [code]true[/code] if comment [code]start_key[/code] exists.
</description> </description>
</method> </method>
<method name="has_string_delimiter" qualifiers="const"> <method name="has_string_delimiter" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="start_key" type="String" />
<argument index="0" name="start_key" type="String">
</argument>
<description> <description>
Returns [code]true[/code] if string [code]start_key[/code] exists. Returns [code]true[/code] if string [code]start_key[/code] exists.
</description> </description>
</method> </method>
<method name="indent_lines"> <method name="indent_lines">
<return type="void"> <return type="void" />
</return>
<description> <description>
Indents selected lines, or in the case of no selection the caret line by one. Indents selected lines, or in the case of no selection the caret line by one.
</description> </description>
</method> </method>
<method name="is_in_comment" qualifiers="const"> <method name="is_in_comment" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int"> <argument index="1" name="column" type="int" default="-1" />
</argument>
<argument index="1" name="column" type="int" default="-1">
</argument>
<description> <description>
Return delimiter index if [code]line[/code] [code]column[/code] is in a comment. If [code]column[/code] is not provided, will return delimiter index if the entire [code]line[/code] is a comment. Otherwise [code]-1[/code]. Return delimiter index if [code]line[/code] [code]column[/code] is in a comment. If [code]column[/code] is not provided, will return delimiter index if the entire [code]line[/code] is a comment. Otherwise [code]-1[/code].
</description> </description>
</method> </method>
<method name="is_in_string" qualifiers="const"> <method name="is_in_string" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int"> <argument index="1" name="column" type="int" default="-1" />
</argument>
<argument index="1" name="column" type="int" default="-1">
</argument>
<description> <description>
Return the delimiter index if [code]line[/code] [code]column[/code] is in a string. If [code]column[/code] is not provided, will return the delimiter index if the entire [code]line[/code] is a string. Otherwise [code]-1[/code]. Return the delimiter index if [code]line[/code] [code]column[/code] is in a string. If [code]column[/code] is not provided, will return the delimiter index if the entire [code]line[/code] is a string. Otherwise [code]-1[/code].
</description> </description>
</method> </method>
<method name="is_line_bookmarked" qualifiers="const"> <method name="is_line_bookmarked" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="is_line_breakpointed" qualifiers="const"> <method name="is_line_breakpointed" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="is_line_executing" qualifiers="const"> <method name="is_line_executing" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="is_line_folded" qualifiers="const"> <method name="is_line_folded" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int">
</argument>
<description> <description>
Returns whether the line at the specified index is folded or not. Returns whether the line at the specified index is folded or not.
</description> </description>
</method> </method>
<method name="remove_comment_delimiter"> <method name="remove_comment_delimiter">
<return type="void"> <return type="void" />
</return> <argument index="0" name="start_key" type="String" />
<argument index="0" name="start_key" type="String">
</argument>
<description> <description>
Removes the comment delimiter with [code]start_key[/code]. Removes the comment delimiter with [code]start_key[/code].
</description> </description>
</method> </method>
<method name="remove_string_delimiter"> <method name="remove_string_delimiter">
<return type="void"> <return type="void" />
</return> <argument index="0" name="start_key" type="String" />
<argument index="0" name="start_key" type="String">
</argument>
<description> <description>
Removes the string delimiter with [code]start_key[/code]. Removes the string delimiter with [code]start_key[/code].
</description> </description>
</method> </method>
<method name="request_code_completion"> <method name="request_code_completion">
<return type="void"> <return type="void" />
</return> <argument index="0" name="force" type="bool" default="false" />
<argument index="0" name="force" type="bool" default="false">
</argument>
<description> <description>
Emits [signal request_code_completion], if [code]force[/code] is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal. Emits [signal request_code_completion], if [code]force[/code] is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal.
</description> </description>
</method> </method>
<method name="set_code_completion_selected_index"> <method name="set_code_completion_selected_index">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Sets the current selected completion option. Sets the current selected completion option.
</description> </description>
</method> </method>
<method name="set_code_hint"> <method name="set_code_hint">
<return type="void"> <return type="void" />
</return> <argument index="0" name="code_hint" type="String" />
<argument index="0" name="code_hint" type="String">
</argument>
<description> <description>
Sets the code hint text. Pass an empty string to clear. Sets the code hint text. Pass an empty string to clear.
</description> </description>
</method> </method>
<method name="set_code_hint_draw_below"> <method name="set_code_hint_draw_below">
<return type="void"> <return type="void" />
</return> <argument index="0" name="draw_below" type="bool" />
<argument index="0" name="draw_below" type="bool">
</argument>
<description> <description>
Sets if the code hint should draw below the text. Sets if the code hint should draw below the text.
</description> </description>
</method> </method>
<method name="set_line_as_bookmarked"> <method name="set_line_as_bookmarked">
<return type="void"> <return type="void" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int"> <argument index="1" name="bookmarked" type="bool" />
</argument>
<argument index="1" name="bookmarked" type="bool">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_line_as_breakpoint"> <method name="set_line_as_breakpoint">
<return type="void"> <return type="void" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int"> <argument index="1" name="breakpointed" type="bool" />
</argument>
<argument index="1" name="breakpointed" type="bool">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_line_as_executing"> <method name="set_line_as_executing">
<return type="void"> <return type="void" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int"> <argument index="1" name="executing" type="bool" />
</argument>
<argument index="1" name="executing" type="bool">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="toggle_foldable_line"> <method name="toggle_foldable_line">
<return type="void"> <return type="void" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int">
</argument>
<description> <description>
Toggle the folding of the code block at the given line. Toggle the folding of the code block at the given line.
</description> </description>
</method> </method>
<method name="unfold_all_lines"> <method name="unfold_all_lines">
<return type="void"> <return type="void" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="unfold_line"> <method name="unfold_line">
<return type="void"> <return type="void" />
</return> <argument index="0" name="line" type="int" />
<argument index="0" name="line" type="int">
</argument>
<description> <description>
Unfolds all lines that were previously folded. Unfolds all lines that were previously folded.
</description> </description>
</method> </method>
<method name="unindent_lines"> <method name="unindent_lines">
<return type="void"> <return type="void" />
</return>
<description> <description>
Unindents selected lines, or in the case of no selection the caret line by one. Unindents selected lines, or in the case of no selection the caret line by one.
</description> </description>
</method> </method>
<method name="update_code_completion_options"> <method name="update_code_completion_options">
<return type="void"> <return type="void" />
</return> <argument index="0" name="force" type="bool" />
<argument index="0" name="force" type="bool">
</argument>
<description> <description>
Submits all completion options added with [method add_code_completion_option]. Will try to force the autoccomplete menu to popup, if [code]force[/code] is [code]true[/code]. Submits all completion options added with [method add_code_completion_option]. Will try to force the autoccomplete menu to popup, if [code]force[/code] is [code]true[/code].
[b]Note[/b]: This will replace all current candidates. [b]Note[/b]: This will replace all current candidates.
@ -526,8 +423,7 @@
</members> </members>
<signals> <signals>
<signal name="breakpoint_toggled"> <signal name="breakpoint_toggled">
<argument index="0" name="line" type="int"> <argument index="0" name="line" type="int" />
</argument>
<description> <description>
</description> </description>
</signal> </signal>

90
doc/classes/CodeHighlighter.xml
View File

@ -10,16 +10,11 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_color_region"> <method name="add_color_region">
<return type="void"> <return type="void" />
</return> <argument index="0" name="start_key" type="String" />
<argument index="0" name="start_key" type="String"> <argument index="1" name="end_key" type="String" />
</argument> <argument index="2" name="color" type="Color" />
<argument index="1" name="end_key" type="String"> <argument index="3" name="line_only" type="bool" default="false" />
</argument>
<argument index="2" name="color" type="Color">
</argument>
<argument index="3" name="line_only" type="bool" default="false">
</argument>
<description> <description>
Adds a color region such as comments or strings. Adds a color region such as comments or strings.
Both the start and end keys must be symbols. Only the start key has to be unique. Both the start and end keys must be symbols. Only the start key has to be unique.
@ -27,24 +22,18 @@
</description> </description>
</method> </method>
<method name="add_keyword_color"> <method name="add_keyword_color">
<return type="void"> <return type="void" />
</return> <argument index="0" name="keyword" type="String" />
<argument index="0" name="keyword" type="String"> <argument index="1" name="color" type="Color" />
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description> <description>
Sets the color for a keyword. Sets the color for a keyword.
The keyword cannot contain any symbols except '_'. The keyword cannot contain any symbols except '_'.
</description> </description>
</method> </method>
<method name="add_member_keyword_color"> <method name="add_member_keyword_color">
<return type="void"> <return type="void" />
</return> <argument index="0" name="member_keyword" type="String" />
<argument index="0" name="member_keyword" type="String"> <argument index="1" name="color" type="Color" />
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description> <description>
Sets the color for a member keyword. Sets the color for a member keyword.
The member keyword cannot contain any symbols except '_'. The member keyword cannot contain any symbols except '_'.
@ -52,94 +41,75 @@
</description> </description>
</method> </method>
<method name="clear_color_regions"> <method name="clear_color_regions">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all color regions. Removes all color regions.
</description> </description>
</method> </method>
<method name="clear_keyword_colors"> <method name="clear_keyword_colors">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all keywords. Removes all keywords.
</description> </description>
</method> </method>
<method name="clear_member_keyword_colors"> <method name="clear_member_keyword_colors">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all member keywords. Removes all member keywords.
</description> </description>
</method> </method>
<method name="get_keyword_color" qualifiers="const"> <method name="get_keyword_color" qualifiers="const">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="keyword" type="String" />
<argument index="0" name="keyword" type="String">
</argument>
<description> <description>
Returns the color for a keyword. Returns the color for a keyword.
</description> </description>
</method> </method>
<method name="get_member_keyword_color" qualifiers="const"> <method name="get_member_keyword_color" qualifiers="const">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="member_keyword" type="String" />
<argument index="0" name="member_keyword" type="String">
</argument>
<description> <description>
Returns the color for a member keyword. Returns the color for a member keyword.
</description> </description>
</method> </method>
<method name="has_color_region" qualifiers="const"> <method name="has_color_region" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="start_key" type="String" />
<argument index="0" name="start_key" type="String">
</argument>
<description> <description>
Return [code]true[/code] if the start key exists, else [code]false[/code]. Return [code]true[/code] if the start key exists, else [code]false[/code].
</description> </description>
</method> </method>
<method name="has_keyword_color" qualifiers="const"> <method name="has_keyword_color" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="keyword" type="String" />
<argument index="0" name="keyword" type="String">
</argument>
<description> <description>
Return [code]true[/code] if the keyword exists, else [code]false[/code]. Return [code]true[/code] if the keyword exists, else [code]false[/code].
</description> </description>
</method> </method>
<method name="has_member_keyword_color" qualifiers="const"> <method name="has_member_keyword_color" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="member_keyword" type="String" />
<argument index="0" name="member_keyword" type="String">
</argument>
<description> <description>
Return [code]true[/code] if the member keyword exists, else [code]false[/code]. Return [code]true[/code] if the member keyword exists, else [code]false[/code].
</description> </description>
</method> </method>
<method name="remove_color_region"> <method name="remove_color_region">
<return type="void"> <return type="void" />
</return> <argument index="0" name="start_key" type="String" />
<argument index="0" name="start_key" type="String">
</argument>
<description> <description>
Removes the color region that uses that start key. Removes the color region that uses that start key.
</description> </description>
</method> </method>
<method name="remove_keyword_color"> <method name="remove_keyword_color">
<return type="void"> <return type="void" />
</return> <argument index="0" name="keyword" type="String" />
<argument index="0" name="keyword" type="String">
</argument>
<description> <description>
Removes the keyword. Removes the keyword.
</description> </description>
</method> </method>
<method name="remove_member_keyword_color"> <method name="remove_member_keyword_color">
<return type="void"> <return type="void" />
</return> <argument index="0" name="member_keyword" type="String" />
<argument index="0" name="member_keyword" type="String">
</argument>
<description> <description>
Removes the member keyword. Removes the member keyword.
</description> </description>

195
doc/classes/CollisionObject2D.xml
View File

@ -10,248 +10,188 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_input_event" qualifiers="virtual"> <method name="_input_event" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="viewport" type="Object" />
<argument index="0" name="viewport" type="Object"> <argument index="1" name="event" type="InputEvent" />
</argument> <argument index="2" name="shape_idx" type="int" />
<argument index="1" name="event" type="InputEvent">
</argument>
<argument index="2" name="shape_idx" type="int">
</argument>
<description> <description>
Accepts unhandled [InputEvent]s. Requires [member input_pickable] to be [code]true[/code]. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events. Accepts unhandled [InputEvent]s. Requires [member input_pickable] to be [code]true[/code]. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events.
</description> </description>
</method> </method>
<method name="create_shape_owner"> <method name="create_shape_owner">
<return type="int"> <return type="int" />
</return> <argument index="0" name="owner" type="Object" />
<argument index="0" name="owner" type="Object">
</argument>
<description> <description>
Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference.
</description> </description>
</method> </method>
<method name="get_collision_layer_bit" qualifiers="const"> <method name="get_collision_layer_bit" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="bit" type="int" />
<argument index="0" name="bit" type="int">
</argument>
<description> <description>
Returns whether or not the specified [code]bit[/code] of the [member collision_layer] is set. Returns whether or not the specified [code]bit[/code] of the [member collision_layer] is set.
</description> </description>
</method> </method>
<method name="get_collision_mask_bit" qualifiers="const"> <method name="get_collision_mask_bit" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="bit" type="int" />
<argument index="0" name="bit" type="int">
</argument>
<description> <description>
Returns whether or not the specified [code]bit[/code] of the [member collision_mask] is set. Returns whether or not the specified [code]bit[/code] of the [member collision_mask] is set.
</description> </description>
</method> </method>
<method name="get_rid" qualifiers="const"> <method name="get_rid" qualifiers="const">
<return type="RID"> <return type="RID" />
</return>
<description> <description>
Returns the object's [RID]. Returns the object's [RID].
</description> </description>
</method> </method>
<method name="get_shape_owner_one_way_collision_margin" qualifiers="const"> <method name="get_shape_owner_one_way_collision_margin" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Returns the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code]. Returns the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code].
</description> </description>
</method> </method>
<method name="get_shape_owners"> <method name="get_shape_owners">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument. Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument.
</description> </description>
</method> </method>
<method name="is_shape_owner_disabled" qualifiers="const"> <method name="is_shape_owner_disabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
If [code]true[/code], the shape owner and its shapes are disabled. If [code]true[/code], the shape owner and its shapes are disabled.
</description> </description>
</method> </method>
<method name="is_shape_owner_one_way_collision_enabled" qualifiers="const"> <method name="is_shape_owner_one_way_collision_enabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Returns [code]true[/code] if collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s. Returns [code]true[/code] if collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s.
</description> </description>
</method> </method>
<method name="remove_shape_owner"> <method name="remove_shape_owner">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Removes the given shape owner. Removes the given shape owner.
</description> </description>
</method> </method>
<method name="set_collision_layer_bit"> <method name="set_collision_layer_bit">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bit" type="int" />
<argument index="0" name="bit" type="int"> <argument index="1" name="value" type="bool" />
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description> <description>
If [code]value[/code] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_layer]. If [code]value[/code] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_layer].
If [code]value[/code] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_layer]. If [code]value[/code] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_layer].
</description> </description>
</method> </method>
<method name="set_collision_mask_bit"> <method name="set_collision_mask_bit">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bit" type="int" />
<argument index="0" name="bit" type="int"> <argument index="1" name="value" type="bool" />
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description> <description>
If [code]value[/code] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_mask]. If [code]value[/code] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_mask].
If [code]value[/code] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_mask]. If [code]value[/code] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_mask].
</description> </description>
</method> </method>
<method name="shape_find_owner" qualifiers="const"> <method name="shape_find_owner" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="shape_index" type="int" />
<argument index="0" name="shape_index" type="int">
</argument>
<description> <description>
Returns the [code]owner_id[/code] of the given shape. Returns the [code]owner_id[/code] of the given shape.
</description> </description>
</method> </method>
<method name="shape_owner_add_shape"> <method name="shape_owner_add_shape">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="shape" type="Shape2D" />
</argument>
<argument index="1" name="shape" type="Shape2D">
</argument>
<description> <description>
Adds a [Shape2D] to the shape owner. Adds a [Shape2D] to the shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_clear_shapes"> <method name="shape_owner_clear_shapes">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Removes all shapes from the shape owner. Removes all shapes from the shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_get_owner" qualifiers="const"> <method name="shape_owner_get_owner" qualifiers="const">
<return type="Object"> <return type="Object" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Returns the parent object of the given shape owner. Returns the parent object of the given shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_get_shape" qualifiers="const"> <method name="shape_owner_get_shape" qualifiers="const">
<return type="Shape2D"> <return type="Shape2D" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="shape_id" type="int" />
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<description> <description>
Returns the [Shape2D] with the given id from the given shape owner. Returns the [Shape2D] with the given id from the given shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_get_shape_count" qualifiers="const"> <method name="shape_owner_get_shape_count" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Returns the number of shapes the given shape owner contains. Returns the number of shapes the given shape owner contains.
</description> </description>
</method> </method>
<method name="shape_owner_get_shape_index" qualifiers="const"> <method name="shape_owner_get_shape_index" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="shape_id" type="int" />
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<description> <description>
Returns the child index of the [Shape2D] with the given id from the given shape owner. Returns the child index of the [Shape2D] with the given id from the given shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_get_transform" qualifiers="const"> <method name="shape_owner_get_transform" qualifiers="const">
<return type="Transform2D"> <return type="Transform2D" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Returns the shape owner's [Transform2D]. Returns the shape owner's [Transform2D].
</description> </description>
</method> </method>
<method name="shape_owner_remove_shape"> <method name="shape_owner_remove_shape">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="shape_id" type="int" />
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<description> <description>
Removes a shape from the given shape owner. Removes a shape from the given shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_set_disabled"> <method name="shape_owner_set_disabled">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="disabled" type="bool" />
</argument>
<argument index="1" name="disabled" type="bool">
</argument>
<description> <description>
If [code]true[/code], disables the given shape owner. If [code]true[/code], disables the given shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_set_one_way_collision"> <method name="shape_owner_set_one_way_collision">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="enable" type="bool" />
</argument>
<argument index="1" name="enable" type="bool">
</argument>
<description> <description>
If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s. If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s.
</description> </description>
</method> </method>
<method name="shape_owner_set_one_way_collision_margin"> <method name="shape_owner_set_one_way_collision_margin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="margin" type="float" />
</argument>
<argument index="1" name="margin" type="float">
</argument>
<description> <description>
Sets the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code] to [code]margin[/code] pixels. Sets the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code] to [code]margin[/code] pixels.
</description> </description>
</method> </method>
<method name="shape_owner_set_transform"> <method name="shape_owner_set_transform">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="transform" type="Transform2D" />
</argument>
<argument index="1" name="transform" type="Transform2D">
</argument>
<description> <description>
Sets the [Transform2D] of the given shape owner. Sets the [Transform2D] of the given shape owner.
</description> </description>
@ -275,12 +215,9 @@
</members> </members>
<signals> <signals>
<signal name="input_event"> <signal name="input_event">
<argument index="0" name="viewport" type="Node"> <argument index="0" name="viewport" type="Node" />
</argument> <argument index="1" name="event" type="InputEvent" />
<argument index="1" name="event" type="InputEvent"> <argument index="2" name="shape_idx" type="int" />
</argument>
<argument index="2" name="shape_idx" type="int">
</argument>
<description> <description>
Emitted when an input event occurs. Requires [member input_pickable] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. See [method _input_event] for details. Emitted when an input event occurs. Requires [member input_pickable] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. See [method _input_event] for details.
</description> </description>
@ -296,15 +233,13 @@
</description> </description>
</signal> </signal>
<signal name="mouse_shape_entered"> <signal name="mouse_shape_entered">
<argument index="0" name="shape_idx" type="int"> <argument index="0" name="shape_idx" type="int" />
</argument>
<description> <description>
Emitted when the mouse pointer enters any of this object's shapes or moves from one shape to another. [code]shape_idx[/code] is the child index of the newly entered [Shape2D]. Requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. Emitted when the mouse pointer enters any of this object's shapes or moves from one shape to another. [code]shape_idx[/code] is the child index of the newly entered [Shape2D]. Requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set.
</description> </description>
</signal> </signal>
<signal name="mouse_shape_exited"> <signal name="mouse_shape_exited">
<argument index="0" name="shape_idx" type="int"> <argument index="0" name="shape_idx" type="int" />
</argument>
<description> <description>
Emitted when the mouse pointer exits any of this object's shapes. [code]shape_idx[/code] is the child index of the exited [Shape2D]. Requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set. Emitted when the mouse pointer exits any of this object's shapes. [code]shape_idx[/code] is the child index of the exited [Shape2D]. Requires [member input_pickable] to be [code]true[/code] and at least one [member collision_layer] bit to be set.
</description> </description>

171
doc/classes/CollisionObject3D.xml
View File

@ -10,212 +10,160 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_input_event" qualifiers="virtual"> <method name="_input_event" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="camera" type="Object" />
<argument index="0" name="camera" type="Object"> <argument index="1" name="event" type="InputEvent" />
</argument> <argument index="2" name="position" type="Vector3" />
<argument index="1" name="event" type="InputEvent"> <argument index="3" name="normal" type="Vector3" />
</argument> <argument index="4" name="shape_idx" type="int" />
<argument index="2" name="position" type="Vector3">
</argument>
<argument index="3" name="normal" type="Vector3">
</argument>
<argument index="4" name="shape_idx" type="int">
</argument>
<description> <description>
Receives unhandled [InputEvent]s. [code]position[/code] is the location in world space of the mouse pointer on the surface of the shape with index [code]shape_idx[/code] and [code]normal[/code] is the normal vector of the surface at that point. Connect to the [signal input_event] signal to easily pick up these events. Receives unhandled [InputEvent]s. [code]position[/code] is the location in world space of the mouse pointer on the surface of the shape with index [code]shape_idx[/code] and [code]normal[/code] is the normal vector of the surface at that point. Connect to the [signal input_event] signal to easily pick up these events.
</description> </description>
</method> </method>
<method name="create_shape_owner"> <method name="create_shape_owner">
<return type="int"> <return type="int" />
</return> <argument index="0" name="owner" type="Object" />
<argument index="0" name="owner" type="Object">
</argument>
<description> <description>
Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference.
</description> </description>
</method> </method>
<method name="get_collision_layer_bit" qualifiers="const"> <method name="get_collision_layer_bit" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="bit" type="int" />
<argument index="0" name="bit" type="int">
</argument>
<description> <description>
Returns whether or not the specified [code]bit[/code] of the [member collision_layer] is set. Returns whether or not the specified [code]bit[/code] of the [member collision_layer] is set.
</description> </description>
</method> </method>
<method name="get_collision_mask_bit" qualifiers="const"> <method name="get_collision_mask_bit" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="bit" type="int" />
<argument index="0" name="bit" type="int">
</argument>
<description> <description>
Returns whether or not the specified [code]bit[/code] of the [member collision_mask] is set. Returns whether or not the specified [code]bit[/code] of the [member collision_mask] is set.
</description> </description>
</method> </method>
<method name="get_rid" qualifiers="const"> <method name="get_rid" qualifiers="const">
<return type="RID"> <return type="RID" />
</return>
<description> <description>
Returns the object's [RID]. Returns the object's [RID].
</description> </description>
</method> </method>
<method name="get_shape_owners"> <method name="get_shape_owners">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument. Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument.
</description> </description>
</method> </method>
<method name="is_shape_owner_disabled" qualifiers="const"> <method name="is_shape_owner_disabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
If [code]true[/code], the shape owner and its shapes are disabled. If [code]true[/code], the shape owner and its shapes are disabled.
</description> </description>
</method> </method>
<method name="remove_shape_owner"> <method name="remove_shape_owner">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Removes the given shape owner. Removes the given shape owner.
</description> </description>
</method> </method>
<method name="set_collision_layer_bit"> <method name="set_collision_layer_bit">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bit" type="int" />
<argument index="0" name="bit" type="int"> <argument index="1" name="value" type="bool" />
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description> <description>
If [code]value[/code] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_layer]. If [code]value[/code] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_layer].
If [code]value[/code] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_layer]. If [code]value[/code] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_layer].
</description> </description>
</method> </method>
<method name="set_collision_mask_bit"> <method name="set_collision_mask_bit">
<return type="void"> <return type="void" />
</return> <argument index="0" name="bit" type="int" />
<argument index="0" name="bit" type="int"> <argument index="1" name="value" type="bool" />
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description> <description>
If [code]value[/code] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_mask]. If [code]value[/code] is [code]true[/code], sets the specified [code]bit[/code] in the the [member collision_mask].
If [code]value[/code] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_mask]. If [code]value[/code] is [code]false[/code], clears the specified [code]bit[/code] in the the [member collision_mask].
</description> </description>
</method> </method>
<method name="shape_find_owner" qualifiers="const"> <method name="shape_find_owner" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="shape_index" type="int" />
<argument index="0" name="shape_index" type="int">
</argument>
<description> <description>
Returns the [code]owner_id[/code] of the given shape. Returns the [code]owner_id[/code] of the given shape.
</description> </description>
</method> </method>
<method name="shape_owner_add_shape"> <method name="shape_owner_add_shape">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="shape" type="Shape3D" />
</argument>
<argument index="1" name="shape" type="Shape3D">
</argument>
<description> <description>
Adds a [Shape3D] to the shape owner. Adds a [Shape3D] to the shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_clear_shapes"> <method name="shape_owner_clear_shapes">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Removes all shapes from the shape owner. Removes all shapes from the shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_get_owner" qualifiers="const"> <method name="shape_owner_get_owner" qualifiers="const">
<return type="Object"> <return type="Object" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Returns the parent object of the given shape owner. Returns the parent object of the given shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_get_shape" qualifiers="const"> <method name="shape_owner_get_shape" qualifiers="const">
<return type="Shape3D"> <return type="Shape3D" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="shape_id" type="int" />
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<description> <description>
Returns the [Shape3D] with the given id from the given shape owner. Returns the [Shape3D] with the given id from the given shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_get_shape_count" qualifiers="const"> <method name="shape_owner_get_shape_count" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Returns the number of shapes the given shape owner contains. Returns the number of shapes the given shape owner contains.
</description> </description>
</method> </method>
<method name="shape_owner_get_shape_index" qualifiers="const"> <method name="shape_owner_get_shape_index" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="shape_id" type="int" />
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<description> <description>
Returns the child index of the [Shape3D] with the given id from the given shape owner. Returns the child index of the [Shape3D] with the given id from the given shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_get_transform" qualifiers="const"> <method name="shape_owner_get_transform" qualifiers="const">
<return type="Transform3D"> <return type="Transform3D" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int">
</argument>
<description> <description>
Returns the shape owner's [Transform3D]. Returns the shape owner's [Transform3D].
</description> </description>
</method> </method>
<method name="shape_owner_remove_shape"> <method name="shape_owner_remove_shape">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="shape_id" type="int" />
</argument>
<argument index="1" name="shape_id" type="int">
</argument>
<description> <description>
Removes a shape from the given shape owner. Removes a shape from the given shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_set_disabled"> <method name="shape_owner_set_disabled">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="disabled" type="bool" />
</argument>
<argument index="1" name="disabled" type="bool">
</argument>
<description> <description>
If [code]true[/code], disables the given shape owner. If [code]true[/code], disables the given shape owner.
</description> </description>
</method> </method>
<method name="shape_owner_set_transform"> <method name="shape_owner_set_transform">
<return type="void"> <return type="void" />
</return> <argument index="0" name="owner_id" type="int" />
<argument index="0" name="owner_id" type="int"> <argument index="1" name="transform" type="Transform3D" />
</argument>
<argument index="1" name="transform" type="Transform3D">
</argument>
<description> <description>
Sets the [Transform3D] of the given shape owner. Sets the [Transform3D] of the given shape owner.
</description> </description>
@ -242,16 +190,11 @@
</members> </members>
<signals> <signals>
<signal name="input_event"> <signal name="input_event">
<argument index="0" name="camera" type="Node"> <argument index="0" name="camera" type="Node" />
</argument> <argument index="1" name="event" type="InputEvent" />
<argument index="1" name="event" type="InputEvent"> <argument index="2" name="position" type="Vector3" />
</argument> <argument index="3" name="normal" type="Vector3" />
<argument index="2" name="position" type="Vector3"> <argument index="4" name="shape_idx" type="int" />
</argument>
<argument index="3" name="normal" type="Vector3">
</argument>
<argument index="4" name="shape_idx" type="int">
</argument>
<description> <description>
Emitted when the object receives an unhandled [InputEvent]. [code]position[/code] is the location in world space of the mouse pointer on the surface of the shape with index [code]shape_idx[/code] and [code]normal[/code] is the normal vector of the surface at that point. Emitted when the object receives an unhandled [InputEvent]. [code]position[/code] is the location in world space of the mouse pointer on the surface of the shape with index [code]shape_idx[/code] and [code]normal[/code] is the normal vector of the surface at that point.
</description> </description>

9
doc/classes/CollisionShape3D.xml
View File

@ -14,17 +14,14 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="make_convex_from_siblings"> <method name="make_convex_from_siblings">
<return type="void"> <return type="void" />
</return>
<description> <description>
Sets the collision shape's shape to the addition of all its convexed [MeshInstance3D] siblings geometry. Sets the collision shape's shape to the addition of all its convexed [MeshInstance3D] siblings geometry.
</description> </description>
</method> </method>
<method name="resource_changed"> <method name="resource_changed">
<return type="void"> <return type="void" />
</return> <argument index="0" name="resource" type="Resource" />
<argument index="0" name="resource" type="Resource">
</argument>
<description> <description>
If this method exists within a script it will be called whenever the shape resource has been modified. If this method exists within a script it will be called whenever the shape resource has been modified.
</description> </description>

261
doc/classes/Color.xml
View File

@ -17,28 +17,22 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="Color" qualifiers="constructor"> <method name="Color" qualifiers="constructor">
<return type="Color"> <return type="Color" />
</return>
<description> <description>
Constructs a default-initialized [Color] with all components set to [code]0[/code]. Constructs a default-initialized [Color] with all components set to [code]0[/code].
</description> </description>
</method> </method>
<method name="Color" qualifiers="constructor"> <method name="Color" qualifiers="constructor">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="from" type="Color" />
<argument index="0" name="from" type="Color">
</argument>
<description> <description>
Constructs a [Color] as a copy of the given [Color]. Constructs a [Color] as a copy of the given [Color].
</description> </description>
</method> </method>
<method name="Color" qualifiers="constructor"> <method name="Color" qualifiers="constructor">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="from" type="Color" />
<argument index="0" name="from" type="Color"> <argument index="1" name="alpha" type="float" />
</argument>
<argument index="1" name="alpha" type="float">
</argument>
<description> <description>
Constructs a [Color] from an existing color, but with a custom alpha value. Constructs a [Color] from an existing color, but with a custom alpha value.
[codeblocks] [codeblocks]
@ -52,36 +46,26 @@
</description> </description>
</method> </method>
<method name="Color" qualifiers="constructor"> <method name="Color" qualifiers="constructor">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="code" type="String" />
<argument index="0" name="code" type="String">
</argument>
<description> <description>
Constructs a [Color] either from an HTML color code or from a standardized color name. Supported color names are the same as the constants. Constructs a [Color] either from an HTML color code or from a standardized color name. Supported color names are the same as the constants.
</description> </description>
</method> </method>
<method name="Color" qualifiers="constructor"> <method name="Color" qualifiers="constructor">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="code" type="String" />
<argument index="0" name="code" type="String"> <argument index="1" name="alpha" type="float" />
</argument>
<argument index="1" name="alpha" type="float">
</argument>
<description> <description>
Constructs a [Color] either from an HTML color code or from a standardized color name, with [code]alpha[/code] on the range of 0 to 1. Supported color names are the same as the constants. Constructs a [Color] either from an HTML color code or from a standardized color name, with [code]alpha[/code] on the range of 0 to 1. Supported color names are the same as the constants.
</description> </description>
</method> </method>
<method name="Color" qualifiers="constructor"> <method name="Color" qualifiers="constructor">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="r" type="float" />
<argument index="0" name="r" type="float"> <argument index="1" name="g" type="float" />
</argument> <argument index="2" name="b" type="float" />
<argument index="1" name="g" type="float"> <argument index="3" name="a" type="float" />
</argument>
<argument index="2" name="b" type="float">
</argument>
<argument index="3" name="a" type="float">
</argument>
<description> <description>
Constructs a [Color] from RGBA values, typically between 0 and 1. Constructs a [Color] from RGBA values, typically between 0 and 1.
[codeblocks] [codeblocks]
@ -95,14 +79,10 @@
</description> </description>
</method> </method>
<method name="Color" qualifiers="constructor"> <method name="Color" qualifiers="constructor">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="r" type="float" />
<argument index="0" name="r" type="float"> <argument index="1" name="g" type="float" />
</argument> <argument index="2" name="b" type="float" />
<argument index="1" name="g" type="float">
</argument>
<argument index="2" name="b" type="float">
</argument>
<description> <description>
Constructs a [Color] from RGB values, typically between 0 and 1. Alpha will be 1. Constructs a [Color] from RGB values, typically between 0 and 1. Alpha will be 1.
[codeblocks] [codeblocks]
@ -116,10 +96,8 @@
</description> </description>
</method> </method>
<method name="blend" qualifiers="const"> <method name="blend" qualifiers="const">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="over" type="Color" />
<argument index="0" name="over" type="Color">
</argument>
<description> <description>
Returns a new color resulting from blending this color over another. If the color is opaque, the result is also opaque. The second color may have a range of alpha values. Returns a new color resulting from blending this color over another. If the color is opaque, the result is also opaque. The second color may have a range of alpha values.
[codeblocks] [codeblocks]
@ -137,21 +115,16 @@
</description> </description>
</method> </method>
<method name="clamp" qualifiers="const"> <method name="clamp" qualifiers="const">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="min" type="Color" default="Color(0, 0, 0, 0)" />
<argument index="0" name="min" type="Color" default="Color(0, 0, 0, 0)"> <argument index="1" name="max" type="Color" default="Color(1, 1, 1, 1)" />
</argument>
<argument index="1" name="max" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<description> <description>
Returns a new color with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component. Returns a new color with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component.
</description> </description>
</method> </method>
<method name="darkened" qualifiers="const"> <method name="darkened" qualifiers="const">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="amount" type="float" />
<argument index="0" name="amount" type="float">
</argument>
<description> <description>
Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1). Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).
[codeblocks] [codeblocks]
@ -167,88 +140,67 @@
</description> </description>
</method> </method>
<method name="find_named_color" qualifiers="static"> <method name="find_named_color" qualifiers="static">
<return type="int"> <return type="int" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="from_rgbe9995" qualifiers="static"> <method name="from_rgbe9995" qualifiers="static">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="rgbe" type="int" />
<argument index="0" name="rgbe" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="from_string" qualifiers="static"> <method name="from_string" qualifiers="static">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="str" type="String" />
<argument index="0" name="str" type="String"> <argument index="1" name="default" type="Color" />
</argument>
<argument index="1" name="default" type="Color">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="get_named_color" qualifiers="static"> <method name="get_named_color" qualifiers="static">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="get_named_color_count" qualifiers="static"> <method name="get_named_color_count" qualifiers="static">
<return type="int"> <return type="int" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="get_named_color_name" qualifiers="static"> <method name="get_named_color_name" qualifiers="static">
<return type="String"> <return type="String" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="hex" qualifiers="static"> <method name="hex" qualifiers="static">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="hex" type="int" />
<argument index="0" name="hex" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="hex64" qualifiers="static"> <method name="hex64" qualifiers="static">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="hex" type="int" />
<argument index="0" name="hex" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="html" qualifiers="static"> <method name="html" qualifiers="static">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="rgba" type="String" />
<argument index="0" name="rgba" type="String">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="html_is_valid" qualifiers="static"> <method name="html_is_valid" qualifiers="static">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="color" type="String" />
<argument index="0" name="color" type="String">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="inverted" qualifiers="const"> <method name="inverted" qualifiers="const">
<return type="Color"> <return type="Color" />
</return>
<description> <description>
Returns the inverted color [code](1 - r, 1 - g, 1 - b, a)[/code]. Returns the inverted color [code](1 - r, 1 - g, 1 - b, a)[/code].
[codeblocks] [codeblocks]
@ -264,21 +216,16 @@
</description> </description>
</method> </method>
<method name="is_equal_approx" qualifiers="const"> <method name="is_equal_approx" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="to" type="Color" />
<argument index="0" name="to" type="Color">
</argument>
<description> <description>
Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component. Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
</description> </description>
</method> </method>
<method name="lerp" qualifiers="const"> <method name="lerp" qualifiers="const">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="to" type="Color" />
<argument index="0" name="to" type="Color"> <argument index="1" name="weight" type="float" />
</argument>
<argument index="1" name="weight" type="float">
</argument>
<description> <description>
Returns the linear interpolation with another color. The interpolation factor [code]weight[/code] is between 0 and 1. Returns the linear interpolation with another color. The interpolation factor [code]weight[/code] is between 0 and 1.
[codeblocks] [codeblocks]
@ -296,10 +243,8 @@
</description> </description>
</method> </method>
<method name="lightened" qualifiers="const"> <method name="lightened" qualifiers="const">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="amount" type="float" />
<argument index="0" name="amount" type="float">
</argument>
<description> <description>
Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1). Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1).
[codeblocks] [codeblocks]
@ -315,108 +260,83 @@
</description> </description>
</method> </method>
<method name="operator !=" qualifiers="operator"> <method name="operator !=" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Color" />
<argument index="0" name="right" type="Color">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator *" qualifiers="operator"> <method name="operator *" qualifiers="operator">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="right" type="Color" />
<argument index="0" name="right" type="Color">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator *" qualifiers="operator"> <method name="operator *" qualifiers="operator">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="right" type="float" />
<argument index="0" name="right" type="float">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator *" qualifiers="operator"> <method name="operator *" qualifiers="operator">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="right" type="int" />
<argument index="0" name="right" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator +" qualifiers="operator"> <method name="operator +" qualifiers="operator">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="right" type="Color" />
<argument index="0" name="right" type="Color">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator -" qualifiers="operator"> <method name="operator -" qualifiers="operator">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="right" type="Color" />
<argument index="0" name="right" type="Color">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator /" qualifiers="operator"> <method name="operator /" qualifiers="operator">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="right" type="Color" />
<argument index="0" name="right" type="Color">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator /" qualifiers="operator"> <method name="operator /" qualifiers="operator">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="right" type="float" />
<argument index="0" name="right" type="float">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator /" qualifiers="operator"> <method name="operator /" qualifiers="operator">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="right" type="int" />
<argument index="0" name="right" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator ==" qualifiers="operator"> <method name="operator ==" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Color" />
<argument index="0" name="right" type="Color">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator []" qualifiers="operator"> <method name="operator []" qualifiers="operator">
<return type="float"> <return type="float" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator unary+" qualifiers="operator"> <method name="operator unary+" qualifiers="operator">
<return type="Color"> <return type="Color" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="operator unary-" qualifiers="operator"> <method name="operator unary-" qualifiers="operator">
<return type="Color"> <return type="Color" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="to_abgr32" qualifiers="const"> <method name="to_abgr32" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the color converted to a 32-bit integer in ABGR format (each byte represents a color channel). ABGR is the reversed version of the default format. Returns the color converted to a 32-bit integer in ABGR format (each byte represents a color channel). ABGR is the reversed version of the default format.
[codeblocks] [codeblocks]
@ -432,8 +352,7 @@
</description> </description>
</method> </method>
<method name="to_abgr64" qualifiers="const"> <method name="to_abgr64" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the color converted to a 64-bit integer in ABGR format (each word represents a color channel). ABGR is the reversed version of the default format. Returns the color converted to a 64-bit integer in ABGR format (each word represents a color channel). ABGR is the reversed version of the default format.
[codeblocks] [codeblocks]
@ -449,8 +368,7 @@
</description> </description>
</method> </method>
<method name="to_argb32" qualifiers="const"> <method name="to_argb32" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX. Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX.
[codeblocks] [codeblocks]
@ -466,8 +384,7 @@
</description> </description>
</method> </method>
<method name="to_argb64" qualifiers="const"> <method name="to_argb64" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX. Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX.
[codeblocks] [codeblocks]
@ -483,10 +400,8 @@
</description> </description>
</method> </method>
<method name="to_html" qualifiers="const"> <method name="to_html" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="with_alpha" type="bool" default="true" />
<argument index="0" name="with_alpha" type="bool" default="true">
</argument>
<description> <description>
Returns the color converted to an HTML hexadecimal color string in RGBA format (ex: [code]ff34f822[/code]). Returns the color converted to an HTML hexadecimal color string in RGBA format (ex: [code]ff34f822[/code]).
Setting [code]with_alpha[/code] to [code]false[/code] excludes alpha from the hexadecimal string (and uses RGB instead of RGBA format). Setting [code]with_alpha[/code] to [code]false[/code] excludes alpha from the hexadecimal string (and uses RGB instead of RGBA format).
@ -505,8 +420,7 @@
</description> </description>
</method> </method>
<method name="to_rgba32" qualifiers="const"> <method name="to_rgba32" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format. Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format.
[codeblocks] [codeblocks]
@ -522,8 +436,7 @@
</description> </description>
</method> </method>
<method name="to_rgba64" qualifiers="const"> <method name="to_rgba64" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format. Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format.
[codeblocks] [codeblocks]

24
doc/classes/ColorPicker.xml
View File

@ -11,27 +11,22 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_preset"> <method name="add_preset">
<return type="void"> <return type="void" />
</return> <argument index="0" name="color" type="Color" />
<argument index="0" name="color" type="Color">
</argument>
<description> <description>
Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them.
[b]Note:[/b] the presets list is only for [i]this[/i] color picker. [b]Note:[/b] the presets list is only for [i]this[/i] color picker.
</description> </description>
</method> </method>
<method name="erase_preset"> <method name="erase_preset">
<return type="void"> <return type="void" />
</return> <argument index="0" name="color" type="Color" />
<argument index="0" name="color" type="Color">
</argument>
<description> <description>
Removes the given color from the list of color presets of this color picker. Removes the given color from the list of color presets of this color picker.
</description> </description>
</method> </method>
<method name="get_presets" qualifiers="const"> <method name="get_presets" qualifiers="const">
<return type="PackedColorArray"> <return type="PackedColorArray" />
</return>
<description> <description>
Returns the list of colors in the presets of the color picker. Returns the list of colors in the presets of the color picker.
</description> </description>
@ -67,22 +62,19 @@
</members> </members>
<signals> <signals>
<signal name="color_changed"> <signal name="color_changed">
<argument index="0" name="color" type="Color"> <argument index="0" name="color" type="Color" />
</argument>
<description> <description>
Emitted when the color is changed. Emitted when the color is changed.
</description> </description>
</signal> </signal>
<signal name="preset_added"> <signal name="preset_added">
<argument index="0" name="color" type="Color"> <argument index="0" name="color" type="Color" />
</argument>
<description> <description>
Emitted when a preset is added. Emitted when a preset is added.
</description> </description>
</signal> </signal>
<signal name="preset_removed"> <signal name="preset_removed">
<argument index="0" name="color" type="Color"> <argument index="0" name="color" type="Color" />
</argument>
<description> <description>
Emitted when a preset is removed. Emitted when a preset is removed.
</description> </description>

9
doc/classes/ColorPickerButton.xml
View File

@ -13,15 +13,13 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_picker"> <method name="get_picker">
<return type="ColorPicker"> <return type="ColorPicker" />
</return>
<description> <description>
Returns the [ColorPicker] that this node toggles. Returns the [ColorPicker] that this node toggles.
</description> </description>
</method> </method>
<method name="get_popup"> <method name="get_popup">
<return type="PopupPanel"> <return type="PopupPanel" />
</return>
<description> <description>
Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden.
</description> </description>
@ -38,8 +36,7 @@
</members> </members>
<signals> <signals>
<signal name="color_changed"> <signal name="color_changed">
<argument index="0" name="color" type="Color"> <argument index="0" name="color" type="Color" />
</argument>
<description> <description>
Emitted when the color changes. Emitted when the color changes.
</description> </description>

9
doc/classes/ConcavePolygonShape3D.xml
View File

@ -12,17 +12,14 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_faces" qualifiers="const"> <method name="get_faces" qualifiers="const">
<return type="PackedVector3Array"> <return type="PackedVector3Array" />
</return>
<description> <description>
Returns the faces (an array of triangles). Returns the faces (an array of triangles).
</description> </description>
</method> </method>
<method name="set_faces"> <method name="set_faces">
<return type="void"> <return type="void" />
</return> <argument index="0" name="faces" type="PackedVector3Array" />
<argument index="0" name="faces" type="PackedVector3Array">
</argument>
<description> <description>
Sets the faces (an array of triangles). Sets the faces (an array of triangles).
</description> </description>

15
doc/classes/ConeTwistJoint3D.xml
View File

@ -12,20 +12,15 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_param" qualifiers="const"> <method name="get_param" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" />
<argument index="0" name="param" type="int" enum="ConeTwistJoint3D.Param">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="set_param"> <method name="set_param">
<return type="void"> <return type="void" />
</return> <argument index="0" name="param" type="int" enum="ConeTwistJoint3D.Param" />
<argument index="0" name="param" type="int" enum="ConeTwistJoint3D.Param"> <argument index="1" name="value" type="float" />
</argument>
<argument index="1" name="value" type="float">
</argument>
<description> <description>
</description> </description>
</method> </method>

120
doc/classes/ConfigFile.xml
View File

@ -50,167 +50,127 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="clear"> <method name="clear">
<return type="void"> <return type="void" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="erase_section"> <method name="erase_section">
<return type="void"> <return type="void" />
</return> <argument index="0" name="section" type="String" />
<argument index="0" name="section" type="String">
</argument>
<description> <description>
Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist. Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist.
</description> </description>
</method> </method>
<method name="erase_section_key"> <method name="erase_section_key">
<return type="void"> <return type="void" />
</return> <argument index="0" name="section" type="String" />
<argument index="0" name="section" type="String"> <argument index="1" name="key" type="String" />
</argument>
<argument index="1" name="key" type="String">
</argument>
<description> <description>
Deletes the specified key in a section. Raises an error if either the section or the key do not exist. Deletes the specified key in a section. Raises an error if either the section or the key do not exist.
</description> </description>
</method> </method>
<method name="get_section_keys" qualifiers="const"> <method name="get_section_keys" qualifiers="const">
<return type="PackedStringArray"> <return type="PackedStringArray" />
</return> <argument index="0" name="section" type="String" />
<argument index="0" name="section" type="String">
</argument>
<description> <description>
Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist. Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist.
</description> </description>
</method> </method>
<method name="get_sections" qualifiers="const"> <method name="get_sections" qualifiers="const">
<return type="PackedStringArray"> <return type="PackedStringArray" />
</return>
<description> <description>
Returns an array of all defined section identifiers. Returns an array of all defined section identifiers.
</description> </description>
</method> </method>
<method name="get_value" qualifiers="const"> <method name="get_value" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="section" type="String" />
<argument index="0" name="section" type="String"> <argument index="1" name="key" type="String" />
</argument> <argument index="2" name="default" type="Variant" default="null" />
<argument index="1" name="key" type="String">
</argument>
<argument index="2" name="default" type="Variant" default="null">
</argument>
<description> <description>
Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback [code]default[/code] value. If [code]default[/code] is not specified or set to [code]null[/code], an error is also raised. Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback [code]default[/code] value. If [code]default[/code] is not specified or set to [code]null[/code], an error is also raised.
</description> </description>
</method> </method>
<method name="has_section" qualifiers="const"> <method name="has_section" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="section" type="String" />
<argument index="0" name="section" type="String">
</argument>
<description> <description>
Returns [code]true[/code] if the specified section exists. Returns [code]true[/code] if the specified section exists.
</description> </description>
</method> </method>
<method name="has_section_key" qualifiers="const"> <method name="has_section_key" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="section" type="String" />
<argument index="0" name="section" type="String"> <argument index="1" name="key" type="String" />
</argument>
<argument index="1" name="key" type="String">
</argument>
<description> <description>
Returns [code]true[/code] if the specified section-key pair exists. Returns [code]true[/code] if the specified section-key pair exists.
</description> </description>
</method> </method>
<method name="load"> <method name="load">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Loads the config file specified as a parameter. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
Returns one of the [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="load_encrypted"> <method name="load_encrypted">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="key" type="PackedByteArray" />
</argument>
<argument index="1" name="key" type="PackedByteArray">
</argument>
<description> <description>
Loads the encrypted config file specified as a parameter, using the provided [code]key[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Loads the encrypted config file specified as a parameter, using the provided [code]key[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
Returns one of the [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="load_encrypted_pass"> <method name="load_encrypted_pass">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="password" type="String" />
</argument>
<argument index="1" name="password" type="String">
</argument>
<description> <description>
Loads the encrypted config file specified as a parameter, using the provided [code]password[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Loads the encrypted config file specified as a parameter, using the provided [code]password[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
Returns one of the [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="parse"> <method name="parse">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="data" type="String" />
<argument index="0" name="data" type="String">
</argument>
<description> <description>
Parses the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on. Parses the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on.
Returns one of the [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="save"> <method name="save">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Saves the contents of the [ConfigFile] object to the file specified as a parameter. The output file uses an INI-style structure. Saves the contents of the [ConfigFile] object to the file specified as a parameter. The output file uses an INI-style structure.
Returns one of the [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="save_encrypted"> <method name="save_encrypted">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="key" type="PackedByteArray" />
</argument>
<argument index="1" name="key" type="PackedByteArray">
</argument>
<description> <description>
Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]key[/code] to encrypt it. The output file uses an INI-style structure. Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]key[/code] to encrypt it. The output file uses an INI-style structure.
Returns one of the [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="save_encrypted_pass"> <method name="save_encrypted_pass">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="password" type="String" />
</argument>
<argument index="1" name="password" type="String">
</argument>
<description> <description>
Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]password[/code] to encrypt it. The output file uses an INI-style structure. Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]password[/code] to encrypt it. The output file uses an INI-style structure.
Returns one of the [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="set_value"> <method name="set_value">
<return type="void"> <return type="void" />
</return> <argument index="0" name="section" type="String" />
<argument index="0" name="section" type="String"> <argument index="1" name="key" type="String" />
</argument> <argument index="2" name="value" type="Variant" />
<argument index="1" name="key" type="String">
</argument>
<argument index="2" name="value" type="Variant">
</argument>
<description> <description>
Assigns a value to the specified key of the specified section. If either the section 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. Assigns a value to the specified key of the specified section. If either the section 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> </description>

3
doc/classes/ConfirmationDialog.xml
View File

@ -19,8 +19,7 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_cancel_button"> <method name="get_cancel_button">
<return type="Button"> <return type="Button" />
</return>
<description> <description>
Returns the cancel button. Returns the cancel button.
</description> </description>

12
doc/classes/Container.xml
View File

@ -11,19 +11,15 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="fit_child_in_rect"> <method name="fit_child_in_rect">
<return type="void"> <return type="void" />
</return> <argument index="0" name="child" type="Control" />
<argument index="0" name="child" type="Control"> <argument index="1" name="rect" type="Rect2" />
</argument>
<argument index="1" name="rect" type="Rect2">
</argument>
<description> <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> </description>
</method> </method>
<method name="queue_sort"> <method name="queue_sort">
<return type="void"> <return type="void" />
</return>
<description> <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> </description>

522
doc/classes/Control.xml
View File

@ -23,12 +23,9 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_can_drop_data" qualifiers="virtual"> <method name="_can_drop_data" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2"> <argument index="1" name="data" type="Variant" />
</argument>
<argument index="1" name="data" type="Variant">
</argument>
<description> <description>
Godot calls this method to test if [code]data[/code] from a control's [method _get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control. Godot calls this method to test if [code]data[/code] from a control's [method _get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control.
This method should only be used to test the data. Process the data in [method _drop_data]. This method should only be used to test the data. Process the data in [method _drop_data].
@ -51,12 +48,9 @@
</description> </description>
</method> </method>
<method name="_drop_data" qualifiers="virtual"> <method name="_drop_data" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2"> <argument index="1" name="data" type="Variant" />
</argument>
<argument index="1" name="data" type="Variant">
</argument>
<description> <description>
Godot calls this method to pass you the [code]data[/code] from a control's [method _get_drag_data] result. Godot first calls [method _can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control. Godot calls this method to pass you the [code]data[/code] from a control's [method _get_drag_data] result. Godot first calls [method _can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control.
[codeblocks] [codeblocks]
@ -80,10 +74,8 @@
</description> </description>
</method> </method>
<method name="_get_drag_data" qualifiers="virtual"> <method name="_get_drag_data" qualifiers="virtual">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2">
</argument>
<description> <description>
Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method _can_drop_data] and [method _drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method _can_drop_data] and [method _drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag].
A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method.
@ -106,18 +98,15 @@
</description> </description>
</method> </method>
<method name="_get_minimum_size" qualifiers="virtual"> <method name="_get_minimum_size" qualifiers="virtual">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to [member rect_min_size] for controlling minimum size via code. The actual minimum size will be the max value of these two (in each axis separately). Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to [member rect_min_size] for controlling minimum size via code. The actual minimum size will be the max value of these two (in each axis separately).
If not overridden, defaults to [constant Vector2.ZERO]. If not overridden, defaults to [constant Vector2.ZERO].
</description> </description>
</method> </method>
<method name="_gui_input" qualifiers="virtual"> <method name="_gui_input" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="event" type="InputEvent" />
<argument index="0" name="event" type="InputEvent">
</argument>
<description> <description>
Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See [method accept_event]. Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See [method accept_event].
Example: clicking a control. Example: clicking a control.
@ -151,10 +140,8 @@
</description> </description>
</method> </method>
<method name="_has_point" qualifiers="virtual const"> <method name="_has_point" qualifiers="virtual const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="" type="Vector2" />
<argument index="0" name="" type="Vector2">
</argument>
<description> <description>
Virtual method to be implemented by the user. Returns whether the given [code]point[/code] is inside this control. Virtual method to be implemented by the user. Returns whether the given [code]point[/code] is inside this control.
If not overridden, default behavior is checking if the point is within control's Rect. If not overridden, default behavior is checking if the point is within control's Rect.
@ -162,10 +149,8 @@
</description> </description>
</method> </method>
<method name="_make_custom_tooltip" qualifiers="virtual"> <method name="_make_custom_tooltip" qualifiers="virtual">
<return type="Control"> <return type="Control" />
</return> <argument index="0" name="for_text" type="String" />
<argument index="0" name="for_text" type="String">
</argument>
<description> <description>
Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. The [code]for_text[/code] includes the contents of the [member hint_tooltip] property. Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. The [code]for_text[/code] includes the contents of the [member hint_tooltip] property.
The returned node must be of type [Control] or Control-derived. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance (if you want to use a pre-existing node from your scene tree, you can duplicate it and pass the duplicated instance). When [code]null[/code] or a non-Control node is returned, the default tooltip will be used instead. The returned node must be of type [Control] or Control-derived. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance (if you want to use a pre-existing node from your scene tree, you can duplicate it and pass the duplicated instance). When [code]null[/code] or a non-Control node is returned, the default tooltip will be used instead.
@ -209,31 +194,24 @@
</description> </description>
</method> </method>
<method name="_structured_text_parser" qualifiers="virtual"> <method name="_structured_text_parser" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="args" type="Array" />
<argument index="0" name="args" type="Array"> <argument index="1" name="text" type="String" />
</argument>
<argument index="1" name="text" type="String">
</argument>
<description> <description>
User defined BiDi algorithm override function. User defined BiDi algorithm override function.
Return [code]Array[/code] of [code]Vector2i[/code] text ranges, in the left-to-right order. Ranges should cover full source [code]text[/code] without overlaps. BiDi algorithm will be used on each range separately. Return [code]Array[/code] of [code]Vector2i[/code] text ranges, in the left-to-right order. Ranges should cover full source [code]text[/code] without overlaps. BiDi algorithm will be used on each range separately.
</description> </description>
</method> </method>
<method name="accept_event"> <method name="accept_event">
<return type="void"> <return type="void" />
</return>
<description> <description>
Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to [method Node._unhandled_input] or [method Node._unhandled_key_input]. Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to [method Node._unhandled_input] or [method Node._unhandled_key_input].
</description> </description>
</method> </method>
<method name="add_theme_color_override"> <method name="add_theme_color_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="color" type="Color" />
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description> <description>
Creates a local override for a theme [Color] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_color_override]. Creates a local override for a theme [Color] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_color_override].
See also [method get_theme_color]. See also [method get_theme_color].
@ -259,60 +237,45 @@
</description> </description>
</method> </method>
<method name="add_theme_constant_override"> <method name="add_theme_constant_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="constant" type="int" />
</argument>
<argument index="1" name="constant" type="int">
</argument>
<description> <description>
Creates a local override for a theme constant with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_constant_override]. Creates a local override for a theme constant with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_constant_override].
See also [method get_theme_constant]. See also [method get_theme_constant].
</description> </description>
</method> </method>
<method name="add_theme_font_override"> <method name="add_theme_font_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="font" type="Font" />
</argument>
<argument index="1" name="font" type="Font">
</argument>
<description> <description>
Creates a local override for a theme [Font] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_override]. Creates a local override for a theme [Font] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_override].
See also [method get_theme_font]. See also [method get_theme_font].
</description> </description>
</method> </method>
<method name="add_theme_font_size_override"> <method name="add_theme_font_size_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="font_size" type="int" />
</argument>
<argument index="1" name="font_size" type="int">
</argument>
<description> <description>
Creates a local override for a theme font size with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_size_override]. Creates a local override for a theme font size with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_size_override].
See also [method get_theme_font_size]. See also [method get_theme_font_size].
</description> </description>
</method> </method>
<method name="add_theme_icon_override"> <method name="add_theme_icon_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="texture" type="Texture2D" />
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
<description> <description>
Creates a local override for a theme icon with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_icon_override]. Creates a local override for a theme icon with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_icon_override].
See also [method get_theme_icon]. See also [method get_theme_icon].
</description> </description>
</method> </method>
<method name="add_theme_stylebox_override"> <method name="add_theme_stylebox_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="stylebox" type="StyleBox" />
</argument>
<argument index="1" name="stylebox" type="StyleBox">
</argument>
<description> <description>
Creates a local override for a theme [StyleBox] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_stylebox_override]. Creates a local override for a theme [StyleBox] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_stylebox_override].
See also [method get_theme_stylebox]. See also [method get_theme_stylebox].
@ -344,137 +307,112 @@
</description> </description>
</method> </method>
<method name="find_next_valid_focus" qualifiers="const"> <method name="find_next_valid_focus" qualifiers="const">
<return type="Control"> <return type="Control" />
</return>
<description> <description>
Finds the next (below in the tree) [Control] that can receive the focus. Finds the next (below in the tree) [Control] that can receive the focus.
</description> </description>
</method> </method>
<method name="find_prev_valid_focus" qualifiers="const"> <method name="find_prev_valid_focus" qualifiers="const">
<return type="Control"> <return type="Control" />
</return>
<description> <description>
Finds the previous (above in the tree) [Control] that can receive the focus. Finds the previous (above in the tree) [Control] that can receive the focus.
</description> </description>
</method> </method>
<method name="force_drag"> <method name="force_drag">
<return type="void"> <return type="void" />
</return> <argument index="0" name="data" type="Variant" />
<argument index="0" name="data" type="Variant"> <argument index="1" name="preview" type="Control" />
</argument>
<argument index="1" name="preview" type="Control">
</argument>
<description> <description>
Forces drag and bypasses [method _get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control. Forces drag and bypasses [method _get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control.
The methods [method _can_drop_data] and [method _drop_data] must be implemented on controls that want to receive drop data. The methods [method _can_drop_data] and [method _drop_data] must be implemented on controls that want to receive drop data.
</description> </description>
</method> </method>
<method name="get_anchor" qualifiers="const"> <method name="get_anchor" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="side" type="int" enum="Side" />
<argument index="0" name="side" type="int" enum="Side">
</argument>
<description> <description>
Returns the anchor for the specified [enum Side]. A getter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. Returns the anchor for the specified [enum Side]. A getter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top].
</description> </description>
</method> </method>
<method name="get_begin" qualifiers="const"> <method name="get_begin" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns [member offset_left] and [member offset_top]. See also [member rect_position]. Returns [member offset_left] and [member offset_top]. See also [member rect_position].
</description> </description>
</method> </method>
<method name="get_combined_minimum_size" qualifiers="const"> <method name="get_combined_minimum_size" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns combined minimum size from [member rect_min_size] and [method get_minimum_size]. Returns combined minimum size from [member rect_min_size] and [method get_minimum_size].
</description> </description>
</method> </method>
<method name="get_cursor_shape" qualifiers="const"> <method name="get_cursor_shape" qualifiers="const">
<return type="int" enum="Control.CursorShape"> <return type="int" enum="Control.CursorShape" />
</return> <argument index="0" name="position" type="Vector2" default="Vector2(0, 0)" />
<argument index="0" name="position" type="Vector2" default="Vector2(0, 0)">
</argument>
<description> <description>
Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape]. Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape].
</description> </description>
</method> </method>
<method name="get_end" qualifiers="const"> <method name="get_end" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns [member offset_right] and [member offset_bottom]. Returns [member offset_right] and [member offset_bottom].
</description> </description>
</method> </method>
<method name="get_focus_neighbor" qualifiers="const"> <method name="get_focus_neighbor" qualifiers="const">
<return type="NodePath"> <return type="NodePath" />
</return> <argument index="0" name="side" type="int" enum="Side" />
<argument index="0" name="side" type="int" enum="Side">
</argument>
<description> <description>
Returns the focus neighbor for the specified [enum Side]. A getter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. Returns the focus neighbor for the specified [enum Side]. A getter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top].
</description> </description>
</method> </method>
<method name="get_focus_owner" qualifiers="const"> <method name="get_focus_owner" qualifiers="const">
<return type="Control"> <return type="Control" />
</return>
<description> <description>
Returns the control that has the keyboard focus or [code]null[/code] if none. Returns the control that has the keyboard focus or [code]null[/code] if none.
</description> </description>
</method> </method>
<method name="get_global_rect" qualifiers="const"> <method name="get_global_rect" qualifiers="const">
<return type="Rect2"> <return type="Rect2" />
</return>
<description> <description>
Returns the position and size of the control relative to the top-left corner of the screen. See [member rect_position] and [member rect_size]. Returns the position and size of the control relative to the top-left corner of the screen. See [member rect_position] and [member rect_size].
</description> </description>
</method> </method>
<method name="get_minimum_size" qualifiers="const"> <method name="get_minimum_size" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns the minimum size for this control. See [member rect_min_size]. Returns the minimum size for this control. See [member rect_min_size].
</description> </description>
</method> </method>
<method name="get_offset" qualifiers="const"> <method name="get_offset" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="offset" type="int" enum="Side" />
<argument index="0" name="offset" type="int" enum="Side">
</argument>
<description> <description>
Returns the anchor for the specified [enum Side]. A getter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top]. Returns the anchor for the specified [enum Side]. A getter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top].
</description> </description>
</method> </method>
<method name="get_parent_area_size" qualifiers="const"> <method name="get_parent_area_size" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return>
<description> <description>
Returns the width/height occupied in the parent control. Returns the width/height occupied in the parent control.
</description> </description>
</method> </method>
<method name="get_parent_control" qualifiers="const"> <method name="get_parent_control" qualifiers="const">
<return type="Control"> <return type="Control" />
</return>
<description> <description>
Returns the parent control node. Returns the parent control node.
</description> </description>
</method> </method>
<method name="get_rect" qualifiers="const"> <method name="get_rect" qualifiers="const">
<return type="Rect2"> <return type="Rect2" />
</return>
<description> <description>
Returns the position and size of the control relative to the top-left corner of the parent Control. See [member rect_position] and [member rect_size]. Returns the position and size of the control relative to the top-left corner of the parent Control. See [member rect_position] and [member rect_size].
</description> </description>
</method> </method>
<method name="get_theme_color" qualifiers="const"> <method name="get_theme_color" qualifiers="const">
<return type="Color"> <return type="Color" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns a [Color] from the first matching [Theme] in the tree if that [Theme] has a color item with the specified [code]name[/code] and [code]theme_type[/code]. If [code]theme_type[/code] is omitted the class name of the current control is used as the type, or [member theme_type_variation] if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked. Returns a [Color] from the first matching [Theme] in the tree if that [Theme] has a color item with the specified [code]name[/code] and [code]theme_type[/code]. If [code]theme_type[/code] is omitted the class name of the current control is used as the type, or [member theme_type_variation] if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked.
For the current control its local overrides are considered first (see [method add_theme_color_override]), then its assigned [member theme]. After the current control, each parent control and its assigned [member theme] are considered; controls without a [member theme] assigned are skipped. If no matching [Theme] is found in the tree, a custom project [Theme] (see [member ProjectSettings.gui/theme/custom]) and the default [Theme] are used. For the current control its local overrides are considered first (see [method add_theme_color_override]), then its assigned [member theme]. After the current control, each parent control and its assigned [member theme] are considered; controls without a [member theme] assigned are skipped. If no matching [Theme] is found in the tree, a custom project [Theme] (see [member ProjectSettings.gui/theme/custom]) and the default [Theme] are used.
@ -499,77 +437,59 @@
</description> </description>
</method> </method>
<method name="get_theme_constant" qualifiers="const"> <method name="get_theme_constant" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns a constant from the first matching [Theme] in the tree if that [Theme] has a constant item with the specified [code]name[/code] and [code]theme_type[/code]. Returns a constant from the first matching [Theme] in the tree if that [Theme] has a constant item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="get_theme_font" qualifiers="const"> <method name="get_theme_font" qualifiers="const">
<return type="Font"> <return type="Font" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns a [Font] from the first matching [Theme] in the tree if that [Theme] has a font item with the specified [code]name[/code] and [code]theme_type[/code]. Returns a [Font] from the first matching [Theme] in the tree if that [Theme] has a font item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="get_theme_font_size" qualifiers="const"> <method name="get_theme_font_size" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns a font size from the first matching [Theme] in the tree if that [Theme] has a font size item with the specified [code]name[/code] and [code]theme_type[/code]. Returns a font size from the first matching [Theme] in the tree if that [Theme] has a font size item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="get_theme_icon" qualifiers="const"> <method name="get_theme_icon" qualifiers="const">
<return type="Texture2D"> <return type="Texture2D" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns an icon from the first matching [Theme] in the tree if that [Theme] has an icon item with the specified [code]name[/code] and [code]theme_type[/code]. Returns an icon from the first matching [Theme] in the tree if that [Theme] has an icon item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="get_theme_stylebox" qualifiers="const"> <method name="get_theme_stylebox" qualifiers="const">
<return type="StyleBox"> <return type="StyleBox" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns a [StyleBox] from the first matching [Theme] in the tree if that [Theme] has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code]. Returns a [StyleBox] from the first matching [Theme] in the tree if that [Theme] has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="get_tooltip" qualifiers="const"> <method name="get_tooltip" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="at_position" type="Vector2" default="Vector2(0, 0)" />
<argument index="0" name="at_position" type="Vector2" default="Vector2(0, 0)">
</argument>
<description> <description>
Returns the tooltip, which will appear when the cursor is resting over this control. See [member hint_tooltip]. Returns the tooltip, which will appear when the cursor is resting over this control. See [member hint_tooltip].
</description> </description>
</method> </method>
<method name="grab_click_focus"> <method name="grab_click_focus">
<return type="void"> <return type="void" />
</return>
<description> <description>
Creates an [InputEventMouseButton] that attempts to click the control. If the event is received, the control acquires focus. Creates an [InputEventMouseButton] that attempts to click the control. If the event is received, the control acquires focus.
[codeblocks] [codeblocks]
@ -587,237 +507,185 @@
</description> </description>
</method> </method>
<method name="grab_focus"> <method name="grab_focus">
<return type="void"> <return type="void" />
</return>
<description> <description>
Steal the focus from another control and become the focused control (see [member focus_mode]). Steal the focus from another control and become the focused control (see [member focus_mode]).
</description> </description>
</method> </method>
<method name="has_focus" qualifiers="const"> <method name="has_focus" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if this is the current focused control. See [member focus_mode]. Returns [code]true[/code] if this is the current focused control. See [member focus_mode].
</description> </description>
</method> </method>
<method name="has_theme_color" qualifiers="const"> <method name="has_theme_color" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a color item with the specified [code]name[/code] and [code]theme_type[/code]. Returns [code]true[/code] if there is a matching [Theme] in the tree that has a color item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="has_theme_color_override" qualifiers="const"> <method name="has_theme_color_override" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if there is a local override for a theme [Color] with the specified [code]name[/code] in this [Control] node. Returns [code]true[/code] if there is a local override for a theme [Color] with the specified [code]name[/code] in this [Control] node.
See [method add_theme_color_override]. See [method add_theme_color_override].
</description> </description>
</method> </method>
<method name="has_theme_constant" qualifiers="const"> <method name="has_theme_constant" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a constant item with the specified [code]name[/code] and [code]theme_type[/code]. Returns [code]true[/code] if there is a matching [Theme] in the tree that has a constant item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="has_theme_constant_override" qualifiers="const"> <method name="has_theme_constant_override" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if there is a local override for a theme constant with the specified [code]name[/code] in this [Control] node. Returns [code]true[/code] if there is a local override for a theme constant with the specified [code]name[/code] in this [Control] node.
See [method add_theme_constant_override]. See [method add_theme_constant_override].
</description> </description>
</method> </method>
<method name="has_theme_font" qualifiers="const"> <method name="has_theme_font" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font item with the specified [code]name[/code] and [code]theme_type[/code]. Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="has_theme_font_override" qualifiers="const"> <method name="has_theme_font_override" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if there is a local override for a theme [Font] with the specified [code]name[/code] in this [Control] node. Returns [code]true[/code] if there is a local override for a theme [Font] with the specified [code]name[/code] in this [Control] node.
See [method add_theme_font_override]. See [method add_theme_font_override].
</description> </description>
</method> </method>
<method name="has_theme_font_size" qualifiers="const"> <method name="has_theme_font_size" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font size item with the specified [code]name[/code] and [code]theme_type[/code]. Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font size item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="has_theme_font_size_override" qualifiers="const"> <method name="has_theme_font_size_override" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if there is a local override for a theme font size with the specified [code]name[/code] in this [Control] node. Returns [code]true[/code] if there is a local override for a theme font size with the specified [code]name[/code] in this [Control] node.
See [method add_theme_font_size_override]. See [method add_theme_font_size_override].
</description> </description>
</method> </method>
<method name="has_theme_icon" qualifiers="const"> <method name="has_theme_icon" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns [code]true[/code] if there is a matching [Theme] in the tree that has an icon item with the specified [code]name[/code] and [code]theme_type[/code]. Returns [code]true[/code] if there is a matching [Theme] in the tree that has an icon item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="has_theme_icon_override" qualifiers="const"> <method name="has_theme_icon_override" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if there is a local override for a theme icon with the specified [code]name[/code] in this [Control] node. Returns [code]true[/code] if there is a local override for a theme icon with the specified [code]name[/code] in this [Control] node.
See [method add_theme_icon_override]. See [method add_theme_icon_override].
</description> </description>
</method> </method>
<method name="has_theme_stylebox" qualifiers="const"> <method name="has_theme_stylebox" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="theme_type" type="StringName" default="&quot;&quot;" />
</argument>
<argument index="1" name="theme_type" type="StringName" default="&quot;&quot;">
</argument>
<description> <description>
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code]. Returns [code]true[/code] if there is a matching [Theme] in the tree that has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code].
See [method get_theme_color] for details. See [method get_theme_color] for details.
</description> </description>
</method> </method>
<method name="has_theme_stylebox_override" qualifiers="const"> <method name="has_theme_stylebox_override" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if there is a local override for a theme [StyleBox] with the specified [code]name[/code] in this [Control] node. Returns [code]true[/code] if there is a local override for a theme [StyleBox] with the specified [code]name[/code] in this [Control] node.
See [method add_theme_stylebox_override]. See [method add_theme_stylebox_override].
</description> </description>
</method> </method>
<method name="is_layout_rtl" qualifiers="const"> <method name="is_layout_rtl" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if layout is right-to-left. Returns [code]true[/code] if layout is right-to-left.
</description> </description>
</method> </method>
<method name="minimum_size_changed"> <method name="minimum_size_changed">
<return type="void"> <return type="void" />
</return>
<description> <description>
Invalidates the size cache in this node and in parent nodes up to top_level. Intended to be used with [method get_minimum_size] when the return value is changed. Setting [member rect_min_size] directly calls this method automatically. Invalidates the size cache in this node and in parent nodes up to top_level. Intended to be used with [method get_minimum_size] when the return value is changed. Setting [member rect_min_size] directly calls this method automatically.
</description> </description>
</method> </method>
<method name="release_focus"> <method name="release_focus">
<return type="void"> <return type="void" />
</return>
<description> <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> </description>
</method> </method>
<method name="remove_theme_color_override"> <method name="remove_theme_color_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Removes a local override for a theme [Color] with the specified [code]name[/code] previously added by [method add_theme_color_override] or via the Inspector dock. Removes a local override for a theme [Color] with the specified [code]name[/code] previously added by [method add_theme_color_override] or via the Inspector dock.
</description> </description>
</method> </method>
<method name="remove_theme_constant_override"> <method name="remove_theme_constant_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Removes a local override for a theme constant with the specified [code]name[/code] previously added by [method add_theme_constant_override] or via the Inspector dock. Removes a local override for a theme constant with the specified [code]name[/code] previously added by [method add_theme_constant_override] or via the Inspector dock.
</description> </description>
</method> </method>
<method name="remove_theme_font_override"> <method name="remove_theme_font_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Removes a local override for a theme [Font] with the specified [code]name[/code] previously added by [method add_theme_font_override] or via the Inspector dock. Removes a local override for a theme [Font] with the specified [code]name[/code] previously added by [method add_theme_font_override] or via the Inspector dock.
</description> </description>
</method> </method>
<method name="remove_theme_font_size_override"> <method name="remove_theme_font_size_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Removes a local override for a theme font size with the specified [code]name[/code] previously added by [method add_theme_font_size_override] or via the Inspector dock. Removes a local override for a theme font size with the specified [code]name[/code] previously added by [method add_theme_font_size_override] or via the Inspector dock.
</description> </description>
</method> </method>
<method name="remove_theme_icon_override"> <method name="remove_theme_icon_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Removes a local override for a theme icon with the specified [code]name[/code] previously added by [method add_theme_icon_override] or via the Inspector dock. Removes a local override for a theme icon with the specified [code]name[/code] previously added by [method add_theme_icon_override] or via the Inspector dock.
</description> </description>
</method> </method>
<method name="remove_theme_stylebox_override"> <method name="remove_theme_stylebox_override">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Removes a local override for a theme [StyleBox] with the specified [code]name[/code] previously added by [method add_theme_stylebox_override] or via the Inspector dock. Removes a local override for a theme [StyleBox] with the specified [code]name[/code] previously added by [method add_theme_stylebox_override] or via the Inspector dock.
</description> </description>
</method> </method>
<method name="set_anchor"> <method name="set_anchor">
<return type="void"> <return type="void" />
</return> <argument index="0" name="side" type="int" enum="Side" />
<argument index="0" name="side" type="int" enum="Side"> <argument index="1" name="anchor" type="float" />
</argument> <argument index="2" name="keep_offset" type="bool" default="false" />
<argument index="1" name="anchor" type="float"> <argument index="3" name="push_opposite_anchor" type="bool" default="true" />
</argument>
<argument index="2" name="keep_offset" type="bool" default="false">
</argument>
<argument index="3" name="push_opposite_anchor" type="bool" default="true">
</argument>
<description> <description>
Sets the anchor for the specified [enum Side] to [code]anchor[/code]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. Sets the anchor for the specified [enum Side] to [code]anchor[/code]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top].
If [code]keep_offset[/code] is [code]true[/code], offsets aren't updated after this operation. If [code]keep_offset[/code] is [code]true[/code], offsets aren't updated after this operation.
@ -825,59 +693,43 @@
</description> </description>
</method> </method>
<method name="set_anchor_and_offset"> <method name="set_anchor_and_offset">
<return type="void"> <return type="void" />
</return> <argument index="0" name="side" type="int" enum="Side" />
<argument index="0" name="side" type="int" enum="Side"> <argument index="1" name="anchor" type="float" />
</argument> <argument index="2" name="offset" type="float" />
<argument index="1" name="anchor" type="float"> <argument index="3" name="push_opposite_anchor" type="bool" default="false" />
</argument>
<argument index="2" name="offset" type="float">
</argument>
<argument index="3" name="push_opposite_anchor" type="bool" default="false">
</argument>
<description> <description>
Works the same as [method set_anchor], but instead of [code]keep_offset[/code] argument and automatic update of offset, it allows to set the offset yourself (see [method set_offset]). Works the same as [method set_anchor], but instead of [code]keep_offset[/code] argument and automatic update of offset, it allows to set the offset yourself (see [method set_offset]).
</description> </description>
</method> </method>
<method name="set_anchors_and_offsets_preset"> <method name="set_anchors_and_offsets_preset">
<return type="void"> <return type="void" />
</return> <argument index="0" name="preset" type="int" enum="Control.LayoutPreset" />
<argument index="0" name="preset" type="int" enum="Control.LayoutPreset"> <argument index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" />
</argument> <argument index="2" name="margin" type="int" default="0" />
<argument index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0">
</argument>
<argument index="2" name="margin" type="int" default="0">
</argument>
<description> <description>
Sets both anchor preset and offset preset. See [method set_anchors_preset] and [method set_offsets_preset]. Sets both anchor preset and offset preset. See [method set_anchors_preset] and [method set_offsets_preset].
</description> </description>
</method> </method>
<method name="set_anchors_preset"> <method name="set_anchors_preset">
<return type="void"> <return type="void" />
</return> <argument index="0" name="preset" type="int" enum="Control.LayoutPreset" />
<argument index="0" name="preset" type="int" enum="Control.LayoutPreset"> <argument index="1" name="keep_offsets" type="bool" default="false" />
</argument>
<argument index="1" name="keep_offsets" type="bool" default="false">
</argument>
<description> <description>
Sets the anchors to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. Sets the anchors to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor.
If [code]keep_offsets[/code] is [code]true[/code], control's position will also be updated. If [code]keep_offsets[/code] is [code]true[/code], control's position will also be updated.
</description> </description>
</method> </method>
<method name="set_begin"> <method name="set_begin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2">
</argument>
<description> <description>
Sets [member offset_left] and [member offset_top] at the same time. Equivalent of changing [member rect_position]. Sets [member offset_left] and [member offset_top] at the same time. Equivalent of changing [member rect_position].
</description> </description>
</method> </method>
<method name="set_drag_forwarding"> <method name="set_drag_forwarding">
<return type="void"> <return type="void" />
</return> <argument index="0" name="target" type="Control" />
<argument index="0" name="target" type="Control">
</argument>
<description> <description>
Forwards the handling of this control's drag and drop to [code]target[/code] control. Forwards the handling of this control's drag and drop to [code]target[/code] control.
Forwarding can be implemented in the target control similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences: Forwarding can be implemented in the target control similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences:
@ -941,10 +793,8 @@
</description> </description>
</method> </method>
<method name="set_drag_preview"> <method name="set_drag_preview">
<return type="void"> <return type="void" />
</return> <argument index="0" name="control" type="Control" />
<argument index="0" name="control" type="Control">
</argument>
<description> <description>
Shows the given control at the mouse pointer. A good time to call this method is in [method _get_drag_data]. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended. Shows the given control at the mouse pointer. A good time to call this method is in [method _get_drag_data]. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended.
[codeblocks] [codeblocks]
@ -977,57 +827,42 @@
</description> </description>
</method> </method>
<method name="set_end"> <method name="set_end">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2">
</argument>
<description> <description>
Sets [member offset_right] and [member offset_bottom] at the same time. Sets [member offset_right] and [member offset_bottom] at the same time.
</description> </description>
</method> </method>
<method name="set_focus_neighbor"> <method name="set_focus_neighbor">
<return type="void"> <return type="void" />
</return> <argument index="0" name="side" type="int" enum="Side" />
<argument index="0" name="side" type="int" enum="Side"> <argument index="1" name="neighbor" type="NodePath" />
</argument>
<argument index="1" name="neighbor" type="NodePath">
</argument>
<description> <description>
Sets the anchor for the specified [enum Side] to the [Control] at [code]neighbor[/code] node path. A setter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top]. Sets the anchor for the specified [enum Side] to the [Control] at [code]neighbor[/code] node path. A setter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top].
</description> </description>
</method> </method>
<method name="set_global_position"> <method name="set_global_position">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2"> <argument index="1" name="keep_offsets" type="bool" default="false" />
</argument>
<argument index="1" name="keep_offsets" type="bool" default="false">
</argument>
<description> <description>
Sets the [member rect_global_position] to given [code]position[/code]. Sets the [member rect_global_position] to given [code]position[/code].
If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets.
</description> </description>
</method> </method>
<method name="set_offset"> <method name="set_offset">
<return type="void"> <return type="void" />
</return> <argument index="0" name="side" type="int" enum="Side" />
<argument index="0" name="side" type="int" enum="Side"> <argument index="1" name="offset" type="float" />
</argument>
<argument index="1" name="offset" type="float">
</argument>
<description> <description>
Sets the offset for the specified [enum Side] to [code]offset[/code]. A setter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top]. Sets the offset for the specified [enum Side] to [code]offset[/code]. A setter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top].
</description> </description>
</method> </method>
<method name="set_offsets_preset"> <method name="set_offsets_preset">
<return type="void"> <return type="void" />
</return> <argument index="0" name="preset" type="int" enum="Control.LayoutPreset" />
<argument index="0" name="preset" type="int" enum="Control.LayoutPreset"> <argument index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" />
</argument> <argument index="2" name="margin" type="int" default="0" />
<argument index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0">
</argument>
<argument index="2" name="margin" type="int" default="0">
</argument>
<description> <description>
Sets the offsets to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. Sets the offsets to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor.
Use parameter [code]resize_mode[/code] with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the [Control]. Constant size will be ignored if used with presets that change size, e.g. [code]PRESET_LEFT_WIDE[/code]. Use parameter [code]resize_mode[/code] with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the [Control]. Constant size will be ignored if used with presets that change size, e.g. [code]PRESET_LEFT_WIDE[/code].
@ -1035,34 +870,26 @@
</description> </description>
</method> </method>
<method name="set_position"> <method name="set_position">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2"> <argument index="1" name="keep_offsets" type="bool" default="false" />
</argument>
<argument index="1" name="keep_offsets" type="bool" default="false">
</argument>
<description> <description>
Sets the [member rect_position] to given [code]position[/code]. Sets the [member rect_position] to given [code]position[/code].
If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets.
</description> </description>
</method> </method>
<method name="set_size"> <method name="set_size">
<return type="void"> <return type="void" />
</return> <argument index="0" name="size" type="Vector2" />
<argument index="0" name="size" type="Vector2"> <argument index="1" name="keep_offsets" type="bool" default="false" />
</argument>
<argument index="1" name="keep_offsets" type="bool" default="false">
</argument>
<description> <description>
Sets the size (see [member rect_size]). Sets the size (see [member rect_size]).
If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets. If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets.
</description> </description>
</method> </method>
<method name="warp_mouse"> <method name="warp_mouse">
<return type="void"> <return type="void" />
</return> <argument index="0" name="to_position" type="Vector2" />
<argument index="0" name="to_position" type="Vector2">
</argument>
<description> <description>
Moves the mouse cursor to [code]to_position[/code], relative to [member rect_position] of this [Control]. Moves the mouse cursor to [code]to_position[/code], relative to [member rect_position] of this [Control].
</description> </description>
@ -1218,8 +1045,7 @@
</description> </description>
</signal> </signal>
<signal name="gui_input"> <signal name="gui_input">
<argument index="0" name="event" type="InputEvent"> <argument index="0" name="event" type="InputEvent" />
</argument>
<description> <description>
Emitted when the node receives an [InputEvent]. Emitted when the node receives an [InputEvent].
</description> </description>

6
doc/classes/ConvexPolygonShape2D.xml
View File

@ -11,10 +11,8 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="set_point_cloud"> <method name="set_point_cloud">
<return type="void"> <return type="void" />
</return> <argument index="0" name="point_cloud" type="PackedVector2Array" />
<argument index="0" name="point_cloud" type="PackedVector2Array">
</argument>
<description> <description>
Based on the set of points provided, this creates and assigns the [member points] property using the convex hull algorithm. Removing all unneeded points. See [method Geometry2D.convex_hull] for details. Based on the set of points provided, this creates and assigns the [member points] property using the convex hull algorithm. Removing all unneeded points. See [method Geometry2D.convex_hull] for details.
</description> </description>

93
doc/classes/Crypto.xml
View File

@ -74,70 +74,52 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="constant_time_compare"> <method name="constant_time_compare">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="trusted" type="PackedByteArray" />
<argument index="0" name="trusted" type="PackedByteArray"> <argument index="1" name="received" type="PackedByteArray" />
</argument>
<argument index="1" name="received" type="PackedByteArray">
</argument>
<description> <description>
Compares two [PackedByteArray]s for equality without leaking timing information in order to prevent timing attacks. Compares two [PackedByteArray]s for equality without leaking timing information in order to prevent timing attacks.
See [url=https://paragonie.com/blog/2015/11/preventing-timing-attacks-on-string-comparison-with-double-hmac-strategy]this blog post[/url] for more information. See [url=https://paragonie.com/blog/2015/11/preventing-timing-attacks-on-string-comparison-with-double-hmac-strategy]this blog post[/url] for more information.
</description> </description>
</method> </method>
<method name="decrypt"> <method name="decrypt">
<return type="PackedByteArray"> <return type="PackedByteArray" />
</return> <argument index="0" name="key" type="CryptoKey" />
<argument index="0" name="key" type="CryptoKey"> <argument index="1" name="ciphertext" type="PackedByteArray" />
</argument>
<argument index="1" name="ciphertext" type="PackedByteArray">
</argument>
<description> <description>
Decrypt the given [code]ciphertext[/code] with the provided private [code]key[/code]. Decrypt the given [code]ciphertext[/code] with the provided private [code]key[/code].
[b]Note[/b]: The maximum size of accepted ciphertext is limited by the key size. [b]Note[/b]: The maximum size of accepted ciphertext is limited by the key size.
</description> </description>
</method> </method>
<method name="encrypt"> <method name="encrypt">
<return type="PackedByteArray"> <return type="PackedByteArray" />
</return> <argument index="0" name="key" type="CryptoKey" />
<argument index="0" name="key" type="CryptoKey"> <argument index="1" name="plaintext" type="PackedByteArray" />
</argument>
<argument index="1" name="plaintext" type="PackedByteArray">
</argument>
<description> <description>
Encrypt the given [code]plaintext[/code] with the provided public [code]key[/code]. Encrypt the given [code]plaintext[/code] with the provided public [code]key[/code].
[b]Note[/b]: The maximum size of accepted plaintext is limited by the key size. [b]Note[/b]: The maximum size of accepted plaintext is limited by the key size.
</description> </description>
</method> </method>
<method name="generate_random_bytes"> <method name="generate_random_bytes">
<return type="PackedByteArray"> <return type="PackedByteArray" />
</return> <argument index="0" name="size" type="int" />
<argument index="0" name="size" type="int">
</argument>
<description> <description>
Generates a [PackedByteArray] of cryptographically secure random bytes with given [code]size[/code]. Generates a [PackedByteArray] of cryptographically secure random bytes with given [code]size[/code].
</description> </description>
</method> </method>
<method name="generate_rsa"> <method name="generate_rsa">
<return type="CryptoKey"> <return type="CryptoKey" />
</return> <argument index="0" name="size" type="int" />
<argument index="0" name="size" type="int">
</argument>
<description> <description>
Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.accept_stream]. Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.accept_stream].
</description> </description>
</method> </method>
<method name="generate_self_signed_certificate"> <method name="generate_self_signed_certificate">
<return type="X509Certificate"> <return type="X509Certificate" />
</return> <argument index="0" name="key" type="CryptoKey" />
<argument index="0" name="key" type="CryptoKey"> <argument index="1" name="issuer_name" type="String" default="&quot;CN=myserver,O=myorganisation,C=IT&quot;" />
</argument> <argument index="2" name="not_before" type="String" default="&quot;20140101000000&quot;" />
<argument index="1" name="issuer_name" type="String" default="&quot;CN=myserver,O=myorganisation,C=IT&quot;"> <argument index="3" name="not_after" type="String" default="&quot;20340101000000&quot;" />
</argument>
<argument index="2" name="not_before" type="String" default="&quot;20140101000000&quot;">
</argument>
<argument index="3" name="not_after" type="String" default="&quot;20340101000000&quot;">
</argument>
<description> <description>
Generates a self-signed [X509Certificate] from the given [CryptoKey] and [code]issuer_name[/code]. The certificate validity will be defined by [code]not_before[/code] and [code]not_after[/code] (first valid date and last valid date). The [code]issuer_name[/code] must contain at least "CN=" (common name, i.e. the domain name), "O=" (organization, i.e. your company name), "C=" (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in). Generates a self-signed [X509Certificate] from the given [CryptoKey] and [code]issuer_name[/code]. The certificate validity will be defined by [code]not_before[/code] and [code]not_after[/code] (first valid date and last valid date). The [code]issuer_name[/code] must contain at least "CN=" (common name, i.e. the domain name), "O=" (organization, i.e. your company name), "C=" (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in).
A small example to generate an RSA key and a X509 self-signed certificate. A small example to generate an RSA key and a X509 self-signed certificate.
@ -160,43 +142,30 @@
</description> </description>
</method> </method>
<method name="hmac_digest"> <method name="hmac_digest">
<return type="PackedByteArray"> <return type="PackedByteArray" />
</return> <argument index="0" name="hash_type" type="int" enum="HashingContext.HashType" />
<argument index="0" name="hash_type" type="int" enum="HashingContext.HashType"> <argument index="1" name="key" type="PackedByteArray" />
</argument> <argument index="2" name="msg" type="PackedByteArray" />
<argument index="1" name="key" type="PackedByteArray">
</argument>
<argument index="2" name="msg" type="PackedByteArray">
</argument>
<description> <description>
Generates an [url=https://en.wikipedia.org/wiki/HMAC]HMAC[/url] digest of [code]msg[/code] using [code]key[/code]. The [code]hash_type[/code] parameter is the hashing algorithm that is used for the inner and outer hashes. Generates an [url=https://en.wikipedia.org/wiki/HMAC]HMAC[/url] digest of [code]msg[/code] using [code]key[/code]. The [code]hash_type[/code] parameter is the hashing algorithm that is used for the inner and outer hashes.
Currently, only [constant HashingContext.HASH_SHA256] and [constant HashingContext.HASH_SHA1] are supported. Currently, only [constant HashingContext.HASH_SHA256] and [constant HashingContext.HASH_SHA1] are supported.
</description> </description>
</method> </method>
<method name="sign"> <method name="sign">
<return type="PackedByteArray"> <return type="PackedByteArray" />
</return> <argument index="0" name="hash_type" type="int" enum="HashingContext.HashType" />
<argument index="0" name="hash_type" type="int" enum="HashingContext.HashType"> <argument index="1" name="hash" type="PackedByteArray" />
</argument> <argument index="2" name="key" type="CryptoKey" />
<argument index="1" name="hash" type="PackedByteArray">
</argument>
<argument index="2" name="key" type="CryptoKey">
</argument>
<description> <description>
Sign a given [code]hash[/code] of type [code]hash_type[/code] with the provided private [code]key[/code]. Sign a given [code]hash[/code] of type [code]hash_type[/code] with the provided private [code]key[/code].
</description> </description>
</method> </method>
<method name="verify"> <method name="verify">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="hash_type" type="int" enum="HashingContext.HashType" />
<argument index="0" name="hash_type" type="int" enum="HashingContext.HashType"> <argument index="1" name="hash" type="PackedByteArray" />
</argument> <argument index="2" name="signature" type="PackedByteArray" />
<argument index="1" name="hash" type="PackedByteArray"> <argument index="3" name="key" type="CryptoKey" />
</argument>
<argument index="2" name="signature" type="PackedByteArray">
</argument>
<argument index="3" name="key" type="CryptoKey">
</argument>
<description> <description>
Verify that a given [code]signature[/code] for [code]hash[/code] of type [code]hash_type[/code] against the provided public [code]key[/code]. Verify that a given [code]signature[/code] for [code]hash[/code] of type [code]hash_type[/code] against the provided public [code]key[/code].
</description> </description>

36
doc/classes/CryptoKey.xml
View File

@ -12,52 +12,40 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="is_public_only" qualifiers="const"> <method name="is_public_only" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Return [code]true[/code] if this CryptoKey only has the public part, and not the private one. Return [code]true[/code] if this CryptoKey only has the public part, and not the private one.
</description> </description>
</method> </method>
<method name="load"> <method name="load">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="public_only" type="bool" default="false" />
</argument>
<argument index="1" name="public_only" type="bool" default="false">
</argument>
<description> <description>
Loads a key from [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded. Loads a key from [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded.
[b]Note[/b]: [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. [b]Note[/b]: [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise.
</description> </description>
</method> </method>
<method name="load_from_string"> <method name="load_from_string">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="string_key" type="String" />
<argument index="0" name="string_key" type="String"> <argument index="1" name="public_only" type="bool" default="false" />
</argument>
<argument index="1" name="public_only" type="bool" default="false">
</argument>
<description> <description>
Loads a key from the given [code]string[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded. Loads a key from the given [code]string[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be loaded.
</description> </description>
</method> </method>
<method name="save"> <method name="save">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="public_only" type="bool" default="false" />
</argument>
<argument index="1" name="public_only" type="bool" default="false">
</argument>
<description> <description>
Saves a key to the given [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be saved. Saves a key to the given [code]path[/code]. If [code]public_only[/code] is [code]true[/code], only the public key will be saved.
[b]Note[/b]: [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise. [b]Note[/b]: [code]path[/code] should be a "*.pub" file if [code]public_only[/code] is [code]true[/code], a "*.key" file otherwise.
</description> </description>
</method> </method>
<method name="save_to_string"> <method name="save_to_string">
<return type="String"> <return type="String" />
</return> <argument index="0" name="public_only" type="bool" default="false" />
<argument index="0" name="public_only" type="bool" default="false">
</argument>
<description> <description>
Returns a string containing the key in PEM format. If [code]public_only[/code] is [code]true[/code], only the public key will be included. Returns a string containing the key in PEM format. If [code]public_only[/code] is [code]true[/code], only the public key will be included.
</description> </description>

132
doc/classes/Curve.xml
View File

@ -10,184 +10,140 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_point"> <method name="add_point">
<return type="int"> <return type="int" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2"> <argument index="1" name="left_tangent" type="float" default="0" />
</argument> <argument index="2" name="right_tangent" type="float" default="0" />
<argument index="1" name="left_tangent" type="float" default="0"> <argument index="3" name="left_mode" type="int" enum="Curve.TangentMode" default="0" />
</argument> <argument index="4" name="right_mode" type="int" enum="Curve.TangentMode" default="0" />
<argument index="2" name="right_tangent" type="float" default="0">
</argument>
<argument index="3" name="left_mode" type="int" enum="Curve.TangentMode" default="0">
</argument>
<argument index="4" name="right_mode" type="int" enum="Curve.TangentMode" default="0">
</argument>
<description> <description>
Adds a point to the curve. For each side, if the [code]*_mode[/code] is [constant TANGENT_LINEAR], the [code]*_tangent[/code] angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the [code]*_tangent[/code] angle if [code]*_mode[/code] is set to [constant TANGENT_FREE]. Adds a point to the curve. For each side, if the [code]*_mode[/code] is [constant TANGENT_LINEAR], the [code]*_tangent[/code] angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the [code]*_tangent[/code] angle if [code]*_mode[/code] is set to [constant TANGENT_FREE].
</description> </description>
</method> </method>
<method name="bake"> <method name="bake">
<return type="void"> <return type="void" />
</return>
<description> <description>
Recomputes the baked cache of points for the curve. Recomputes the baked cache of points for the curve.
</description> </description>
</method> </method>
<method name="clean_dupes"> <method name="clean_dupes">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes points that are closer than [code]CMP_EPSILON[/code] (0.00001) units to their neighbor on the curve. Removes points that are closer than [code]CMP_EPSILON[/code] (0.00001) units to their neighbor on the curve.
</description> </description>
</method> </method>
<method name="clear_points"> <method name="clear_points">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all points from the curve. Removes all points from the curve.
</description> </description>
</method> </method>
<method name="get_point_count" qualifiers="const"> <method name="get_point_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of points describing the curve. Returns the number of points describing the curve.
</description> </description>
</method> </method>
<method name="get_point_left_mode" qualifiers="const"> <method name="get_point_left_mode" qualifiers="const">
<return type="int" enum="Curve.TangentMode"> <return type="int" enum="Curve.TangentMode" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Returns the left [enum TangentMode] for the point at [code]index[/code]. Returns the left [enum TangentMode] for the point at [code]index[/code].
</description> </description>
</method> </method>
<method name="get_point_left_tangent" qualifiers="const"> <method name="get_point_left_tangent" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Returns the left tangent angle (in degrees) for the point at [code]index[/code]. Returns the left tangent angle (in degrees) for the point at [code]index[/code].
</description> </description>
</method> </method>
<method name="get_point_position" qualifiers="const"> <method name="get_point_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Returns the curve coordinates for the point at [code]index[/code]. Returns the curve coordinates for the point at [code]index[/code].
</description> </description>
</method> </method>
<method name="get_point_right_mode" qualifiers="const"> <method name="get_point_right_mode" qualifiers="const">
<return type="int" enum="Curve.TangentMode"> <return type="int" enum="Curve.TangentMode" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Returns the right [enum TangentMode] for the point at [code]index[/code]. Returns the right [enum TangentMode] for the point at [code]index[/code].
</description> </description>
</method> </method>
<method name="get_point_right_tangent" qualifiers="const"> <method name="get_point_right_tangent" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Returns the right tangent angle (in degrees) for the point at [code]index[/code]. Returns the right tangent angle (in degrees) for the point at [code]index[/code].
</description> </description>
</method> </method>
<method name="interpolate" qualifiers="const"> <method name="interpolate" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="offset" type="float" />
<argument index="0" name="offset" type="float">
</argument>
<description> <description>
Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve. Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve.
</description> </description>
</method> </method>
<method name="interpolate_baked" qualifiers="const"> <method name="interpolate_baked" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="offset" type="float" />
<argument index="0" name="offset" type="float">
</argument>
<description> <description>
Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked. Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked.
</description> </description>
</method> </method>
<method name="remove_point"> <method name="remove_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int">
</argument>
<description> <description>
Removes the point at [code]index[/code] from the curve. Removes the point at [code]index[/code] from the curve.
</description> </description>
</method> </method>
<method name="set_point_left_mode"> <method name="set_point_left_mode">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int"> <argument index="1" name="mode" type="int" enum="Curve.TangentMode" />
</argument>
<argument index="1" name="mode" type="int" enum="Curve.TangentMode">
</argument>
<description> <description>
Sets the left [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code]. Sets the left [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code].
</description> </description>
</method> </method>
<method name="set_point_left_tangent"> <method name="set_point_left_tangent">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int"> <argument index="1" name="tangent" type="float" />
</argument>
<argument index="1" name="tangent" type="float">
</argument>
<description> <description>
Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code]. Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code].
</description> </description>
</method> </method>
<method name="set_point_offset"> <method name="set_point_offset">
<return type="int"> <return type="int" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int"> <argument index="1" name="offset" type="float" />
</argument>
<argument index="1" name="offset" type="float">
</argument>
<description> <description>
Sets the offset from [code]0.5[/code]. Sets the offset from [code]0.5[/code].
</description> </description>
</method> </method>
<method name="set_point_right_mode"> <method name="set_point_right_mode">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int"> <argument index="1" name="mode" type="int" enum="Curve.TangentMode" />
</argument>
<argument index="1" name="mode" type="int" enum="Curve.TangentMode">
</argument>
<description> <description>
Sets the right [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code]. Sets the right [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code].
</description> </description>
</method> </method>
<method name="set_point_right_tangent"> <method name="set_point_right_tangent">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int"> <argument index="1" name="tangent" type="float" />
</argument>
<argument index="1" name="tangent" type="float">
</argument>
<description> <description>
Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code]. Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code].
</description> </description>
</method> </method>
<method name="set_point_value"> <method name="set_point_value">
<return type="void"> <return type="void" />
</return> <argument index="0" name="index" type="int" />
<argument index="0" name="index" type="int"> <argument index="1" name="y" type="float" />
</argument>
<argument index="1" name="y" type="float">
</argument>
<description> <description>
Assigns the vertical position [code]y[/code] to the point at [code]index[/code]. Assigns the vertical position [code]y[/code] to the point at [code]index[/code].
</description> </description>

123
doc/classes/Curve2D.xml
View File

@ -11,115 +11,90 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_point"> <method name="add_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="Vector2" />
<argument index="0" name="position" type="Vector2"> <argument index="1" name="in" type="Vector2" default="Vector2(0, 0)" />
</argument> <argument index="2" name="out" type="Vector2" default="Vector2(0, 0)" />
<argument index="1" name="in" type="Vector2" default="Vector2(0, 0)"> <argument index="3" name="at_position" type="int" default="-1" />
</argument>
<argument index="2" name="out" type="Vector2" default="Vector2(0, 0)">
</argument>
<argument index="3" name="at_position" type="int" default="-1">
</argument>
<description> <description>
Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code]. Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code].
If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position &lt;0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position &lt;0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list.
</description> </description>
</method> </method>
<method name="clear_points"> <method name="clear_points">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all points from the curve. Removes all points from the curve.
</description> </description>
</method> </method>
<method name="get_baked_length" qualifiers="const"> <method name="get_baked_length" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the total length of the curve, based on the cached points. Given enough density (see [member bake_interval]), it should be approximate enough. Returns the total length of the curve, based on the cached points. Given enough density (see [member bake_interval]), it should be approximate enough.
</description> </description>
</method> </method>
<method name="get_baked_points" qualifiers="const"> <method name="get_baked_points" qualifiers="const">
<return type="PackedVector2Array"> <return type="PackedVector2Array" />
</return>
<description> <description>
Returns the cache of points as a [PackedVector2Array]. Returns the cache of points as a [PackedVector2Array].
</description> </description>
</method> </method>
<method name="get_closest_offset" qualifiers="const"> <method name="get_closest_offset" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="to_point" type="Vector2" />
<argument index="0" name="to_point" type="Vector2">
</argument>
<description> <description>
Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked]. Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked].
[code]to_point[/code] must be in this curve's local space. [code]to_point[/code] must be in this curve's local space.
</description> </description>
</method> </method>
<method name="get_closest_point" qualifiers="const"> <method name="get_closest_point" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="to_point" type="Vector2" />
<argument index="0" name="to_point" type="Vector2">
</argument>
<description> <description>
Returns the closest baked point (in curve's local space) to [code]to_point[/code]. Returns the closest baked point (in curve's local space) to [code]to_point[/code].
[code]to_point[/code] must be in this curve's local space. [code]to_point[/code] must be in this curve's local space.
</description> </description>
</method> </method>
<method name="get_point_count" qualifiers="const"> <method name="get_point_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of points describing the curve. Returns the number of points describing the curve.
</description> </description>
</method> </method>
<method name="get_point_in" qualifiers="const"> <method name="get_point_in" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code].
</description> </description>
</method> </method>
<method name="get_point_out" qualifiers="const"> <method name="get_point_out" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code].
</description> </description>
</method> </method>
<method name="get_point_position" qualifiers="const"> <method name="get_point_position" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code].
</description> </description>
</method> </method>
<method name="interpolate" qualifiers="const"> <method name="interpolate" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int"> <argument index="1" name="t" type="float" />
</argument>
<argument index="1" name="t" type="float">
</argument>
<description> <description>
Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] 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 [code]t[/code] outside the range ([code]0.0 &gt;= t &lt;=1[/code]) give strange, but predictable results. Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] 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 [code]t[/code] outside the range ([code]0.0 &gt;= t &lt;=1[/code]) give strange, but predictable results.
If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0)[/code]. If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0)[/code].
</description> </description>
</method> </method>
<method name="interpolate_baked" qualifiers="const"> <method name="interpolate_baked" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="offset" type="float" />
<argument index="0" name="offset" type="float"> <argument index="1" name="cubic" type="bool" default="false" />
</argument>
<argument index="1" name="cubic" type="bool" default="false">
</argument>
<description> <description>
Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a pixel distance along the curve. Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a pixel distance along the curve.
To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code]. To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code].
@ -127,63 +102,47 @@
</description> </description>
</method> </method>
<method name="interpolatef" qualifiers="const"> <method name="interpolatef" qualifiers="const">
<return type="Vector2"> <return type="Vector2" />
</return> <argument index="0" name="fofs" type="float" />
<argument index="0" name="fofs" type="float">
</argument>
<description> <description>
Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code]. Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code].
</description> </description>
</method> </method>
<method name="remove_point"> <method name="remove_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds. Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds.
</description> </description>
</method> </method>
<method name="set_point_in"> <method name="set_point_in">
<return type="void"> <return type="void" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int"> <argument index="1" name="position" type="Vector2" />
</argument>
<argument index="1" name="position" type="Vector2">
</argument>
<description> <description>
Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex.
</description> </description>
</method> </method>
<method name="set_point_out"> <method name="set_point_out">
<return type="void"> <return type="void" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int"> <argument index="1" name="position" type="Vector2" />
</argument>
<argument index="1" name="position" type="Vector2">
</argument>
<description> <description>
Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex.
</description> </description>
</method> </method>
<method name="set_point_position"> <method name="set_point_position">
<return type="void"> <return type="void" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int"> <argument index="1" name="position" type="Vector2" />
</argument>
<argument index="1" name="position" type="Vector2">
</argument>
<description> <description>
Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
</description> </description>
</method> </method>
<method name="tessellate" qualifiers="const"> <method name="tessellate" qualifiers="const">
<return type="PackedVector2Array"> <return type="PackedVector2Array" />
</return> <argument index="0" name="max_stages" type="int" default="5" />
<argument index="0" name="max_stages" type="int" default="5"> <argument index="1" name="tolerance_degrees" type="float" default="4" />
</argument>
<argument index="1" name="tolerance_degrees" type="float" default="4">
</argument>
<description> <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. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.

153
doc/classes/Curve3D.xml
View File

@ -11,139 +11,110 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_point"> <method name="add_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="position" type="Vector3" />
<argument index="0" name="position" type="Vector3"> <argument index="1" name="in" type="Vector3" default="Vector3(0, 0, 0)" />
</argument> <argument index="2" name="out" type="Vector3" default="Vector3(0, 0, 0)" />
<argument index="1" name="in" type="Vector3" default="Vector3(0, 0, 0)"> <argument index="3" name="at_position" type="int" default="-1" />
</argument>
<argument index="2" name="out" type="Vector3" default="Vector3(0, 0, 0)">
</argument>
<argument index="3" name="at_position" type="int" default="-1">
</argument>
<description> <description>
Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code]. Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code].
If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position &lt;0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position &lt;0[/code] or [code]at_position &gt;= [method get_point_count][/code]), the point will be appended at the end of the point list.
</description> </description>
</method> </method>
<method name="clear_points"> <method name="clear_points">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all points from the curve. Removes all points from the curve.
</description> </description>
</method> </method>
<method name="get_baked_length" qualifiers="const"> <method name="get_baked_length" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the total length of the curve, based on the cached points. Given enough density (see [member bake_interval]), it should be approximate enough. Returns the total length of the curve, based on the cached points. Given enough density (see [member bake_interval]), it should be approximate enough.
</description> </description>
</method> </method>
<method name="get_baked_points" qualifiers="const"> <method name="get_baked_points" qualifiers="const">
<return type="PackedVector3Array"> <return type="PackedVector3Array" />
</return>
<description> <description>
Returns the cache of points as a [PackedVector3Array]. Returns the cache of points as a [PackedVector3Array].
</description> </description>
</method> </method>
<method name="get_baked_tilts" qualifiers="const"> <method name="get_baked_tilts" qualifiers="const">
<return type="PackedFloat32Array"> <return type="PackedFloat32Array" />
</return>
<description> <description>
Returns the cache of tilts as a [PackedFloat32Array]. Returns the cache of tilts as a [PackedFloat32Array].
</description> </description>
</method> </method>
<method name="get_baked_up_vectors" qualifiers="const"> <method name="get_baked_up_vectors" qualifiers="const">
<return type="PackedVector3Array"> <return type="PackedVector3Array" />
</return>
<description> <description>
Returns the cache of up vectors as a [PackedVector3Array]. Returns the cache of up vectors as a [PackedVector3Array].
If [member up_vector_enabled] is [code]false[/code], the cache will be empty. If [member up_vector_enabled] is [code]false[/code], the cache will be empty.
</description> </description>
</method> </method>
<method name="get_closest_offset" qualifiers="const"> <method name="get_closest_offset" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="to_point" type="Vector3" />
<argument index="0" name="to_point" type="Vector3">
</argument>
<description> <description>
Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked] or [method interpolate_baked_up_vector]. Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked] or [method interpolate_baked_up_vector].
[code]to_point[/code] must be in this curve's local space. [code]to_point[/code] must be in this curve's local space.
</description> </description>
</method> </method>
<method name="get_closest_point" qualifiers="const"> <method name="get_closest_point" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="to_point" type="Vector3" />
<argument index="0" name="to_point" type="Vector3">
</argument>
<description> <description>
Returns the closest baked point (in curve's local space) to [code]to_point[/code]. Returns the closest baked point (in curve's local space) to [code]to_point[/code].
[code]to_point[/code] must be in this curve's local space. [code]to_point[/code] must be in this curve's local space.
</description> </description>
</method> </method>
<method name="get_point_count" qualifiers="const"> <method name="get_point_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of points describing the curve. Returns the number of points describing the curve.
</description> </description>
</method> </method>
<method name="get_point_in" qualifiers="const"> <method name="get_point_in" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
</description> </description>
</method> </method>
<method name="get_point_out" qualifiers="const"> <method name="get_point_out" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
</description> </description>
</method> </method>
<method name="get_point_position" qualifiers="const"> <method name="get_point_position" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
</description> </description>
</method> </method>
<method name="get_point_tilt" qualifiers="const"> <method name="get_point_tilt" qualifiers="const">
<return type="float"> <return type="float" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code]0[/code]. Returns the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code]0[/code].
</description> </description>
</method> </method>
<method name="interpolate" qualifiers="const"> <method name="interpolate" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int"> <argument index="1" name="t" type="float" />
</argument>
<argument index="1" name="t" type="float">
</argument>
<description> <description>
Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] 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 [code]t[/code] outside the range ([code]0.0 &gt;= t &lt;=1[/code]) give strange, but predictable results. Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] 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 [code]t[/code] outside the range ([code]0.0 &gt;= t &lt;=1[/code]) give strange, but predictable results.
If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0, 0)[/code].
</description> </description>
</method> </method>
<method name="interpolate_baked" qualifiers="const"> <method name="interpolate_baked" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="offset" type="float" />
<argument index="0" name="offset" type="float"> <argument index="1" name="cubic" type="bool" default="false" />
</argument>
<argument index="1" name="cubic" type="bool" default="false">
</argument>
<description> <description>
Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve. Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve.
To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code]. To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code].
@ -151,12 +122,9 @@
</description> </description>
</method> </method>
<method name="interpolate_baked_up_vector" qualifiers="const"> <method name="interpolate_baked_up_vector" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="offset" type="float" />
<argument index="0" name="offset" type="float"> <argument index="1" name="apply_tilt" type="bool" default="false" />
</argument>
<argument index="1" name="apply_tilt" type="bool" default="false">
</argument>
<description> <description>
Returns an up vector within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve. Returns an up vector within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve.
To do that, it finds the two cached up vectors where the [code]offset[/code] lies between, then interpolates the values. If [code]apply_tilt[/code] is [code]true[/code], an interpolated tilt is applied to the interpolated up vector. To do that, it finds the two cached up vectors where the [code]offset[/code] lies between, then interpolates the values. If [code]apply_tilt[/code] is [code]true[/code], an interpolated tilt is applied to the interpolated up vector.
@ -164,75 +132,56 @@
</description> </description>
</method> </method>
<method name="interpolatef" qualifiers="const"> <method name="interpolatef" qualifiers="const">
<return type="Vector3"> <return type="Vector3" />
</return> <argument index="0" name="fofs" type="float" />
<argument index="0" name="fofs" type="float">
</argument>
<description> <description>
Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code]. Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code].
</description> </description>
</method> </method>
<method name="remove_point"> <method name="remove_point">
<return type="void"> <return type="void" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds. Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds.
</description> </description>
</method> </method>
<method name="set_point_in"> <method name="set_point_in">
<return type="void"> <return type="void" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int"> <argument index="1" name="position" type="Vector3" />
</argument>
<argument index="1" name="position" type="Vector3">
</argument>
<description> <description>
Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex.
</description> </description>
</method> </method>
<method name="set_point_out"> <method name="set_point_out">
<return type="void"> <return type="void" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int"> <argument index="1" name="position" type="Vector3" />
</argument>
<argument index="1" name="position" type="Vector3">
</argument>
<description> <description>
Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex.
</description> </description>
</method> </method>
<method name="set_point_position"> <method name="set_point_position">
<return type="void"> <return type="void" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int"> <argument index="1" name="position" type="Vector3" />
</argument>
<argument index="1" name="position" type="Vector3">
</argument>
<description> <description>
Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console.
</description> </description>
</method> </method>
<method name="set_point_tilt"> <method name="set_point_tilt">
<return type="void"> <return type="void" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int"> <argument index="1" name="tilt" type="float" />
</argument>
<argument index="1" name="tilt" type="float">
</argument>
<description> <description>
Sets the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. Sets the tilt angle in radians for the point [code]idx[/code]. 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 [PathFollow3D], this tilt is an offset over the natural tilt the [PathFollow3D] calculates. 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 [PathFollow3D], this tilt is an offset over the natural tilt the [PathFollow3D] calculates.
</description> </description>
</method> </method>
<method name="tessellate" qualifiers="const"> <method name="tessellate" qualifiers="const">
<return type="PackedVector3Array"> <return type="PackedVector3Array" />
</return> <argument index="0" name="max_stages" type="int" default="5" />
<argument index="0" name="max_stages" type="int" default="5"> <argument index="1" name="tolerance_degrees" type="float" default="4" />
</argument>
<argument index="1" name="tolerance_degrees" type="float" default="4">
</argument>
<description> <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. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.

18
doc/classes/DTLSServer.xml
View File

@ -147,23 +147,17 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="setup"> <method name="setup">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="key" type="CryptoKey" />
<argument index="0" name="key" type="CryptoKey"> <argument index="1" name="certificate" type="X509Certificate" />
</argument> <argument index="2" name="chain" type="X509Certificate" default="null" />
<argument index="1" name="certificate" type="X509Certificate">
</argument>
<argument index="2" name="chain" type="X509Certificate" default="null">
</argument>
<description> <description>
Setup the DTLS server to use the given [code]private_key[/code] and provide the given [code]certificate[/code] to clients. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate. Setup the DTLS server to use the given [code]private_key[/code] and provide the given [code]certificate[/code] to clients. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate.
</description> </description>
</method> </method>
<method name="take_connection"> <method name="take_connection">
<return type="PacketPeerDTLS"> <return type="PacketPeerDTLS" />
</return> <argument index="0" name="udp_peer" type="PacketPeerUDP" />
<argument index="0" name="udp_peer" type="PacketPeerUDP">
</argument>
<description> <description>
Try to initiate the DTLS handshake with the given [code]udp_peer[/code] which must be already connected (see [method PacketPeerUDP.connect_to_host]). Try to initiate the DTLS handshake with the given [code]udp_peer[/code] which must be already connected (see [method PacketPeerUDP.connect_to_host]).
[b]Note[/b]: You must check that the state of the return PacketPeerUDP is [constant PacketPeerDTLS.STATUS_HANDSHAKING], as it is normal that 50% of the new connections will be invalid due to cookie exchange. [b]Note[/b]: You must check that the state of the return PacketPeerUDP is [constant PacketPeerDTLS.STATUS_HANDSHAKING], as it is normal that 50% of the new connections will be invalid due to cookie exchange.

15
doc/classes/Decal.xml
View File

@ -12,10 +12,8 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_texture" qualifiers="const"> <method name="get_texture" qualifiers="const">
<return type="Texture2D"> <return type="Texture2D" />
</return> <argument index="0" name="type" type="int" enum="Decal.DecalTexture" />
<argument index="0" name="type" type="int" enum="Decal.DecalTexture">
</argument>
<description> <description>
Returns the [Texture2D] associated with the specified [enum DecalTexture]. This is a convenience method, in most cases you should access the texture directly. Returns the [Texture2D] associated with the specified [enum DecalTexture]. This is a convenience method, in most cases you should access the texture directly.
For example, instead of [code]albedo_tex = $Decal.get_texture(Decal.TEXTURE_ALBEDO)[/code], use [code]albedo_tex = $Decal.texture_albedo[/code]. For example, instead of [code]albedo_tex = $Decal.get_texture(Decal.TEXTURE_ALBEDO)[/code], use [code]albedo_tex = $Decal.texture_albedo[/code].
@ -35,12 +33,9 @@
</description> </description>
</method> </method>
<method name="set_texture"> <method name="set_texture">
<return type="void"> <return type="void" />
</return> <argument index="0" name="type" type="int" enum="Decal.DecalTexture" />
<argument index="0" name="type" type="int" enum="Decal.DecalTexture"> <argument index="1" name="texture" type="Texture2D" />
</argument>
<argument index="1" name="texture" type="Texture2D">
</argument>
<description> <description>
Sets the [Texture2D] associated with the specified [enum DecalTexture]. This is a convenience method, in most cases you should access the texture directly. Sets the [Texture2D] associated with the specified [enum DecalTexture]. This is a convenience method, in most cases you should access the texture directly.
For example, instead of [code]$Decal.set_texture(Decal.TEXTURE_ALBEDO, albedo_tex)[/code], use [code]$Decal.texture_albedo = albedo_tex[/code]. For example, instead of [code]$Decal.set_texture(Decal.TEXTURE_ALBEDO, albedo_tex)[/code], use [code]$Decal.texture_albedo = albedo_tex[/code].

78
doc/classes/Dictionary.xml
View File

@ -184,62 +184,49 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="Dictionary" qualifiers="constructor"> <method name="Dictionary" qualifiers="constructor">
<return type="Dictionary"> <return type="Dictionary" />
</return>
<description> <description>
Constructs an empty [Dictionary]. Constructs an empty [Dictionary].
</description> </description>
</method> </method>
<method name="Dictionary" qualifiers="constructor"> <method name="Dictionary" qualifiers="constructor">
<return type="Dictionary"> <return type="Dictionary" />
</return> <argument index="0" name="from" type="Dictionary" />
<argument index="0" name="from" type="Dictionary">
</argument>
<description> <description>
Constructs a [Dictionary] as a copy of the given [Dictionary]. Constructs a [Dictionary] as a copy of the given [Dictionary].
</description> </description>
</method> </method>
<method name="clear"> <method name="clear">
<return type="void"> <return type="void" />
</return>
<description> <description>
Clear the dictionary, removing all key/value pairs. Clear the dictionary, removing all key/value pairs.
</description> </description>
</method> </method>
<method name="duplicate" qualifiers="const"> <method name="duplicate" qualifiers="const">
<return type="Dictionary"> <return type="Dictionary" />
</return> <argument index="0" name="deep" type="bool" default="false" />
<argument index="0" name="deep" type="bool" default="false">
</argument>
<description> <description>
Creates a copy of the dictionary, and returns it. The [code]deep[/code] parameter causes inner dictionaries and arrays to be copied recursively, but does not apply to objects. Creates a copy of the dictionary, and returns it. The [code]deep[/code] parameter causes inner dictionaries and arrays to be copied recursively, but does not apply to objects.
</description> </description>
</method> </method>
<method name="erase"> <method name="erase">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="key" type="Variant" />
<argument index="0" name="key" type="Variant">
</argument>
<description> <description>
Erase a dictionary key/value pair by key. Returns [code]true[/code] if the given key was present in the dictionary, [code]false[/code] otherwise. Does not erase elements while iterating over the dictionary. Erase a dictionary key/value pair by key. Returns [code]true[/code] if the given key was present in the dictionary, [code]false[/code] otherwise. Does not erase elements while iterating over the dictionary.
</description> </description>
</method> </method>
<method name="get" qualifiers="const"> <method name="get" qualifiers="const">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="key" type="Variant" />
<argument index="0" name="key" type="Variant"> <argument index="1" name="default" type="Variant" default="null" />
</argument>
<argument index="1" name="default" type="Variant" default="null">
</argument>
<description> <description>
Returns the current value for the specified key in the [Dictionary]. If the key does not exist, the method returns the value of the optional default argument, or [code]null[/code] if it is omitted. Returns the current value for the specified key in the [Dictionary]. If the key does not exist, the method returns the value of the optional default argument, or [code]null[/code] if it is omitted.
</description> </description>
</method> </method>
<method name="has" qualifiers="const"> <method name="has" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="key" type="Variant" />
<argument index="0" name="key" type="Variant">
</argument>
<description> <description>
Returns [code]true[/code] if the dictionary has a given key. Returns [code]true[/code] if the dictionary has a given key.
[b]Note:[/b] This is equivalent to using the [code]in[/code] operator as follows: [b]Note:[/b] This is equivalent to using the [code]in[/code] operator as follows:
@ -261,17 +248,14 @@
</description> </description>
</method> </method>
<method name="has_all" qualifiers="const"> <method name="has_all" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="keys" type="Array" />
<argument index="0" name="keys" type="Array">
</argument>
<description> <description>
Returns [code]true[/code] if the dictionary has all the keys in the given array. Returns [code]true[/code] if the dictionary has all the keys in the given array.
</description> </description>
</method> </method>
<method name="hash" qualifiers="const"> <method name="hash" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns a hashed integer value representing the dictionary contents. This can be used to compare dictionaries by value: Returns a hashed integer value representing the dictionary contents. This can be used to compare dictionaries by value:
[codeblocks] [codeblocks]
@ -293,53 +277,43 @@
</description> </description>
</method> </method>
<method name="is_empty" qualifiers="const"> <method name="is_empty" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the dictionary is empty. Returns [code]true[/code] if the dictionary is empty.
</description> </description>
</method> </method>
<method name="keys" qualifiers="const"> <method name="keys" qualifiers="const">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns the list of keys in the [Dictionary]. Returns the list of keys in the [Dictionary].
</description> </description>
</method> </method>
<method name="operator !=" qualifiers="operator"> <method name="operator !=" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Dictionary" />
<argument index="0" name="right" type="Dictionary">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator ==" qualifiers="operator"> <method name="operator ==" qualifiers="operator">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="right" type="Dictionary" />
<argument index="0" name="right" type="Dictionary">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="operator []" qualifiers="operator"> <method name="operator []" qualifiers="operator">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="key" type="Variant" />
<argument index="0" name="key" type="Variant">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="size" qualifiers="const"> <method name="size" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of keys in the dictionary. Returns the number of keys in the dictionary.
</description> </description>
</method> </method>
<method name="values" qualifiers="const"> <method name="values" qualifiers="const">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns the list of values in the [Dictionary]. Returns the list of values in the [Dictionary].
</description> </description>

96
doc/classes/Directory.xml
View File

@ -58,106 +58,86 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="change_dir"> <method name="change_dir">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="todir" type="String" />
<argument index="0" name="todir" type="String">
</argument>
<description> <description>
Changes 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]). Changes 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]).
Returns one of the [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="copy"> <method name="copy">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="from" type="String" />
<argument index="0" name="from" type="String"> <argument index="1" name="to" type="String" />
</argument>
<argument index="1" name="to" type="String">
</argument>
<description> <description>
Copies the [code]from[/code] file to the [code]to[/code] 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. Copies the [code]from[/code] file to the [code]to[/code] 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 [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="current_is_dir" qualifiers="const"> <method name="current_is_dir" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). Returns whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories).
</description> </description>
</method> </method>
<method name="dir_exists"> <method name="dir_exists">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path. Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path.
If the [Directory] is not open, the path is relative to [code]res://[/code]. If the [Directory] is not open, the path is relative to [code]res://[/code].
</description> </description>
</method> </method>
<method name="file_exists"> <method name="file_exists">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path. Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path.
If the [Directory] is not open, the path is relative to [code]res://[/code]. If the [Directory] is not open, the path is relative to [code]res://[/code].
</description> </description>
</method> </method>
<method name="get_current_dir"> <method name="get_current_dir">
<return type="String"> <return type="String" />
</return>
<description> <description>
Returns the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]). Returns the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]).
</description> </description>
</method> </method>
<method name="get_current_drive"> <method name="get_current_drive">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the currently opened directory's drive index. See [method get_drive] to convert returned index to the name of the drive. Returns the currently opened directory's drive index. See [method get_drive] to convert returned index to the name of the drive.
</description> </description>
</method> </method>
<method name="get_drive"> <method name="get_drive">
<return type="String"> <return type="String" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
On Windows, returns 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 exist, the method returns an empty String. On Windows, returns 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 exist, the method returns an empty String.
</description> </description>
</method> </method>
<method name="get_drive_count"> <method name="get_drive_count">
<return type="int"> <return type="int" />
</return>
<description> <description>
On Windows, returns the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0. On Windows, returns the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0.
</description> </description>
</method> </method>
<method name="get_next"> <method name="get_next">
<return type="String"> <return type="String" />
</return>
<description> <description>
Returns the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code], unless [code]skip_navigational[/code] was given to [method list_dir_begin]). Returns the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code], unless [code]skip_navigational[/code] was given to [method list_dir_begin]).
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). 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> </description>
</method> </method>
<method name="get_space_left"> <method name="get_space_left">
<return type="int"> <return type="int" />
</return>
<description> <description>
On UNIX desktop systems, returns 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, returns 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> </description>
</method> </method>
<method name="list_dir_begin"> <method name="list_dir_begin">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="show_navigational" type="bool" default="false" />
<argument index="0" name="show_navigational" type="bool" default="false"> <argument index="1" name="show_hidden" type="bool" default="false" />
</argument>
<argument index="1" name="show_hidden" type="bool" default="false">
</argument>
<description> <description>
Initializes the stream used to list all files and directories using the [method get_next] function, closing the currently opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end]. Initializes the stream used to list all files and directories using the [method get_next] function, closing the currently opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end].
If [code]show_navigational[/code] is [code]true[/code], [code].[/code] and [code]..[/code] are included too. If [code]show_navigational[/code] is [code]true[/code], [code].[/code] and [code]..[/code] are included too.
@ -165,59 +145,47 @@
</description> </description>
</method> </method>
<method name="list_dir_end"> <method name="list_dir_end">
<return type="void"> <return type="void" />
</return>
<description> <description>
Closes the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] does not matter). Closes the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] does not matter).
</description> </description>
</method> </method>
<method name="make_dir"> <method name="make_dir">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Creates 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]). Creates 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]).
Returns one of the [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="make_dir_recursive"> <method name="make_dir_recursive">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Creates 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. Creates 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 [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="open"> <method name="open">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Opens an existing directory of the filesystem. The [code]path[/code] 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]). Opens an existing directory of the filesystem. The [code]path[/code] 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]).
Returns one of the [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="remove"> <method name="remove">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Deletes 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. Deletes 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 [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).
</description> </description>
</method> </method>
<method name="rename"> <method name="rename">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="from" type="String" />
<argument index="0" name="from" type="String"> <argument index="1" name="to" type="String" />
</argument>
<argument index="1" name="to" type="String">
</argument>
<description> <description>
Renames (move) the [code]from[/code] file to the [code]to[/code] 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. Renames (move) the [code]from[/code] file to the [code]to[/code] 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 [enum Error] code constants ([code]OK[/code] on success). Returns one of the [enum Error] code constants ([code]OK[/code] on success).

744
doc/classes/DisplayServer.xml
View File

File diff suppressed because it is too large Load Diff

42
doc/classes/EditorDebuggerPlugin.xml
View File

@ -12,63 +12,50 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="has_capture"> <method name="has_capture">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if a message capture with given name is present otherwise [code]false[/code]. Returns [code]true[/code] if a message capture with given name is present otherwise [code]false[/code].
</description> </description>
</method> </method>
<method name="is_breaked"> <method name="is_breaked">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the game is in break state otherwise [code]false[/code]. Returns [code]true[/code] if the game is in break state otherwise [code]false[/code].
</description> </description>
</method> </method>
<method name="is_debuggable"> <method name="is_debuggable">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if the game can be debugged otherwise [code]false[/code]. Returns [code]true[/code] if the game can be debugged otherwise [code]false[/code].
</description> </description>
</method> </method>
<method name="is_session_active"> <method name="is_session_active">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if there is an instance of the game running with the attached debugger otherwise [code]false[/code]. Returns [code]true[/code] if there is an instance of the game running with the attached debugger otherwise [code]false[/code].
</description> </description>
</method> </method>
<method name="register_message_capture"> <method name="register_message_capture">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName"> <argument index="1" name="callable" type="Callable" />
</argument>
<argument index="1" name="callable" type="Callable">
</argument>
<description> <description>
Registers a message capture with given [code]name[/code]. If [code]name[/code] is "my_message" then messages starting with "my_message:" will be called with the given callable. Registers a message capture with given [code]name[/code]. If [code]name[/code] is "my_message" then messages starting with "my_message:" will be called with the given callable.
Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return [code]true[/code] otherwise [code]false[/code]. Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return [code]true[/code] otherwise [code]false[/code].
</description> </description>
</method> </method>
<method name="send_message"> <method name="send_message">
<return type="void"> <return type="void" />
</return> <argument index="0" name="message" type="String" />
<argument index="0" name="message" type="String"> <argument index="1" name="data" type="Array" />
</argument>
<argument index="1" name="data" type="Array">
</argument>
<description> <description>
Sends a message with given [code]message[/code] and [code]data[/code] array. Sends a message with given [code]message[/code] and [code]data[/code] array.
</description> </description>
</method> </method>
<method name="unregister_message_capture"> <method name="unregister_message_capture">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="StringName" />
<argument index="0" name="name" type="StringName">
</argument>
<description> <description>
Unregisters the message capture with given name. Unregisters the message capture with given name.
</description> </description>
@ -76,8 +63,7 @@
</methods> </methods>
<signals> <signals>
<signal name="breaked"> <signal name="breaked">
<argument index="0" name="can_debug" type="bool"> <argument index="0" name="can_debug" type="bool" />
</argument>
<description> <description>
Emitted when the game enters a break state. Emitted when the game enters a break state.
</description> </description>

96
doc/classes/EditorExportPlugin.xml
View File

@ -10,77 +10,57 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_export_begin" qualifiers="virtual"> <method name="_export_begin" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="features" type="PackedStringArray" />
<argument index="0" name="features" type="PackedStringArray"> <argument index="1" name="is_debug" type="bool" />
</argument> <argument index="2" name="path" type="String" />
<argument index="1" name="is_debug" type="bool"> <argument index="3" name="flags" type="int" />
</argument>
<argument index="2" name="path" type="String">
</argument>
<argument index="3" name="flags" type="int">
</argument>
<description> <description>
Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. [code]features[/code] is the list of features for the export, [code]is_debug[/code] is [code]true[/code] for debug builds, [code]path[/code] is the target path for the exported project. [code]flags[/code] is only used when running a runnable profile, e.g. when using native run on Android. Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. [code]features[/code] is the list of features for the export, [code]is_debug[/code] is [code]true[/code] for debug builds, [code]path[/code] is the target path for the exported project. [code]flags[/code] is only used when running a runnable profile, e.g. when using native run on Android.
</description> </description>
</method> </method>
<method name="_export_end" qualifiers="virtual"> <method name="_export_end" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
Virtual method to be overridden by the user. Called when the export is finished. Virtual method to be overridden by the user. Called when the export is finished.
</description> </description>
</method> </method>
<method name="_export_file" qualifiers="virtual"> <method name="_export_file" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="type" type="String" />
</argument> <argument index="2" name="features" type="PackedStringArray" />
<argument index="1" name="type" type="String">
</argument>
<argument index="2" name="features" type="PackedStringArray">
</argument>
<description> <description>
Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. [code]path[/code] is the path of the file, [code]type[/code] is the [Resource] represented by the file (e.g. [PackedScene]) and [code]features[/code] is the list of features for the export. Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. [code]path[/code] is the path of the file, [code]type[/code] is the [Resource] represented by the file (e.g. [PackedScene]) and [code]features[/code] is the list of features for the export.
Calling [method skip] inside this callback will make the file not included in the export. Calling [method skip] inside this callback will make the file not included in the export.
</description> </description>
</method> </method>
<method name="add_file"> <method name="add_file">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="file" type="PackedByteArray" />
</argument> <argument index="2" name="remap" type="bool" />
<argument index="1" name="file" type="PackedByteArray">
</argument>
<argument index="2" name="remap" type="bool">
</argument>
<description> <description>
Adds a custom file to be exported. [code]path[/code] is the virtual path that can be used to load the file, [code]file[/code] is the binary data of the file. If [code]remap[/code] is [code]true[/code], file will not be exported, but instead remapped to the given [code]path[/code]. Adds a custom file to be exported. [code]path[/code] is the virtual path that can be used to load the file, [code]file[/code] is the binary data of the file. If [code]remap[/code] is [code]true[/code], file will not be exported, but instead remapped to the given [code]path[/code].
</description> </description>
</method> </method>
<method name="add_ios_bundle_file"> <method name="add_ios_bundle_file">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Adds an iOS bundle file from the given [code]path[/code] to the exported project. Adds an iOS bundle file from the given [code]path[/code] to the exported project.
</description> </description>
</method> </method>
<method name="add_ios_cpp_code"> <method name="add_ios_cpp_code">
<return type="void"> <return type="void" />
</return> <argument index="0" name="code" type="String" />
<argument index="0" name="code" type="String">
</argument>
<description> <description>
Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin. Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin.
</description> </description>
</method> </method>
<method name="add_ios_embedded_framework"> <method name="add_ios_embedded_framework">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Adds a dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary. Adds a dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary.
[b]Note:[/b] For static libraries (*.a) works in same way as [code]add_ios_framework[/code]. [b]Note:[/b] For static libraries (*.a) works in same way as [code]add_ios_framework[/code].
@ -88,55 +68,43 @@
</description> </description>
</method> </method>
<method name="add_ios_framework"> <method name="add_ios_framework">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project. Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project.
</description> </description>
</method> </method>
<method name="add_ios_linker_flags"> <method name="add_ios_linker_flags">
<return type="void"> <return type="void" />
</return> <argument index="0" name="flags" type="String" />
<argument index="0" name="flags" type="String">
</argument>
<description> <description>
Adds linker flags for the iOS export. Adds linker flags for the iOS export.
</description> </description>
</method> </method>
<method name="add_ios_plist_content"> <method name="add_ios_plist_content">
<return type="void"> <return type="void" />
</return> <argument index="0" name="plist_content" type="String" />
<argument index="0" name="plist_content" type="String">
</argument>
<description> <description>
Adds content for iOS Property List files. Adds content for iOS Property List files.
</description> </description>
</method> </method>
<method name="add_ios_project_static_lib"> <method name="add_ios_project_static_lib">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Adds a static lib from the given [code]path[/code] to the iOS project. Adds a static lib from the given [code]path[/code] to the iOS project.
</description> </description>
</method> </method>
<method name="add_shared_object"> <method name="add_shared_object">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="tags" type="PackedStringArray" />
</argument>
<argument index="1" name="tags" type="PackedStringArray">
</argument>
<description> <description>
Adds a shared object with the given [code]tags[/code] and destination [code]path[/code]. Adds a shared object with the given [code]tags[/code] and destination [code]path[/code].
</description> </description>
</method> </method>
<method name="skip"> <method name="skip">
<return type="void"> <return type="void" />
</return>
<description> <description>
To be called inside [method _export_file]. Skips the current file, so it's not included in the export. To be called inside [method _export_file]. Skips the current file, so it's not included in the export.
</description> </description>

84
doc/classes/EditorFeatureProfile.xml
View File

@ -11,112 +11,84 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_feature_name"> <method name="get_feature_name">
<return type="String"> <return type="String" />
</return> <argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" />
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature">
</argument>
<description> <description>
Returns the specified [code]feature[/code]'s human-readable name. Returns the specified [code]feature[/code]'s human-readable name.
</description> </description>
</method> </method>
<method name="is_class_disabled" qualifiers="const"> <method name="is_class_disabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="class_name" type="StringName" />
<argument index="0" name="class_name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if the class specified by [code]class_name[/code] is disabled. When disabled, the class won't appear in the Create New Node dialog. Returns [code]true[/code] if the class specified by [code]class_name[/code] is disabled. When disabled, the class won't appear in the Create New Node dialog.
</description> </description>
</method> </method>
<method name="is_class_editor_disabled" qualifiers="const"> <method name="is_class_editor_disabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="class_name" type="StringName" />
<argument index="0" name="class_name" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if editing for the class specified by [code]class_name[/code] is disabled. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class. Returns [code]true[/code] if editing for the class specified by [code]class_name[/code] is disabled. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class.
</description> </description>
</method> </method>
<method name="is_class_property_disabled" qualifiers="const"> <method name="is_class_property_disabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="class_name" type="StringName" />
<argument index="0" name="class_name" type="StringName"> <argument index="1" name="property" type="StringName" />
</argument>
<argument index="1" name="property" type="StringName">
</argument>
<description> <description>
Returns [code]true[/code] if [code]property[/code] is disabled in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code]. Returns [code]true[/code] if [code]property[/code] is disabled in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code].
</description> </description>
</method> </method>
<method name="is_feature_disabled" qualifiers="const"> <method name="is_feature_disabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" />
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature">
</argument>
<description> <description>
Returns [code]true[/code] if the [code]feature[/code] is disabled. When a feature is disabled, it will disappear from the editor entirely. Returns [code]true[/code] if the [code]feature[/code] is disabled. When a feature is disabled, it will disappear from the editor entirely.
</description> </description>
</method> </method>
<method name="load_from_file"> <method name="load_from_file">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's [b]Export[/b] button or the [method save_to_file] method. Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's [b]Export[/b] button or the [method save_to_file] method.
</description> </description>
</method> </method>
<method name="save_to_file"> <method name="save_to_file">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's [b]Import[/b] button or the [method load_from_file] button. Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's [b]Import[/b] button or the [method load_from_file] button.
</description> </description>
</method> </method>
<method name="set_disable_class"> <method name="set_disable_class">
<return type="void"> <return type="void" />
</return> <argument index="0" name="class_name" type="StringName" />
<argument index="0" name="class_name" type="StringName"> <argument index="1" name="disable" type="bool" />
</argument>
<argument index="1" name="disable" type="bool">
</argument>
<description> <description>
If [code]disable[/code] is [code]true[/code], disables the class specified by [code]class_name[/code]. When disabled, the class won't appear in the Create New Node dialog. If [code]disable[/code] is [code]true[/code], disables the class specified by [code]class_name[/code]. When disabled, the class won't appear in the Create New Node dialog.
</description> </description>
</method> </method>
<method name="set_disable_class_editor"> <method name="set_disable_class_editor">
<return type="void"> <return type="void" />
</return> <argument index="0" name="class_name" type="StringName" />
<argument index="0" name="class_name" type="StringName"> <argument index="1" name="disable" type="bool" />
</argument>
<argument index="1" name="disable" type="bool">
</argument>
<description> <description>
If [code]disable[/code] is [code]true[/code], disables editing for the class specified by [code]class_name[/code]. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class. If [code]disable[/code] is [code]true[/code], disables editing for the class specified by [code]class_name[/code]. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class.
</description> </description>
</method> </method>
<method name="set_disable_class_property"> <method name="set_disable_class_property">
<return type="void"> <return type="void" />
</return> <argument index="0" name="class_name" type="StringName" />
<argument index="0" name="class_name" type="StringName"> <argument index="1" name="property" type="StringName" />
</argument> <argument index="2" name="disable" type="bool" />
<argument index="1" name="property" type="StringName">
</argument>
<argument index="2" name="disable" type="bool">
</argument>
<description> <description>
If [code]disable[/code] is [code]true[/code], disables editing for [code]property[/code] in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code]. If [code]disable[/code] is [code]true[/code], disables editing for [code]property[/code] in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code].
</description> </description>
</method> </method>
<method name="set_disable_feature"> <method name="set_disable_feature">
<return type="void"> <return type="void" />
</return> <argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature" />
<argument index="0" name="feature" type="int" enum="EditorFeatureProfile.Feature"> <argument index="1" name="disable" type="bool" />
</argument>
<argument index="1" name="disable" type="bool">
</argument>
<description> <description>
If [code]disable[/code] is [code]true[/code], disables the editor feature specified in [code]feature[/code]. When a feature is disabled, it will disappear from the editor entirely. If [code]disable[/code] is [code]true[/code], disables the editor feature specified in [code]feature[/code]. When a feature is disabled, it will disappear from the editor entirely.
</description> </description>

24
doc/classes/EditorFileDialog.xml
View File

@ -9,32 +9,27 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_filter"> <method name="add_filter">
<return type="void"> <return type="void" />
</return> <argument index="0" name="filter" type="String" />
<argument index="0" name="filter" type="String">
</argument>
<description> <description>
Adds a comma-delimited file extension filter option to the [EditorFileDialog] with an optional semi-colon-delimited label. Adds a comma-delimited file extension filter option to the [EditorFileDialog] with an optional semi-colon-delimited label.
For example, [code]"*.tscn, *.scn; Scenes"[/code] results in filter text "Scenes (*.tscn, *.scn)". For example, [code]"*.tscn, *.scn; Scenes"[/code] results in filter text "Scenes (*.tscn, *.scn)".
</description> </description>
</method> </method>
<method name="clear_filters"> <method name="clear_filters">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes all filters except for "All Files (*)". Removes all filters except for "All Files (*)".
</description> </description>
</method> </method>
<method name="get_vbox"> <method name="get_vbox">
<return type="VBoxContainer"> <return type="VBoxContainer" />
</return>
<description> <description>
Returns the [code]VBoxContainer[/code] used to display the file system. Returns the [code]VBoxContainer[/code] used to display the file system.
</description> </description>
</method> </method>
<method name="invalidate"> <method name="invalidate">
<return type="void"> <return type="void" />
</return>
<description> <description>
Notify the [EditorFileDialog] that its view of the data is no longer accurate. Updates the view contents on next view update. Notify the [EditorFileDialog] that its view of the data is no longer accurate. Updates the view contents on next view update.
</description> </description>
@ -70,22 +65,19 @@
</members> </members>
<signals> <signals>
<signal name="dir_selected"> <signal name="dir_selected">
<argument index="0" name="dir" type="String"> <argument index="0" name="dir" type="String" />
</argument>
<description> <description>
Emitted when a directory is selected. Emitted when a directory is selected.
</description> </description>
</signal> </signal>
<signal name="file_selected"> <signal name="file_selected">
<argument index="0" name="path" type="String"> <argument index="0" name="path" type="String" />
</argument>
<description> <description>
Emitted when a file is selected. Emitted when a file is selected.
</description> </description>
</signal> </signal>
<signal name="files_selected"> <signal name="files_selected">
<argument index="0" name="paths" type="PackedStringArray"> <argument index="0" name="paths" type="PackedStringArray" />
</argument>
<description> <description>
Emitted when multiple files are selected. Emitted when multiple files are selected.
</description> </description>

45
doc/classes/EditorFileSystem.xml
View File

@ -11,70 +11,58 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_file_type" qualifiers="const"> <method name="get_file_type" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Gets the type of the file, given the full path. Gets the type of the file, given the full path.
</description> </description>
</method> </method>
<method name="get_filesystem"> <method name="get_filesystem">
<return type="EditorFileSystemDirectory"> <return type="EditorFileSystemDirectory" />
</return>
<description> <description>
Gets the root directory object. Gets the root directory object.
</description> </description>
</method> </method>
<method name="get_filesystem_path"> <method name="get_filesystem_path">
<return type="EditorFileSystemDirectory"> <return type="EditorFileSystemDirectory" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Returns a view into the filesystem at [code]path[/code]. Returns a view into the filesystem at [code]path[/code].
</description> </description>
</method> </method>
<method name="get_scanning_progress" qualifiers="const"> <method name="get_scanning_progress" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the scan progress for 0 to 1 if the FS is being scanned. Returns the scan progress for 0 to 1 if the FS is being scanned.
</description> </description>
</method> </method>
<method name="is_scanning" qualifiers="const"> <method name="is_scanning" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] of the filesystem is being scanned. Returns [code]true[/code] of the filesystem is being scanned.
</description> </description>
</method> </method>
<method name="scan"> <method name="scan">
<return type="void"> <return type="void" />
</return>
<description> <description>
Scan the filesystem for changes. Scan the filesystem for changes.
</description> </description>
</method> </method>
<method name="scan_sources"> <method name="scan_sources">
<return type="void"> <return type="void" />
</return>
<description> <description>
Check if the source of any imported resource changed. Check if the source of any imported resource changed.
</description> </description>
</method> </method>
<method name="update_file"> <method name="update_file">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Update a file information. Call this if an external program (not Godot) modified the file. Update a file information. Call this if an external program (not Godot) modified the file.
</description> </description>
</method> </method>
<method name="update_script_classes"> <method name="update_script_classes">
<return type="void"> <return type="void" />
</return>
<description> <description>
Scans the script files and updates the list of custom class names. Scans the script files and updates the list of custom class names.
</description> </description>
@ -87,22 +75,19 @@
</description> </description>
</signal> </signal>
<signal name="resources_reimported"> <signal name="resources_reimported">
<argument index="0" name="resources" type="PackedStringArray"> <argument index="0" name="resources" type="PackedStringArray" />
</argument>
<description> <description>
Emitted if a resource is reimported. Emitted if a resource is reimported.
</description> </description>
</signal> </signal>
<signal name="resources_reload"> <signal name="resources_reload">
<argument index="0" name="resources" type="PackedStringArray"> <argument index="0" name="resources" type="PackedStringArray" />
</argument>
<description> <description>
Emitted if at least one resource is reloaded when the filesystem is scanned. Emitted if at least one resource is reloaded when the filesystem is scanned.
</description> </description>
</signal> </signal>
<signal name="sources_changed"> <signal name="sources_changed">
<argument index="0" name="exist" type="bool"> <argument index="0" name="exist" type="bool" />
</argument>
<description> <description>
Emitted if the source of any imported file changed. Emitted if the source of any imported file changed.
</description> </description>

69
doc/classes/EditorFileSystemDirectory.xml
View File

@ -10,117 +10,94 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="find_dir_index" qualifiers="const"> <method name="find_dir_index" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found. Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found.
</description> </description>
</method> </method>
<method name="find_file_index" qualifiers="const"> <method name="find_file_index" qualifiers="const">
<return type="int"> <return type="int" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found. Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found.
</description> </description>
</method> </method>
<method name="get_file" qualifiers="const"> <method name="get_file" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the name of the file at index [code]idx[/code]. Returns the name of the file at index [code]idx[/code].
</description> </description>
</method> </method>
<method name="get_file_count" qualifiers="const"> <method name="get_file_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of files in this directory. Returns the number of files in this directory.
</description> </description>
</method> </method>
<method name="get_file_import_is_valid" qualifiers="const"> <method name="get_file_import_is_valid" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns [code]true[/code] if the file at index [code]idx[/code] imported properly. Returns [code]true[/code] if the file at index [code]idx[/code] imported properly.
</description> </description>
</method> </method>
<method name="get_file_path" qualifiers="const"> <method name="get_file_path" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the path to the file at index [code]idx[/code]. Returns the path to the file at index [code]idx[/code].
</description> </description>
</method> </method>
<method name="get_file_script_class_extends" qualifiers="const"> <method name="get_file_script_class_extends" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the base class of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string. Returns the base class of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string.
</description> </description>
</method> </method>
<method name="get_file_script_class_name" qualifiers="const"> <method name="get_file_script_class_name" qualifiers="const">
<return type="String"> <return type="String" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the name of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string. Returns the name of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string.
</description> </description>
</method> </method>
<method name="get_file_type" qualifiers="const"> <method name="get_file_type" qualifiers="const">
<return type="StringName"> <return type="StringName" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the file extension of the file at index [code]idx[/code]. Returns the file extension of the file at index [code]idx[/code].
</description> </description>
</method> </method>
<method name="get_name"> <method name="get_name">
<return type="String"> <return type="String" />
</return>
<description> <description>
Returns the name of this directory. Returns the name of this directory.
</description> </description>
</method> </method>
<method name="get_parent"> <method name="get_parent">
<return type="EditorFileSystemDirectory"> <return type="EditorFileSystemDirectory" />
</return>
<description> <description>
Returns the parent directory for this directory or [code]null[/code] if called on a directory at [code]res://[/code] or [code]user://[/code]. Returns the parent directory for this directory or [code]null[/code] if called on a directory at [code]res://[/code] or [code]user://[/code].
</description> </description>
</method> </method>
<method name="get_path" qualifiers="const"> <method name="get_path" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
Returns the path to this directory. Returns the path to this directory.
</description> </description>
</method> </method>
<method name="get_subdir"> <method name="get_subdir">
<return type="EditorFileSystemDirectory"> <return type="EditorFileSystemDirectory" />
</return> <argument index="0" name="idx" type="int" />
<argument index="0" name="idx" type="int">
</argument>
<description> <description>
Returns the subdirectory at index [code]idx[/code]. Returns the subdirectory at index [code]idx[/code].
</description> </description>
</method> </method>
<method name="get_subdir_count" qualifiers="const"> <method name="get_subdir_count" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Returns the number of subdirectories in this directory. Returns the number of subdirectories in this directory.
</description> </description>

63
doc/classes/EditorImportPlugin.xml
View File

@ -114,35 +114,28 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_get_import_options" qualifiers="virtual"> <method name="_get_import_options" qualifiers="virtual">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="preset" type="int" />
<argument index="0" name="preset" type="int">
</argument>
<description> <description>
Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: [code]name[/code], [code]default_value[/code], [code]property_hint[/code] (optional), [code]hint_string[/code] (optional), [code]usage[/code] (optional). Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: [code]name[/code], [code]default_value[/code], [code]property_hint[/code] (optional), [code]hint_string[/code] (optional), [code]usage[/code] (optional).
</description> </description>
</method> </method>
<method name="_get_import_order" qualifiers="virtual"> <method name="_get_import_order" qualifiers="virtual">
<return type="int"> <return type="int" />
</return>
<description> <description>
Gets the order of this importer to be run when importing resources. Importers with [i]lower[/i] import orders will be called first, and higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. The default import order is [code]0[/code] unless overridden by a specific importer. See [enum ResourceImporter.ImportOrder] for some predefined values. Gets the order of this importer to be run when importing resources. Importers with [i]lower[/i] import orders will be called first, and higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. The default import order is [code]0[/code] unless overridden by a specific importer. See [enum ResourceImporter.ImportOrder] for some predefined values.
</description> </description>
</method> </method>
<method name="_get_importer_name" qualifiers="virtual"> <method name="_get_importer_name" qualifiers="virtual">
<return type="String"> <return type="String" />
</return>
<description> <description>
Gets the unique name of the importer. Gets the unique name of the importer.
</description> </description>
</method> </method>
<method name="_get_option_visibility" qualifiers="virtual"> <method name="_get_option_visibility" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="option" type="String" />
<argument index="0" name="option" type="String"> <argument index="1" name="options" type="Dictionary" />
</argument>
<argument index="1" name="options" type="Dictionary">
</argument>
<description> <description>
This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example: This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example:
[codeblocks] [codeblocks]
@ -171,69 +164,55 @@
</description> </description>
</method> </method>
<method name="_get_preset_count" qualifiers="virtual"> <method name="_get_preset_count" qualifiers="virtual">
<return type="int"> <return type="int" />
</return>
<description> <description>
Gets the number of initial presets defined by the plugin. Use [method _get_import_options] to get the default options for the preset and [method _get_preset_name] to get the name of the preset. Gets the number of initial presets defined by the plugin. Use [method _get_import_options] to get the default options for the preset and [method _get_preset_name] to get the name of the preset.
</description> </description>
</method> </method>
<method name="_get_preset_name" qualifiers="virtual"> <method name="_get_preset_name" qualifiers="virtual">
<return type="String"> <return type="String" />
</return> <argument index="0" name="preset" type="int" />
<argument index="0" name="preset" type="int">
</argument>
<description> <description>
Gets the name of the options preset at this index. Gets the name of the options preset at this index.
</description> </description>
</method> </method>
<method name="_get_priority" qualifiers="virtual"> <method name="_get_priority" qualifiers="virtual">
<return type="float"> <return type="float" />
</return>
<description> <description>
Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is [code]1.0[/code]. Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is [code]1.0[/code].
</description> </description>
</method> </method>
<method name="_get_recognized_extensions" qualifiers="virtual"> <method name="_get_recognized_extensions" qualifiers="virtual">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Gets the list of file extensions to associate with this loader (case-insensitive). e.g. [code]["obj"][/code]. Gets the list of file extensions to associate with this loader (case-insensitive). e.g. [code]["obj"][/code].
</description> </description>
</method> </method>
<method name="_get_resource_type" qualifiers="virtual"> <method name="_get_resource_type" qualifiers="virtual">
<return type="String"> <return type="String" />
</return>
<description> <description>
Gets the Godot resource type associated with this loader. e.g. [code]"Mesh"[/code] or [code]"Animation"[/code]. Gets the Godot resource type associated with this loader. e.g. [code]"Mesh"[/code] or [code]"Animation"[/code].
</description> </description>
</method> </method>
<method name="_get_save_extension" qualifiers="virtual"> <method name="_get_save_extension" qualifiers="virtual">
<return type="String"> <return type="String" />
</return>
<description> <description>
Gets the extension used to save this resource in the [code].godot/imported[/code] directory. Gets the extension used to save this resource in the [code].godot/imported[/code] directory.
</description> </description>
</method> </method>
<method name="_get_visible_name" qualifiers="virtual"> <method name="_get_visible_name" qualifiers="virtual">
<return type="String"> <return type="String" />
</return>
<description> <description>
Gets the name to display in the import window. You should choose this name as a continuation to "Import as", e.g. "Import as Special Mesh". Gets the name to display in the import window. You should choose this name as a continuation to "Import as", e.g. "Import as Special Mesh".
</description> </description>
</method> </method>
<method name="_import" qualifiers="virtual"> <method name="_import" qualifiers="virtual">
<return type="int"> <return type="int" />
</return> <argument index="0" name="source_file" type="String" />
<argument index="0" name="source_file" type="String"> <argument index="1" name="save_path" type="String" />
</argument> <argument index="2" name="options" type="Dictionary" />
<argument index="1" name="save_path" type="String"> <argument index="3" name="platform_variants" type="Array" />
</argument> <argument index="4" name="gen_files" type="Array" />
<argument index="2" name="options" type="Dictionary">
</argument>
<argument index="3" name="platform_variants" type="Array">
</argument>
<argument index="4" name="gen_files" type="Array">
</argument>
<description> <description>
Imports [code]source_file[/code] into [code]save_path[/code] with the import [code]options[/code] specified. The [code]platform_variants[/code] and [code]gen_files[/code] arrays will be modified by this function. Imports [code]source_file[/code] into [code]save_path[/code] with the import [code]options[/code] specified. The [code]platform_variants[/code] and [code]gen_files[/code] arrays will be modified by this function.
This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method. This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method.

27
doc/classes/EditorInspector.xml
View File

@ -16,55 +16,46 @@
</members> </members>
<signals> <signals>
<signal name="object_id_selected"> <signal name="object_id_selected">
<argument index="0" name="id" type="int"> <argument index="0" name="id" type="int" />
</argument>
<description> <description>
Emitted when the Edit button of an [Object] has been pressed in the inspector. This is mainly used in the remote scene tree inspector. Emitted when the Edit button of an [Object] has been pressed in the inspector. This is mainly used in the remote scene tree inspector.
</description> </description>
</signal> </signal>
<signal name="property_deleted"> <signal name="property_deleted">
<argument index="0" name="property" type="String"> <argument index="0" name="property" type="String" />
</argument>
<description> <description>
Emitted when a property is removed from the inspector. Emitted when a property is removed from the inspector.
</description> </description>
</signal> </signal>
<signal name="property_edited"> <signal name="property_edited">
<argument index="0" name="property" type="String"> <argument index="0" name="property" type="String" />
</argument>
<description> <description>
Emitted when a property is edited in the inspector. Emitted when a property is edited in the inspector.
</description> </description>
</signal> </signal>
<signal name="property_keyed"> <signal name="property_keyed">
<argument index="0" name="property" type="String"> <argument index="0" name="property" type="String" />
</argument>
<description> <description>
Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled. Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled.
</description> </description>
</signal> </signal>
<signal name="property_selected"> <signal name="property_selected">
<argument index="0" name="property" type="String"> <argument index="0" name="property" type="String" />
</argument>
<description> <description>
Emitted when a property is selected in the inspector. Emitted when a property is selected in the inspector.
</description> </description>
</signal> </signal>
<signal name="property_toggled"> <signal name="property_toggled">
<argument index="0" name="property" type="String"> <argument index="0" name="property" type="String" />
</argument> <argument index="1" name="checked" type="bool" />
<argument index="1" name="checked" type="bool">
</argument>
<description> <description>
Emitted when a boolean property is toggled in the inspector. Emitted when a boolean property is toggled in the inspector.
[b]Note:[/b] This signal is never emitted if the internal [code]autoclear[/code] property enabled. Since this property is always enabled in the editor inspector, this signal is never emitted by the editor itself. [b]Note:[/b] This signal is never emitted if the internal [code]autoclear[/code] property enabled. Since this property is always enabled in the editor inspector, this signal is never emitted by the editor itself.
</description> </description>
</signal> </signal>
<signal name="resource_selected"> <signal name="resource_selected">
<argument index="0" name="res" type="Object"> <argument index="0" name="res" type="Object" />
</argument> <argument index="1" name="prop" type="String" />
<argument index="1" name="prop" type="String">
</argument>
<description> <description>
Emitted when a resource is selected in the inspector. Emitted when a resource is selected in the inspector.
</description> </description>

63
doc/classes/EditorInspectorPlugin.xml
View File

@ -16,83 +16,62 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_can_handle" qualifiers="virtual"> <method name="_can_handle" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="object" type="Object" />
<argument index="0" name="object" type="Object">
</argument>
<description> <description>
Returns [code]true[/code] if this object can be handled by this plugin. Returns [code]true[/code] if this object can be handled by this plugin.
</description> </description>
</method> </method>
<method name="_parse_begin" qualifiers="virtual"> <method name="_parse_begin" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
Called to allow adding controls at the beginning of the list. Called to allow adding controls at the beginning of the list.
</description> </description>
</method> </method>
<method name="_parse_category" qualifiers="virtual"> <method name="_parse_category" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="category" type="String" />
<argument index="0" name="category" type="String">
</argument>
<description> <description>
Called to allow adding controls at the beginning of the category. Called to allow adding controls at the beginning of the category.
</description> </description>
</method> </method>
<method name="_parse_end" qualifiers="virtual"> <method name="_parse_end" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
Called to allow adding controls at the end of the list. Called to allow adding controls at the end of the list.
</description> </description>
</method> </method>
<method name="_parse_property" qualifiers="virtual"> <method name="_parse_property" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="type" type="int" />
<argument index="0" name="type" type="int"> <argument index="1" name="path" type="String" />
</argument> <argument index="2" name="hint" type="int" />
<argument index="1" name="path" type="String"> <argument index="3" name="hint_text" type="String" />
</argument> <argument index="4" name="usage" type="int" />
<argument index="2" name="hint" type="int">
</argument>
<argument index="3" name="hint_text" type="String">
</argument>
<argument index="4" name="usage" type="int">
</argument>
<description> <description>
Called to allow adding property specific editors to the inspector. Usually these inherit [EditorProperty]. Returning [code]true[/code] removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. Called to allow adding property specific editors to the inspector. Usually these inherit [EditorProperty]. Returning [code]true[/code] removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one.
</description> </description>
</method> </method>
<method name="add_custom_control"> <method name="add_custom_control">
<return type="void"> <return type="void" />
</return> <argument index="0" name="control" type="Control" />
<argument index="0" name="control" type="Control">
</argument>
<description> <description>
Adds a custom control, not necessarily a property editor. Adds a custom control, not necessarily a property editor.
</description> </description>
</method> </method>
<method name="add_property_editor"> <method name="add_property_editor">
<return type="void"> <return type="void" />
</return> <argument index="0" name="property" type="String" />
<argument index="0" name="property" type="String"> <argument index="1" name="editor" type="Control" />
</argument>
<argument index="1" name="editor" type="Control">
</argument>
<description> <description>
Adds a property editor, this must inherit [EditorProperty]. Adds a property editor, this must inherit [EditorProperty].
</description> </description>
</method> </method>
<method name="add_property_editor_for_multiple_properties"> <method name="add_property_editor_for_multiple_properties">
<return type="void"> <return type="void" />
</return> <argument index="0" name="label" type="String" />
<argument index="0" name="label" type="String"> <argument index="1" name="properties" type="PackedStringArray" />
</argument> <argument index="2" name="editor" type="Control" />
<argument index="1" name="properties" type="PackedStringArray">
</argument>
<argument index="2" name="editor" type="Control">
</argument>
<description> <description>
Adds an editor that allows modifying multiple properties, this must inherit [EditorProperty]. Adds an editor that allows modifying multiple properties, this must inherit [EditorProperty].
</description> </description>

150
doc/classes/EditorInterface.xml
View File

@ -11,267 +11,217 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="edit_node"> <method name="edit_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="node" type="Node" />
<argument index="0" name="node" type="Node">
</argument>
<description> <description>
Edits the given [Node]. The node will be also selected if it's inside the scene tree. Edits the given [Node]. The node will be also selected if it's inside the scene tree.
</description> </description>
</method> </method>
<method name="edit_resource"> <method name="edit_resource">
<return type="void"> <return type="void" />
</return> <argument index="0" name="resource" type="Resource" />
<argument index="0" name="resource" type="Resource">
</argument>
<description> <description>
Edits the given [Resource]. Edits the given [Resource].
</description> </description>
</method> </method>
<method name="get_base_control"> <method name="get_base_control">
<return type="Control"> <return type="Control" />
</return>
<description> <description>
Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly. Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly.
</description> </description>
</method> </method>
<method name="get_current_path" qualifiers="const"> <method name="get_current_path" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
Returns the current path being viewed in the [FileSystemDock]. Returns the current path being viewed in the [FileSystemDock].
</description> </description>
</method> </method>
<method name="get_edited_scene_root"> <method name="get_edited_scene_root">
<return type="Node"> <return type="Node" />
</return>
<description> <description>
Returns the edited (current) scene's root [Node]. Returns the edited (current) scene's root [Node].
</description> </description>
</method> </method>
<method name="get_editor_main_control"> <method name="get_editor_main_control">
<return type="Control"> <return type="Control" />
</return>
<description> <description>
Returns the main editor control. Use this as a parent for main screens. Returns the main editor control. Use this as a parent for main screens.
[b]Note:[/b] This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically. [b]Note:[/b] This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically.
</description> </description>
</method> </method>
<method name="get_editor_paths"> <method name="get_editor_paths">
<return type="EditorPaths"> <return type="EditorPaths" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="get_editor_scale" qualifiers="const"> <method name="get_editor_scale" qualifiers="const">
<return type="float"> <return type="float" />
</return>
<description> <description>
Returns the actual scale of the editor UI ([code]1.0[/code] being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins. Returns the actual scale of the editor UI ([code]1.0[/code] being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins.
[b]Note:[/b] This value is set via the [code]interface/editor/display_scale[/code] and [code]interface/editor/custom_display_scale[/code] editor settings. Editor must be restarted for changes to be properly applied. [b]Note:[/b] This value is set via the [code]interface/editor/display_scale[/code] and [code]interface/editor/custom_display_scale[/code] editor settings. Editor must be restarted for changes to be properly applied.
</description> </description>
</method> </method>
<method name="get_editor_settings"> <method name="get_editor_settings">
<return type="EditorSettings"> <return type="EditorSettings" />
</return>
<description> <description>
Returns the editor's [EditorSettings] instance. Returns the editor's [EditorSettings] instance.
</description> </description>
</method> </method>
<method name="get_file_system_dock"> <method name="get_file_system_dock">
<return type="FileSystemDock"> <return type="FileSystemDock" />
</return>
<description> <description>
Returns the editor's [FileSystemDock] instance. Returns the editor's [FileSystemDock] instance.
</description> </description>
</method> </method>
<method name="get_inspector" qualifiers="const"> <method name="get_inspector" qualifiers="const">
<return type="EditorInspector"> <return type="EditorInspector" />
</return>
<description> <description>
Returns the editor's [EditorInspector] instance. Returns the editor's [EditorInspector] instance.
</description> </description>
</method> </method>
<method name="get_open_scenes" qualifiers="const"> <method name="get_open_scenes" qualifiers="const">
<return type="Array"> <return type="Array" />
</return>
<description> <description>
Returns an [Array] with the file paths of the currently opened scenes. Returns an [Array] with the file paths of the currently opened scenes.
</description> </description>
</method> </method>
<method name="get_playing_scene" qualifiers="const"> <method name="get_playing_scene" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string. Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string.
</description> </description>
</method> </method>
<method name="get_resource_filesystem"> <method name="get_resource_filesystem">
<return type="EditorFileSystem"> <return type="EditorFileSystem" />
</return>
<description> <description>
Returns the editor's [EditorFileSystem] instance. Returns the editor's [EditorFileSystem] instance.
</description> </description>
</method> </method>
<method name="get_resource_previewer"> <method name="get_resource_previewer">
<return type="EditorResourcePreview"> <return type="EditorResourcePreview" />
</return>
<description> <description>
Returns the editor's [EditorResourcePreview] instance. Returns the editor's [EditorResourcePreview] instance.
</description> </description>
</method> </method>
<method name="get_script_editor"> <method name="get_script_editor">
<return type="ScriptEditor"> <return type="ScriptEditor" />
</return>
<description> <description>
Returns the editor's [ScriptEditor] instance. Returns the editor's [ScriptEditor] instance.
</description> </description>
</method> </method>
<method name="get_selected_path" qualifiers="const"> <method name="get_selected_path" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
Returns the path of the directory currently selected in the [FileSystemDock]. If a file is selected, its base directory will be returned using [method String.get_base_dir] instead. Returns the path of the directory currently selected in the [FileSystemDock]. If a file is selected, its base directory will be returned using [method String.get_base_dir] instead.
</description> </description>
</method> </method>
<method name="get_selection"> <method name="get_selection">
<return type="EditorSelection"> <return type="EditorSelection" />
</return>
<description> <description>
Returns the editor's [EditorSelection] instance. Returns the editor's [EditorSelection] instance.
</description> </description>
</method> </method>
<method name="inspect_object"> <method name="inspect_object">
<return type="void"> <return type="void" />
</return> <argument index="0" name="object" type="Object" />
<argument index="0" name="object" type="Object"> <argument index="1" name="for_property" type="String" default="&quot;&quot;" />
</argument> <argument index="2" name="inspector_only" type="bool" default="false" />
<argument index="1" name="for_property" type="String" default="&quot;&quot;">
</argument>
<argument index="2" name="inspector_only" type="bool" default="false">
</argument>
<description> <description>
Shows the given property on the given [code]object[/code] in the editor's Inspector dock. If [code]inspector_only[/code] is [code]true[/code], plugins will not attempt to edit [code]object[/code]. Shows the given property on the given [code]object[/code] in the editor's Inspector dock. If [code]inspector_only[/code] is [code]true[/code], plugins will not attempt to edit [code]object[/code].
</description> </description>
</method> </method>
<method name="is_playing_scene" qualifiers="const"> <method name="is_playing_scene" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if a scene is currently being played, [code]false[/code] otherwise. Paused scenes are considered as being played. Returns [code]true[/code] if a scene is currently being played, [code]false[/code] otherwise. Paused scenes are considered as being played.
</description> </description>
</method> </method>
<method name="is_plugin_enabled" qualifiers="const"> <method name="is_plugin_enabled" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="plugin" type="String" />
<argument index="0" name="plugin" type="String">
</argument>
<description> <description>
Returns [code]true[/code] if the specified [code]plugin[/code] is enabled. The plugin name is the same as its directory name. Returns [code]true[/code] if the specified [code]plugin[/code] is enabled. The plugin name is the same as its directory name.
</description> </description>
</method> </method>
<method name="make_mesh_previews"> <method name="make_mesh_previews">
<return type="Array"> <return type="Array" />
</return> <argument index="0" name="meshes" type="Array" />
<argument index="0" name="meshes" type="Array"> <argument index="1" name="preview_size" type="int" />
</argument>
<argument index="1" name="preview_size" type="int">
</argument>
<description> <description>
Returns mesh previews rendered at the given size as an [Array] of [Texture2D]s. Returns mesh previews rendered at the given size as an [Array] of [Texture2D]s.
</description> </description>
</method> </method>
<method name="open_scene_from_path"> <method name="open_scene_from_path">
<return type="void"> <return type="void" />
</return> <argument index="0" name="scene_filepath" type="String" />
<argument index="0" name="scene_filepath" type="String">
</argument>
<description> <description>
Opens the scene at the given path. Opens the scene at the given path.
</description> </description>
</method> </method>
<method name="play_current_scene"> <method name="play_current_scene">
<return type="void"> <return type="void" />
</return>
<description> <description>
Plays the currently active scene. Plays the currently active scene.
</description> </description>
</method> </method>
<method name="play_custom_scene"> <method name="play_custom_scene">
<return type="void"> <return type="void" />
</return> <argument index="0" name="scene_filepath" type="String" />
<argument index="0" name="scene_filepath" type="String">
</argument>
<description> <description>
Plays the scene specified by its filepath. Plays the scene specified by its filepath.
</description> </description>
</method> </method>
<method name="play_main_scene"> <method name="play_main_scene">
<return type="void"> <return type="void" />
</return>
<description> <description>
Plays the main scene. Plays the main scene.
</description> </description>
</method> </method>
<method name="reload_scene_from_path"> <method name="reload_scene_from_path">
<return type="void"> <return type="void" />
</return> <argument index="0" name="scene_filepath" type="String" />
<argument index="0" name="scene_filepath" type="String">
</argument>
<description> <description>
Reloads the scene at the given path. Reloads the scene at the given path.
</description> </description>
</method> </method>
<method name="save_scene"> <method name="save_scene">
<return type="int" enum="Error"> <return type="int" enum="Error" />
</return>
<description> <description>
Saves the scene. Returns either [code]OK[/code] or [code]ERR_CANT_CREATE[/code] (see [@GlobalScope] constants). Saves the scene. Returns either [code]OK[/code] or [code]ERR_CANT_CREATE[/code] (see [@GlobalScope] constants).
</description> </description>
</method> </method>
<method name="save_scene_as"> <method name="save_scene_as">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="with_preview" type="bool" default="true" />
</argument>
<argument index="1" name="with_preview" type="bool" default="true">
</argument>
<description> <description>
Saves the scene as a file at [code]path[/code]. Saves the scene as a file at [code]path[/code].
</description> </description>
</method> </method>
<method name="select_file"> <method name="select_file">
<return type="void"> <return type="void" />
</return> <argument index="0" name="file" type="String" />
<argument index="0" name="file" type="String">
</argument>
<description> <description>
Selects the file, with the path provided by [code]file[/code], in the FileSystem dock. Selects the file, with the path provided by [code]file[/code], in the FileSystem dock.
</description> </description>
</method> </method>
<method name="set_main_screen_editor"> <method name="set_main_screen_editor">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
Sets the editor's current main screen to the one specified in [code]name[/code]. [code]name[/code] must match the text of the tab in question exactly ([code]2D[/code], [code]3D[/code], [code]Script[/code], [code]AssetLib[/code]). Sets the editor's current main screen to the one specified in [code]name[/code]. [code]name[/code] must match the text of the tab in question exactly ([code]2D[/code], [code]3D[/code], [code]Script[/code], [code]AssetLib[/code]).
</description> </description>
</method> </method>
<method name="set_plugin_enabled"> <method name="set_plugin_enabled">
<return type="void"> <return type="void" />
</return> <argument index="0" name="plugin" type="String" />
<argument index="0" name="plugin" type="String"> <argument index="1" name="enabled" type="bool" />
</argument>
<argument index="1" name="enabled" type="bool">
</argument>
<description> <description>
Sets the enabled status of a plugin. The plugin name is the same as its directory name. Sets the enabled status of a plugin. The plugin name is the same as its directory name.
</description> </description>
</method> </method>
<method name="stop_playing_scene"> <method name="stop_playing_scene">
<return type="void"> <return type="void" />
</return>
<description> <description>
Stops the scene that is currently playing. Stops the scene that is currently playing.
</description> </description>

192
doc/classes/EditorNode3DGizmo.xml
View File

@ -10,253 +10,189 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_commit_handle" qualifiers="virtual"> <method name="_commit_handle" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="restore" type="Variant" />
</argument> <argument index="2" name="cancel" type="bool" default="false" />
<argument index="1" name="restore" type="Variant">
</argument>
<argument index="2" name="cancel" type="bool" default="false">
</argument>
<description> <description>
Override this method to commit a handle being edited (handles must have been previously added by [method add_handles]). This usually means creating an [UndoRedo] action for the change, using the current handle value as "do" and the [code]restore[/code] argument as "undo". Override this method to commit a handle being edited (handles must have been previously added by [method add_handles]). This usually means creating an [UndoRedo] action for the change, using the current handle value as "do" and the [code]restore[/code] argument as "undo".
If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] value should be directly set, without any [UndoRedo] action. If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] value should be directly set, without any [UndoRedo] action.
</description> </description>
</method> </method>
<method name="_commit_subgizmos" qualifiers="virtual"> <method name="_commit_subgizmos" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="ids" type="PackedInt32Array" />
<argument index="0" name="ids" type="PackedInt32Array"> <argument index="1" name="restore" type="Array" />
</argument> <argument index="2" name="cancel" type="bool" default="false" />
<argument index="1" name="restore" type="Array">
</argument>
<argument index="2" name="cancel" type="bool" default="false">
</argument>
<description> <description>
Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [code]restore[/code] transforms as "undo". Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [code]restore[/code] transforms as "undo".
If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] transforms should be directly set, without any [UndoRedo] action. If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] transforms should be directly set, without any [UndoRedo] action.
</description> </description>
</method> </method>
<method name="_get_handle_name" qualifiers="virtual"> <method name="_get_handle_name" qualifiers="virtual">
<return type="String"> <return type="String" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Override this method to return the name of an edited handle (handles must have been previously added by [method add_handles]). Override this method to return 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. Handles can be named for reference to the user when editing.
</description> </description>
</method> </method>
<method name="_get_handle_value" qualifiers="virtual"> <method name="_get_handle_value" qualifiers="virtual">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_handle]. Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_handle].
</description> </description>
</method> </method>
<method name="_get_subgizmo_transform" qualifiers="virtual"> <method name="_get_subgizmo_transform" qualifiers="virtual">
<return type="Transform3D"> <return type="Transform3D" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Override this method to return the current transform of a subgizmo. This transform will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_subgizmos]. Override this method to return the current transform of a subgizmo. This transform will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_subgizmos].
</description> </description>
</method> </method>
<method name="_is_handle_highlighted" qualifiers="virtual"> <method name="_is_handle_highlighted" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
Override this method to return [code]true[/code] whenever the given handle should be highlighted in the editor. Override this method to return [code]true[/code] whenever the given handle should be highlighted in the editor.
</description> </description>
</method> </method>
<method name="_redraw" qualifiers="virtual"> <method name="_redraw" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call [method clear] at the beginning of this method and then add visual elements depending on the node's properties. Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call [method clear] at the beginning of this method and then add visual elements depending on the node's properties.
</description> </description>
</method> </method>
<method name="_set_handle" qualifiers="virtual"> <method name="_set_handle" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="camera" type="Camera3D" />
</argument> <argument index="2" name="point" type="Vector2" />
<argument index="1" name="camera" type="Camera3D">
</argument>
<argument index="2" name="point" type="Vector2">
</argument>
<description> <description>
Override this method to update the node properties when the user drags a gizmo handle (previously added with [method add_handles]). The provided [code]point[/code] is the mouse position in screen coordinates and the [code]camera[/code] can be used to convert it to raycasts. Override this method to update the node properties when the user drags a gizmo handle (previously added with [method add_handles]). The provided [code]point[/code] is the mouse position in screen coordinates and the [code]camera[/code] can be used to convert it to raycasts.
</description> </description>
</method> </method>
<method name="_set_subgizmo_transform" qualifiers="virtual"> <method name="_set_subgizmo_transform" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int"> <argument index="1" name="transform" type="Transform3D" />
</argument>
<argument index="1" name="transform" type="Transform3D">
</argument>
<description> <description>
Override this method to update the node properties during subgizmo editing (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). The [code]transform[/code] is given in the Node3D's local coordinate system. Override this method to update the node properties during subgizmo editing (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). The [code]transform[/code] is given in the Node3D's local coordinate system.
</description> </description>
</method> </method>
<method name="_subgizmos_intersect_frustum" qualifiers="virtual"> <method name="_subgizmos_intersect_frustum" qualifiers="virtual">
<return type="PackedInt32Array"> <return type="PackedInt32Array" />
</return> <argument index="0" name="camera" type="Camera3D" />
<argument index="0" name="camera" type="Camera3D"> <argument index="1" name="frustum" type="Array" />
</argument>
<argument index="1" name="frustum" type="Array">
</argument>
<description> <description>
Override this method to allow selecting subgizmos using mouse drag box selection. Given a [code]camera[/code] and a [code]frustum[/code], this method should return which subgizmos are contained within the frustum. The [code]frustum[/code] argument consists of an [code]Array[/code] with all the [code]Plane[/code]s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Override this method to allow selecting subgizmos using mouse drag box selection. Given a [code]camera[/code] and a [code]frustum[/code], this method should return which subgizmos are contained within the frustum. The [code]frustum[/code] argument consists of an [code]Array[/code] with all the [code]Plane[/code]s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos].
</description> </description>
</method> </method>
<method name="_subgizmos_intersect_ray" qualifiers="virtual"> <method name="_subgizmos_intersect_ray" qualifiers="virtual">
<return type="int"> <return type="int" />
</return> <argument index="0" name="camera" type="Camera3D" />
<argument index="0" name="camera" type="Camera3D"> <argument index="1" name="point" type="Vector2" />
</argument>
<argument index="1" name="point" type="Vector2">
</argument>
<description> <description>
Override this method to allow selecting subgizmos using mouse clicks. Given a [code]camera[/code] and a [code]point[/code] in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Override this method to allow selecting subgizmos using mouse clicks. Given a [code]camera[/code] and a [code]point[/code] in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos].
</description> </description>
</method> </method>
<method name="add_collision_segments"> <method name="add_collision_segments">
<return type="void"> <return type="void" />
</return> <argument index="0" name="segments" type="PackedVector3Array" />
<argument index="0" name="segments" type="PackedVector3Array">
</argument>
<description> <description>
Adds the specified [code]segments[/code] to the gizmo's collision shape for picking. Call this method during [method _redraw]. Adds the specified [code]segments[/code] to the gizmo's collision shape for picking. Call this method during [method _redraw].
</description> </description>
</method> </method>
<method name="add_collision_triangles"> <method name="add_collision_triangles">
<return type="void"> <return type="void" />
</return> <argument index="0" name="triangles" type="TriangleMesh" />
<argument index="0" name="triangles" type="TriangleMesh">
</argument>
<description> <description>
Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this method during [method _redraw]. Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this method during [method _redraw].
</description> </description>
</method> </method>
<method name="add_handles"> <method name="add_handles">
<return type="void"> <return type="void" />
</return> <argument index="0" name="handles" type="PackedVector3Array" />
<argument index="0" name="handles" type="PackedVector3Array"> <argument index="1" name="material" type="Material" />
</argument> <argument index="2" name="ids" type="PackedInt32Array" />
<argument index="1" name="material" type="Material"> <argument index="3" name="billboard" type="bool" default="false" />
</argument> <argument index="4" name="secondary" type="bool" default="false" />
<argument index="2" name="ids" type="PackedInt32Array">
</argument>
<argument index="3" name="billboard" type="bool" default="false">
</argument>
<argument index="4" name="secondary" type="bool" default="false">
</argument>
<description> <description>
Adds a list of handles (points) which can be used to edit the properties of the gizmo's Node3D. The [code]ids[/code] argument can be used to specify a custom identifier for each handle, if an empty [code]Array[/code] is passed, the ids will be assigned automatically from the [code]handles[/code] argument order. Adds a list of handles (points) which can be used to edit the properties of the gizmo's Node3D. The [code]ids[/code] argument can be used to specify a custom identifier for each handle, if an empty [code]Array[/code] is passed, the ids will be assigned automatically from the [code]handles[/code] argument order.
There are virtual methods which will be called upon editing of these handles. Call this method during [method _redraw]. There are virtual methods which will be called upon editing of these handles. Call this method during [method _redraw].
</description> </description>
</method> </method>
<method name="add_lines"> <method name="add_lines">
<return type="void"> <return type="void" />
</return> <argument index="0" name="lines" type="PackedVector3Array" />
<argument index="0" name="lines" type="PackedVector3Array"> <argument index="1" name="material" type="Material" />
</argument> <argument index="2" name="billboard" type="bool" default="false" />
<argument index="1" name="material" type="Material"> <argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
</argument>
<argument index="2" name="billboard" type="bool" default="false">
</argument>
<argument index="3" name="modulate" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<description> <description>
Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during [method _redraw]. Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this method during [method _redraw].
</description> </description>
</method> </method>
<method name="add_mesh"> <method name="add_mesh">
<return type="void"> <return type="void" />
</return> <argument index="0" name="mesh" type="ArrayMesh" />
<argument index="0" name="mesh" type="ArrayMesh"> <argument index="1" name="material" type="Material" default="null" />
</argument> <argument index="2" name="transform" type="Transform3D" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)" />
<argument index="1" name="material" type="Material" default="null"> <argument index="3" name="skeleton" type="SkinReference" default="null" />
</argument>
<argument index="2" name="transform" type="Transform3D" default="Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)">
</argument>
<argument index="3" name="skeleton" type="SkinReference" default="null">
</argument>
<description> <description>
Adds a mesh to the gizmo with the specified [code]material[/code], local [code]transform[/code] and [code]skeleton[/code]. Call this method during [method _redraw]. Adds a mesh to the gizmo with the specified [code]material[/code], local [code]transform[/code] and [code]skeleton[/code]. Call this method during [method _redraw].
</description> </description>
</method> </method>
<method name="add_unscaled_billboard"> <method name="add_unscaled_billboard">
<return type="void"> <return type="void" />
</return> <argument index="0" name="material" type="Material" />
<argument index="0" name="material" type="Material"> <argument index="1" name="default_scale" type="float" default="1" />
</argument> <argument index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)" />
<argument index="1" name="default_scale" type="float" default="1">
</argument>
<argument index="2" name="modulate" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<description> <description>
Adds an unscaled billboard for visualization and selection. Call this method during [method _redraw]. Adds an unscaled billboard for visualization and selection. Call this method during [method _redraw].
</description> </description>
</method> </method>
<method name="clear"> <method name="clear">
<return type="void"> <return type="void" />
</return>
<description> <description>
Removes everything in the gizmo including meshes, collisions and handles. Removes everything in the gizmo including meshes, collisions and handles.
</description> </description>
</method> </method>
<method name="get_plugin" qualifiers="const"> <method name="get_plugin" qualifiers="const">
<return type="EditorNode3DGizmoPlugin"> <return type="EditorNode3DGizmoPlugin" />
</return>
<description> <description>
Returns the [EditorNode3DGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorNode3DGizmoPlugin.get_material]. Returns the [EditorNode3DGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorNode3DGizmoPlugin.get_material].
</description> </description>
</method> </method>
<method name="get_spatial_node" qualifiers="const"> <method name="get_spatial_node" qualifiers="const">
<return type="Node3D"> <return type="Node3D" />
</return>
<description> <description>
Returns the Node3D node associated with this gizmo. Returns the Node3D node associated with this gizmo.
</description> </description>
</method> </method>
<method name="get_subgizmo_selection" qualifiers="const"> <method name="get_subgizmo_selection" qualifiers="const">
<return type="PackedInt32Array"> <return type="PackedInt32Array" />
</return>
<description> <description>
Returns a list of the currently selected subgizmos. Can be used to highlight selected elements during [method _redraw]. Returns a list of the currently selected subgizmos. Can be used to highlight selected elements during [method _redraw].
</description> </description>
</method> </method>
<method name="is_subgizmo_selected" qualifiers="const"> <method name="is_subgizmo_selected" qualifiers="const">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="arg0" type="int" />
<argument index="0" name="arg0" type="int">
</argument>
<description> <description>
Returns [code]true[/code] if the given subgizmo is currently selected. Can be used to highlight selected elements during [method _redraw]. Returns [code]true[/code] if the given subgizmo is currently selected. Can be used to highlight selected elements during [method _redraw].
</description> </description>
</method> </method>
<method name="set_hidden"> <method name="set_hidden">
<return type="void"> <return type="void" />
</return> <argument index="0" name="hidden" type="bool" />
<argument index="0" name="hidden" type="bool">
</argument>
<description> <description>
Sets the gizmo's hidden state. If [code]true[/code], the gizmo will be hidden. If [code]false[/code], it will be shown. Sets the gizmo's hidden state. If [code]true[/code], the gizmo will be hidden. If [code]false[/code], it will be shown.
</description> </description>
</method> </method>
<method name="set_spatial_node"> <method name="set_spatial_node">
<return type="void"> <return type="void" />
</return> <argument index="0" name="node" type="Node" />
<argument index="0" name="node" type="Node">
</argument>
<description> <description>
Sets the reference [Node3D] node for the gizmo. [code]node[/code] must inherit from [Node3D]. Sets the reference [Node3D] node for the gizmo. [code]node[/code] must inherit from [Node3D].
</description> </description>

210
doc/classes/EditorNode3DGizmoPlugin.xml
View File

@ -11,255 +11,185 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_can_be_hidden" qualifiers="virtual"> <method name="_can_be_hidden" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Override this method to define whether the gizmos handled by this plugin can be hidden or not. Returns [code]true[/code] if not overridden. Override this method to define whether the gizmos handled by this plugin can be hidden or not. Returns [code]true[/code] if not overridden.
</description> </description>
</method> </method>
<method name="_commit_handle" qualifiers="virtual"> <method name="_commit_handle" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo"> <argument index="1" name="id" type="int" />
</argument> <argument index="2" name="restore" type="Variant" />
<argument index="1" name="id" type="int"> <argument index="3" name="cancel" type="bool" default="false" />
</argument>
<argument index="2" name="restore" type="Variant">
</argument>
<argument index="3" name="cancel" type="bool" default="false">
</argument>
<description> <description>
Override this method to commit a handle being edited (handles must have been previously added by [method EditorNode3DGizmo.add_handles] during [method _redraw]). This usually means creating an [UndoRedo] action for the change, using the current handle value as "do" and the [code]restore[/code] argument as "undo". Override this method to commit a handle being edited (handles must have been previously added by [method EditorNode3DGizmo.add_handles] during [method _redraw]). This usually means creating an [UndoRedo] action for the change, using the current handle value as "do" and the [code]restore[/code] argument as "undo".
If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] value should be directly set, without any [UndoRedo] action. Called for this plugin's active gizmos. If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] value should be directly set, without any [UndoRedo] action. Called for this plugin's active gizmos.
</description> </description>
</method> </method>
<method name="_commit_subgizmos" qualifiers="virtual"> <method name="_commit_subgizmos" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo"> <argument index="1" name="ids" type="PackedInt32Array" />
</argument> <argument index="2" name="restore" type="Array" />
<argument index="1" name="ids" type="PackedInt32Array"> <argument index="3" name="cancel" type="bool" default="false" />
</argument>
<argument index="2" name="restore" type="Array">
</argument>
<argument index="3" name="cancel" type="bool" default="false">
</argument>
<description> <description>
Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [code]restore[/code] transforms as "undo". Override this method to commit a group of subgizmos being edited (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). This usually means creating an [UndoRedo] action for the change, using the current transforms as "do" and the [code]restore[/code] transforms as "undo".
If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] transforms should be directly set, without any [UndoRedo] action. As with all subgizmo methods, transforms are given in local space respect to the gizmo's Node3D. Called for this plugin's active gizmos. If the [code]cancel[/code] argument is [code]true[/code], the [code]restore[/code] transforms should be directly set, without any [UndoRedo] action. As with all subgizmo methods, transforms are given in local space respect to the gizmo's Node3D. Called for this plugin's active gizmos.
</description> </description>
</method> </method>
<method name="_create_gizmo" qualifiers="virtual"> <method name="_create_gizmo" qualifiers="virtual">
<return type="EditorNode3DGizmo"> <return type="EditorNode3DGizmo" />
</return> <argument index="0" name="spatial" type="Node3D" />
<argument index="0" name="spatial" type="Node3D">
</argument>
<description> <description>
Override this method to return a custom [EditorNode3DGizmo] for the spatial nodes of your choice, return [code]null[/code] for the rest of nodes. See also [method _has_gizmo]. Override this method to return a custom [EditorNode3DGizmo] for the spatial nodes of your choice, return [code]null[/code] for the rest of nodes. See also [method _has_gizmo].
</description> </description>
</method> </method>
<method name="_get_gizmo_name" qualifiers="virtual"> <method name="_get_gizmo_name" qualifiers="virtual">
<return type="String"> <return type="String" />
</return>
<description> <description>
Override this method to provide the name that will appear in the gizmo visibility menu. Override this method to provide the name that will appear in the gizmo visibility menu.
</description> </description>
</method> </method>
<method name="_get_handle_name" qualifiers="virtual"> <method name="_get_handle_name" qualifiers="virtual">
<return type="String"> <return type="String" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo"> <argument index="1" name="id" type="int" />
</argument>
<argument index="1" name="id" type="int">
</argument>
<description> <description>
Override this method to provide gizmo's handle names. Called for this plugin's active gizmos. Override this method to provide gizmo's handle names. Called for this plugin's active gizmos.
</description> </description>
</method> </method>
<method name="_get_handle_value" qualifiers="virtual"> <method name="_get_handle_value" qualifiers="virtual">
<return type="Variant"> <return type="Variant" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo"> <argument index="1" name="id" type="int" />
</argument>
<argument index="1" name="id" type="int">
</argument>
<description> <description>
Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_handle]. Called for this plugin's active gizmos. Override this method to return the current value of a handle. This value will be requested at the start of an edit and used as the [code]restore[/code] argument in [method _commit_handle]. Called for this plugin's active gizmos.
</description> </description>
</method> </method>
<method name="_get_priority" qualifiers="virtual"> <method name="_get_priority" qualifiers="virtual">
<return type="int"> <return type="int" />
</return>
<description> <description>
Override this method to set the gizmo's priority. Gizmos with higher priority will have precedence when processing inputs like handles or subgizmos selection. Override this method to set the gizmo's priority. Gizmos with higher priority will have precedence when processing inputs like handles or subgizmos selection.
All built-in editor gizmos return a priority of [code]-1[/code]. If not overridden, this method will return [code]0[/code], which means custom gizmos will automatically get higher priority than built-in gizmos. All built-in editor gizmos return a priority of [code]-1[/code]. If not overridden, this method will return [code]0[/code], which means custom gizmos will automatically get higher priority than built-in gizmos.
</description> </description>
</method> </method>
<method name="_get_subgizmo_transform" qualifiers="virtual"> <method name="_get_subgizmo_transform" qualifiers="virtual">
<return type="Transform3D"> <return type="Transform3D" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo"> <argument index="1" name="id" type="int" />
</argument>
<argument index="1" name="id" type="int">
</argument>
<description> <description>
Override this method to return the current transform of a subgizmo. As with all subgizmo methods, the transform should be in local space respect to the gizmo's Node3D. This transform will be requested at the start of an edit and used in the [code]restore[/code] argument in [method _commit_subgizmos]. Called for this plugin's active gizmos. Override this method to return the current transform of a subgizmo. As with all subgizmo methods, the transform should be in local space respect to the gizmo's Node3D. This transform will be requested at the start of an edit and used in the [code]restore[/code] argument in [method _commit_subgizmos]. Called for this plugin's active gizmos.
</description> </description>
</method> </method>
<method name="_has_gizmo" qualifiers="virtual"> <method name="_has_gizmo" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="spatial" type="Node3D" />
<argument index="0" name="spatial" type="Node3D">
</argument>
<description> <description>
Override this method to define which Node3D nodes have a gizmo from this plugin. Whenever a [Node3D] node is added to a scene this method is called, if it returns [code]true[/code] the node gets a generic [EditorNode3DGizmo] assigned and is added to this plugin's list of active gizmos. Override this method to define which Node3D nodes have a gizmo from this plugin. Whenever a [Node3D] node is added to a scene this method is called, if it returns [code]true[/code] the node gets a generic [EditorNode3DGizmo] assigned and is added to this plugin's list of active gizmos.
</description> </description>
</method> </method>
<method name="_is_handle_highlighted" qualifiers="virtual"> <method name="_is_handle_highlighted" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo"> <argument index="1" name="id" type="int" />
</argument>
<argument index="1" name="id" type="int">
</argument>
<description> <description>
Override this method to return [code]true[/code] whenever to given handle should be highlighted in the editor. Called for this plugin's active gizmos. Override this method to return [code]true[/code] whenever to given handle should be highlighted in the editor. Called for this plugin's active gizmos.
</description> </description>
</method> </method>
<method name="_is_selectable_when_hidden" qualifiers="virtual"> <method name="_is_selectable_when_hidden" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Override this method to define whether Node3D with this gizmo should be selectable even when the gizmo is hidden. Override this method to define whether Node3D with this gizmo should be selectable even when the gizmo is hidden.
</description> </description>
</method> </method>
<method name="_redraw" qualifiers="virtual"> <method name="_redraw" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo">
</argument>
<description> <description>
Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call [method EditorNode3DGizmo.clear] at the beginning of this method and then add visual elements depending on the node's properties. Override this method to add all the gizmo elements whenever a gizmo update is requested. It's common to call [method EditorNode3DGizmo.clear] at the beginning of this method and then add visual elements depending on the node's properties.
</description> </description>
</method> </method>
<method name="_set_handle" qualifiers="virtual"> <method name="_set_handle" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo"> <argument index="1" name="id" type="int" />
</argument> <argument index="2" name="camera" type="Camera3D" />
<argument index="1" name="id" type="int"> <argument index="3" name="point" type="Vector2" />
</argument>
<argument index="2" name="camera" type="Camera3D">
</argument>
<argument index="3" name="point" type="Vector2">
</argument>
<description> <description>
Override this method to update the node's properties when the user drags a gizmo handle (previously added with [method EditorNode3DGizmo.add_handles]). The provided [code]point[/code] is the mouse position in screen coordinates and the [code]camera[/code] can be used to convert it to raycasts. Called for this plugin's active gizmos. Override this method to update the node's properties when the user drags a gizmo handle (previously added with [method EditorNode3DGizmo.add_handles]). The provided [code]point[/code] is the mouse position in screen coordinates and the [code]camera[/code] can be used to convert it to raycasts. Called for this plugin's active gizmos.
</description> </description>
</method> </method>
<method name="_set_subgizmo_transform" qualifiers="virtual"> <method name="_set_subgizmo_transform" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo"> <argument index="1" name="id" type="int" />
</argument> <argument index="2" name="transform" type="Transform3D" />
<argument index="1" name="id" type="int">
</argument>
<argument index="2" name="transform" type="Transform3D">
</argument>
<description> <description>
Override this method to update the node properties during subgizmo editing (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). The [code]transform[/code] is given in the Node3D's local coordinate system. Called for this plugin's active gizmos. Override this method to update the node properties during subgizmo editing (see [method _subgizmos_intersect_ray] and [method _subgizmos_intersect_frustum]). The [code]transform[/code] is given in the Node3D's local coordinate system. Called for this plugin's active gizmos.
</description> </description>
</method> </method>
<method name="_subgizmos_intersect_frustum" qualifiers="virtual"> <method name="_subgizmos_intersect_frustum" qualifiers="virtual">
<return type="PackedInt32Array"> <return type="PackedInt32Array" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo"> <argument index="1" name="camera" type="Camera3D" />
</argument> <argument index="2" name="frustum" type="Array" />
<argument index="1" name="camera" type="Camera3D">
</argument>
<argument index="2" name="frustum" type="Array">
</argument>
<description> <description>
Override this method to allow selecting subgizmos using mouse drag box selection. Given a [code]camera[/code] and a [code]frustum[/code], this method should return which subgizmos are contained within the frustum. The [code]frustum[/code] argument consists of an [code]Array[/code] with all the [code]Plane[/code]s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, these identifiers can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Called for this plugin's active gizmos. Override this method to allow selecting subgizmos using mouse drag box selection. Given a [code]camera[/code] and a [code]frustum[/code], this method should return which subgizmos are contained within the frustum. The [code]frustum[/code] argument consists of an [code]Array[/code] with all the [code]Plane[/code]s that make up the selection frustum. The returned value should contain a list of unique subgizmo identifiers, these identifiers can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Called for this plugin's active gizmos.
</description> </description>
</method> </method>
<method name="_subgizmos_intersect_ray" qualifiers="virtual"> <method name="_subgizmos_intersect_ray" qualifiers="virtual">
<return type="int"> <return type="int" />
</return> <argument index="0" name="gizmo" type="EditorNode3DGizmo" />
<argument index="0" name="gizmo" type="EditorNode3DGizmo"> <argument index="1" name="camera" type="Camera3D" />
</argument> <argument index="2" name="point" type="Vector2" />
<argument index="1" name="camera" type="Camera3D">
</argument>
<argument index="2" name="point" type="Vector2">
</argument>
<description> <description>
Override this method to allow selecting subgizmos using mouse clicks. Given a [code]camera[/code] and a [code]point[/code] in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Called for this plugin's active gizmos. Override this method to allow selecting subgizmos using mouse clicks. Given a [code]camera[/code] and a [code]point[/code] in screen coordinates, this method should return which subgizmo should be selected. The returned value should be a unique subgizmo identifier, which can have any non-negative value and will be used in other virtual methods like [method _get_subgizmo_transform] or [method _commit_subgizmos]. Called for this plugin's active gizmos.
</description> </description>
</method> </method>
<method name="add_material"> <method name="add_material">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String"> <argument index="1" name="material" type="StandardMaterial3D" />
</argument>
<argument index="1" name="material" type="StandardMaterial3D">
</argument>
<description> <description>
Adds a new material to the internal material list for the plugin. It can then be accessed with [method get_material]. Should not be overridden. Adds a new material to the internal material list for the plugin. It can then be accessed with [method get_material]. Should not be overridden.
</description> </description>
</method> </method>
<method name="create_handle_material"> <method name="create_handle_material">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String"> <argument index="1" name="billboard" type="bool" default="false" />
</argument> <argument index="2" name="texture" type="Texture2D" default="null" />
<argument index="1" name="billboard" type="bool" default="false">
</argument>
<argument index="2" name="texture" type="Texture2D" default="null">
</argument>
<description> <description>
Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_handles]. Should not be overridden. Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_handles]. Should not be overridden.
You can optionally provide a texture to use instead of the default icon. You can optionally provide a texture to use instead of the default icon.
</description> </description>
</method> </method>
<method name="create_icon_material"> <method name="create_icon_material">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String"> <argument index="1" name="texture" type="Texture2D" />
</argument> <argument index="2" name="on_top" type="bool" default="false" />
<argument index="1" name="texture" type="Texture2D"> <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" />
</argument>
<argument index="2" name="on_top" type="bool" default="false">
</argument>
<argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)">
</argument>
<description> <description>
Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_unscaled_billboard]. Should not be overridden. Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_unscaled_billboard]. Should not be overridden.
</description> </description>
</method> </method>
<method name="create_material"> <method name="create_material">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String"> <argument index="1" name="color" type="Color" />
</argument> <argument index="2" name="billboard" type="bool" default="false" />
<argument index="1" name="color" type="Color"> <argument index="3" name="on_top" type="bool" default="false" />
</argument> <argument index="4" name="use_vertex_color" type="bool" default="false" />
<argument index="2" name="billboard" type="bool" default="false">
</argument>
<argument index="3" name="on_top" type="bool" default="false">
</argument>
<argument index="4" name="use_vertex_color" type="bool" default="false">
</argument>
<description> <description>
Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_mesh] and [method EditorNode3DGizmo.add_lines]. Should not be overridden. Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorNode3DGizmo.add_mesh] and [method EditorNode3DGizmo.add_lines]. Should not be overridden.
</description> </description>
</method> </method>
<method name="get_material"> <method name="get_material">
<return type="StandardMaterial3D"> <return type="StandardMaterial3D" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String"> <argument index="1" name="gizmo" type="EditorNode3DGizmo" default="null" />
</argument>
<argument index="1" name="gizmo" type="EditorNode3DGizmo" default="null">
</argument>
<description> <description>
Gets material from the internal list of materials. If an [EditorNode3DGizmo] is provided, it will try to get the corresponding variant (selected and/or editable). Gets material from the internal list of materials. If an [EditorNode3DGizmo] is provided, it will try to get the corresponding variant (selected and/or editable).
</description> </description>

15
doc/classes/EditorPaths.xml
View File

@ -8,32 +8,27 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="get_cache_dir" qualifiers="const"> <method name="get_cache_dir" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="get_config_dir" qualifiers="const"> <method name="get_config_dir" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="get_data_dir" qualifiers="const"> <method name="get_data_dir" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="get_self_contained_file" qualifiers="const"> <method name="get_self_contained_file" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
</description> </description>
</method> </method>
<method name="is_self_contained" qualifiers="const"> <method name="is_self_contained" qualifiers="const">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
</description> </description>
</method> </method>

354
doc/classes/EditorPlugin.xml
View File

@ -11,56 +11,47 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_apply_changes" qualifiers="virtual"> <method name="_apply_changes" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
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. 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.
This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object.
</description> </description>
</method> </method>
<method name="_build" qualifiers="virtual"> <method name="_build" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs. This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs.
This method must return a boolean. If this method returns [code]false[/code], the project will not run. The run is aborted immediately, so this also prevents all other plugins' [method _build] methods from running. This method must return a boolean. If this method returns [code]false[/code], the project will not run. The run is aborted immediately, so this also prevents all other plugins' [method _build] methods from running.
</description> </description>
</method> </method>
<method name="_clear" qualifiers="virtual"> <method name="_clear" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
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 from the wrong scene. 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 from the wrong scene.
</description> </description>
</method> </method>
<method name="_disable_plugin" qualifiers="virtual"> <method name="_disable_plugin" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
Called by the engine when the user disables the [EditorPlugin] in the Plugin tab of the project settings window. Called by the engine when the user disables the [EditorPlugin] in the Plugin tab of the project settings window.
</description> </description>
</method> </method>
<method name="_edit" qualifiers="virtual"> <method name="_edit" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="object" type="Object" />
<argument index="0" name="object" type="Object">
</argument>
<description> <description>
This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object.
</description> </description>
</method> </method>
<method name="_enable_plugin" qualifiers="virtual"> <method name="_enable_plugin" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
Called by the engine when the user enables the [EditorPlugin] in the Plugin tab of the project settings window. Called by the engine when the user enables the [EditorPlugin] in the Plugin tab of the project settings window.
</description> </description>
</method> </method>
<method name="_forward_canvas_draw_over_viewport" qualifiers="virtual"> <method name="_forward_canvas_draw_over_viewport" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="overlay" type="Control" />
<argument index="0" name="overlay" type="Control">
</argument>
<description> <description>
Called by the engine when the 2D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. Called by the engine when the 2D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays].
[codeblocks] [codeblocks]
@ -97,20 +88,16 @@
</description> </description>
</method> </method>
<method name="_forward_canvas_force_draw_over_viewport" qualifiers="virtual"> <method name="_forward_canvas_force_draw_over_viewport" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="overlay" type="Control" />
<argument index="0" name="overlay" type="Control">
</argument>
<description> <description>
This method is the same as [method _forward_canvas_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. This method is the same as [method _forward_canvas_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else.
You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled].
</description> </description>
</method> </method>
<method name="_forward_canvas_gui_input" qualifiers="virtual"> <method name="_forward_canvas_gui_input" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="event" type="InputEvent" />
<argument index="0" name="event" type="InputEvent">
</argument>
<description> <description>
Called when there is a root node in the current edited scene, [method _handles] is implemented and an [InputEvent] happens in the 2D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example: Called when there is a root node in the current edited scene, [method _handles] is implemented and an [InputEvent] happens in the 2D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example:
[codeblocks] [codeblocks]
@ -145,10 +132,8 @@
</description> </description>
</method> </method>
<method name="_forward_spatial_draw_over_viewport" qualifiers="virtual"> <method name="_forward_spatial_draw_over_viewport" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="overlay" type="Control" />
<argument index="0" name="overlay" type="Control">
</argument>
<description> <description>
Called by the engine when the 3D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. Called by the engine when the 3D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays].
[codeblocks] [codeblocks]
@ -185,22 +170,17 @@
</description> </description>
</method> </method>
<method name="_forward_spatial_force_draw_over_viewport" qualifiers="virtual"> <method name="_forward_spatial_force_draw_over_viewport" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="overlay" type="Control" />
<argument index="0" name="overlay" type="Control">
</argument>
<description> <description>
This method is the same as [method _forward_spatial_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. This method is the same as [method _forward_spatial_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else.
You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled].
</description> </description>
</method> </method>
<method name="_forward_spatial_gui_input" qualifiers="virtual"> <method name="_forward_spatial_gui_input" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="camera" type="Camera3D" />
<argument index="0" name="camera" type="Camera3D"> <argument index="1" name="event" type="InputEvent" />
</argument>
<argument index="1" name="event" type="InputEvent">
</argument>
<description> <description>
Called when there is a root node in the current edited scene, [method _handles] is implemented and an [InputEvent] happens in the 3D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example: Called when there is a root node in the current edited scene, [method _handles] is implemented and an [InputEvent] happens in the 3D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example:
[codeblocks] [codeblocks]
@ -235,15 +215,13 @@
</description> </description>
</method> </method>
<method name="_get_breakpoints" qualifiers="virtual"> <method name="_get_breakpoints" qualifiers="virtual">
<return type="PackedStringArray"> <return type="PackedStringArray" />
</return>
<description> <description>
This is for editors that edit script-based objects. You can return a list of breakpoints in the format ([code]script:line[/code]), for example: [code]res://path_to_script.gd:25[/code]. This is for editors that edit script-based objects. You can return a list of breakpoints in the format ([code]script:line[/code]), for example: [code]res://path_to_script.gd:25[/code].
</description> </description>
</method> </method>
<method name="_get_plugin_icon" qualifiers="virtual"> <method name="_get_plugin_icon" qualifiers="virtual">
<return type="Texture2D"> <return type="Texture2D" />
</return>
<description> <description>
Override this method in your plugin to return a [Texture2D] in order to give it an icon. Override this method in your plugin to return a [Texture2D] in order to give it an icon.
For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons.
@ -269,109 +247,86 @@
</description> </description>
</method> </method>
<method name="_get_plugin_name" qualifiers="virtual"> <method name="_get_plugin_name" qualifiers="virtual">
<return type="String"> <return type="String" />
</return>
<description> <description>
Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor. Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor.
For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons.
</description> </description>
</method> </method>
<method name="_get_state" qualifiers="virtual"> <method name="_get_state" qualifiers="virtual">
<return type="Dictionary"> <return type="Dictionary" />
</return>
<description> <description>
Gets 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). Gets 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).
</description> </description>
</method> </method>
<method name="_get_window_layout" qualifiers="virtual"> <method name="_get_window_layout" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="layout" type="ConfigFile" />
<argument index="0" name="layout" type="ConfigFile">
</argument>
<description> <description>
Gets the GUI layout of the plugin. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock). Gets the GUI layout of the plugin. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock).
</description> </description>
</method> </method>
<method name="_handles" qualifiers="virtual"> <method name="_handles" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return> <argument index="0" name="object" type="Object" />
<argument index="0" name="object" type="Object">
</argument>
<description> <description>
Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method _edit] and [method _make_visible] called when the editor requests them. If you have declared the methods [method _forward_canvas_gui_input] and [method _forward_spatial_gui_input] these will be called too. Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method _edit] and [method _make_visible] called when the editor requests them. If you have declared the methods [method _forward_canvas_gui_input] and [method _forward_spatial_gui_input] these will be called too.
</description> </description>
</method> </method>
<method name="_has_main_screen" qualifiers="virtual"> <method name="_has_main_screen" qualifiers="virtual">
<return type="bool"> <return type="bool" />
</return>
<description> <description>
Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspace selector together with [b]2D[/b], [b]3D[/b], [b]Script[/b] and [b]AssetLib[/b]). Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspace selector together with [b]2D[/b], [b]3D[/b], [b]Script[/b] and [b]AssetLib[/b]).
</description> </description>
</method> </method>
<method name="_make_visible" qualifiers="virtual"> <method name="_make_visible" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="visible" type="bool" />
<argument index="0" name="visible" type="bool">
</argument>
<description> <description>
This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type.
Remember that you have to manage the visibility of all your editor controls manually. Remember that you have to manage the visibility of all your editor controls manually.
</description> </description>
</method> </method>
<method name="_save_external_data" qualifiers="virtual"> <method name="_save_external_data" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources.
</description> </description>
</method> </method>
<method name="_set_state" qualifiers="virtual"> <method name="_set_state" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="state" type="Dictionary" />
<argument index="0" name="state" type="Dictionary">
</argument>
<description> <description>
Restore the state saved by [method _get_state]. Restore the state saved by [method _get_state].
</description> </description>
</method> </method>
<method name="_set_window_layout" qualifiers="virtual"> <method name="_set_window_layout" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="layout" type="ConfigFile" />
<argument index="0" name="layout" type="ConfigFile">
</argument>
<description> <description>
Restore the plugin GUI layout saved by [method _get_window_layout]. Restore the plugin GUI layout saved by [method _get_window_layout].
</description> </description>
</method> </method>
<method name="add_autoload_singleton"> <method name="add_autoload_singleton">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String"> <argument index="1" name="path" type="String" />
</argument>
<argument index="1" name="path" type="String">
</argument>
<description> <description>
Adds a script at [code]path[/code] to the Autoload list as [code]name[/code]. Adds a script at [code]path[/code] to the Autoload list as [code]name[/code].
</description> </description>
</method> </method>
<method name="add_control_to_bottom_panel"> <method name="add_control_to_bottom_panel">
<return type="Button"> <return type="Button" />
</return> <argument index="0" name="control" type="Control" />
<argument index="0" name="control" type="Control"> <argument index="1" name="title" type="String" />
</argument>
<argument index="1" name="title" type="String">
</argument>
<description> <description>
Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free]. Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free].
</description> </description>
</method> </method>
<method name="add_control_to_container"> <method name="add_control_to_container">
<return type="void"> <return type="void" />
</return> <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer" />
<argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer"> <argument index="1" name="control" type="Control" />
</argument>
<argument index="1" name="control" type="Control">
</argument>
<description> <description>
Adds a custom control to a container (see [enum CustomControlContainer]). There are many locations where custom controls can be added in the editor UI. Adds a custom control to a container (see [enum CustomControlContainer]). There are many locations where custom controls can be added in the editor UI.
Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it).
@ -379,12 +334,9 @@
</description> </description>
</method> </method>
<method name="add_control_to_dock"> <method name="add_control_to_dock">
<return type="void"> <return type="void" />
</return> <argument index="0" name="slot" type="int" enum="EditorPlugin.DockSlot" />
<argument index="0" name="slot" type="int" enum="EditorPlugin.DockSlot"> <argument index="1" name="control" type="Control" />
</argument>
<argument index="1" name="control" type="Control">
</argument>
<description> <description>
Adds the control to a specific dock slot (see [enum DockSlot] for options). Adds the control to a specific dock slot (see [enum DockSlot] for options).
If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions.
@ -392,16 +344,11 @@
</description> </description>
</method> </method>
<method name="add_custom_type"> <method name="add_custom_type">
<return type="void"> <return type="void" />
</return> <argument index="0" name="type" type="String" />
<argument index="0" name="type" type="String"> <argument index="1" name="base" type="String" />
</argument> <argument index="2" name="script" type="Script" />
<argument index="1" name="base" type="String"> <argument index="3" name="icon" type="Texture2D" />
</argument>
<argument index="2" name="script" type="Script">
</argument>
<argument index="3" name="icon" type="Texture2D">
</argument>
<description> <description>
Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed.
When a given node or resource is selected, the base type will be instantiated (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object. When a given node or resource is selected, the base type will be instantiated (e.g. "Node3D", "Control", "Resource"), then the script will be loaded and set to this object.
@ -410,29 +357,23 @@
</description> </description>
</method> </method>
<method name="add_debugger_plugin"> <method name="add_debugger_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="script" type="Script" />
<argument index="0" name="script" type="Script">
</argument>
<description> <description>
Adds a [Script] as debugger plugin to the Debugger. The script must extend [EditorDebuggerPlugin]. Adds a [Script] as debugger plugin to the Debugger. The script must extend [EditorDebuggerPlugin].
</description> </description>
</method> </method>
<method name="add_export_plugin"> <method name="add_export_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="plugin" type="EditorExportPlugin" />
<argument index="0" name="plugin" type="EditorExportPlugin">
</argument>
<description> <description>
Registers a new [EditorExportPlugin]. Export plugins are used to perform tasks when the project is being exported. Registers a new [EditorExportPlugin]. Export plugins are used to perform tasks when the project is being exported.
See [method add_inspector_plugin] for an example of how to register a plugin. See [method add_inspector_plugin] for an example of how to register a plugin.
</description> </description>
</method> </method>
<method name="add_import_plugin"> <method name="add_import_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="importer" type="EditorImportPlugin" />
<argument index="0" name="importer" type="EditorImportPlugin">
</argument>
<description> <description>
Registers a new [EditorImportPlugin]. Import plugins are used to import custom and unsupported assets as a custom [Resource] type. Registers a new [EditorImportPlugin]. Import plugins are used to import custom and unsupported assets as a custom [Resource] type.
[b]Note:[/b] If you want to import custom 3D asset formats use [method add_scene_import_plugin] instead. [b]Note:[/b] If you want to import custom 3D asset formats use [method add_scene_import_plugin] instead.
@ -440,10 +381,8 @@
</description> </description>
</method> </method>
<method name="add_inspector_plugin"> <method name="add_inspector_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="plugin" type="EditorInspectorPlugin" />
<argument index="0" name="plugin" type="EditorInspectorPlugin">
</argument>
<description> <description>
Registers a new [EditorInspectorPlugin]. Inspector plugins are used to extend [EditorInspector] and provide custom configuration tools for your object's properties. Registers a new [EditorInspectorPlugin]. Inspector plugins are used to extend [EditorInspector] and provide custom configuration tools for your object's properties.
[b]Note:[/b] Always use [method remove_inspector_plugin] to remove the registered [EditorInspectorPlugin] when your [EditorPlugin] is disabled to prevent leaks and an unexpected behavior. [b]Note:[/b] Always use [method remove_inspector_plugin] to remove the registered [EditorInspectorPlugin] when your [EditorPlugin] is disabled to prevent leaks and an unexpected behavior.
@ -462,255 +401,202 @@
</description> </description>
</method> </method>
<method name="add_scene_import_plugin"> <method name="add_scene_import_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="scene_importer" type="EditorSceneImporter" />
<argument index="0" name="scene_importer" type="EditorSceneImporter">
</argument>
<description> <description>
Registers a new [EditorSceneImporter]. Scene importers are used to import custom 3D asset formats as scenes. Registers a new [EditorSceneImporter]. Scene importers are used to import custom 3D asset formats as scenes.
</description> </description>
</method> </method>
<method name="add_spatial_gizmo_plugin"> <method name="add_spatial_gizmo_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="plugin" type="EditorNode3DGizmoPlugin" />
<argument index="0" name="plugin" type="EditorNode3DGizmoPlugin">
</argument>
<description> <description>
Registers a new [EditorNode3DGizmoPlugin]. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a [Node3D]. Registers a new [EditorNode3DGizmoPlugin]. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a [Node3D].
See [method add_inspector_plugin] for an example of how to register a plugin. See [method add_inspector_plugin] for an example of how to register a plugin.
</description> </description>
</method> </method>
<method name="add_tool_menu_item"> <method name="add_tool_menu_item">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String"> <argument index="1" name="callable" type="Callable" />
</argument>
<argument index="1" name="callable" type="Callable">
</argument>
<description> <description>
Adds a custom menu item to [b]Project &gt; Tools[/b] named [code]name[/code]. When clicked, the provided [code]callable[/code] will be called. Adds a custom menu item to [b]Project &gt; Tools[/b] named [code]name[/code]. When clicked, the provided [code]callable[/code] will be called.
</description> </description>
</method> </method>
<method name="add_tool_submenu_item"> <method name="add_tool_submenu_item">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String"> <argument index="1" name="submenu" type="Object" />
</argument>
<argument index="1" name="submenu" type="Object">
</argument>
<description> <description>
Adds a custom submenu under [b]Project &gt; Tools &gt;[/b] [code]name[/code]. [code]submenu[/code] should be an object of class [PopupMenu]. Use [code]remove_tool_menu_item(name)[/code] on plugin clean up to remove the menu. Adds a custom submenu under [b]Project &gt; Tools &gt;[/b] [code]name[/code]. [code]submenu[/code] should be an object of class [PopupMenu]. Use [code]remove_tool_menu_item(name)[/code] on plugin clean up to remove the menu.
</description> </description>
</method> </method>
<method name="add_translation_parser_plugin"> <method name="add_translation_parser_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="parser" type="EditorTranslationParserPlugin" />
<argument index="0" name="parser" type="EditorTranslationParserPlugin">
</argument>
<description> <description>
Registers a custom translation parser plugin for extracting translatable strings from custom files. Registers a custom translation parser plugin for extracting translatable strings from custom files.
</description> </description>
</method> </method>
<method name="add_undo_redo_inspector_hook_callback"> <method name="add_undo_redo_inspector_hook_callback">
<return type="void"> <return type="void" />
</return> <argument index="0" name="callable" type="Callable" />
<argument index="0" name="callable" type="Callable">
</argument>
<description> <description>
Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified. Hooks a callback into the undo/redo action creation when a property is modified in the inspector. This allows, for example, to save other properties that may be lost when a given property is modified.
The callback should have 4 arguments: [Object] [code]undo_redo[/code], [Object] [code]modified_object[/code], [String] [code]property[/code] and [Variant] [code]new_value[/code]. They are, respectively, the [UndoRedo] object used by the inspector, the currently modified object, the name of the modified property and the new value the property is about to take. The callback should have 4 arguments: [Object] [code]undo_redo[/code], [Object] [code]modified_object[/code], [String] [code]property[/code] and [Variant] [code]new_value[/code]. They are, respectively, the [UndoRedo] object used by the inspector, the currently modified object, the name of the modified property and the new value the property is about to take.
</description> </description>
</method> </method>
<method name="get_editor_interface"> <method name="get_editor_interface">
<return type="EditorInterface"> <return type="EditorInterface" />
</return>
<description> <description>
Returns the [EditorInterface] object that gives you control over Godot editor's window and its functionalities. Returns the [EditorInterface] object that gives you control over Godot editor's window and its functionalities.
</description> </description>
</method> </method>
<method name="get_script_create_dialog"> <method name="get_script_create_dialog">
<return type="ScriptCreateDialog"> <return type="ScriptCreateDialog" />
</return>
<description> <description>
Gets the Editor's dialogue used for making scripts. Gets the Editor's dialogue used for making scripts.
[b]Note:[/b] Users can configure it before use. [b]Note:[/b] Users can configure it before use.
</description> </description>
</method> </method>
<method name="get_undo_redo"> <method name="get_undo_redo">
<return type="UndoRedo"> <return type="UndoRedo" />
</return>
<description> <description>
Gets 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. Gets 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> </description>
</method> </method>
<method name="hide_bottom_panel"> <method name="hide_bottom_panel">
<return type="void"> <return type="void" />
</return>
<description> <description>
Minimizes the bottom panel. Minimizes the bottom panel.
</description> </description>
</method> </method>
<method name="make_bottom_panel_item_visible"> <method name="make_bottom_panel_item_visible">
<return type="void"> <return type="void" />
</return> <argument index="0" name="item" type="Control" />
<argument index="0" name="item" type="Control">
</argument>
<description> <description>
Makes a specific item in the bottom panel visible. Makes a specific item in the bottom panel visible.
</description> </description>
</method> </method>
<method name="queue_save_layout"> <method name="queue_save_layout">
<return type="void"> <return type="void" />
</return>
<description> <description>
Queue save the project's editor layout. Queue save the project's editor layout.
</description> </description>
</method> </method>
<method name="remove_autoload_singleton"> <method name="remove_autoload_singleton">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
Removes an Autoload [code]name[/code] from the list. Removes an Autoload [code]name[/code] from the list.
</description> </description>
</method> </method>
<method name="remove_control_from_bottom_panel"> <method name="remove_control_from_bottom_panel">
<return type="void"> <return type="void" />
</return> <argument index="0" name="control" type="Control" />
<argument index="0" name="control" type="Control">
</argument>
<description> <description>
Removes the control from the bottom panel. You have to manually [method Node.queue_free] the control. Removes the control from the bottom panel. You have to manually [method Node.queue_free] the control.
</description> </description>
</method> </method>
<method name="remove_control_from_container"> <method name="remove_control_from_container">
<return type="void"> <return type="void" />
</return> <argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer" />
<argument index="0" name="container" type="int" enum="EditorPlugin.CustomControlContainer"> <argument index="1" name="control" type="Control" />
</argument>
<argument index="1" name="control" type="Control">
</argument>
<description> <description>
Removes the control from the specified container. You have to manually [method Node.queue_free] the control. Removes the control from the specified container. You have to manually [method Node.queue_free] the control.
</description> </description>
</method> </method>
<method name="remove_control_from_docks"> <method name="remove_control_from_docks">
<return type="void"> <return type="void" />
</return> <argument index="0" name="control" type="Control" />
<argument index="0" name="control" type="Control">
</argument>
<description> <description>
Removes the control from the dock. You have to manually [method Node.queue_free] the control. Removes the control from the dock. You have to manually [method Node.queue_free] the control.
</description> </description>
</method> </method>
<method name="remove_custom_type"> <method name="remove_custom_type">
<return type="void"> <return type="void" />
</return> <argument index="0" name="type" type="String" />
<argument index="0" name="type" type="String">
</argument>
<description> <description>
Removes a custom type added by [method add_custom_type]. Removes a custom type added by [method add_custom_type].
</description> </description>
</method> </method>
<method name="remove_debugger_plugin"> <method name="remove_debugger_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="script" type="Script" />
<argument index="0" name="script" type="Script">
</argument>
<description> <description>
Removes the debugger plugin with given script from the Debugger. Removes the debugger plugin with given script from the Debugger.
</description> </description>
</method> </method>
<method name="remove_export_plugin"> <method name="remove_export_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="plugin" type="EditorExportPlugin" />
<argument index="0" name="plugin" type="EditorExportPlugin">
</argument>
<description> <description>
Removes an export plugin registered by [method add_export_plugin]. Removes an export plugin registered by [method add_export_plugin].
</description> </description>
</method> </method>
<method name="remove_import_plugin"> <method name="remove_import_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="importer" type="EditorImportPlugin" />
<argument index="0" name="importer" type="EditorImportPlugin">
</argument>
<description> <description>
Removes an import plugin registered by [method add_import_plugin]. Removes an import plugin registered by [method add_import_plugin].
</description> </description>
</method> </method>
<method name="remove_inspector_plugin"> <method name="remove_inspector_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="plugin" type="EditorInspectorPlugin" />
<argument index="0" name="plugin" type="EditorInspectorPlugin">
</argument>
<description> <description>
Removes an inspector plugin registered by [method add_import_plugin] Removes an inspector plugin registered by [method add_import_plugin]
</description> </description>
</method> </method>
<method name="remove_scene_import_plugin"> <method name="remove_scene_import_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="scene_importer" type="EditorSceneImporter" />
<argument index="0" name="scene_importer" type="EditorSceneImporter">
</argument>
<description> <description>
Removes a scene importer registered by [method add_scene_import_plugin]. Removes a scene importer registered by [method add_scene_import_plugin].
</description> </description>
</method> </method>
<method name="remove_spatial_gizmo_plugin"> <method name="remove_spatial_gizmo_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="plugin" type="EditorNode3DGizmoPlugin" />
<argument index="0" name="plugin" type="EditorNode3DGizmoPlugin">
</argument>
<description> <description>
Removes a gizmo plugin registered by [method add_spatial_gizmo_plugin]. Removes a gizmo plugin registered by [method add_spatial_gizmo_plugin].
</description> </description>
</method> </method>
<method name="remove_tool_menu_item"> <method name="remove_tool_menu_item">
<return type="void"> <return type="void" />
</return> <argument index="0" name="name" type="String" />
<argument index="0" name="name" type="String">
</argument>
<description> <description>
Removes a menu [code]name[/code] from [b]Project &gt; Tools[/b]. Removes a menu [code]name[/code] from [b]Project &gt; Tools[/b].
</description> </description>
</method> </method>
<method name="remove_translation_parser_plugin"> <method name="remove_translation_parser_plugin">
<return type="void"> <return type="void" />
</return> <argument index="0" name="parser" type="EditorTranslationParserPlugin" />
<argument index="0" name="parser" type="EditorTranslationParserPlugin">
</argument>
<description> <description>
Removes a custom translation parser plugin registered by [method add_translation_parser_plugin]. Removes a custom translation parser plugin registered by [method add_translation_parser_plugin].
</description> </description>
</method> </method>
<method name="remove_undo_redo_inspector_hook_callback"> <method name="remove_undo_redo_inspector_hook_callback">
<return type="void"> <return type="void" />
</return> <argument index="0" name="callable" type="Callable" />
<argument index="0" name="callable" type="Callable">
</argument>
<description> <description>
Removes a callback previsously added by [method add_undo_redo_inspector_hook_callback]. Removes a callback previsously added by [method add_undo_redo_inspector_hook_callback].
</description> </description>
</method> </method>
<method name="set_force_draw_over_forwarding_enabled"> <method name="set_force_draw_over_forwarding_enabled">
<return type="void"> <return type="void" />
</return>
<description> <description>
Enables calling of [method _forward_canvas_force_draw_over_viewport] for the 2D editor and [method _forward_spatial_force_draw_over_viewport] for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin. Enables calling of [method _forward_canvas_force_draw_over_viewport] for the 2D editor and [method _forward_spatial_force_draw_over_viewport] for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin.
</description> </description>
</method> </method>
<method name="set_input_event_forwarding_always_enabled"> <method name="set_input_event_forwarding_always_enabled">
<return type="void"> <return type="void" />
</return>
<description> <description>
Use this method if you always want to receive inputs from 3D view screen inside [method _forward_spatial_gui_input]. It might be especially usable if your plugin will want to use raycast in the scene. Use this method if you always want to receive inputs from 3D view screen inside [method _forward_spatial_gui_input]. It might be especially usable if your plugin will want to use raycast in the scene.
</description> </description>
</method> </method>
<method name="update_overlays" qualifiers="const"> <method name="update_overlays" qualifiers="const">
<return type="int"> <return type="int" />
</return>
<description> <description>
Updates the overlays of the 2D and 3D editor viewport. Causes methods [method _forward_canvas_draw_over_viewport], [method _forward_canvas_force_draw_over_viewport], [method _forward_spatial_draw_over_viewport] and [method _forward_spatial_force_draw_over_viewport] to be called. Updates the overlays of the 2D and 3D editor viewport. Causes methods [method _forward_canvas_draw_over_viewport], [method _forward_canvas_force_draw_over_viewport], [method _forward_spatial_draw_over_viewport] and [method _forward_spatial_force_draw_over_viewport] to be called.
</description> </description>
@ -718,8 +604,7 @@
</methods> </methods>
<signals> <signals>
<signal name="main_screen_changed"> <signal name="main_screen_changed">
<argument index="0" name="screen_name" type="String"> <argument index="0" name="screen_name" type="String" />
</argument>
<description> <description>
Emitted when user changes the workspace ([b]2D[/b], [b]3D[/b], [b]Script[/b], [b]AssetLib[/b]). Also works with custom screens defined by plugins. Emitted when user changes the workspace ([b]2D[/b], [b]3D[/b], [b]Script[/b], [b]AssetLib[/b]). Also works with custom screens defined by plugins.
</description> </description>
@ -729,21 +614,18 @@
</description> </description>
</signal> </signal>
<signal name="resource_saved"> <signal name="resource_saved">
<argument index="0" name="resource" type="Resource"> <argument index="0" name="resource" type="Resource" />
</argument>
<description> <description>
</description> </description>
</signal> </signal>
<signal name="scene_changed"> <signal name="scene_changed">
<argument index="0" name="scene_root" type="Node"> <argument index="0" name="scene_root" type="Node" />
</argument>
<description> <description>
Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be [code]null[/code]. Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be [code]null[/code].
</description> </description>
</signal> </signal>
<signal name="scene_closed"> <signal name="scene_closed">
<argument index="0" name="filepath" type="String"> <argument index="0" name="filepath" type="String" />
</argument>
<description> <description>
Emitted when user closes a scene. The argument is file path to a closed scene. Emitted when user closes a scene. The argument is file path to a closed scene.
</description> </description>

87
doc/classes/EditorProperty.xml
View File

@ -10,62 +10,49 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_update_property" qualifiers="virtual"> <method name="_update_property" qualifiers="virtual">
<return type="void"> <return type="void" />
</return>
<description> <description>
When this virtual function is called, you must update your editor. When this virtual function is called, you must update your editor.
</description> </description>
</method> </method>
<method name="add_focusable"> <method name="add_focusable">
<return type="void"> <return type="void" />
</return> <argument index="0" name="control" type="Control" />
<argument index="0" name="control" type="Control">
</argument>
<description> <description>
If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed. If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed.
</description> </description>
</method> </method>
<method name="emit_changed"> <method name="emit_changed">
<return type="void"> <return type="void" />
</return> <argument index="0" name="property" type="StringName" />
<argument index="0" name="property" type="StringName"> <argument index="1" name="value" type="Variant" />
</argument> <argument index="2" name="field" type="StringName" default="&amp;&quot;&quot;" />
<argument index="1" name="value" type="Variant"> <argument index="3" name="changing" type="bool" default="false" />
</argument>
<argument index="2" name="field" type="StringName" default="&amp;&quot;&quot;">
</argument>
<argument index="3" name="changing" type="bool" default="false">
</argument>
<description> <description>
If one or several properties have changed, this must be called. [code]field[/code] is used in case your editor can modify fields separately (as an example, Vector3.x). The [code]changing[/code] argument avoids the editor requesting this property to be refreshed (leave as [code]false[/code] if unsure). If one or several properties have changed, this must be called. [code]field[/code] is used in case your editor can modify fields separately (as an example, Vector3.x). The [code]changing[/code] argument avoids the editor requesting this property to be refreshed (leave as [code]false[/code] if unsure).
</description> </description>
</method> </method>
<method name="get_edited_object"> <method name="get_edited_object">
<return type="Object"> <return type="Object" />
</return>
<description> <description>
Gets the edited object. Gets the edited object.
</description> </description>
</method> </method>
<method name="get_edited_property"> <method name="get_edited_property">
<return type="StringName"> <return type="StringName" />
</return>
<description> <description>
Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin._parse_property]), then this will return the property. Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin._parse_property]), then this will return the property.
</description> </description>
</method> </method>
<method name="get_tooltip_text" qualifiers="const"> <method name="get_tooltip_text" qualifiers="const">
<return type="String"> <return type="String" />
</return>
<description> <description>
Override if you want to allow a custom tooltip over your property. Override if you want to allow a custom tooltip over your property.
</description> </description>
</method> </method>
<method name="set_bottom_editor"> <method name="set_bottom_editor">
<return type="void"> <return type="void" />
</return> <argument index="0" name="editor" type="Control" />
<argument index="0" name="editor" type="Control">
</argument>
<description> <description>
Adds controls with this function if you want them on the bottom (below the label). Adds controls with this function if you want them on the bottom (below the label).
</description> </description>
@ -96,78 +83,62 @@
</members> </members>
<signals> <signals>
<signal name="multiple_properties_changed"> <signal name="multiple_properties_changed">
<argument index="0" name="properties" type="PackedStringArray"> <argument index="0" name="properties" type="PackedStringArray" />
</argument> <argument index="1" name="value" type="Array" />
<argument index="1" name="value" type="Array">
</argument>
<description> <description>
Emit it if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin._parse_property]. Emit it if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin._parse_property].
</description> </description>
</signal> </signal>
<signal name="object_id_selected"> <signal name="object_id_selected">
<argument index="0" name="property" type="StringName"> <argument index="0" name="property" type="StringName" />
</argument> <argument index="1" name="id" type="int" />
<argument index="1" name="id" type="int">
</argument>
<description> <description>
Used by sub-inspectors. Emit it if what was selected was an Object ID. Used by sub-inspectors. Emit it if what was selected was an Object ID.
</description> </description>
</signal> </signal>
<signal name="property_changed"> <signal name="property_changed">
<argument index="0" name="property" type="StringName"> <argument index="0" name="property" type="StringName" />
</argument> <argument index="1" name="value" type="Variant" />
<argument index="1" name="value" type="Variant">
</argument>
<description> <description>
Do not emit this manually, use the [method emit_changed] method instead. Do not emit this manually, use the [method emit_changed] method instead.
</description> </description>
</signal> </signal>
<signal name="property_checked"> <signal name="property_checked">
<argument index="0" name="property" type="StringName"> <argument index="0" name="property" type="StringName" />
</argument> <argument index="1" name="bool" type="String" />
<argument index="1" name="bool" type="String">
</argument>
<description> <description>
Emitted when a property was checked. Used internally. Emitted when a property was checked. Used internally.
</description> </description>
</signal> </signal>
<signal name="property_deleted"> <signal name="property_deleted">
<argument index="0" name="property" type="StringName"> <argument index="0" name="property" type="StringName" />
</argument>
<description> <description>
Emitted when a property was deleted. Used internally. Emitted when a property was deleted. Used internally.
</description> </description>
</signal> </signal>
<signal name="property_keyed"> <signal name="property_keyed">
<argument index="0" name="property" type="StringName"> <argument index="0" name="property" type="StringName" />
</argument>
<description> <description>
Emit it if you want to add this value as an animation key (check for keying being enabled first). Emit it if you want to add this value as an animation key (check for keying being enabled first).
</description> </description>
</signal> </signal>
<signal name="property_keyed_with_value"> <signal name="property_keyed_with_value">
<argument index="0" name="property" type="StringName"> <argument index="0" name="property" type="StringName" />
</argument> <argument index="1" name="value" type="Variant" />
<argument index="1" name="value" type="Variant">
</argument>
<description> <description>
Emit it if you want to key a property with a single value. Emit it if you want to key a property with a single value.
</description> </description>
</signal> </signal>
<signal name="resource_selected"> <signal name="resource_selected">
<argument index="0" name="path" type="String"> <argument index="0" name="path" type="String" />
</argument> <argument index="1" name="resource" type="Resource" />
<argument index="1" name="resource" type="Resource">
</argument>
<description> <description>
If you want a sub-resource to be edited, emit this signal with the resource. If you want a sub-resource to be edited, emit this signal with the resource.
</description> </description>
</signal> </signal>
<signal name="selected"> <signal name="selected">
<argument index="0" name="path" type="String"> <argument index="0" name="path" type="String" />
</argument> <argument index="1" name="focusable_idx" type="int" />
<argument index="1" name="focusable_idx" type="int">
</argument>
<description> <description>
Emitted when selected. Used internally. Emitted when selected. Used internally.
</description> </description>

9
doc/classes/EditorResourceConversionPlugin.xml
View File

@ -8,16 +8,13 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_convert" qualifiers="virtual"> <method name="_convert" qualifiers="virtual">
<return type="Resource"> <return type="Resource" />
</return> <argument index="0" name="resource" type="Resource" />
<argument index="0" name="resource" type="Resource">
</argument>
<description> <description>
</description> </description>
</method> </method>
<method name="_converts_to" qualifiers="virtual"> <method name="_converts_to" qualifiers="virtual">
<return type="String"> <return type="String" />
</return>
<description> <description>
</description> </description>
</method> </method>

27
doc/classes/EditorResourcePicker.xml
View File

@ -11,36 +11,29 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="_handle_menu_selected" qualifiers="virtual"> <method name="_handle_menu_selected" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="id" type="int" />
<argument index="0" name="id" type="int">
</argument>
<description> <description>
This virtual method can be implemented to handle context menu items not handled by default. See [method _set_create_options]. This virtual method can be implemented to handle context menu items not handled by default. See [method _set_create_options].
</description> </description>
</method> </method>
<method name="_set_create_options" qualifiers="virtual"> <method name="_set_create_options" qualifiers="virtual">
<return type="void"> <return type="void" />
</return> <argument index="0" name="menu_node" type="Object" />
<argument index="0" name="menu_node" type="Object">
</argument>
<description> <description>
This virtual method is called when updating the context menu of [EditorResourcePicker]. Implement this method to override the "New ..." items with your own options. [code]menu_node[/code] is a reference to the [PopupMenu] node. This virtual method is called when updating the context menu of [EditorResourcePicker]. Implement this method to override the "New ..." items with your own options. [code]menu_node[/code] is a reference to the [PopupMenu] node.
[b]Note:[/b] Implement [method _handle_menu_selected] to handle these custom items. [b]Note:[/b] Implement [method _handle_menu_selected] to handle these custom items.
</description> </description>
</method> </method>
<method name="get_allowed_types" qualifiers="const"> <method name="get_allowed_types" qualifiers="const">
<return type="PackedStringArray"> <return type="PackedStringArray" />
</return>
<description> <description>
Returns a list of all allowed types and subtypes corresponding to the [member base_type]. If the [member base_type] is empty, an empty list is returned. Returns a list of all allowed types and subtypes corresponding to the [member base_type]. If the [member base_type] is empty, an empty list is returned.
</description> </description>
</method> </method>
<method name="set_toggle_pressed"> <method name="set_toggle_pressed">
<return type="void"> <return type="void" />
</return> <argument index="0" name="pressed" type="bool" />
<argument index="0" name="pressed" type="bool">
</argument>
<description> <description>
Sets the toggle mode state for the main button. Works only if [member toggle_mode] is set to [code]true[/code]. Sets the toggle mode state for the main button. Works only if [member toggle_mode] is set to [code]true[/code].
</description> </description>
@ -62,15 +55,13 @@
</members> </members>
<signals> <signals>
<signal name="resource_changed"> <signal name="resource_changed">
<argument index="0" name="resource" type="Resource"> <argument index="0" name="resource" type="Resource" />
</argument>
<description> <description>
Emitted when the value of the edited resource was changed. Emitted when the value of the edited resource was changed.
</description> </description>
</signal> </signal>
<signal name="resource_selected"> <signal name="resource_selected">
<argument index="0" name="resource" type="Resource"> <argument index="0" name="resource" type="Resource" />
</argument>
<description> <description>
Emitted when the resource value was set and user clicked to edit it. Emitted when the resource value was set and user clicked to edit it.
</description> </description>

51
doc/classes/EditorResourcePreview.xml
View File

@ -11,60 +11,44 @@
</tutorials> </tutorials>
<methods> <methods>
<method name="add_preview_generator"> <method name="add_preview_generator">
<return type="void"> <return type="void" />
</return> <argument index="0" name="generator" type="EditorResourcePreviewGenerator" />
<argument index="0" name="generator" type="EditorResourcePreviewGenerator">
</argument>
<description> <description>
Create an own, custom preview generator. Create an own, custom preview generator.
</description> </description>
</method> </method>
<method name="check_for_invalidation"> <method name="check_for_invalidation">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String">
</argument>
<description> <description>
Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted. Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted.
</description> </description>
</method> </method>
<method name="queue_edited_resource_preview"> <method name="queue_edited_resource_preview">
<return type="void"> <return type="void" />
</return> <argument index="0" name="resource" type="Resource" />
<argument index="0" name="resource" type="Resource"> <argument index="1" name="receiver" type="Object" />
</argument> <argument index="2" name="receiver_func" type="StringName" />
<argument index="1" name="receiver" type="Object"> <argument index="3" name="userdata" type="Variant" />
</argument>
<argument index="2" name="receiver_func" type="StringName">
</argument>
<argument index="3" name="userdata" type="Variant">
</argument>
<description> <description>
Queue the [code]resource[/code] being edited for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. Queue the [code]resource[/code] being edited for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called.
[b]Note[/b]: If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. [b]Note[/b]: If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null.
</description> </description>
</method> </method>
<method name="queue_resource_preview"> <method name="queue_resource_preview">
<return type="void"> <return type="void" />
</return> <argument index="0" name="path" type="String" />
<argument index="0" name="path" type="String"> <argument index="1" name="receiver" type="Object" />
</argument> <argument index="2" name="receiver_func" type="StringName" />
<argument index="1" name="receiver" type="Object"> <argument index="3" name="userdata" type="Variant" />
</argument>
<argument index="2" name="receiver_func" type="StringName">
</argument>
<argument index="3" name="userdata" type="Variant">
</argument>
<description> <description>
Queue a resource file located at [code]path[/code] for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. Queue a resource file located at [code]path[/code] for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture2D] preview, [Texture2D] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called.
[b]Note[/b]: If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. [b]Note[/b]: If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null.
</description> </description>
</method> </method>
<method name="remove_preview_generator"> <method name="remove_preview_generator">
<return type="void"> <return type="void" />
</return> <argument index="0" name="generator" type="EditorResourcePreviewGenerator" />
<argument index="0" name="generator" type="EditorResourcePreviewGenerator">
</argument>
<description> <description>
Removes a custom preview generator. Removes a custom preview generator.
</description> </description>
@ -72,8 +56,7 @@
</methods> </methods>
<signals> <signals>
<signal name="preview_invalidated"> <signal name="preview_invalidated">
<argument index="0" name="path" type="String"> <argument index="0" name="path" type="String" />
</argument>
<description> <description>
Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview. Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview.
</description> </description>

Some files were not shown because too many files have changed in this diff Show More