Godot API - gdext API differences

> [!note]
> _Edited by Bromeon to stay up-to-date with progress._
> 
> :construction: actionable to be addressed.
> :white_check_mark: completed.



While scouring for [null related documentation in the Godot API](https://github.com/godot-rust/gdext/pull/883#issuecomment-2331273744), i found some inconsistencies betwen godot and gdext API. Some probably idiomatically better in rust, but I still document them here so we don't lose track. This is not exhaustive because I only found them while searching for "null" in the API
 
# AABB

- :white_check_mark: add method `intersect_ray()`, returning `Option<Vector3>`.
- :white_check_mark: decide if `intersects_ray()` should stay, and if yes, implemented using the above.

Both implemented in #1001.

<details>

**Godot : [Variant](https://docs.godotengine.org/en/4.2/classes/class_variant.html#class-variant) [intersects_ray](https://docs.godotengine.org/en/4.2/classes/class_aabb.html#class-aabb-method-intersects-ray) ( [Vector3](https://docs.godotengine.org/en/4.2/classes/class_vector3.html#class-vector3) from, [Vector3](https://docs.godotengine.org/en/4.2/classes/class_vector3.html#class-vector3) dir ) const** 
Returns the first point where this bounding box and the given ray intersect, as a [Vector3](https://docs.godotengine.org/en/4.2/classes/class_vector3.html#class-vector3). If no intersection occurs, returns `null`. 
The ray begin at `from`, faces `dir` and extends towards infinity.

**gdext : pub fn [intersects_ray](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Aabb.html#method.intersects_ray)(self, from: [Vector3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Vector3.html), dir: [Vector3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Vector3.html "struct godot::builtin::Vector3")) -> [bool](https://doc.rust-lang.org/nightly/std/primitive.bool.html)**
Returns `true` if the given ray intersects with this AABB. Ray length is infinite. 
##### Panics:
If `self.size` is negative.
</details>

---
> **Godot : [Variant](https://docs.godotengine.org/en/4.2/classes/class_variant.html#class-variant) [intersects_segment](https://docs.godotengine.org/en/4.2/classes/class_aabb.html#class-aabb-method-intersects-segment) ( [Vector3](https://docs.godotengine.org/en/4.2/classes/class_vector3.html#class-vector3) from, [Vector3](https://docs.godotengine.org/en/4.2/classes/class_vector3.html#class-vector3) to ) const**
>
> **gdext : pub fn [intersects_segment](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Aabb.html#method.intersects_segment)(self, from: [Vector3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Vector3.html)**
> Returns the first point where this bounding box and the given segment intersect, as a [Vector3](https://docs.godotengine.org/en/4.2/classes/class_vector3.html#class-vector3). If no intersection occurs, returns `null`. The segment begins at `from` and ends at `to`.

 

# Array

> **Godot : [Variant](https://docs.godotengine.org/en/4.2/classes/class_variant.html#class-variant) [get_typed_script](https://docs.godotengine.org/en/4.2/classes/class_array.html#class-array-method-get-typed-script)() const** 
Returns the script associated with the typed array. This method returns a [Script](https://docs.godotengine.org/en/4.2/classes/class_script.html#class-script) instance or `null`.
> **gdext : (missing)**

- :construction: Decide if we need this.

--- 



- :white_check_mark: `pop_at` named as `remove` in Rust is intended and doc-aliased; nothing to do.


<details>
**Godot: [Variant](https://docs.godotengine.org/en/4.2/classes/class_variant.html#class-variant) pop_at ( [int](https://docs.godotengine.org/en/4.2/classes/class_int.html#class-int) position )**
 Removes and returns the element of the array at index `position`. If negative, `position` is considered relative to the end of the array. Leaves the array unchanged and returns `null` if the array is empty or if it's accessed out of bounds. An error message is printed when the array is accessed out of bounds, but not when the array is empty. 
**Note:** On large arrays, this method can be slower than [pop_back](https://docs.godotengine.org/en/4.2/classes/class_array.html#class-array-method-pop-back) as it will reindex the array's elements that are located after the removed element. The larger the array and the lower the index of the removed element, the slower [pop_at](https://docs.godotengine.org/en/4.2/classes/class_array.html#class-array-method-pop-at) will be.

**gdext: pub fn [remove](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Array.html#method.remove)(&mut self, index: [usize](https://doc.rust-lang.org/nightly/std/primitive.usize.html)) -> T**
⚠️ Removes and returns the element at the specified index. Equivalent of `pop_at` in GDScript.
On large arrays, this method is much slower than [`pop()`](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Array.html#method.pop) as it will move all the array’s elements after the removed element. The larger the array, the slower `remove()` will be.
##### Panics
If `index` is out of bounds.
</details>

 

# Dictionary

> :construction: We should add `get_or_add`, maybe check Rust naming.
> 
> **Godot: [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant) [get_or_add](https://docs.godotengine.org/en/4.3/classes/class_dictionary.html#class-dictionary-method-get-or-add)(key: [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant), default: [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant) = null)[](https://docs.godotengine.org/en/4.3/classes/class_dictionary.html#class-dictionary-method-get-or-add)**
> 
> Gets a value and ensures the key is set. If the `key` exists in the dictionary, this behaves like [get](https://docs.godotengine.org/en/4.3/classes/class_dictionary.html#class-dictionary-method-get). Otherwise, the `default` value is inserted into the dictionary and returned.

> **gdext: (missing)**
> (Iride's note: This apparently is new API in 4.3)

 

# PackedByteArray

> (Iride's note: Everything here is missing from gdext)

- :white_check_mark: All `PackedByteArray` methods have been implemented in #994.

<details>

[float](https://docs.godotengine.org/en/4.3/classes/class_float.html#class-float) **decode_double**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-double)

Decodes a 64-bit floating-point number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0.0` if a valid number can't be decoded.

---

[float](https://docs.godotengine.org/en/4.3/classes/class_float.html#class-float) **decode_float**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-float)

Decodes a 32-bit floating-point number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0.0` if a valid number can't be decoded.

---

[float](https://docs.godotengine.org/en/4.3/classes/class_float.html#class-float) **decode_half**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-half)

Decodes a 16-bit floating-point number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0.0` if a valid number can't be decoded.

---

[int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) **decode_s8**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-s8)

Decodes a 8-bit signed integer number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0` if a valid number can't be decoded.

---

[int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) **decode_s16**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-s16)

Decodes a 16-bit signed integer number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0` if a valid number can't be decoded.

---

[int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) **decode_s32**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-s32)

Decodes a 32-bit signed integer number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0` if a valid number can't be decoded.

---

[int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) **decode_s64**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-s64)

Decodes a 64-bit signed integer number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0` if a valid number can't be decoded.

---

[int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) **decode_u8**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-u8)

Decodes a 8-bit unsigned integer number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0` if a valid number can't be decoded.

---

[int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) **decode_u16**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-u16)

Decodes a 16-bit unsigned integer number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0` if a valid number can't be decoded.

---

[int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) **decode_u32**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-u32)

Decodes a 32-bit unsigned integer number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0` if a valid number can't be decoded.

---

[int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) **decode_u64**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int)) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-u64)

Decodes a 64-bit unsigned integer number from the bytes starting at `byte_offset`. Fails if the byte count is insufficient. Returns `0` if a valid number can't be decoded.

---

[Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant) **decode_var**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), allow_objects: [bool](https://docs.godotengine.org/en/4.3/classes/class_bool.html#class-bool) = false) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-var)

Decodes a [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant) from the bytes starting at `byte_offset`. Returns `null` if a valid variant can't be decoded or the value is [Object](https://docs.godotengine.org/en/4.3/classes/class_object.html#class-object)-derived and `allow_objects` is `false`.

---

[int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) **decode_var_size**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), allow_objects: [bool](https://docs.godotengine.org/en/4.3/classes/class_bool.html#class-bool) = false) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decode-var-size)

Decodes a size of a [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant) from the bytes starting at `byte_offset`. Requires at least 4 bytes of data starting at the offset, otherwise fails.

---

[PackedByteArray](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray) **decompress**(buffer_size: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), compression_mode: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) = 0) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decompress)

Returns a new **PackedByteArray** with the data decompressed. Set `buffer_size` to the size of the uncompressed data. Set the compression mode using one of [CompressionMode](https://docs.godotengine.org/en/4.3/classes/class_fileaccess.html#enum-fileaccess-compressionmode)'s constants.

**Note:** Decompression is not guaranteed to work with data not compressed by Godot, for example if data compressed with the deflate compression mode lacks a checksum or header.

---

[PackedByteArray](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray) **decompress_dynamic**(max_output_size: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), compression_mode: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) = 0) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decompress-dynamic)

Returns a new **PackedByteArray** with the data decompressed. Set the compression mode using one of [CompressionMode](https://docs.godotengine.org/en/4.3/classes/class_fileaccess.html#enum-fileaccess-compressionmode)'s constants. **This method only accepts brotli, gzip, and deflate compression modes.**

This method is potentially slower than [decompress](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decompress), as it may have to re-allocate its output buffer multiple times while decompressing, whereas [decompress](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-decompress) knows it's output buffer size from the beginning.

GZIP has a maximal compression ratio of 1032:1, meaning it's very possible for a small compressed payload to decompress to a potentially very large output. To guard against this, you may provide a maximum size this function is allowed to allocate in bytes via `max_output_size`. Passing -1 will allow for unbounded output. If any positive value is passed, and the decompression exceeds that amount in bytes, then an error will be returned.

**Note:** Decompression is not guaranteed to work with data not compressed by Godot, for example if data compressed with the deflate compression mode lacks a checksum or header.

---

void **encode_double**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [float](https://docs.godotengine.org/en/4.3/classes/class_float.html#class-float))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-double)

Encodes a 64-bit floating-point number as bytes at the index of `byte_offset` bytes. The array must have at least 8 bytes of allocated space, starting at the offset.

---

void **encode_float**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [float](https://docs.godotengine.org/en/4.3/classes/class_float.html#class-float))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-float)

Encodes a 32-bit floating-point number as bytes at the index of `byte_offset` bytes. The array must have at least 4 bytes of space, starting at the offset.

---

void **encode_half**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [float](https://docs.godotengine.org/en/4.3/classes/class_float.html#class-float))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-half)

Encodes a 16-bit floating-point number as bytes at the index of `byte_offset` bytes. The array must have at least 2 bytes of space, starting at the offset.

---

void **encode_s8**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-s8)

Encodes a 8-bit signed integer number (signed byte) at the index of `byte_offset` bytes. The array must have at least 1 byte of space, starting at the offset.

---

void **encode_s16**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-s16)

Encodes a 16-bit signed integer number as bytes at the index of `byte_offset` bytes. The array must have at least 2 bytes of space, starting at the offset.

---

void **encode_s32**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-s32)

Encodes a 32-bit signed integer number as bytes at the index of `byte_offset` bytes. The array must have at least 4 bytes of space, starting at the offset.

---

void **encode_s64**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-s64)

Encodes a 64-bit signed integer number as bytes at the index of `byte_offset` bytes. The array must have at least 8 bytes of space, starting at the offset.

---

void **encode_u8**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-u8)

Encodes a 8-bit unsigned integer number (byte) at the index of `byte_offset` bytes. The array must have at least 1 byte of space, starting at the offset.

---

void **encode_u16**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-u16)

Encodes a 16-bit unsigned integer number as bytes at the index of `byte_offset` bytes. The array must have at least 2 bytes of space, starting at the offset.

---

void **encode_u32**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-u32)

Encodes a 32-bit unsigned integer number as bytes at the index of `byte_offset` bytes. The array must have at least 4 bytes of space, starting at the offset.

---

void **encode_u64**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int))[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-u64)

Encodes a 64-bit unsigned integer number as bytes at the index of `byte_offset` bytes. The array must have at least 8 bytes of space, starting at the offset.

---

[int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int) **encode_var**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), value: [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant), allow_objects: [bool](https://docs.godotengine.org/en/4.3/classes/class_bool.html#class-bool) = false)[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-encode-var)

Encodes a [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant) at the index of `byte_offset` bytes. A sufficient space must be allocated, depending on the encoded variant's size. If `allow_objects` is `false`, [Object](https://docs.godotengine.org/en/4.3/classes/class_object.html#class-object)-derived values are not permitted and will instead be serialized as ID-only.

---
[String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string) **get_string_from_ascii**() const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-get-string-from-ascii)

Converts ASCII/Latin-1 encoded array to [String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string). Fast alternative to [get_string_from_utf8](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-get-string-from-utf8) if the content is ASCII/Latin-1 only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use [get_string_from_utf8](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-get-string-from-utf8). This is the inverse of [String.to_ascii_buffer](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string-method-to-ascii-buffer).

---

[String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string) **get_string_from_utf8**() const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-get-string-from-utf8)

Converts UTF-8 encoded array to [String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string). Slower than [get_string_from_ascii](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-get-string-from-ascii) but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. Returns empty string if source array is not valid UTF-8 string. This is the inverse of [String.to_utf8_buffer](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string-method-to-utf8-buffer).

---

[String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string) **get_string_from_utf16**() const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-get-string-from-utf16)

Converts UTF-16 encoded array to [String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string). If the BOM is missing, system endianness is assumed. Returns empty string if source array is not valid UTF-16 string. This is the inverse of [String.to_utf16_buffer](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string-method-to-utf16-buffer).

---

[String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string) **get_string_from_utf32**() const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-get-string-from-utf32)

Converts UTF-32 encoded array to [String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string). System endianness is assumed. Returns empty string if source array is not valid UTF-32 string. This is the inverse of [String.to_utf32_buffer](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string-method-to-utf32-buffer).

---

[String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string) **get_string_from_wchar**() const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-get-string-from-wchar)

Converts wide character (`wchar_t`, UTF-16 on Windows, UTF-32 on other platforms) encoded array to [String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string). Returns empty string if source array is not valid wide string. This is the inverse of [String.to_wchar_buffer](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string-method-to-wchar-buffer).

[bool](https://docs.godotengine.org/en/4.3/classes/class_bool.html#class-bool) **has_encoded_var**(byte_offset: [int](https://docs.godotengine.org/en/4.3/classes/class_int.html#class-int), allow_objects: [bool](https://docs.godotengine.org/en/4.3/classes/class_bool.html#class-bool) = false) const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-has-encoded-var)

Returns `true` if a valid [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant) value can be decoded at the `byte_offset`. Returns `false` otherwise or when the value is [Object](https://docs.godotengine.org/en/4.3/classes/class_object.html#class-object)-derived and `allow_objects` is `false`.

---

[String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string) **hex_encode**() const[](https://docs.godotengine.org/en/4.3/classes/class_packedbytearray.html#class-packedbytearray-method-hex-encode)

Returns a hexadecimal representation of this array as a [String](https://docs.godotengine.org/en/4.3/classes/class_string.html#class-string).

```gdscript
var array = PackedByteArray([11, 46, 255])
print(array.hex_encode()) # Prints: 0b2eff
```

</details>

 

# Plane

:white_check_mark: Nothing to do; intersection APIs returning `Option<Vector3>` are the optimal design. We need to make others (`Aabb`, maybe rects) consistent with it.


<details>


**Godot: [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant) intersect_3(b: [Plane](https://docs.godotengine.org/en/4.3/classes/class_plane.html#class-plane), c: [Plane](https://docs.godotengine.org/en/4.3/classes/class_plane.html#class-plane)) const[](https://docs.godotengine.org/en/4.3/classes/class_plane.html#class-plane-method-intersect-3)**

Returns the intersection point of the three planes `b`, `c` and this plane. If no intersection is found, `null` is returned.

**gdext: pub fn [intersect_3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Plane.html#method.intersect_3)(self, b: [Plane](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Plane.html ), c: [Plane](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Plane.html )) -> [Option](https://doc.rust-lang.org/nightly/core/option/enum.Option.html)<[Vector3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Vector3.html )>**

Finds the intersection point of three planes.

If no intersection point is found, `None` will be returned.



---

**Godot: [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant) intersects_ray(from: [Vector3](https://docs.godotengine.org/en/4.3/classes/class_vector3.html#class-vector3), dir: [Vector3](https://docs.godotengine.org/en/4.3/classes/class_vector3.html#class-vector3)) const[](https://docs.godotengine.org/en/4.3/classes/class_plane.html#class-plane-method-intersects-ray)**

Returns the intersection point of a ray consisting of the position `from` and the direction normal `dir` with this plane. If no intersection is found, `null` is returned.

 **gdext: pub fn [intersect_ray](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Plane.html#method.intersect_ray)(self, from: [Vector3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Vector3.html), dir: [Vector3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Vector3.html)) -> [Option](https://doc.rust-lang.org/nightly/core/option/enum.Option.html)<[Vector3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Vector3.html)>**

Finds the intersection point of the plane with a ray.

The ray starts at position `from` and has direction vector `dir`, i.e. it is unbounded in one direction.

If no intersection is found (the ray is parallel to the plane or points away from it), `None` will be returned.


---
**Godot : [Variant](https://docs.godotengine.org/en/4.3/classes/class_variant.html#class-variant) intersects_segment(from: [Vector3](https://docs.godotengine.org/en/4.3/classes/class_vector3.html#class-vector3), to: [Vector3](https://docs.godotengine.org/en/4.3/classes/class_vector3.html#class-vector3)) const[](https://docs.godotengine.org/en/4.3/classes/class_plane.html#class-plane-method-intersects-segment)**

Returns the intersection point of a segment from position `from` to position `to` with this plane. If no intersection is found, `null` is returned.

**gdext: pub fn [intersect_segment](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Plane.html#method.intersect_segment)(self, from: [Vector3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Vector3.html "struct godot::builtin::Vector3"), to: [Vector3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Vector3.html)) -> [Option](https://doc.rust-lang.org/nightly/core/option/enum.Option.html)<[Vector3](https://godot-rust.github.io/docs/gdext/master/godot/builtin/struct.Vector3.html )>**

Finds the intersection point of the plane with a line segment.

The segment starts at position ‘from’ and ends at position ‘to’, i.e. it is bounded at two directions.

If no intersection is found (the segment is parallel to the plane or does not intersect it), `None` will be returned.


</details>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Godot API - gdext API differences #887

AABB

Panics:

Array

Panics

Dictionary

PackedByteArray

Plane

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Uh oh!

Godot API - gdext API differences #887

Description

AABB

Panics:

Array

Panics

Dictionary

PackedByteArray

Plane

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions