mirror of
https://github.com/godotengine/godot.git
synced 2024-11-22 12:12:28 +00:00
d8078d3f4c
This adds a way to ensure that methods that were modified in the Godot API will continue working in older builds of GDExtension even if the new signature is different.
```C++
// New version (changed)
ClassDB::bind_method(D_METHOD("add_sphere","radius","position"),&MyShapes::add_sphere);
// Compatibility version (still available to extensions).
ClassDB::bind_compatibility_method(D_METHOD("add_sphere","radius"),&MyShapes::_compat_add_sphere);
```
**Q**: If I add an extra argument and provide a default value (hence can still be called the same), do I still have to provide the compatibility version?
**A**: Yes, you must still provide a compatibility method. Most language bindings use the raw method pointer to do the call and process the default parameters in the binding language, hence if the actual method signature changes it will no longer work.
**Q**: If I removed a method, can I still bind a compatibility version even though the main method no longer exists?
**A**: Yes, for methods that were removed or renamed, compatibility versions can still be provided.
**Q**: Would it be possible to automate checking that methods were removed by mistake?
**A**: Yes, as part of a future PR, the idea is to add a a command line option to Godot that can be run like : `$ godot --test-api-compatibility older_api_dump.json`, which will also be integrated to the CI runs.
|
||
|---|---|---|
| .. | ||
| callable_method_pointer.cpp | ||
| callable_method_pointer.h | ||
| class_db.cpp | ||
| class_db.h | ||
| make_virtuals.py | ||
| message_queue.cpp | ||
| message_queue.h | ||
| method_bind.cpp | ||
| method_bind.h | ||
| object_id.h | ||
| object.cpp | ||
| object.h | ||
| ref_counted.cpp | ||
| ref_counted.h | ||
| script_language_extension.cpp | ||
| script_language_extension.h | ||
| script_language.cpp | ||
| script_language.h | ||
| SCsub | ||
| undo_redo.cpp | ||
| undo_redo.h | ||
| worker_thread_pool.cpp | ||
| worker_thread_pool.h | ||