Tracking issue for builtin feature-completeness

[lilizoey]

More detailed breakdown of the builtin types than present in #24.

Similar to #209 and #143, there are more builtins missing functions, here's a list of our progress when it comes to implementing all functionality.

The missing functionality here is largely going to be easy to reimplement, unless otherwise specified. We should try to reimplement what we can in rust, but for many types (like for instance the stringy types) it's likely not going to be very easy to do so. In those cases we can simply make a wrapper around a call to the InnerX type, (for instance InnerGString for GString). Which simply makes a call to godot to call that function.

For anything labelled ❔ it would be good to check if all the godot methods are implemented yet. Feel free to leave a comment on this post if you do. Keep in mind that not everything is directly implemented as a method in rust, some things for instance are trait implementations, for instance Projection(Transform3D from) was reimplemented as a impl From<Transform3D> for Projection { .. }.

Legend

🟥 bare-bones, missing almost everything
🟡 most functions re-implemented
💚 all planned functions re-implemented, (could still mean there are QOL things we could add)
🚧 work already in progress
❔ to be confirmed if everything is re-implemented

Stringy Types

• GString 💚 Tracking issue for builtin feature-completeness #310 (comment)
• StringName 💚 Tracking issue for builtin feature-completeness #310 (comment)
• NodePath 💚

Bounding Boxes

• Aabb 💚 Reimplemented Aabb.rs in godot-core/src/builtin #280
• Rect2 💚 Reimplement Rect2 functions #242
• Rect2i 💚

Matrices

• Basis 💚 Implement the matrix types #124
• Transform2D 💚 Implement the matrix types #124
• Transform3D 💚 Implement the matrix types #124
• Projection💚 Reimplements Many Projection Methods in Rust #179
  • fovy_of is currently a wrapper around InnerProjection::get_fovy
  • create_fit_aabb, initially not implemented because Aabb wasn't implemented

Vectors

• Vector2 💚
  • missing documentation
  • todo note - compare slerp with gdnative
• Vector2i 💚
• Vector3 💚
  • missing slerp Reimplement slerp on Vector3 #316
• Vector3i 💚
• Vector4 💚
• Vector4i 💚
• snapped for int vectors 🟥

Misc Math

• Plane 💚 godot-core: builtin: reimplement Plane functions/methods #268
• Quaternion 💚 PR #4/5 Astolfo feature/builtin-quaternion #68
  • spherical_cubic_interpolate
  • spherical_cubic_interpolate_in_time

Arrays

• Packed*Array 💚
  • to_byte_array()
  • len() should have a doc-alias for size() Add doc-aliases to functions that have their name changed from godot #232
  • could have FromIterator impl for &T for the copy-arrays
  • validate that functions work as expected, see here
• PackedByteArray 🟡
  • compress/decompress should likely just defer to godot implementation
  • encode_*/decode_* and get_string_from_* can be done through slice(), is this sufficient?
  • has_encoded_var
  • hex_encode

Standard Collections

• Dictionary 🟡
  • Consider whether we should include the read-only semantics with is_read_only() and make_read_only()
• Array 🟡
  • [x]bsearch_custom()
  • sort_custom()
  • Consider whether we should include the read-only semantics with is_read_only() and make_read_only()

Other

• Rid 💚 Implement support for RID #171
• Callable 💚 Add implementation of Callable #231, the unimplemented functionality is currently broken and cannot be used in gdextension
• Signal 💚, not going to be easy to reimplement

[T4rmyn]

I've been checking the vectors and these is what I've found so far:

• Vector2 and Vector3 have little or no documentation on their methods.
• Vector2's methods appears to be complete (there also was a TODO note of slerp to compare with GDNative).
• Vector3 is lacking slerp.
• Vector2i, Vector3i, Vector4, and Vector4i are lacking most of their methods.

[lilizoey]

im working on GodotString and StringName.

[lilizoey]

im working on GodotString and StringName.

I've gotten a bit side-tracked. Feel free to have a look here if someone else wants to continue, https://github.com/lilizoey/gdextension/tree/feature/stringy-types. Though there are some things i'm not sure if should go into a PR as is (like the indexing operators).

[0awful]

Dictionary

Godot Method	Rust Method
clear() -> void (mutates)	clear(&mut self)
duplicate(deep: bool) -> Dictionary	duplicate_deep() -> Dictionary duplicate_shallow() -> Dictionary
erase(key: Variant) -> bool (mutates)	remove<K>(&mut self, key: K) -> Option<Variant>
find_key(value: Variant) -> Variant	find_key_by_value<V>(value: V) -> Option<Variant>
get(key: Variant, default: Optional<Variant>) -> Variant	get<K>(key: K) -> Option<Variant> get_or_nil<K>(k: K) -> Variant
has(key: Variant) -> bool	contains_key<K>(key: K) -> bool
has_all(keys: Array<Variant>) -> bool	contains_all_keys(key: Array<Variant>) -> bool
hash() -> int	hash() -> u32
is_empty() -> bool	is_empty() -> bool
is_read_only() -> bool
keys() -> Array<Variant>	keys_array() -> Array<Variant>
make_read_only() -> void (mutates)
merge(dictionary: Dictionary, overwrites: Optional<bool>) -> void (mutates)	extend_dictionary(&mut self, other: Dictionary, overwrite: bool)
"set" dict[k] = v	set<K, V>(&mut self, key: K, value: V)
size() -> int	len() -> usize
values() -> Array	values_array() -> Array<Variant>
No GDScript Equivalent	insert(&mut self) iter_shared keys_shared

Status

The only functions that aren't present are is_read_only()and make_read_only(). All rust functions have the same mutability rules. Rust has three functions that aren't present in gdscript. Information was compiled from gdscript docs and gdext docs

The only different function is erase(). It has a different return type (Option<Variant>) which conveys all the same information and some. It doesn't make sense to reduce it to mirror gdscript exactly.

Remaining Work

If we believe it is worthwhile to copy the read_only semantics of gdscript, then that is all that remains. If such functionality is not something gdext is interested in then dictionaries are complete.

[0awful]

Array

Godot Method	Rust Method
array[i] -> ?	get(index:usize) -> T
array[i] = V mutates	set(index:usize, value:T) mutates
all(Callable) -> bool
any(Callable) -> bool
append(Variant) -> void mutates	This is an alias of push_back()
append_array(Array) -> void mutates	extend_array(other:Array<T>) mutates
assign(Array) -> void mutates
back() -> Variant	last() -> Option<T>
bsearch(Variant, before=true) -> int	binary_search(v: &T) -> usize
bsearch_custom(Variant, Callable, before=true) -> int
clear() -> void mutates	clear() mutates
count(Variant) -> int	count(V:&T) -> usize
duplicate(deep=false) -> Array	duplicate_shallow() duplicate_deep()
erase(Variant) -> void mutates	erase(v:&T)
fill(Variant) -> void mutates	fill(v:&T)
filter(Callable) -> Array	Iter
find(Variant, from=0) -> int	find(v:&T, from:Option<usize>) -> Option<usize>
front() -> Variant	first() -> Option<T>
get_typed_builtin() -> int
get_typed_class_name() -> StringName
get_typed_script() -> Variant
has(Variant) -> bool	contains(v:&T) -> bool
hash() -> int	hash() -> u32
insert(int, Variant) -> int mutates	insert(index:usize, v:T)
is_empty() -> bool	is_empty() -> bool
is_read_only() -> bool
is_same_typed(Array) -> bool`
is_typed() -> bool
make_read_only() -> void mutates
map(Callable) -> Array	Iter
max() -> Variant	max() -> Option<T>
min() -> Variant	min() -> Option<T>
pick_random() -> Variant	pick_random() -> Option<T>
pop_at(int) -> Variant mutates	remove(index:usize) -> T
pop_back() -> Variant mutates	pop() -> Option<T>
pop_front() -> Variant mutates	pop_front() -> Option<T>
push_back(Variant) -> void mutates	push(v:T)
push_front(Variant) -> void mutates	push_front(v:T)
reduce(Callable, Variant accum=null) -> Variant	Iter
remove_at(int) -> void mutates	remove(index:usize) -> T
resize(int) -> int mutates	resize(size:usize) -> () mutates
reverse() -> void mutates	reverse() -> () mutates
rfind(Variant, int from=-1) -> int	rfind(value:&T, from:Option<usize>) -> Option<usize>
shuffle() -> void mutates	shuffle() mutates
size() -> int	len() -> usize
slice(begin:int, end:int=2147483647, step:int=1, deep:bool=false) -> Array	subarray_shallow(begin: usize, end:usize, step:Option<isize>) subarray_deep(begin: usize, end:usize, step:Option<isize>)
sort() -> void	sort_unstable() mutates
sort_custom(Callable) -> void
No GDScript Equivalent	try_get(index:usize)

Status

Like dictionary there is no is_read_only() and make_read_only().

The "type" methods don't make sense in the context of gdext. Though there are similar things present on variants, so it may be worth bringing it to this level.

all() and any() don't have mirrors within gdext, but can be achieved relatively easily due to the Iter trait. I'm not finding slice() in gdext, though perhaps it is present via a trait. _custom() variants for sort and bsearch don't exist. assign() doesn't have an analogue, but also perhaps shouldn't. assign() doesn't strike me as a very useful method, but maybe my personal belief is irrelevant here.

Remaining Work

slice() bsearch_custom() sort_custom() seem like good candidates.

all() and any() strike me as an example of "won't do". Iter exposes all you need to implement that yourself.

I personally don't see value in assign() but we may want it purely for mirroring gdscript.

I don't know about the typed methods or read_only and would appreciate someone else making a call in that area.

edit: slice() is subarray_shallow() or subarray_deep()