godot/editor/editor_settings.h

213 lines
8.1 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* editor_settings.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 01:10:30 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
2014-02-10 01:10:30 +00:00
#ifndef EDITOR_SETTINGS_H
#define EDITOR_SETTINGS_H
#include "core/io/config_file.h"
#include "core/io/resource.h"
#include "core/os/thread_safe.h"
2014-02-10 01:10:30 +00:00
class EditorPlugin;
class InputEvent;
class Shortcut;
2014-02-10 01:10:30 +00:00
class EditorSettings : public Resource {
GDCLASS(EditorSettings, Resource);
2014-02-10 01:10:30 +00:00
_THREAD_SAFE_CLASS_
public:
struct Plugin {
EditorPlugin *instance = nullptr;
2014-02-10 01:10:30 +00:00
String path;
String name;
String author;
String version;
String description;
bool installs = false;
2014-02-10 01:10:30 +00:00
String script;
Vector<String> install_files;
};
private:
2014-02-10 01:10:30 +00:00
struct VariantContainer {
int order = 0;
2014-02-10 01:10:30 +00:00
Variant variant;
Variant initial;
bool has_default_value = false;
bool hide_from_editor = false;
bool save = false;
bool restart_if_changed = false;
VariantContainer() {}
VariantContainer(const Variant &p_variant, int p_order) :
order(p_order),
variant(p_variant) {
}
2014-02-10 01:10:30 +00:00
};
static Ref<EditorSettings> singleton;
Set<String> changed_settings;
HashMap<String, PropertyInfo> hints;
HashMap<String, VariantContainer> props;
int last_order;
Ref<Resource> clipboard;
mutable Map<String, Ref<Shortcut>> shortcuts;
Map<String, List<Ref<InputEvent>>> builtin_action_overrides;
2014-02-10 01:10:30 +00:00
String config_file_path;
Vector<String> favorites;
Vector<String> recent_dirs;
2014-02-10 01:10:30 +00:00
bool save_changed_setting;
bool optimize_save; //do not save stuff that came from config but was not set from engine
2018-01-06 11:40:43 +00:00
bool _set(const StringName &p_name, const Variant &p_value);
bool _set_only(const StringName &p_name, const Variant &p_value);
bool _get(const StringName &p_name, Variant &r_ret) const;
void _initial_set(const StringName &p_name, const Variant &p_value);
void _get_property_list(List<PropertyInfo> *p_list) const;
void _add_property_info_bind(const Dictionary &p_info);
void _load_defaults(Ref<ConfigFile> p_extra_config = Ref<ConfigFile>());
void _load_godot2_text_editor_theme();
2016-04-12 14:45:31 +00:00
bool _save_text_editor_theme(String p_file);
2019-06-26 13:08:25 +00:00
bool _is_default_text_editor_theme(String p_theme_name);
2014-02-10 01:10:30 +00:00
protected:
static void _bind_methods();
public:
2014-02-10 01:10:30 +00:00
enum {
NOTIFICATION_EDITOR_SETTINGS_CHANGED = 10000
2014-02-10 01:10:30 +00:00
};
static EditorSettings *get_singleton();
static void create();
void setup_language();
void setup_network();
2014-02-10 01:10:30 +00:00
static void save();
static void destroy();
void set_optimize_save(bool p_optimize);
2014-02-10 01:10:30 +00:00
bool has_default_value(const String &p_setting) const;
void set_setting(const String &p_setting, const Variant &p_value);
Variant get_setting(const String &p_setting) const;
bool has_setting(const String &p_setting) const;
void erase(const String &p_setting);
void raise_order(const String &p_setting);
void set_initial_value(const StringName &p_setting, const Variant &p_value, bool p_update_current = false);
void set_restart_if_changed(const StringName &p_setting, bool p_restart);
void set_manually(const StringName &p_setting, const Variant &p_value, bool p_emit_signal = false) {
if (p_emit_signal) {
2018-01-06 11:40:43 +00:00
_set(p_setting, p_value);
} else {
2018-01-06 11:40:43 +00:00
_set_only(p_setting, p_value);
}
}
bool property_can_revert(const String &p_setting);
Variant property_get_revert(const String &p_setting);
void add_property_hint(const PropertyInfo &p_hint);
Array get_changed_settings() const;
bool check_changed_settings_in_group(const String &p_setting_prefix) const;
void mark_setting_changed(const String &p_setting);
2014-02-10 01:10:30 +00:00
void set_resource_clipboard(const Ref<Resource> &p_resource) { clipboard = p_resource; }
2014-02-10 01:10:30 +00:00
Ref<Resource> get_resource_clipboard() const { return clipboard; }
String get_data_dir() const;
String get_templates_dir() const;
String get_project_settings_dir() const;
String get_text_editor_themes_dir() const;
String get_script_templates_dir() const;
String get_project_script_templates_dir() const;
String get_feature_profiles_dir() const;
void set_project_metadata(const String &p_section, const String &p_key, Variant p_data);
Variant get_project_metadata(const String &p_section, const String &p_key, Variant p_default) const;
2014-02-10 01:10:30 +00:00
void set_favorites(const Vector<String> &p_favorites);
Vector<String> get_favorites() const;
void set_recent_dirs(const Vector<String> &p_recent_dirs);
Vector<String> get_recent_dirs() const;
void load_favorites_and_recent_dirs();
bool is_dark_theme();
2016-04-12 14:45:31 +00:00
void list_text_editor_themes();
void load_text_editor_theme();
bool import_text_editor_theme(String p_file);
bool save_text_editor_theme();
bool save_text_editor_theme_as(String p_file);
bool is_default_text_editor_theme();
2016-04-12 14:45:31 +00:00
Vector<String> get_script_templates(const String &p_extension, const String &p_custom_path = String());
String get_editor_layouts_config() const;
float get_auto_display_scale() const;
void add_shortcut(const String &p_name, Ref<Shortcut> &p_shortcut);
bool is_shortcut(const String &p_name, const Ref<InputEvent> &p_event) const;
Ref<Shortcut> get_shortcut(const String &p_name) const;
void get_shortcut_list(List<String> *r_shortcuts);
void set_builtin_action_override(const String &p_name, const Array &p_events);
const Array get_builtin_action_overrides(const String &p_name) const;
void notify_changes();
2014-02-10 01:10:30 +00:00
EditorSettings();
~EditorSettings();
};
//not a macro any longer
#define EDITOR_DEF(m_var, m_val) _EDITOR_DEF(m_var, Variant(m_val))
#define EDITOR_DEF_RST(m_var, m_val) _EDITOR_DEF(m_var, Variant(m_val), true)
Variant _EDITOR_DEF(const String &p_setting, const Variant &p_default, bool p_restart_if_changed = false);
2014-02-10 01:10:30 +00:00
#define EDITOR_GET(m_var) _EDITOR_GET(m_var)
Variant _EDITOR_GET(const String &p_setting);
#define ED_IS_SHORTCUT(p_name, p_ev) (EditorSettings::get_singleton()->is_shortcut(p_name, p_ev))
2021-08-13 21:31:57 +00:00
Ref<Shortcut> ED_SHORTCUT(const String &p_path, const String &p_name, Key p_keycode = Key::NONE);
Ref<Shortcut> ED_SHORTCUT_ARRAY(const String &p_path, const String &p_name, const PackedInt32Array &p_keycodes);
2021-08-13 21:31:57 +00:00
void ED_SHORTCUT_OVERRIDE(const String &p_path, const String &p_feature, Key p_keycode = Key::NONE);
void ED_SHORTCUT_OVERRIDE_ARRAY(const String &p_path, const String &p_feature, const PackedInt32Array &p_keycodes);
Ref<Shortcut> ED_GET_SHORTCUT(const String &p_path);
2014-02-10 01:10:30 +00:00
#endif // EDITOR_SETTINGS_H