123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238 |
- This file contains the expected output of --validate-extension-api when run against the extension_api.json of the
- 4.3-stable tag (the basename of this file).
- Only lines that start with "Validate extension JSON:" matter, everything else is considered a comment and ignored. They
- should instead be used to justify these changes and describe how users should work around these changes.
- Add new entries at the end of the file.
- ## Changes between 4.3-stable and 4.4-stable
- GH-95374
- --------
- Validate extension JSON: Error: Field 'classes/ShapeCast2D/properties/collision_result': getter changed value in new API, from "_get_collision_result" to &"get_collision_result".
- Validate extension JSON: Error: Field 'classes/ShapeCast3D/properties/collision_result': getter changed value in new API, from "_get_collision_result" to &"get_collision_result".
- These getters have been renamed to expose them. GDExtension language bindings couldn't have exposed these properties before.
- GH-90993
- --------
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments': size changed value in new API, from 9 to 10.
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/9': type changed value in new API, from "Array" to "int".
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/9': default_value changed value in new API, from "Array[RID]([])" to "0".
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/9': type changed value in new API, from "typedarray::RID" to "int".
- draw_list_begin added a new optional debug argument called breadcrumb.
- There used to be an Array argument as arg #9 initially, then changed to typedarray::RID in 4.1, and finally removed in 4.3.
- Since we're adding a new one at the same location, we need to silence those warnings for 4.1 and 4.3.
- GH-95126
- --------
- Validate extension JSON: Error: Field 'classes/Shader/methods/get_default_texture_parameter/return_value': type changed value in new API, from "Texture2D" to "Texture".
- Validate extension JSON: Error: Field 'classes/Shader/methods/set_default_texture_parameter/arguments/1': type changed value in new API, from "Texture2D" to "Texture".
- Validate extension JSON: Error: Field 'classes/VisualShaderNodeCubemap/methods/get_cube_map/return_value': type changed value in new API, from "Cubemap" to "TextureLayered".
- Validate extension JSON: Error: Field 'classes/VisualShaderNodeCubemap/methods/set_cube_map/arguments/0': type changed value in new API, from "Cubemap" to "TextureLayered".
- Validate extension JSON: Error: Field 'classes/VisualShaderNodeCubemap/properties/cube_map': type changed value in new API, from "Cubemap" to "Cubemap,CompressedCubemap,PlaceholderCubemap,TextureCubemapRD".
- Validate extension JSON: Error: Field 'classes/VisualShaderNodeTexture2DArray/methods/get_texture_array/return_value': type changed value in new API, from "Texture2DArray" to "TextureLayered".
- Validate extension JSON: Error: Field 'classes/VisualShaderNodeTexture2DArray/methods/set_texture_array/arguments/0': type changed value in new API, from "Texture2DArray" to "TextureLayered".
- Validate extension JSON: Error: Field 'classes/VisualShaderNodeTexture2DArray/properties/texture_array': type changed value in new API, from "Texture2DArray" to "Texture2DArray,CompressedTexture2DArray,PlaceholderTexture2DArray,Texture2DArrayRD".
- Allow setting a cubemap as default parameter to shader.
- Compatibility methods registered.
- GH-93605
- --------
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/Semaphore/methods/post': arguments
- Optional arguments added. Compatibility methods registered.
- GH-95212
- --------
- Validate extension JSON: Error: Field 'classes/RegEx/methods/compile/arguments': size changed value in new API, from 1 to 2.
- Validate extension JSON: Error: Field 'classes/RegEx/methods/create_from_string/arguments': size changed value in new API, from 1 to 2.
- Add optional argument to control error printing on compilation fail. Compatibility methods registered.
- GH-95375
- --------
- Validate extension JSON: Error: Field 'classes/AudioStreamPlayer/properties/playing': setter changed value in new API, from "_set_playing" to &"set_playing".
- Validate extension JSON: Error: Field 'classes/AudioStreamPlayer2D/properties/playing': setter changed value in new API, from "_set_playing" to &"set_playing".
- Validate extension JSON: Error: Field 'classes/AudioStreamPlayer3D/properties/playing': setter changed value in new API, from "_set_playing" to &"set_playing".
- These setters have been renamed to expose them. GDExtension language bindings couldn't have exposed these properties before.
- GH-94322
- --------
- Validate extension JSON: Error: Field 'classes/EditorInterface/methods/popup_node_selector/arguments': size changed value in new API, from 2 to 3.
- Validate extension JSON: Error: Field 'classes/EditorInterface/methods/popup_property_selector/arguments': size changed value in new API, from 3 to 4.
- Added optional argument to popup_property_selector and popup_node_selector to specify the current value.
- GH-94434
- --------
- Validate extension JSON: Error: Field 'classes/OS/methods/execute_with_pipe/arguments': size changed value in new API, from 2 to 3.
- Optional argument added. Compatibility method registered.
- GH-94684
- --------
- Validate extension JSON: Error: Field 'classes/SoftBody3D/methods/set_point_pinned/arguments': size changed value in new API, from 3 to 4.
- Optional argument added to allow for adding pin point at specific index. Compatibility method registered.
- GH-97281
- --------
- Validate extension JSON: Error: Field 'classes/InputMap/methods/add_action/arguments/1': default_value changed value in new API, from "0.5" to "0.2".
- Default deadzone value was changed. No adjustments should be necessary.
- Compatibility method registered.
- GH-97020
- --------
- Validate extension JSON: Error: Field 'classes/AnimationNode/methods/_process': is_const changed value in new API, from true to false.
- `_process` virtual method fixed to be non const instead.
- GH-97257
- --------
- Validate extension JSON: Error: Field 'classes/EditorFeatureProfile/enums/Feature/values/FEATURE_MAX': value changed value in new API, from 8.0 to 9.
- New entry to the `EditorFeatureProfile.Feature` enum added. Those need to go before `FEATURE_MAX`, which will always cause a compatibility break.
- GH-91201
- --------
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/OS/methods/read_string_from_stdin': arguments
- Added optional argument. Compatibility method registered.
- GH-98918
- --------
- Validate extension JSON: Error: Field 'classes/FileAccess/methods/open_encrypted/arguments': size changed value in new API, from 3 to 4.
- Optional argument added to allow setting initialization vector. Compatibility method registered.
- GH-98972
- --------
- Validate extension JSON: Error: Field 'classes/TranslationServer/methods/standardize_locale/arguments': size changed value in new API, from 1 to 2.
- Optional argument added. Compatibility method registered.
- GH-99424
- --------
- Validate extension JSON: API was removed: builtin_classes/Projection/constants/PLANE_BOTTOM
- Validate extension JSON: API was removed: builtin_classes/Projection/constants/PLANE_FAR
- Validate extension JSON: API was removed: builtin_classes/Projection/constants/PLANE_LEFT
- Validate extension JSON: API was removed: builtin_classes/Projection/constants/PLANE_NEAR
- Validate extension JSON: API was removed: builtin_classes/Projection/constants/PLANE_RIGHT
- Validate extension JSON: API was removed: builtin_classes/Projection/constants/PLANE_TOP
- Validate extension JSON: API was removed: builtin_classes/Vector2/constants/AXIS_X
- Validate extension JSON: API was removed: builtin_classes/Vector2/constants/AXIS_Y
- Validate extension JSON: API was removed: builtin_classes/Vector2i/constants/AXIS_X
- Validate extension JSON: API was removed: builtin_classes/Vector2i/constants/AXIS_Y
- Validate extension JSON: API was removed: builtin_classes/Vector3/constants/AXIS_X
- Validate extension JSON: API was removed: builtin_classes/Vector3/constants/AXIS_Y
- Validate extension JSON: API was removed: builtin_classes/Vector3/constants/AXIS_Z
- Validate extension JSON: API was removed: builtin_classes/Vector3i/constants/AXIS_X
- Validate extension JSON: API was removed: builtin_classes/Vector3i/constants/AXIS_Y
- Validate extension JSON: API was removed: builtin_classes/Vector3i/constants/AXIS_Z
- Validate extension JSON: API was removed: builtin_classes/Vector4/constants/AXIS_W
- Validate extension JSON: API was removed: builtin_classes/Vector4/constants/AXIS_X
- Validate extension JSON: API was removed: builtin_classes/Vector4/constants/AXIS_Y
- Validate extension JSON: API was removed: builtin_classes/Vector4/constants/AXIS_Z
- Validate extension JSON: API was removed: builtin_classes/Vector4i/constants/AXIS_W
- Validate extension JSON: API was removed: builtin_classes/Vector4i/constants/AXIS_X
- Validate extension JSON: API was removed: builtin_classes/Vector4i/constants/AXIS_Y
- Validate extension JSON: API was removed: builtin_classes/Vector4i/constants/AXIS_Z
- These constants have been replaced with corresponding enum constants.
- GH-98670
- --------
- Validate extension JSON: Error: Field 'classes/RenderSceneBuffersRD/methods/create_texture/arguments': size changed value in new API, from 9 to 10.
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments': size changed value in new API, from 10 to 7.
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments': size changed value in new API, from 9 to 7.
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/1': type changed value in new API, from "enum::RenderingDevice.InitialAction" to "bitfield::RenderingDevice.DrawFlags".
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/2': type changed value in new API, from "enum::RenderingDevice.FinalAction" to "PackedColorArray".
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/3': type changed value in new API, from "enum::RenderingDevice.InitialAction" to "float".
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/4': type changed value in new API, from "enum::RenderingDevice.FinalAction" to "int".
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/5': default_value changed value in new API, from "PackedColorArray()" to "Rect2(0, 0, 0, 0)".
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/5': type changed value in new API, from "PackedColorArray" to "Rect2".
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/6': default_value changed value in new API, from "1.0" to "0".
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/6': meta changed value in new API, from "float" to "uint32".
- Validate extension JSON: Error: Field 'classes/RenderingDevice/methods/draw_list_begin/arguments/6': type changed value in new API, from "float" to "int".
- Draw lists no longer require the initial and final action for color and depth attachments to be specified.
- Draw lists can now specify if a particular color, depth, or stencil attachment should be cleared.
- GH-78289
- --------
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_16': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_32': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_64': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_8': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_buffer': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_csv_line': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_double': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_half': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_float': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_line': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_pascal_string': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_real': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_string': return_value
- Validate extension JSON: JSON file: Field was added in a way that breaks compatibility 'classes/FileAccess/methods/store_var': return_value
- Added return values. Compatibility method registered.
- GH-99481
- --------
- Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/push_meta/arguments': size changed value in new API, from 2 to 3.
- Optional argument added to set tooltip. Compatibility method registered.
- GH-98443
- --------
- Validate extension JSON: Error: Field 'classes/Control/properties/offset_bottom': type changed value in new API, from "int" to "float".
- Validate extension JSON: Error: Field 'classes/Control/properties/offset_left': type changed value in new API, from "int" to "float".
- Validate extension JSON: Error: Field 'classes/Control/properties/offset_right': type changed value in new API, from "int" to "float".
- Validate extension JSON: Error: Field 'classes/Control/properties/offset_top': type changed value in new API, from "int" to "float".
- Property type changed to float to match the actual internal API and documentation.
- GH-100129
- ---------
- Validate extension JSON: Error: Field 'classes/NavigationServer2D/methods/query_path': is_const changed value in new API, from true to false.
- Validate extension JSON: Error: Field 'classes/NavigationServer3D/methods/query_path': is_const changed value in new API, from true to false.
- Validate extension JSON: Error: Field 'classes/NavigationServer2D/methods/query_path/arguments': size changed value in new API, from 2 to 3.
- Validate extension JSON: Error: Field 'classes/NavigationServer3D/methods/query_path/arguments': size changed value in new API, from 2 to 3.
- Validate extension JSON: Error: Field 'classes/NavigationServer2D/methods/map_get_path': is_const changed value in new API, from true to false.
- Validate extension JSON: Error: Field 'classes/NavigationServer3D/methods/map_get_path': is_const changed value in new API, from true to false.
- `query_path` and `map_get_path` methods changed to be non const due to internal compatibility and server changes.
- Added optional callback parameters to `query_path` functions. Compatibility methods registered.
- GH-90057
- --------
- Validate extension JSON: Error: Field 'classes/EditorInterface/methods/open_scene_from_path/arguments': size changed value in new API, from 1 to 2.
- Added optional argument to open_scene_from_path to create a new inherited scene.
- Compatibility method registered.
|