Add SkyMaterial base class

[zhehangd]

Implements godotengine/godot-proposals#11518

CI failed at "Check for GDExtension compatibility". I know it is because it changes inheritance, but what am I suppose to do with this error?

[clayjohn]

CI failed at "Check for GDExtension compatibility". I know it is because it changes inheritance, but what am I suppose to do with this error?

Check out our documentation on handling compatibility breakage https://docs.godotengine.org/en/latest/contributing/development/handling_compatibility_breakages.html

[zhehangd]

CI failed at "Check for GDExtension compatibility". I know it is because it changes inheritance, but what am I suppose to do with this error?

Check out our documentation on handling compatibility breakage https://docs.godotengine.org/en/latest/contributing/development/handling_compatibility_breakages.html

Thanks for the link. But in my case I changed the base class of the three sky material classes to a newly added SkyMaterial class, made Sky accept "SkyMaterial,ShaderMaterial" instead of "ShaderMaterial,PanoramaSkyMaterial,ProceduralSkyMaterial,PhysicalSkyMaterial". It is compatible to the old APIs, but it seems that the validation system detects the change by simply comparsing the strings, it is out of its ability to recognize this change.

Error: Validate extension JSON: Error: Field 'classes/Sky/properties/sky_material': type changed value in new API, from "ShaderMaterial,PanoramaSkyMaterial,ProceduralSkyMaterial,PhysicalSkyMaterial" to "SkyMaterial,ShaderMaterial".

[Calinou]

It is compatible to the old APIs, but it seems that the validation system detects the change by simply comparsing the strings, it is out of its ability to recognize this change.

You need to modify https://github.com/godotengine/godot/blob/8c6dbff6d35eb613c83f065c408a49ab02fa7f67/misc/extension_api_validation/4.3-stable.expected to add the validation error to the list below a new title with the PR number (GH-101292 in this case).

[zhehangd]

You need to modify https://github.com/godotengine/godot/blob/8c6dbff6d35eb613c83f065c408a49ab02fa7f67/misc/extension_api_validation/4.3-stable.expected to add the validation error to the list below a new title with the PR number (GH-101292 in this case).

Thanks. It seems like validate_extension_api.sh compares the result of extension_api.json difference between 4.x and 4.4 and the accumulated records in extension_api_validation/*.expected from 4.0 to 4.x. One probem is that 4.3 changed the order of the types from "ShaderMaterial,PanoramaSkyMaterial,ProceduralSkyMaterial,PhysicalSkyMaterial" to "PanoramaSkyMaterial,ProceduralSkyMaterial,PhysicalSkyMaterial,ShaderMaterial". If I just add

... "PanoramaSkyMaterial,ProceduralSkyMaterial,PhysicalSkyMaterial,ShaderMaterial" to "SkyMaterial,ShaderMaterial".

to 4.3-stable.expected, 4.3 will pass but 4.0 - 4.2 will fail. So I have to write

... "PanoramaSkyMaterial,ProceduralSkyMaterial,PhysicalSkyMaterial,ShaderMaterial" to "SkyMaterial,ShaderMaterial".
... "ShaderMaterial,PanoramaSkyMaterial,ProceduralSkyMaterial,PhysicalSkyMaterial" to "SkyMaterial,ShaderMaterial".

and it seems to work. Is this an appropriate workaround?

[akien-mga]

Yes the workaround you found is the one we use currently in such situations. The validation scripts need some work to better deal with successive compatibility changes.