summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-09-25 18:38:17 +0200
committerRémi Verschelde <rverschelde@gmail.com>2023-09-25 18:38:17 +0200
commit9750876d7ab1878c5062a87799e93adeb781286f (patch)
tree8936d81626affbffbfbf7b1b06958902ead46d03
parent82f6e9be5ea06bfef1adb315f15a409939b4a100 (diff)
parent4cdbbfd071924d7ac9ea708819fa71be4a6a8d21 (diff)
downloadredot-engine-9750876d7ab1878c5062a87799e93adeb781286f.tar.gz
Merge pull request #80962 from YuriSizov/godot-the-editor-engine
Differentiate between core and editor-only singletons
-rw-r--r--core/config/engine.cpp30
-rw-r--r--core/config/engine.h6
-rw-r--r--editor/register_editor_types.cpp4
3 files changed, 36 insertions, 4 deletions
diff --git a/core/config/engine.cpp b/core/config/engine.cpp
index 17d3bdb744..0e27d556ec 100644
--- a/core/config/engine.cpp
+++ b/core/config/engine.cpp
@@ -260,14 +260,21 @@ bool Engine::is_printing_error_messages() const {
}
void Engine::add_singleton(const Singleton &p_singleton) {
- ERR_FAIL_COND_MSG(singleton_ptrs.has(p_singleton.name), "Can't register singleton that already exists: " + String(p_singleton.name));
+ ERR_FAIL_COND_MSG(singleton_ptrs.has(p_singleton.name), vformat("Can't register singleton '%s' because it already exists.", p_singleton.name));
singletons.push_back(p_singleton);
singleton_ptrs[p_singleton.name] = p_singleton.ptr;
}
Object *Engine::get_singleton_object(const StringName &p_name) const {
HashMap<StringName, Object *>::ConstIterator E = singleton_ptrs.find(p_name);
- ERR_FAIL_COND_V_MSG(!E, nullptr, "Failed to retrieve non-existent singleton '" + String(p_name) + "'.");
+ ERR_FAIL_COND_V_MSG(!E, nullptr, vformat("Failed to retrieve non-existent singleton '%s'.", p_name));
+
+#ifdef TOOLS_ENABLED
+ if (!is_editor_hint() && is_singleton_editor_only(p_name)) {
+ ERR_FAIL_V_MSG(nullptr, vformat("Can't retrieve singleton '%s' outside of editor.", p_name));
+ }
+#endif
+
return E->value;
}
@@ -282,6 +289,19 @@ bool Engine::is_singleton_user_created(const StringName &p_name) const {
return false;
}
+
+bool Engine::is_singleton_editor_only(const StringName &p_name) const {
+ ERR_FAIL_COND_V(!singleton_ptrs.has(p_name), false);
+
+ for (const Singleton &E : singletons) {
+ if (E.name == p_name && E.editor_only) {
+ return true;
+ }
+ }
+
+ return false;
+}
+
void Engine::remove_singleton(const StringName &p_name) {
ERR_FAIL_COND(!singleton_ptrs.has(p_name));
@@ -300,6 +320,12 @@ bool Engine::has_singleton(const StringName &p_name) const {
void Engine::get_singletons(List<Singleton> *p_singletons) {
for (const Singleton &E : singletons) {
+#ifdef TOOLS_ENABLED
+ if (!is_editor_hint() && E.editor_only) {
+ continue;
+ }
+#endif
+
p_singletons->push_back(E);
}
}
diff --git a/core/config/engine.h b/core/config/engine.h
index ff88fbc787..8184496597 100644
--- a/core/config/engine.h
+++ b/core/config/engine.h
@@ -44,8 +44,11 @@ public:
struct Singleton {
StringName name;
Object *ptr = nullptr;
- StringName class_name; //used for binding generation hinting
+ StringName class_name; // Used for binding generation hinting.
+ // Singleton scope flags.
bool user_created = false;
+ bool editor_only = false;
+
Singleton(const StringName &p_name = StringName(), Object *p_ptr = nullptr, const StringName &p_class_name = StringName());
};
@@ -129,6 +132,7 @@ public:
Object *get_singleton_object(const StringName &p_name) const;
void remove_singleton(const StringName &p_name);
bool is_singleton_user_created(const StringName &p_name) const;
+ bool is_singleton_editor_only(const StringName &p_name) const;
#ifdef TOOLS_ENABLED
_FORCE_INLINE_ void set_editor_hint(bool p_enabled) { editor_hint = p_enabled; }
diff --git a/editor/register_editor_types.cpp b/editor/register_editor_types.cpp
index a636d8c1f2..1e7aabf001 100644
--- a/editor/register_editor_types.cpp
+++ b/editor/register_editor_types.cpp
@@ -278,7 +278,9 @@ void register_editor_types() {
GLOBAL_DEF("editor/version_control/autoload_on_startup", false);
EditorInterface::create();
- Engine::get_singleton()->add_singleton(Engine::Singleton("EditorInterface", EditorInterface::get_singleton()));
+ Engine::Singleton ei_singleton = Engine::Singleton("EditorInterface", EditorInterface::get_singleton());
+ ei_singleton.editor_only = true;
+ Engine::get_singleton()->add_singleton(ei_singleton);
OS::get_singleton()->benchmark_end_measure("register_editor_types");
}