Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a backwards-compatibility system for GDExtension #76446

Merged

Commits on May 15, 2023

  1. Add a backwards-compatibility system for GDExtension method

    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.
    reduz committed May 15, 2023
    Configuration menu
    Copy the full SHA
    d8078d3 View commit details
    Browse the repository at this point in the history