Skip to content

Latest commit

 

History

History
436 lines (336 loc) · 29 KB

Changelog.md

File metadata and controls

436 lines (336 loc) · 29 KB

Changelog

This document tracks changes of released library versions.

See also Pulse for recent activities.
Cutting-edge API docs of the master branch are available here.

🌊 indicates a breaking change. Deprecations are not marked breaking.

Quick navigation

v0.3.0

31 May 2025

See devlog article for highlights.

🌻 Features

  • Godot 4.4 support (#1065)
  • Type-safe signals
    • 🌊 User-defined signals (#1000)
    • Explicit signal visibility (#1075)
    • Type-safe signals for engine classes (#1111)
    • Inherited typed signals (#1134)
    • emit() now available on inherited symbols + smaller cleanups (#1135)
    • User classes expose typed-signal API even without #[signal] (#1146)
    • Generated emit() functions now take impl AsArg<T> (#1150)
    • Simplify connect* usage (#1152)
    • Clean up ConnectBuilder and some other signal APIs (#1171)
    • ConnectBuilder::connect_*_gd() takes Gd instead of &mut Gd (#1175)
    • Replace macro approach with indirect trait (#1179)
  • Async/await
    • Async Signals (#1043)
    • Allow Gd<T> to be passed as a parameter in async signals (#1091)
    • Prevent signal_future_send_arg_no_panic test from panicking (#1137)
    • Itest runner must call on_finished deferred (#1095)
    • Impl DynamicSend for Array<T> (#1122)
  • Registration
    • 🌊 Add OnEditor<T>, remove impl<T> Export for Gd<T> and DynGd<T, D> (#1051, #1079)
    • Add OnReady::from_loaded() + #[init(load = "PATH")] (#1083)
    • Add support for @experimental and @deprecated attributes for user-generated docs (#1114)
  • Builtin types
    • Callables to builtin methods; Array::bsearch_by, sort_unstable_by (#1064)
    • GString, StringName: add conversions from bytes and C-strings (#1062)
    • Array, Dictionary: add into_read_only() + is_read_only() (#1096)
  • Interface traits
    • Virtual methods can become optional/required/removed in derived classes (#1136)
    • 🌊 Final and non-instantiable classes (#1162)
    • 🌊 Final classes no longer have a I* interface trait (#1182)
  • Support f32 directly in process and physics_process (#1110)

📈 Performance

  • Reduce number of classes in minimal codegen (#1099)
  • Decrease CallError size from 176 to 8 bytes (#1167)

🧹 Quality of life

  • Usability
    • Propagate panics in object constructors to Gd::from_init_fn(), new_gd(), new_alloc() (#1140)
    • 🌊 Correct ConnectFlags classification (enum -> bitfield) (#1002)
    • Bitfields now have |= operator (#1097)
    • Panic handling: thread safety; set hook once and not repeatedly (#1037)
    • Add diagnostic hints for missing ToGodot/FromGodot traits (#1084)
    • bind/bind_mut borrow errors now print previous stacktrace (#1094)
    • Make CollisionShapes ...debug_color methods available in Release builds (#1149)
    • 🌊 Add _rawptr suffix to all unsafe virtual functions (#1174)
    • 🌊 Remove deprecated symbols for v0.3 (#1160)
  • Refactoring
    • Experiment with splitting up signature differently (#1042)
    • XML doc generation: code cleanup (#1077)
    • GodotFfi::variant_type can be constant (#1090)
    • Refactor parsing of #[godot_api] inner attributes (#1154)
    • Adjust test to account for Node::set_name() change (String -> StringName) (#1153)
  • Dependencies, project structure, tooling
    • Move examples out of repository (#1085)
    • Remove paste, simplify plugin macros (#1069)
    • 🌊 Bump MSRV from 1.80 to 1.87 (#1076, #1184)
    • Validate that api-custom is run for Godot Debug binary (#1071)
    • Centralize + update dependencies in workspace Cargo.toml (#1127)
    • 🌊 Reduce number of classes in minimal codegen (#1099)
    • Post Rust 1.86 update: apply clippy lints (#1115)
    • Move itest default feature codegen-full into build script (#1100)

🛠️ Bugfixes

  • WebAssembly
    • Wasm threading fixes (#1093)
    • Remove gensym, fix Wasm class registration (#1092)
    • Undo Wasm threading fix on panic context tracking (#1107)
  • Editor integration
    • Fix editor docs not generating when class itself is undocumented (#1089)
    • Fix crash related to adding EditorPlugin to the editor before all the classes are registered (#1138)
  • Misc
    • 🌊 Callable::from_local_static() now requires Godot 4.4+ (#1029)
    • Masked enums can now be constructed from integers (#1106)
    • Properly set GDExtensionBool is_valid to true in to_string function (#1145)
    • Virtual dispatch: fix incorrect matching of renamed methods (#1173)
  • Tooling workarounds
    • Release job in minimal CI; temporarily work around Godot blocker (#1143)
    • Work around OpenXR* APIs wrongly exposed in release; wider release checks in CI (#1070)
    • Work around ResourceDeepDuplicateMode wrongly marked as an global enum in extension_api.json (#1180)

📚 Documentation

  • Move builtin API design to __docs module (#1063)
  • Regression test for checking if RustCallable is connected to signal (#1068)
  • Describe semantics of base_mut() in docs (#1103)
  • Document DynGd<_, D> type inference (#1142)
  • #[derive(GodotClass)], #[godot_api] docs: replace table of contents with sidebar (#1155)
  • Add rustc-args to package.metadata.docs.rs (#1169)
  • Document runtime class in editor requirement (#1168)
  • Improve signal/async docs (#1184)

v0.2.4

24 February 2025

🌻 Features

  • Support additional doc comment markdown (#1017)
  • Provide safe way for implementing IScriptExtension::instance_has (#1013)
  • Global main thread ID (#1045)
  • Add validate_property virtual func (#1030)

📈 Performance

  • Speed up creating and extending packed arrays from iterators up to 63× (#1023)

🧹 Quality of life

  • Test generation of proc-macro code via declarative macro (#1008)
  • Test: support switching API versions in check.sh (#1016)
  • Support Variant::object_id() for Godot <4.4; add object_id_unchecked() (#1034)
  • Rename Basis + Quaternion methods, closer to Godot (#1035)
  • Compare scripts via object_id (#1036)
  • Add Godot 4.3 to minimal CI (#1044)
  • Add .uid files for GDScript + GDExtension resources; update script cache (#1050)
  • Add #[allow(...)] directives to macro-generated entries (#1049)
  • Clippy: disable excessive operator-precedence lint (#1055)

🛠️ Bugfixes

  • Fix Variant -> Gd conversions not taking into account dead objects (#1033)
  • Fix DynGd<T,D> export, implement proper export for Array<DynGd<T,D>> (#1056)
  • In #[var]s, handle renamed #[func]s (#1019)
  • 🌊 #[signal]: validate that there is no function body (#1032)
  • Disambiguate virtual method calls (#1020)
  • Parse doc strings with litrs (#1015)
  • Register-docs: don't duplicate brief in description (#1053)
  • Move some compile-time validations from godot to godot-ffi (#1058)
  • Clippy: fix "looks like a formatting argument but it is not part of a formatting macro" (#1041)

v0.2.3

30 January 2025

🌻 Features

  • Map Vector2.Axis and Vector2i.Axis to Vector2Axis enum (#1012)
  • Implement Var and Export for DynGd<T, D> (#998)
  • Support associated types in #[godot_dyn] (#1022)
  • Add Aabb::intersect_ray() (#1001)
  • FFI: compatibility layer for virtual methods (#991, #1007)
  • FFI: postinit create, icon paths (#991)

🧹 Quality of life

  • Follow clippy 1.84; limit NodePath::subpath() polyfill again (#1010)
  • Remove dead binding code regarding Godot 4.0 (#1014)
  • API consistency for bounding boxes (#1001)
  • Document and refactor PluginItem related stuff (#1003)

🛠️ Bugfixes

  • Fix nightly compiler warnings about #[cfg(before_api = "4.3")] in the generated #[godot_api] impl (#995)
  • Fix #[derive(Var)] generating incorrect hint_string for enums (#1011)

📚 Documentation

  • Document + test limitations of Callable::from_local_static() (#1004)
  • Document builtin API design (#999)

v0.2.2

31 December 2024

🌻 Features

  • Feature parity with Godot builtin types
  • Support static functions in Callable (#989)
  • Codegen can directly expose Inner* builtin methods (#976)
  • Generate builtin methods with varargs (#977)

🧹 Quality of life

  • More accurately provide spans to errors in the GodotClass macro (#920)
  • Improve some proc-macro attribute error messages (#971)
  • Add required virtual method IScriptInstance::get_doc_class_name() in test (#975)
  • Clean up Callable + tests, fix check.sh test (#990)

📚 Documentation

  • Improve docs in DynGd (re-enrichment) + Cargo features (#969)

v0.2.1

8 December 2024

🌻 Features

  • #[godot_api(secondary)] for multiple impl blocks (#927)
  • DynGd<T, D> smart pointer for Rust-side dynamic dispatch (#953, #958)
  • Callable::from_local_fn() + Callable::from_sync_fn() (#965)
  • Add Variant::object_id() (#914)

🧹 Quality of life

  • #[gdextension] macro: rename entry_point -> entry_symbol and write docs (#959)
  • Use GDExtensionCallableCustomInfo2 instead of deprecated GDExtensionCallableCustomInfo (#952)
  • sys::short_type_name, conversions and relaxed GodotType (#957)
  • Clippy (elided lifetimes) + rustfmt (#956)
  • Add test verifying that custom callables don't crash when Err is returned (#950)
  • Minor signal cleanup; prevent #[signal] from being used in secondary impl blocks (#964)

🛠️ Bugfixes

  • Fix #[godot_dyn] causing error when implemented for two traits (#962)
  • Prevent abort on double-panic if single-threading check fails (#965)

📚 Documentation

  • #[gdextension] macro: rename entry_point -> entry_symbol and write docs (#959)
  • Helpful doc aliases: func, var, init, .. (#960)

v0.2.0

15 November 2024

See devlog article for highlights.

🌻 Features

  • Godot 4.3 support in CI and api-4-3 feature (#859)
  • 🌊 Drop support for Godot 4.0 (#820)
  • 🌊 Ergonomic arguments
    • AsObjectArg trait enabling implicit conversions for object parameters (#800)
    • Pass-by-ref for non-Copy builtins (#900, #906)
    • String argument conversion + AsArg trait (#940)
    • Callable is now passed by-ref (#944)
    • Require AsObjectArg pass-by-ref, consistent with AsArg (#847, #947)
  • Godot docs from RustDoc comments
    • Generate documentation from doc comments (#748)
    • Generate valid XML from doc comments (#861)
    • Include register-docs feature in CI (#819)
  • RPC attributes
    • Add #[rpc] attribute to user-defined functions (#902)
  • Registration APIs
    • 🌊 Add OnReady::node() + #[init(node = "...")] attribute (#807)
    • Support Unicode class names (Godot 4.4+) (#891)
    • Unicode support in ClassName::new_cached(); adjust test (#899)
    • Derive Ord and PartialOrd for ClassName (#928)
    • Implement Debug for InitState and OnReady (#879)
  • Enums
    • #[derive(GodotClass)] enums can now have complex ordinal expressions (#843)
    • Enums can now be bit-combined with known masks (#857)
    • Add as_str and godot_name to non-bitfield enums (#898)
  • Required virtual functions
    • Detect whether virtual functions are required to override (#904)
    • 🌊 Required virtual methods should be required at compile-time (#771)
  • Conversions + operators
    • Implement GodotConvert for Vec<T>, [T; N] and &[T] (#795)
    • Implement From<&[char]> for GString (#862)
    • Add From<[Elem; N]> for Packed Array and Optimize From<Vec<Elem>> (#827)
    • Handle typed array metadata (#855)
    • Vector conversion functions (#824)
    • Add Mul operator for Quaternion + Vector3 (#894)

📈 Performance

  • RawGd: cache pointer to internal storage (#831)
  • ClassName now dynamic and faster (#834)
  • Pass-by-ref for non-Copy builtins (backend) (#906)

🧹 Quality of life

  • Renames and removals
    • 🌊 Remove deprecated symbols from before v0.1 (#808)
    • Deprecate instance utilities in godot::global (#901)
    • Shorten #[init(default = ...)] to #[init(val = ...)] (#844)
    • #[class] attribute: rename hidden -> internal, deprecate editor_plugin (#884)
    • Cleanup around godot::meta argument conversions (#948)
    • Remove to_2d() + to_3d(); clean up ApiParam (#943)
    • 🌊 Simplify property hint APIs (#838)
  • Validation
    • Fix validation for api-* mutual exclusivity (#809)
    • Validate that virtual extension classes require #[class(tool)] (#850)
    • Validate that editor plugin classes require #[class(tool)] (#852)
    • Best-effort checks for Array<Integer> conversions; fix Debug for variants containing typed arrays (#853)
    • 🌊 Disallow Export if class doesn't inherit Node or Resource (#839)
    • 🌊 Validate that Nodes can only be exported from Node-derived classes (#841)
  • CI and tooling
    • Cargo-deny maintenance: update to advisories/licenses v2 (#829)
    • CI runner updates (#941)
    • Skip notify-docs job when running in a fork (#945)
    • Allow manually triggering full-ci workflow (mostly useful for forks) (#933)
  • Code generation and Godot APIs
    • Allow codegen for UniformSetCacheRD for Godot >=4.3 (#816)
    • Enable ResourceLoader::load_threaded_* with experimental-threads (#856)
    • Dependency update, more tests for vector angle functions (#860)
  • Upstream follow-up
    • 🌊 Support GDExtensionScriptInstanceInfo3 in 4.3 (#849)
    • Support meta char16 and char32 (#895)
    • Add GodotConvert impl for *const u8 pointers (#866)
    • Update list of experimental classes (#897)
    • Update hint_string tests to account for Godot 4.4 floats with .0 formatting (#936)
  • Panics
    • Disable panic hooks in Release mode (#889)
    • In debug, include location information in error message on panic (#926)
  • Refactoring
    • Rewrite #[var] + #[export] registration to use type-safe API behind scenes (#840)
    • Get rid of placeholder names like "foo" (#888)

🛠️ Bugfixes

  • Argument passing
    • Set null into Godot Engint APIs nullable parameters as default (#823)
    • Fix Ex* builder parameters: ObjectArg<T> -> impl AsObjectArg<T> (#830)
  • Godot doc generation from RustDoc
    • Fix doc comments not showing up if only some class members are documented (#815)
    • Fix register-docs feature not being tested (#942)
  • Registration
    • Fix Array<T> registered without element type (#836)
    • Virtual methods now take Option<Gd<T>> (unless whitelisted) (#883)
    • Make arrays exportable only when their inner type is exportable (#875)
    • Display script-virtual methods as _method instead of method in Godot docs (#918)
    • Implement the safe_ident strategy for virtual call parameter identifier generation (#822)
  • FFI and memory safety
    • Fix user-after-free in AsObjectArg pass-by-value (in default-param methods) (#846)
    • RawGd::move_return_ptr with PtrcallType::Virtual leaks reference (#848)
    • Don't abort on panic inside Callable (#873)
  • Tooling and dependencies
    • Dev-dependencies are enabling full codegen (#842)
    • OpenXR is not available on Web (#872)
    • Fix enum_test.rs accidentally excluded from itest (#931)
    • Codegen-rustfmt: use 2021 edition (#937)
  • Math
    • Vecor3::sign() gives incorrect results due to i32 conversion (#865)

📚 Documentation

  • Builtin docs (impl blocks, navigation table, link to Godot) (#821)
  • Add docs for #[rpc] (#949)
  • Overview about type conversions (#833)
  • Document godot::meta argument conversions (#948)
  • Add a doc to point users to kwarg builders (#876)
  • Resolve doc warning with global enums (#896)
  • ReadMe update + clippy error (#929)

v0.1.3

22 July 2024

🧹 Quality of life

  • Add helpful error for renamed Wasm module (#799)
  • More thoroughly document unsafe in godot-ffi (#774)

🛠️ Bugfixes

  • Map Vector3i.Axis enum to builtin Vector3Axis (#797)
  • Prevent out! from actually formatting the input if disabled (#801)
  • Disable main_thread_id assertion for Android debug build (#780)
  • GdCell::borrow_mut should block on main thread if shared ref exists (#787)

📚 Documentation

  • Typos + code reordering (#802)
  • Add crates.io ReadMe + docs logo (#804)

v0.1.2

15 July 2024

🌻 Features

  • Add more normalized functions (#761)
  • Add conversion from Vec<$Element> to $PackedArray types (#785)
  • Add snapped to integer vectors (#768)
  • Add determinant to Transform2D (#770)
  • Support #[export(range = (radians_as_degrees, suffix=XX))] (#783)
  • Add support for nothreads Wasm builds (Godot 4.3+) (#794)

🧹 Quality of life

  • Reorder compile errors for #[derive(GodotClass)] (#773)
  • Change Global to use Once (#752)
  • Prevent global CallError tracker from growing indefinitely (#798)

🛠️ Bugfixes

  • Change logic to disable OpenXR for iOS (#781)
  • Pointer is already *const u32 on aarch64 (#788)
  • Handle panics in virtual interface methods (#757)

📚 Documentation

  • Document why Basis columns are a, b, and c (#776)

v0.1.1

24 June 2024

Initial release on crates.io. See devlog article.