Make Settings for the individual extensions #234
Conversation
You often don't want to use all the extensions, so this adds project settings to control which extensions are enabled for the addon.
There was a problem hiding this comment.
Thanks!
At a high-level, this is a really great idea! I'll try to test this when I have a moment.
Which Godot versions have you tried it with? I suspect this won't work with Godot 4.3 and earlier, because the ProjectSettings singleton isn't available early enough. PR godotengine/godot#98862 was recently merged to Godot master (and I personally tested it with a use case like your PR :-)), so I think this may need to be Godot 4.4+
UPDATE: Yeah, the CI, which uses Godot 4.3, is spitting out this error message:
ERROR: Failed to retrieve non-existent singleton 'ProjectSettings'.
at: (core/config/engine.cpp:294)
So, this change will be Godot 4.4+ - which is fine, but it's something we need to consider when merging it. The current master here is still compatible with Godot 4.3, but we'll need to switch to 4.4 at some point for some of the new features that are in the works
|
|
||
| ClassDB::register_class<OpenXRFbHandTrackingAimExtensionWrapper>(); | ||
| OpenXRFbHandTrackingAimExtensionWrapper::get_singleton()->register_extension_wrapper(); | ||
| void add_plugin_core_settings() { |
There was a problem hiding this comment.
I think we probably want all these internal functions to be static?
| void add_plugin_core_settings() { | |
| void static add_plugin_core_settings() { |
|
|
||
| ClassDB::register_class<OpenXRFbCompositionLayerSecureContentExtensionWrapper>(); | ||
| OpenXRFbCompositionLayerSecureContentExtensionWrapper::get_singleton()->register_extension_wrapper(); | ||
| void add_plugin_project_settings() { |
There was a problem hiding this comment.
| void add_plugin_project_settings() { | |
| static void add_plugin_project_settings() { |
| if (global_bool_get("xr/openxr/extensions/fb_passthrough")) { | ||
| Engine::get_singleton()->register_singleton("OpenXRFbPassthroughExtensionWrapper", OpenXRFbPassthroughExtensionWrapper::get_singleton()); | ||
| ClassDB::register_class<OpenXRFbPassthroughGeometry>(); | ||
| ClassDB::register_class<OpenXRMetaPassthroughColorLut>(); | ||
| } |
There was a problem hiding this comment.
For the node types, I don't think we should make registering them conditional on the project setting, otherwise you have to restart the Godot editor for the node types to become available to use. So, I think this one, and all the following shouldn't be checking project settings
There may be an argument for always registering the classes for the extension wrappers also (just not calling register_extension_wrapper()), so that the editor is aware that the classes exist, and what their methods are, because a couple of those singletons have public methods.
You often don't want to use all the extensions, so this adds project settings to control which extensions are enabled for the addon.
I've found it useful for my current game.