project_settings.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. /*************************************************************************/
  2. /* project_settings.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #ifndef GLOBAL_CONFIG_H
  31. #define GLOBAL_CONFIG_H
  32. #include "core/object.h"
  33. #include "core/os/thread_safe.h"
  34. #include "core/set.h"
  35. /**
  36. @author Juan Linietsky <reduzio@gmail.com>
  37. */
  38. class ProjectSettings : public Object {
  39. GDCLASS(ProjectSettings, Object);
  40. _THREAD_SAFE_CLASS_
  41. public:
  42. typedef Map<String, Variant> CustomMap;
  43. enum {
  44. //properties that are not for built in values begin from this value, so builtin ones are displayed first
  45. NO_BUILTIN_ORDER_BASE = 1 << 16
  46. };
  47. protected:
  48. struct VariantContainer {
  49. int order;
  50. bool persist;
  51. Variant variant;
  52. Variant initial;
  53. bool hide_from_editor;
  54. bool overridden;
  55. bool restart_if_changed;
  56. VariantContainer() :
  57. order(0),
  58. persist(false),
  59. hide_from_editor(false),
  60. overridden(false),
  61. restart_if_changed(false) {
  62. }
  63. VariantContainer(const Variant &p_variant, int p_order, bool p_persist = false) :
  64. order(p_order),
  65. persist(p_persist),
  66. variant(p_variant),
  67. hide_from_editor(false),
  68. overridden(false),
  69. restart_if_changed(false) {
  70. }
  71. };
  72. bool registering_order;
  73. int last_order;
  74. int last_builtin_order;
  75. Map<StringName, VariantContainer> props;
  76. String resource_path;
  77. Map<StringName, PropertyInfo> custom_prop_info;
  78. bool disable_feature_overrides;
  79. bool using_datapack;
  80. List<String> input_presets;
  81. Set<String> custom_features;
  82. Map<StringName, StringName> feature_overrides;
  83. bool _set(const StringName &p_name, const Variant &p_value);
  84. bool _get(const StringName &p_name, Variant &r_ret) const;
  85. void _get_property_list(List<PropertyInfo> *p_list) const;
  86. static ProjectSettings *singleton;
  87. Error _load_settings_text(const String p_path);
  88. Error _load_settings_binary(const String p_path);
  89. Error _load_settings_text_or_binary(const String p_text_path, const String p_bin_path);
  90. Error _save_settings_text(const String &p_file, const Map<String, List<String> > &props, const CustomMap &p_custom = CustomMap(), const String &p_custom_features = String());
  91. Error _save_settings_binary(const String &p_file, const Map<String, List<String> > &props, const CustomMap &p_custom = CustomMap(), const String &p_custom_features = String());
  92. Error _save_custom_bnd(const String &p_file);
  93. void _convert_to_last_version(int p_from_version);
  94. bool _load_resource_pack(const String &p_pack);
  95. void _add_property_info_bind(const Dictionary &p_info);
  96. Error _setup(const String &p_path, const String &p_main_pack, bool p_upwards = false);
  97. protected:
  98. static void _bind_methods();
  99. public:
  100. static const int CONFIG_VERSION = 4;
  101. void set_setting(const String &p_setting, const Variant &p_value);
  102. Variant get_setting(const String &p_setting) const;
  103. bool has_setting(String p_var) const;
  104. String localize_path(const String &p_path) const;
  105. String globalize_path(const String &p_path) const;
  106. void set_initial_value(const String &p_name, const Variant &p_value);
  107. void set_restart_if_changed(const String &p_name, bool p_restart);
  108. bool property_can_revert(const String &p_name);
  109. Variant property_get_revert(const String &p_name);
  110. String get_resource_path() const;
  111. static ProjectSettings *get_singleton();
  112. void clear(const String &p_name);
  113. int get_order(const String &p_name) const;
  114. void set_order(const String &p_name, int p_order);
  115. void set_builtin_order(const String &p_name);
  116. Error setup(const String &p_path, const String &p_main_pack, bool p_upwards = false);
  117. Error save_custom(const String &p_path = "", const CustomMap &p_custom = CustomMap(), const Vector<String> &p_custom_features = Vector<String>(), bool p_merge_with_current = true);
  118. Error save();
  119. void set_custom_property_info(const String &p_prop, const PropertyInfo &p_info);
  120. const Map<StringName, PropertyInfo> &get_custom_property_info() const;
  121. Vector<String> get_optimizer_presets() const;
  122. List<String> get_input_presets() const { return input_presets; }
  123. void set_disable_feature_overrides(bool p_disable);
  124. bool is_using_datapack() const;
  125. void set_registering_order(bool p_enable);
  126. bool has_custom_feature(const String &p_feature) const;
  127. ProjectSettings();
  128. ~ProjectSettings();
  129. };
  130. //not a macro any longer
  131. Variant _GLOBAL_DEF(const String &p_var, const Variant &p_default, bool p_restart_if_changed = false);
  132. #define GLOBAL_DEF(m_var, m_value) _GLOBAL_DEF(m_var, m_value)
  133. #define GLOBAL_DEF_RST(m_var, m_value) _GLOBAL_DEF(m_var, m_value, true)
  134. #define GLOBAL_GET(m_var) ProjectSettings::get_singleton()->get(m_var)
  135. #endif