summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/base/classes.xml257
1 files changed, 204 insertions, 53 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 4db81f487c..5f7e995099 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -313,7 +313,7 @@
<method name="seed">
<return type="Nil">
</return>
- <argument index="0" name="seed" type="float">
+ <argument index="0" name="seed" type="int">
</argument>
<description>
Set seed for the random number generator.
@@ -322,7 +322,7 @@
<method name="rand_seed">
<return type="Array">
</return>
- <argument index="0" name="seed" type="float">
+ <argument index="0" name="seed" type="int">
</argument>
<description>
Random from seed, pass a seed and an array with both number and new seed is returned.
@@ -804,10 +804,10 @@
Backspace Key
</constant>
<constant name="KEY_RETURN" value="16777221">
- Return Key
+ Return Key (On Main Keyboard)
</constant>
<constant name="KEY_ENTER" value="16777222">
- Enter Key
+ Enter Key (On Numpad)
</constant>
<constant name="KEY_INSERT" value="16777223">
Insert Key
@@ -6883,6 +6883,12 @@
Return a rect containing the editable contents of the item.
</description>
</method>
+ <method name="get_item_and_children_rect" qualifiers="const">
+ <return type="Rect2">
+ </return>
+ <description>
+ </description>
+ </method>
<method name="get_canvas_item" qualifiers="const">
<return type="RID">
</return>
@@ -8453,7 +8459,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
- Resize the array.
+ Set the size of the [ColorArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
</description>
</method>
<method name="set">
@@ -8462,7 +8468,7 @@
<argument index="1" name="color" type="Color">
</argument>
<description>
- Set an index in the array.
+ Change the [Color] at the given index.
</description>
</method>
<method name="size">
@@ -12289,8 +12295,27 @@ This approximation makes straight segments between each point, then subdivides t
</class>
<class name="File" inherits="Reference" category="Core">
<brief_description>
+ Type to handle file reading and writing operations.
</brief_description>
<description>
+ File type. This is used to permanently store data into the user device's file system and to read from it. This can be used to store game save data or player configuration files, for example.
+
+ Here's a sample on how to write and read from a file:
+
+ [codeblock]
+ func save(content):
+ var file = File.new()
+ file.open("user://save_game.dat", file.WRITE)
+ file.store_string(content)
+ file.close()
+
+ func load():
+ var file = File.new()
+ file.open("user://save_game.dat", file.READ)
+ var content = file.get_as_text()
+ file.close()
+ return content
+ [/codeblock]
</description>
<methods>
<method name="open_encrypted">
@@ -12303,6 +12328,7 @@ This approximation makes straight segments between each point, then subdivides t
<argument index="2" name="key" type="RawArray">
</argument>
<description>
+ Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
</description>
</method>
<method name="open_encrypted_with_pass">
@@ -12315,6 +12341,7 @@ This approximation makes straight segments between each point, then subdivides t
<argument index="2" name="pass" type="String">
</argument>
<description>
+ Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
</description>
</method>
<method name="open">
@@ -12325,88 +12352,103 @@ This approximation makes straight segments between each point, then subdivides t
<argument index="1" name="flags" type="int">
</argument>
<description>
+ Open the file for writing or reading, depending on the flags.
</description>
</method>
<method name="close">
<description>
+ Close the currently opened file.
</description>
</method>
<method name="is_open" qualifiers="const">
<return type="bool">
</return>
<description>
+ Return whether the file is currently opened.
</description>
</method>
<method name="seek">
<argument index="0" name="pos" type="int">
</argument>
<description>
+ Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file).
</description>
</method>
<method name="seek_end">
<argument index="0" name="pos" type="int" default="0">
</argument>
<description>
+ Change the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file.
</description>
</method>
<method name="get_pos" qualifiers="const">
<return type="int">
</return>
<description>
+ Return the file cursor position.
</description>
</method>
<method name="get_len" qualifiers="const">
<return type="int">
</return>
<description>
+ Return the size of the file in bytes.
</description>
</method>
<method name="eof_reached" qualifiers="const">
<return type="bool">
</return>
<description>
+ Return whether the file cursor reached the end of the file.
</description>
</method>
<method name="get_8" qualifiers="const">
<return type="int">
</return>
<description>
+ Get the next 8 bits from the file as an integer.
</description>
</method>
<method name="get_16" qualifiers="const">
<return type="int">
</return>
<description>
+ Get the next 16 bits from the file as an integer.
</description>
</method>
<method name="get_32" qualifiers="const">
<return type="int">
</return>
<description>
+ Get the next 32 bits from the file as an integer.
</description>
</method>
<method name="get_64" qualifiers="const">
<return type="int">
</return>
<description>
+ Get the next 64 bits from the file as an integer.
</description>
</method>
<method name="get_float" qualifiers="const">
<return type="float">
</return>
<description>
+ Get the next 32 bits from the file as a floating point number.
</description>
</method>
<method name="get_double" qualifiers="const">
<return type="float">
</return>
<description>
+ Get the next 64 bits from the file as a floating point number.
</description>
</method>
<method name="get_real" qualifiers="const">
<return type="float">
</return>
<description>
+ Get the next bits from the file as a floating point number.
</description>
</method>
<method name="get_buffer" qualifiers="const">
@@ -12415,18 +12457,21 @@ This approximation makes straight segments between each point, then subdivides t
<argument index="0" name="len" type="int">
</argument>
<description>
+ Get next len bytes of the file as a [RawArray].
</description>
</method>
<method name="get_line" qualifiers="const">
<return type="String">
</return>
<description>
+ Get the next line of the file as a [String].
</description>
</method>
<method name="get_as_text" qualifiers="const">
<return type="String">
</return>
<description>
+ Get the whole file as a [String].
</description>
</method>
<method name="get_md5" qualifiers="const">
@@ -12435,30 +12480,44 @@ This approximation makes straight segments between each point, then subdivides t
<argument index="0" name="path" type="String">
</argument>
<description>
- Returns on success, a md5 String representing the file of the given path.
- else, empty String "".
+ Return a md5 String representing the file at the given path or an empty [String] on failure.
+ </description>
+ </method>
+ <method name="get_sha256" qualifiers="const">
+ <return type="String">
+ </return>
+ <argument index="0" name="path" type="String">
+ </argument>
+ <description>
+ Return a sha256 String representing the file at the given path or an empty [String] on failure.
</description>
</method>
<method name="get_endian_swap">
<return type="bool">
</return>
<description>
+ Get whether endian swap is enabled for this file.
</description>
</method>
<method name="set_endian_swap">
<argument index="0" name="enable" type="bool">
</argument>
<description>
+ Set whether to swap the endianess of the file. Enable this if you're dealing with files written in big endian machines.
+
+ Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file.
</description>
</method>
<method name="get_error" qualifiers="const">
<return type="Error">
</return>
<description>
+ Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope].
</description>
</method>
<method name="get_var" qualifiers="const">
<description>
+ Get the next Variant value from the file.
</description>
</method>
<method name="get_csv_line" qualifiers="const">
@@ -12467,84 +12526,98 @@ This approximation makes straight segments between each point, then subdivides t
<argument index="0" name="delim" type="String" default="&quot;,&quot;">
</argument>
<description>
+ Get the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma).
</description>
</method>
<method name="store_8">
<argument index="0" name="value" type="int">
</argument>
<description>
+ Store an integer as 8 bits in the file.
</description>
</method>
<method name="store_16">
<argument index="0" name="value" type="int">
</argument>
<description>
+ Store an integer as 16 bits in the file.
</description>
</method>
<method name="store_32">
<argument index="0" name="value" type="int">
</argument>
<description>
+ Store an integer as 32 bits in the file.
</description>
</method>
<method name="store_64">
<argument index="0" name="value" type="int">
</argument>
<description>
+ Store an integer as 64 bits in the file.
</description>
</method>
<method name="store_float">
<argument index="0" name="value" type="float">
</argument>
<description>
+ Store a floating point number as 32 bits in the file.
</description>
</method>
<method name="store_double">
<argument index="0" name="value" type="float">
</argument>
<description>
+ Store a floating point number as 64 bits in the file.
</description>
</method>
<method name="store_real">
<argument index="0" name="value" type="float">
</argument>
<description>
+ Store a floating point number in the file.
</description>
</method>
<method name="store_buffer">
<argument index="0" name="buffer" type="RawArray">
</argument>
<description>
+ Store the given array of bytes in the file.
</description>
</method>
<method name="store_line">
<argument index="0" name="line" type="String">
</argument>
<description>
+ Store the given [String] as a line in the file.
</description>
</method>
<method name="store_string">
<argument index="0" name="string" type="String">
</argument>
<description>
+ Store the given [String] in the file.
</description>
</method>
<method name="store_var">
<argument index="0" name="value" type="Variant">
</argument>
<description>
+ Store any Variant value in the file.
</description>
</method>
<method name="store_pascal_string">
<argument index="0" name="string" type="String">
</argument>
<description>
+ Store the given [String] as a line in the file in Pascal format (i.e. also store the length of the string).
</description>
</method>
<method name="get_pascal_string">
<return type="String">
</return>
<description>
+ Get a [String] saved in Pascal format from the file.
</description>
</method>
<method name="file_exists" qualifiers="const">
@@ -12553,17 +12626,22 @@ This approximation makes straight segments between each point, then subdivides t
<argument index="0" name="path" type="String">
</argument>
<description>
+ Get whether or not the file in the specified path exists.
</description>
</method>
</methods>
<constants>
<constant name="READ" value="1">
+ Open the file for reading.
</constant>
<constant name="WRITE" value="2">
+ Open the file for writing. Create it if the file not exists and truncate if it exists.
</constant>
<constant name="READ_WRITE" value="3">
+ Open the file for reading and writing, without truncating the file.
</constant>
<constant name="WRITE_READ" value="7">
+ Open the file for reading and writing. Create it if the file not exists and truncate if it exists.
</constant>
</constants>
</class>
@@ -15837,6 +15915,27 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<description>
Returns the duration of the current vibration effect in seconds.
</description>
+ </method>
+ <method name="start_joy_vibration">
+ <argument index="0" name="device" type="int">
+ </argument>
+ <argument index="1" name="weak_magnitude" type="float">
+ </argument>
+ <argument index="2" name="strong_magnitude" type="float">
+ </argument>
+ <argument index="3" name="duration" type="float">
+ </argument>
+ <description>
+ Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will play the vibration indefinitely).
+ </description>
+ </method>
+ <method name="stop_joy_vibration">
+ <argument index="0" name="device" type="int">
+ </argument>
+ <description>
+ Stops the vibration of the joystick.
+ </description>
+ </method>
<method name="get_accelerometer">
<return type="Vector3">
</return>
@@ -15879,26 +15978,6 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
Return the mouse mode. See the constants for more information.
</description>
</method>
- <method name="start_joy_vibration">
- <argument index="0" name="device" type="int">
- </argument>
- <argument index="1" name="weak_magnitude" type="float">
- </argument>
- <argument index="2" name="strong_magnitude" type="float">
- </argument>
- <argument index="3" name="duration" type="float">
- </argument>
- <description>
- Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will play the vibration indefinitely).
- </description>
- </method>
- <method name="stop_joy_vibration">
- <argument index="0" name="device" type="int">
- </argument>
- <description>
- Stops the vibration of the joystick.
- </description>
- </method>
<method name="warp_mouse_pos">
<argument index="0" name="to" type="Vector2">
</argument>
@@ -16966,7 +17045,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<argument index="0" name="idx" type="int">
</argument>
<description>
- Resize the array.
+ Set the size of the [IntArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
</description>
</method>
<method name="set">
@@ -16975,7 +17054,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<argument index="1" name="integer" type="int">
</argument>
<description>
- Set an index in the array.
+ Change the int at the given index.
</description>
</method>
<method name="size">
@@ -20485,22 +20564,27 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
</class>
<class name="Mutex" inherits="Reference" category="Core">
<brief_description>
+ A synchronization Mutex.
</brief_description>
<description>
+ A synchronization Mutex. Element used in multi-threadding. Basically a binary [Semaphore]. Guarantees that only one thread has this lock, can be used to protect a critical section.
</description>
<methods>
<method name="lock">
<description>
+ Lock this [Mutex], blocks until it is unlocked by the current owner.
</description>
</method>
<method name="try_lock">
<return type="Error">
</return>
<description>
+ Try locking this [Mutex], does not block. Returns [OK] on success else [ERR_BUSY].
</description>
</method>
<method name="unlock">
<description>
+ Unlock this [Mutex], leaving it to others threads.
</description>
</method>
</methods>
@@ -23471,7 +23555,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
</description>
<methods>
<method name="get_var" qualifiers="const">
+ <return type="Variant">
+ </return>
<description>
+ Get a Variant.
</description>
</method>
<method name="put_var">
@@ -23480,12 +23567,14 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<argument index="0" name="var" type="Variant">
</argument>
<description>
+ Send a Variant as a packet.
</description>
</method>
<method name="get_packet" qualifiers="const">
<return type="RawArray">
</return>
<description>
+ Get a raw packet.
</description>
</method>
<method name="put_packet">
@@ -23494,18 +23583,21 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<argument index="0" name="buffer" type="RawArray">
</argument>
<description>
+ Send a raw packet.
</description>
</method>
<method name="get_packet_error" qualifiers="const">
<return type="Error">
</return>
<description>
+ Return the error state of the last packet received (via [method get_packet] and [method get_var]).
</description>
</method>
<method name="get_available_packet_count" qualifiers="const">
<return type="int">
</return>
<description>
+ Return the number of packets currently available in the ring-buffer.
</description>
</method>
</methods>
@@ -23533,8 +23625,10 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
</class>
<class name="PacketPeerUDP" inherits="PacketPeer" category="Core">
<brief_description>
+ UDP packet peer.
</brief_description>
<description>
+ UDP packet peer. Can be used to send raw UDP packets as well as [Variant]s.
</description>
<methods>
<method name="listen">
@@ -23545,40 +23639,47 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<argument index="1" name="recv_buf_size" type="int" default="65536">
</argument>
<description>
+ Make this [PacketPeerUDP] listen on the "port" using a buffer size "recv_buf_size". Listens on all available adresses.
</description>
</method>
<method name="close">
<description>
+ Close the UDP socket the [PacketPeerUDP] is currently listening on.
</description>
</method>
<method name="wait">
<return type="Error">
</return>
<description>
+ Wait for a packet to arrive on the listening port, see [method listen].
</description>
</method>
<method name="is_listening" qualifiers="const">
<return type="bool">
</return>
<description>
+ Return whether this [PacketPeerUDP] is listening.
</description>
</method>
<method name="get_packet_ip" qualifiers="const">
<return type="String">
</return>
<description>
+ Return the IP of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]).
</description>
</method>
<method name="get_packet_address" qualifiers="const">
<return type="int">
</return>
<description>
+ Return the address of the remote peer(as a 32bit integer) that sent the last packet(that was received with [method get_packet] or [method get_var]).
</description>
</method>
<method name="get_packet_port" qualifiers="const">
<return type="int">
</return>
<description>
+ Return the port of the remote peer that sent the last packet(that was received with [method get_packet] or [method get_var]).
</description>
</method>
<method name="set_send_address">
@@ -23589,6 +23690,7 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<argument index="1" name="port" type="int">
</argument>
<description>
+ Set the destination address and port for sending packets and variables, a hostname will be resolved if valid.
</description>
</method>
</methods>
@@ -29964,12 +30066,14 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="byte" type="int">
</argument>
<description>
+ Append an element at the end of the array.
</description>
</method>
<method name="resize">
<argument index="0" name="idx" type="int">
</argument>
<description>
+ Set the size of the [RawArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
</description>
</method>
<method name="set">
@@ -29978,12 +30082,14 @@ This method controls whether the position between two cached points is interpola
<argument index="1" name="byte" type="int">
</argument>
<description>
+ Change the byte at the given index.
</description>
</method>
<method name="size">
<return type="int">
</return>
<description>
+ Return the size of the array.
</description>
</method>
<method name="RawArray">
@@ -29992,6 +30098,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="Array">
</argument>
<description>
+ Create from a generic array.
</description>
</method>
</methods>
@@ -30305,12 +30412,14 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="value" type="float">
</argument>
<description>
+ Append an element at the end of the array.
</description>
</method>
<method name="resize">
<argument index="0" name="idx" type="int">
</argument>
<description>
+ Set the size of the [RealArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
</description>
</method>
<method name="set">
@@ -30319,12 +30428,14 @@ This method controls whether the position between two cached points is interpola
<argument index="1" name="value" type="float">
</argument>
<description>
+ Change the float at the given index.
</description>
</method>
<method name="size">
<return type="int">
</return>
<description>
+ Return the size of the array.
</description>
</method>
<method name="RealArray">
@@ -30333,6 +30444,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="Array">
</argument>
<description>
+ Create from a generic array.
</description>
</method>
</methods>
@@ -33637,20 +33749,24 @@ This method controls whether the position between two cached points is interpola
</class>
<class name="Semaphore" inherits="Reference" category="Core">
<brief_description>
+ A synchronization Semaphore.
</brief_description>
<description>
+ A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation.
</description>
<methods>
<method name="wait">
<return type="Error">
</return>
<description>
+ Tries to wait for the [Semaphore], if it's value is zero, blocks until non-zero.
</description>
</method>
<method name="post">
<return type="Error">
</return>
<description>
+ Lowers the [Semaphore], allowing one more thread in.
</description>
</method>
</methods>
@@ -36779,7 +36895,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="val" type="Variant">
</argument>
<description>
- Put a variable into the stream.
+ Put a Variant into the stream.
</description>
</method>
<method name="get_8">
@@ -36874,7 +36990,7 @@ This method controls whether the position between two cached points is interpola
<return type="Variant">
</return>
<description>
- Get a variable from the stream.
+ Get a Variant from the stream.
</description>
</method>
</methods>
@@ -36925,16 +37041,16 @@ This method controls whether the position between two cached points is interpola
</methods>
<constants>
<constant name="STATUS_DISCONNECTED" value="0">
- A status representing a [StreamPeerSSL] that is disconnected.
+ A status representing a [StreamPeerSSL] that is disconnected.
</constant>
<constant name="STATUS_CONNECTED" value="1">
- A status representing a [StreamPeerSSL] that is connected to a host.
+ A status representing a [StreamPeerSSL] that is connected to a host.
</constant>
<constant name="STATUS_ERROR_NO_CERTIFICATE" value="2">
- An errot status that shows the peer did not present a SSL certificate and validation was requested.
+ An errot status that shows the peer did not present a SSL certificate and validation was requested.
</constant>
<constant name="STATUS_ERROR_HOSTNAME_MISMATCH" value="3">
- An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation.
+ An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation.
</constant>
</constants>
</class>
@@ -36993,16 +37109,16 @@ This method controls whether the position between two cached points is interpola
</methods>
<constants>
<constant name="STATUS_NONE" value="0">
- The initial status of the [StreamPeerTCP], also the status after a disconnect.
+ The initial status of the [StreamPeerTCP], also the status after a disconnect.
</constant>
<constant name="STATUS_CONNECTING" value="1">
- A status representing a [StreamPeerTCP] that is connecting to a host.
+ A status representing a [StreamPeerTCP] that is connecting to a host.
</constant>
<constant name="STATUS_CONNECTED" value="2">
- A status representing a [StreamPeerTCP] that is connected to a host.
+ A status representing a [StreamPeerTCP] that is connected to a host.
</constant>
<constant name="STATUS_ERROR" value="3">
- A staus representing a [StreamPeerTCP] in error state.
+ A staus representing a [StreamPeerTCP] in error state.
</constant>
</constants>
</class>
@@ -37216,6 +37332,13 @@ This method controls whether the position between two cached points is interpola
Return true if the strings begins with the given string.
</description>
</method>
+ <method name="bigrams">
+ <return type="StringArray">
+ </return>
+ <description>
+ Return the bigrams (pairs of consecutive letters) of this string.
+ </description>
+ </method>
<method name="c_escape">
<return type="String">
</return>
@@ -37569,6 +37692,21 @@ This method controls whether the position between two cached points is interpola
Return the right side of the string from a given position.
</description>
</method>
+ <method name="sha256_text">
+ <return type="String">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="similarity">
+ <return type="float">
+ </return>
+ <argument index="0" name="text" type="String">
+ </argument>
+ <description>
+ Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar.
+ </description>
+ </method>
<method name="split">
<return type="StringArray">
</return>
@@ -37692,7 +37830,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="idx" type="int">
</argument>
<description>
- Reset the size of the array.
+ Set the size of the [StringArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
</description>
</method>
<method name="set">
@@ -37701,6 +37839,7 @@ This method controls whether the position between two cached points is interpola
<argument index="1" name="string" type="String">
</argument>
<description>
+ Change the [String] at the given index.
</description>
</method>
<method name="size">
@@ -37716,6 +37855,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="Array">
</argument>
<description>
+ Create from a generic array.
</description>
</method>
</methods>
@@ -39616,8 +39756,10 @@ This method controls whether the position between two cached points is interpola
</class>
<class name="Thread" inherits="Reference" category="Core">
<brief_description>
+ A unit of execution in a process.
</brief_description>
<description>
+ A unit of execution in a process. Can run methods on [Object]s simultaneously. The use of synchronization via [Mutex], [Semaphore] is advised if working with shared objects.
</description>
<methods>
<method name="start">
@@ -39632,24 +39774,29 @@ This method controls whether the position between two cached points is interpola
<argument index="3" name="priority" type="int" default="1">
</argument>
<description>
+ Start a new [Thread], it will run "method" on object "instance" using "userdata" as an argument and running with "priority", one of PRIORITY_* enum.
+ Returns OK on success, or ERR_CANT_CREATE on failure.
</description>
</method>
<method name="get_id" qualifiers="const">
<return type="String">
</return>
<description>
+ Return the id of the thread, uniquely identifying it among all threads.
</description>
</method>
<method name="is_active" qualifiers="const">
<return type="bool">
</return>
<description>
+ Whether this thread is currently active, an active Thread cannot start work on a new method but can be joined with [method wait_to_finish].
</description>
</method>
<method name="wait_to_finish">
<return type="Variant">
</return>
<description>
+ Joins the [Thread] and waits for it to finish. Returns what the method called returned.
</description>
</method>
</methods>
@@ -41152,6 +41299,8 @@ This method controls whether the position between two cached points is interpola
</theme_item>
<theme_item name="hseparation" type="int">
</theme_item>
+ <theme_item name="draw_relationship_lines" type="int">
+ </theme_item>
<theme_item name="button_margin" type="int">
</theme_item>
<theme_item name="title_button_color" type="Color">
@@ -41166,6 +41315,8 @@ This method controls whether the position between two cached points is interpola
</theme_item>
<theme_item name="font_color" type="Color">
</theme_item>
+ <theme_item name="relationship_line_color" type="Color">
+ </theme_item>
<theme_item name="drop_position_color" type="Color">
</theme_item>
<theme_item name="arrow" type="Texture">
@@ -42567,14 +42718,14 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="vector2" type="Vector2">
</argument>
<description>
- Inserts a Vector2 at the end.
+ Insert a [Vector2] at the end.
</description>
</method>
<method name="resize">
<argument index="0" name="idx" type="int">
</argument>
<description>
- Sets the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
+ Set the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
</description>
</method>
<method name="set">
@@ -42583,14 +42734,14 @@ This method controls whether the position between two cached points is interpola
<argument index="1" name="vector2" type="Vector2">
</argument>
<description>
- Changes the Vector2 at the given index.
+ Change the [Vector2] at the given index.
</description>
</method>
<method name="size">
<return type="int">
</return>
<description>
- Returns the size of the array.
+ Return the size of the array.
</description>
</method>
<method name="Vector2Array">
@@ -42599,7 +42750,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="Array">
</argument>
<description>
- Constructs a new Vector2Array. Optionally, you can pass in an Array that will be converted.
+ Construct a new [Vector2Array]. Optionally, you can pass in an Array that will be converted.
</description>
</method>
</methods>
@@ -42826,14 +42977,14 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="vector3" type="Vector3">
</argument>
<description>
- Inserts a Vector3 at the end.
+ Insert a Vector3 at the end.
</description>
</method>
<method name="resize">
<argument index="0" name="idx" type="int">
</argument>
<description>
- Sets the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
+ Set the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
</description>
</method>
<method name="set">
@@ -42842,14 +42993,14 @@ This method controls whether the position between two cached points is interpola
<argument index="1" name="vector3" type="Vector3">
</argument>
<description>
- Changes the Vector3 at the given index.
+ Change the [Vector3] at the given index.
</description>
</method>
<method name="size">
<return type="int">
</return>
<description>
- Returns the size of the array.
+ Return the size of the array.
</description>
</method>
<method name="Vector3Array">
@@ -42858,7 +43009,7 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="from" type="Array">
</argument>
<description>
- Constructs a new Vector3Array. Optionally, you can pass in an Array that will be converted.
+ Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted.
</description>
</method>
</methods>
@@ -42931,7 +43082,7 @@ This method controls whether the position between two cached points is interpola
<description>
</description>
</method>
- <method name="get_linear_velocity">
+ <method name="get_linear_velocity" qualifiers="const">
<return type="Vector3">
</return>
<description>
@@ -45339,7 +45490,7 @@ This method controls whether the position between two cached points is interpola
<description>
</description>
</method>
- <method name="free">
+ <method name="free_rid">
<argument index="0" name="arg0" type="RID">
</argument>
<description>