Experimental support for required parameters/returns in Godot APIs#1383
Merged
Experimental support for required parameters/returns in Godot APIs#1383
Conversation
7a1fb92 to
e430cce
Compare
|
API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-1383 |
1dfe871 to
765d2a7
Compare
765d2a7 to
096af2e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implements godotengine/godot#86079 in Rust, enabling required parameters and return types.
GDExtension newly advertises information about parameters and return types in engine APIs, which are required, meaning non-null. In Rust, this means we can use
Gd<T>instead ofOption<Gd<T>>, improving type safety and unnecessary unwrapping.The generated code looks as follows:
The upstream PR is not yet merged, but you can test it as follows:
GODOT4_BINenvironment variable to the Godot binary.I gated this functionality behind a new feature
experimental-required-objs, because it's still in flux, and every upstream change becomes breaking. Since I also refactored a few parts in related codegen, I will merge this soon, but the feature should leave existing usage unaffected.Compilation: