project_settings.cpp 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689
  1. /**************************************************************************/
  2. /* project_settings.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  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. #include "project_settings.h"
  31. #include "core/core_bind.h" // For Compression enum.
  32. #include "core/input/input_map.h"
  33. #include "core/io/config_file.h"
  34. #include "core/io/dir_access.h"
  35. #include "core/io/file_access.h"
  36. #include "core/io/file_access_pack.h"
  37. #include "core/io/marshalls.h"
  38. #include "core/io/resource_uid.h"
  39. #include "core/object/script_language.h"
  40. #include "core/templates/rb_set.h"
  41. #include "core/variant/typed_array.h"
  42. #include "core/variant/variant_parser.h"
  43. #include "core/version.h"
  44. #ifdef TOOLS_ENABLED
  45. #include "modules/modules_enabled.gen.h" // For mono.
  46. #endif // TOOLS_ENABLED
  47. const String ProjectSettings::PROJECT_DATA_DIR_NAME_SUFFIX = "godot";
  48. ProjectSettings *ProjectSettings::singleton = nullptr;
  49. ProjectSettings *ProjectSettings::get_singleton() {
  50. return singleton;
  51. }
  52. String ProjectSettings::get_project_data_dir_name() const {
  53. return project_data_dir_name;
  54. }
  55. String ProjectSettings::get_project_data_path() const {
  56. return "res://" + get_project_data_dir_name();
  57. }
  58. String ProjectSettings::get_resource_path() const {
  59. return resource_path;
  60. }
  61. String ProjectSettings::get_imported_files_path() const {
  62. return get_project_data_path().path_join("imported");
  63. }
  64. #ifdef TOOLS_ENABLED
  65. // Returns the features that a project must have when opened with this build of Godot.
  66. // This is used by the project manager to provide the initial_settings for config/features.
  67. const PackedStringArray ProjectSettings::get_required_features() {
  68. PackedStringArray features;
  69. features.append(GODOT_VERSION_BRANCH);
  70. #ifdef REAL_T_IS_DOUBLE
  71. features.append("Double Precision");
  72. #endif
  73. return features;
  74. }
  75. // Returns the features supported by this build of Godot. Includes all required features.
  76. const PackedStringArray ProjectSettings::_get_supported_features() {
  77. PackedStringArray features = get_required_features();
  78. #ifdef MODULE_MONO_ENABLED
  79. features.append("C#");
  80. #endif
  81. // Allow pinning to a specific patch number or build type by marking
  82. // them as supported. They're only used if the user adds them manually.
  83. features.append(GODOT_VERSION_BRANCH "." _MKSTR(GODOT_VERSION_PATCH));
  84. features.append(GODOT_VERSION_FULL_CONFIG);
  85. features.append(GODOT_VERSION_FULL_BUILD);
  86. #ifdef RD_ENABLED
  87. features.append("Forward Plus");
  88. features.append("Mobile");
  89. #endif
  90. #ifdef GLES3_ENABLED
  91. features.append("GL Compatibility");
  92. #endif
  93. return features;
  94. }
  95. // Returns the features that this project needs but this build of Godot lacks.
  96. const PackedStringArray ProjectSettings::get_unsupported_features(const PackedStringArray &p_project_features) {
  97. PackedStringArray unsupported_features;
  98. PackedStringArray supported_features = singleton->_get_supported_features();
  99. for (int i = 0; i < p_project_features.size(); i++) {
  100. if (!supported_features.has(p_project_features[i])) {
  101. // Temporary compatibility code to ease upgrade to 4.0 beta 2+.
  102. if (p_project_features[i].begins_with("Vulkan")) {
  103. continue;
  104. }
  105. unsupported_features.append(p_project_features[i]);
  106. }
  107. }
  108. unsupported_features.sort();
  109. return unsupported_features;
  110. }
  111. // Returns the features that both this project has and this build of Godot has, ensuring required features exist.
  112. const PackedStringArray ProjectSettings::_trim_to_supported_features(const PackedStringArray &p_project_features) {
  113. // Remove unsupported features if present.
  114. PackedStringArray features = PackedStringArray(p_project_features);
  115. PackedStringArray supported_features = _get_supported_features();
  116. for (int i = p_project_features.size() - 1; i > -1; i--) {
  117. if (!supported_features.has(p_project_features[i])) {
  118. features.remove_at(i);
  119. }
  120. }
  121. // Add required features if not present.
  122. PackedStringArray required_features = get_required_features();
  123. for (int i = 0; i < required_features.size(); i++) {
  124. if (!features.has(required_features[i])) {
  125. features.append(required_features[i]);
  126. }
  127. }
  128. features.sort();
  129. return features;
  130. }
  131. #endif // TOOLS_ENABLED
  132. String ProjectSettings::localize_path(const String &p_path) const {
  133. String path = p_path.simplify_path();
  134. if (resource_path.is_empty() || (path.is_absolute_path() && !path.begins_with(resource_path))) {
  135. return path;
  136. }
  137. // Check if we have a special path (like res://) or a protocol identifier.
  138. int p = path.find("://");
  139. bool found = false;
  140. if (p > 0) {
  141. found = true;
  142. for (int i = 0; i < p; i++) {
  143. if (!is_ascii_alphanumeric_char(path[i])) {
  144. found = false;
  145. break;
  146. }
  147. }
  148. }
  149. if (found) {
  150. return path;
  151. }
  152. Ref<DirAccess> dir = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  153. if (dir->change_dir(path) == OK) {
  154. String cwd = dir->get_current_dir();
  155. cwd = cwd.replace_char('\\', '/');
  156. // Ensure that we end with a '/'.
  157. // This is important to ensure that we do not wrongly localize the resource path
  158. // in an absolute path that just happens to contain this string but points to a
  159. // different folder (e.g. "/my/project" as resource_path would be contained in
  160. // "/my/project_data", even though the latter is not part of res://.
  161. // `path_join("")` is an easy way to ensure we have a trailing '/'.
  162. const String res_path = resource_path.path_join("");
  163. // DirAccess::get_current_dir() is not guaranteed to return a path that with a trailing '/',
  164. // so we must make sure we have it as well in order to compare with 'res_path'.
  165. cwd = cwd.path_join("");
  166. if (!cwd.begins_with(res_path)) {
  167. return path;
  168. }
  169. return cwd.replace_first(res_path, "res://");
  170. } else {
  171. int sep = path.rfind_char('/');
  172. if (sep == -1) {
  173. return "res://" + path;
  174. }
  175. String parent = path.substr(0, sep);
  176. String plocal = localize_path(parent);
  177. if (plocal.is_empty()) {
  178. return "";
  179. }
  180. // Only strip the starting '/' from 'path' if its parent ('plocal') ends with '/'
  181. if (plocal[plocal.length() - 1] == '/') {
  182. sep += 1;
  183. }
  184. return plocal + path.substr(sep);
  185. }
  186. }
  187. void ProjectSettings::set_initial_value(const String &p_name, const Variant &p_value) {
  188. ERR_FAIL_COND_MSG(!props.has(p_name), vformat("Request for nonexistent project setting: '%s'.", p_name));
  189. // Duplicate so that if value is array or dictionary, changing the setting will not change the stored initial value.
  190. props[p_name].initial = p_value.duplicate();
  191. }
  192. void ProjectSettings::set_restart_if_changed(const String &p_name, bool p_restart) {
  193. ERR_FAIL_COND_MSG(!props.has(p_name), vformat("Request for nonexistent project setting: '%s'.", p_name));
  194. props[p_name].restart_if_changed = p_restart;
  195. }
  196. void ProjectSettings::set_as_basic(const String &p_name, bool p_basic) {
  197. ERR_FAIL_COND_MSG(!props.has(p_name), vformat("Request for nonexistent project setting: '%s'.", p_name));
  198. props[p_name].basic = p_basic;
  199. }
  200. void ProjectSettings::set_as_internal(const String &p_name, bool p_internal) {
  201. ERR_FAIL_COND_MSG(!props.has(p_name), vformat("Request for nonexistent project setting: '%s'.", p_name));
  202. props[p_name].internal = p_internal;
  203. }
  204. void ProjectSettings::set_ignore_value_in_docs(const String &p_name, bool p_ignore) {
  205. ERR_FAIL_COND_MSG(!props.has(p_name), vformat("Request for nonexistent project setting: '%s'.", p_name));
  206. #ifdef DEBUG_METHODS_ENABLED
  207. props[p_name].ignore_value_in_docs = p_ignore;
  208. #endif
  209. }
  210. bool ProjectSettings::get_ignore_value_in_docs(const String &p_name) const {
  211. ERR_FAIL_COND_V_MSG(!props.has(p_name), false, vformat("Request for nonexistent project setting: '%s'.", p_name));
  212. #ifdef DEBUG_METHODS_ENABLED
  213. return props[p_name].ignore_value_in_docs;
  214. #else
  215. return false;
  216. #endif
  217. }
  218. void ProjectSettings::add_hidden_prefix(const String &p_prefix) {
  219. ERR_FAIL_COND_MSG(hidden_prefixes.has(p_prefix), vformat("Hidden prefix '%s' already exists.", p_prefix));
  220. hidden_prefixes.push_back(p_prefix);
  221. }
  222. String ProjectSettings::globalize_path(const String &p_path) const {
  223. if (p_path.begins_with("res://")) {
  224. if (!resource_path.is_empty()) {
  225. return p_path.replace("res:/", resource_path);
  226. }
  227. return p_path.replace("res://", "");
  228. } else if (p_path.begins_with("uid://")) {
  229. const String path = ResourceUID::uid_to_path(p_path);
  230. if (!resource_path.is_empty()) {
  231. return path.replace("res:/", resource_path);
  232. }
  233. return path.replace("res://", "");
  234. } else if (p_path.begins_with("user://")) {
  235. String data_dir = OS::get_singleton()->get_user_data_dir();
  236. if (!data_dir.is_empty()) {
  237. return p_path.replace("user:/", data_dir);
  238. }
  239. return p_path.replace("user://", "");
  240. }
  241. return p_path;
  242. }
  243. bool ProjectSettings::_set(const StringName &p_name, const Variant &p_value) {
  244. _THREAD_SAFE_METHOD_
  245. if (p_value.get_type() == Variant::NIL) {
  246. props.erase(p_name);
  247. if (p_name.operator String().begins_with("autoload/")) {
  248. String node_name = p_name.operator String().split("/")[1];
  249. if (autoloads.has(node_name)) {
  250. remove_autoload(node_name);
  251. }
  252. } else if (p_name.operator String().begins_with("global_group/")) {
  253. String group_name = p_name.operator String().get_slicec('/', 1);
  254. if (global_groups.has(group_name)) {
  255. remove_global_group(group_name);
  256. }
  257. }
  258. } else {
  259. if (p_name == CoreStringName(_custom_features)) {
  260. Vector<String> custom_feature_array = String(p_value).split(",");
  261. for (int i = 0; i < custom_feature_array.size(); i++) {
  262. custom_features.insert(custom_feature_array[i]);
  263. }
  264. _queue_changed();
  265. return true;
  266. }
  267. { // Feature overrides.
  268. int dot = p_name.operator String().find_char('.');
  269. if (dot != -1) {
  270. Vector<String> s = p_name.operator String().split(".");
  271. for (int i = 1; i < s.size(); i++) {
  272. String feature = s[i].strip_edges();
  273. Pair<StringName, StringName> feature_override(feature, p_name);
  274. if (!feature_overrides.has(s[0])) {
  275. feature_overrides[s[0]] = LocalVector<Pair<StringName, StringName>>();
  276. }
  277. feature_overrides[s[0]].push_back(feature_override);
  278. }
  279. }
  280. }
  281. if (props.has(p_name)) {
  282. props[p_name].variant = p_value;
  283. } else {
  284. props[p_name] = VariantContainer(p_value, last_order++);
  285. }
  286. if (p_name.operator String().begins_with("autoload/")) {
  287. String node_name = p_name.operator String().split("/")[1];
  288. AutoloadInfo autoload;
  289. autoload.name = node_name;
  290. String path = p_value;
  291. if (path.begins_with("*")) {
  292. autoload.is_singleton = true;
  293. autoload.path = path.substr(1).simplify_path();
  294. } else {
  295. autoload.path = path.simplify_path();
  296. }
  297. add_autoload(autoload);
  298. } else if (p_name.operator String().begins_with("global_group/")) {
  299. String group_name = p_name.operator String().get_slicec('/', 1);
  300. add_global_group(group_name, p_value);
  301. }
  302. }
  303. _queue_changed();
  304. return true;
  305. }
  306. bool ProjectSettings::_get(const StringName &p_name, Variant &r_ret) const {
  307. _THREAD_SAFE_METHOD_
  308. if (!props.has(p_name)) {
  309. return false;
  310. }
  311. r_ret = props[p_name].variant;
  312. return true;
  313. }
  314. Variant ProjectSettings::get_setting_with_override_and_custom_features(const StringName &p_name, const Vector<String> &p_features) const {
  315. _THREAD_SAFE_METHOD_
  316. StringName name = p_name;
  317. if (feature_overrides.has(name)) {
  318. const LocalVector<Pair<StringName, StringName>> &overrides = feature_overrides[name];
  319. for (uint32_t i = 0; i < overrides.size(); i++) {
  320. if (p_features.has(String(overrides[i].first).to_lower())) {
  321. if (props.has(overrides[i].second)) {
  322. name = overrides[i].second;
  323. break;
  324. }
  325. }
  326. }
  327. }
  328. if (!props.has(name)) {
  329. WARN_PRINT("Property not found: " + String(name));
  330. return Variant();
  331. }
  332. return props[name].variant;
  333. }
  334. Variant ProjectSettings::get_setting_with_override(const StringName &p_name) const {
  335. _THREAD_SAFE_METHOD_
  336. const LocalVector<Pair<StringName, StringName>> *overrides = feature_overrides.getptr(p_name);
  337. if (overrides) {
  338. for (uint32_t i = 0; i < overrides->size(); i++) {
  339. if (!OS::get_singleton()->has_feature((*overrides)[i].first)) {
  340. continue;
  341. }
  342. // Custom features are checked in OS.has_feature() already. No need to check twice.
  343. const RBMap<StringName, VariantContainer>::Element *override_prop = props.find((*overrides)[i].second);
  344. if (override_prop) {
  345. return override_prop->get().variant;
  346. }
  347. }
  348. }
  349. const RBMap<StringName, VariantContainer>::Element *prop = props.find(p_name);
  350. if (!prop) {
  351. WARN_PRINT(vformat("Property not found: '%s'.", p_name));
  352. return Variant();
  353. }
  354. return prop->get().variant;
  355. }
  356. struct _VCSort {
  357. String name;
  358. Variant::Type type = Variant::VARIANT_MAX;
  359. int order = 0;
  360. uint32_t flags = 0;
  361. bool operator<(const _VCSort &p_vcs) const { return order == p_vcs.order ? name < p_vcs.name : order < p_vcs.order; }
  362. };
  363. void ProjectSettings::_get_property_list(List<PropertyInfo> *p_list) const {
  364. _THREAD_SAFE_METHOD_
  365. RBSet<_VCSort> vclist;
  366. for (const KeyValue<StringName, VariantContainer> &E : props) {
  367. const VariantContainer *v = &E.value;
  368. if (v->hide_from_editor) {
  369. continue;
  370. }
  371. _VCSort vc;
  372. vc.name = E.key;
  373. vc.order = v->order;
  374. vc.type = v->variant.get_type();
  375. bool internal = v->internal;
  376. if (!internal) {
  377. for (const String &F : hidden_prefixes) {
  378. if (vc.name.begins_with(F)) {
  379. internal = true;
  380. break;
  381. }
  382. }
  383. }
  384. if (internal) {
  385. vc.flags = PROPERTY_USAGE_STORAGE;
  386. } else {
  387. vc.flags = PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_STORAGE;
  388. }
  389. if (v->internal) {
  390. vc.flags |= PROPERTY_USAGE_INTERNAL;
  391. }
  392. if (v->basic) {
  393. vc.flags |= PROPERTY_USAGE_EDITOR_BASIC_SETTING;
  394. }
  395. if (v->restart_if_changed) {
  396. vc.flags |= PROPERTY_USAGE_RESTART_IF_CHANGED;
  397. }
  398. vclist.insert(vc);
  399. }
  400. for (const _VCSort &E : vclist) {
  401. String prop_info_name = E.name;
  402. int dot = prop_info_name.find_char('.');
  403. if (dot != -1 && !custom_prop_info.has(prop_info_name)) {
  404. prop_info_name = prop_info_name.substr(0, dot);
  405. }
  406. if (custom_prop_info.has(prop_info_name)) {
  407. PropertyInfo pi = custom_prop_info[prop_info_name];
  408. pi.name = E.name;
  409. pi.usage = E.flags;
  410. p_list->push_back(pi);
  411. } else {
  412. p_list->push_back(PropertyInfo(E.type, E.name, PROPERTY_HINT_NONE, "", E.flags));
  413. }
  414. }
  415. }
  416. void ProjectSettings::_queue_changed() {
  417. if (is_changed || !MessageQueue::get_singleton() || MessageQueue::get_singleton()->get_max_buffer_usage() == 0) {
  418. return;
  419. }
  420. is_changed = true;
  421. callable_mp(this, &ProjectSettings::_emit_changed).call_deferred();
  422. }
  423. void ProjectSettings::_emit_changed() {
  424. if (!is_changed) {
  425. return;
  426. }
  427. is_changed = false;
  428. emit_signal("settings_changed");
  429. }
  430. bool ProjectSettings::load_resource_pack(const String &p_pack, bool p_replace_files, int p_offset) {
  431. return ProjectSettings::_load_resource_pack(p_pack, p_replace_files, p_offset, false);
  432. }
  433. bool ProjectSettings::_load_resource_pack(const String &p_pack, bool p_replace_files, int p_offset, bool p_main_pack) {
  434. if (PackedData::get_singleton()->is_disabled()) {
  435. return false;
  436. }
  437. if (p_pack == "res://") {
  438. // Loading the resource directory as a pack source is reserved for internal use only.
  439. return false;
  440. }
  441. if (!p_main_pack && !using_datapack && !OS::get_singleton()->get_resource_dir().is_empty()) {
  442. // Add the project's resource file system to PackedData so directory access keeps working when
  443. // the game is running without a main pack, like in the editor or on Android.
  444. PackedData::get_singleton()->add_pack_source(memnew(PackedSourceDirectory));
  445. PackedData::get_singleton()->add_pack("res://", false, 0);
  446. DirAccess::make_default<DirAccessPack>(DirAccess::ACCESS_RESOURCES);
  447. using_datapack = true;
  448. }
  449. bool ok = PackedData::get_singleton()->add_pack(p_pack, p_replace_files, p_offset) == OK;
  450. if (!ok) {
  451. return false;
  452. }
  453. if (project_loaded) {
  454. // This pack may have declared new global classes (make sure they are picked up).
  455. refresh_global_class_list();
  456. // This pack may have defined new UIDs, make sure they are cached.
  457. ResourceUID::get_singleton()->load_from_cache(false);
  458. }
  459. // If the data pack was found, all directory access will be from here.
  460. if (!using_datapack) {
  461. DirAccess::make_default<DirAccessPack>(DirAccess::ACCESS_RESOURCES);
  462. using_datapack = true;
  463. }
  464. return true;
  465. }
  466. void ProjectSettings::_convert_to_last_version(int p_from_version) {
  467. #ifndef DISABLE_DEPRECATED
  468. if (p_from_version <= 3) {
  469. // Converts the actions from array to dictionary (array of events to dictionary with deadzone + events)
  470. for (KeyValue<StringName, ProjectSettings::VariantContainer> &E : props) {
  471. Variant value = E.value.variant;
  472. if (String(E.key).begins_with("input/") && value.get_type() == Variant::ARRAY) {
  473. Array array = value;
  474. Dictionary action;
  475. action["deadzone"] = Variant(0.5f);
  476. action["events"] = array;
  477. E.value.variant = action;
  478. }
  479. }
  480. }
  481. #endif // DISABLE_DEPRECATED
  482. }
  483. /*
  484. * This method is responsible for loading a project.godot file and/or data file
  485. * using the following merit order:
  486. * - If using NetworkClient, try to lookup project file or fail.
  487. * - If --main-pack was passed by the user (`p_main_pack`), load it or fail.
  488. * - Search for project PCKs automatically. For each step we try loading a potential
  489. * PCK, and if it doesn't work, we proceed to the next step. If any step succeeds,
  490. * we try loading the project settings, and abort if it fails. Steps:
  491. * o Bundled PCK in the executable.
  492. * o [macOS only] PCK with same basename as the binary in the .app resource dir.
  493. * o PCK with same basename as the binary in the binary's directory. We handle both
  494. * changing the extension to '.pck' (e.g. 'win_game.exe' -> 'win_game.pck') and
  495. * appending '.pck' to the binary name (e.g. 'linux_game' -> 'linux_game.pck').
  496. * o PCK with the same basename as the binary in the current working directory.
  497. * Same as above for the two possible PCK file names.
  498. * - On relevant platforms (Android/iOS), lookup project file in OS resource path.
  499. * If found, load it or fail.
  500. * - Lookup project file in passed `p_path` (--path passed by the user), i.e. we
  501. * are running from source code.
  502. * If not found and `p_upwards` is true (--upwards passed by the user), look for
  503. * project files in parent folders up to the system root (used to run a game
  504. * from command line while in a subfolder).
  505. * If a project file is found, load it or fail.
  506. * If nothing was found, error out.
  507. */
  508. Error ProjectSettings::_setup(const String &p_path, const String &p_main_pack, bool p_upwards, bool p_ignore_override) {
  509. if (!OS::get_singleton()->get_resource_dir().is_empty()) {
  510. // OS will call ProjectSettings->get_resource_path which will be empty if not overridden!
  511. // If the OS would rather use a specific location, then it will not be empty.
  512. resource_path = OS::get_singleton()->get_resource_dir().replace_char('\\', '/');
  513. if (!resource_path.is_empty() && resource_path[resource_path.length() - 1] == '/') {
  514. resource_path = resource_path.substr(0, resource_path.length() - 1); // Chop end.
  515. }
  516. }
  517. // Attempt with a user-defined main pack first
  518. if (!p_main_pack.is_empty()) {
  519. bool ok = _load_resource_pack(p_main_pack, false, 0, true);
  520. ERR_FAIL_COND_V_MSG(!ok, ERR_CANT_OPEN, vformat("Cannot open resource pack '%s'.", p_main_pack));
  521. Error err = _load_settings_text_or_binary("res://project.godot", "res://project.binary");
  522. if (err == OK && !p_ignore_override) {
  523. // Load override from location of the main pack
  524. // Optional, we don't mind if it fails
  525. _load_settings_text(p_main_pack.get_base_dir().path_join("override.cfg"));
  526. }
  527. return err;
  528. }
  529. String exec_path = OS::get_singleton()->get_executable_path();
  530. if (!exec_path.is_empty()) {
  531. // We do several tests sequentially until one succeeds to find a PCK,
  532. // and if so, we attempt loading it at the end.
  533. // Attempt with PCK bundled into executable.
  534. bool found = _load_resource_pack(exec_path, false, 0, true);
  535. // Attempt with exec_name.pck.
  536. // (This is the usual case when distributing a Godot game.)
  537. String exec_dir = exec_path.get_base_dir();
  538. String exec_filename = exec_path.get_file();
  539. String exec_basename = exec_filename.get_basename();
  540. // Based on the OS, it can be the exec path + '.pck' (Linux w/o extension, macOS in .app bundle)
  541. // or the exec path's basename + '.pck' (Windows).
  542. // We need to test both possibilities as extensions for Linux binaries are optional
  543. // (so both 'mygame.bin' and 'mygame' should be able to find 'mygame.pck').
  544. #ifdef MACOS_ENABLED
  545. if (!found) {
  546. // Attempt to load PCK from macOS .app bundle resources.
  547. found = _load_resource_pack(OS::get_singleton()->get_bundle_resource_dir().path_join(exec_basename + ".pck"), false, 0, true) || _load_resource_pack(OS::get_singleton()->get_bundle_resource_dir().path_join(exec_filename + ".pck"), false, 0, true);
  548. }
  549. #endif
  550. if (!found) {
  551. // Try to load data pack at the location of the executable.
  552. // As mentioned above, we have two potential names to attempt.
  553. found = _load_resource_pack(exec_dir.path_join(exec_basename + ".pck"), false, 0, true) || _load_resource_pack(exec_dir.path_join(exec_filename + ".pck"), false, 0, true);
  554. }
  555. if (!found) {
  556. // If we couldn't find them next to the executable, we attempt
  557. // the current working directory. Same story, two tests.
  558. found = _load_resource_pack(exec_basename + ".pck", false, 0, true) || _load_resource_pack(exec_filename + ".pck", false, 0, true);
  559. }
  560. // If we opened our package, try and load our project.
  561. if (found) {
  562. Error err = _load_settings_text_or_binary("res://project.godot", "res://project.binary");
  563. if (err == OK && !p_ignore_override) {
  564. // Load overrides from the PCK and the executable location.
  565. // Optional, we don't mind if either fails.
  566. _load_settings_text("res://override.cfg");
  567. _load_settings_text(exec_path.get_base_dir().path_join("override.cfg"));
  568. }
  569. return err;
  570. }
  571. }
  572. // Try to use the filesystem for files, according to OS.
  573. // (Only Android -when reading from pck- and iOS use this.)
  574. if (!OS::get_singleton()->get_resource_dir().is_empty()) {
  575. Error err = _load_settings_text_or_binary("res://project.godot", "res://project.binary");
  576. if (err == OK && !p_ignore_override) {
  577. // Optional, we don't mind if it fails.
  578. _load_settings_text("res://override.cfg");
  579. }
  580. return err;
  581. }
  582. #ifdef MACOS_ENABLED
  583. // Attempt to load project file from macOS .app bundle resources.
  584. resource_path = OS::get_singleton()->get_bundle_resource_dir();
  585. if (!resource_path.is_empty()) {
  586. if (resource_path[resource_path.length() - 1] == '/') {
  587. resource_path = resource_path.substr(0, resource_path.length() - 1); // Chop end.
  588. }
  589. Ref<DirAccess> d = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  590. ERR_FAIL_COND_V_MSG(d.is_null(), ERR_CANT_CREATE, vformat("Cannot create DirAccess for path '%s'.", resource_path));
  591. d->change_dir(resource_path);
  592. Error err;
  593. err = _load_settings_text_or_binary(resource_path.path_join("project.godot"), resource_path.path_join("project.binary"));
  594. if (err == OK && !p_ignore_override) {
  595. // Optional, we don't mind if it fails.
  596. _load_settings_text(resource_path.path_join("override.cfg"));
  597. return err;
  598. }
  599. }
  600. #endif
  601. // Nothing was found, try to find a project file in provided path (`p_path`)
  602. // or, if requested (`p_upwards`) in parent directories.
  603. Ref<DirAccess> d = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  604. ERR_FAIL_COND_V_MSG(d.is_null(), ERR_CANT_CREATE, vformat("Cannot create DirAccess for path '%s'.", p_path));
  605. d->change_dir(p_path);
  606. String current_dir = d->get_current_dir();
  607. bool found = false;
  608. Error err;
  609. while (true) {
  610. // Set the resource path early so things can be resolved when loading.
  611. resource_path = current_dir;
  612. resource_path = resource_path.replace_char('\\', '/'); // Windows path to Unix path just in case.
  613. err = _load_settings_text_or_binary(current_dir.path_join("project.godot"), current_dir.path_join("project.binary"));
  614. if (err == OK && !p_ignore_override) {
  615. // Optional, we don't mind if it fails.
  616. _load_settings_text(current_dir.path_join("override.cfg"));
  617. found = true;
  618. break;
  619. }
  620. if (p_upwards) {
  621. // Try to load settings ascending through parent directories
  622. d->change_dir("..");
  623. if (d->get_current_dir() == current_dir) {
  624. break; // not doing anything useful
  625. }
  626. current_dir = d->get_current_dir();
  627. } else {
  628. break;
  629. }
  630. }
  631. if (!found) {
  632. return err;
  633. }
  634. if (resource_path.length() && resource_path[resource_path.length() - 1] == '/') {
  635. resource_path = resource_path.substr(0, resource_path.length() - 1); // Chop end.
  636. }
  637. return OK;
  638. }
  639. Error ProjectSettings::setup(const String &p_path, const String &p_main_pack, bool p_upwards, bool p_ignore_override) {
  640. Error err = _setup(p_path, p_main_pack, p_upwards, p_ignore_override);
  641. if (err == OK && !p_ignore_override) {
  642. String custom_settings = GLOBAL_GET("application/config/project_settings_override");
  643. if (!custom_settings.is_empty()) {
  644. _load_settings_text(custom_settings);
  645. }
  646. }
  647. // Updating the default value after the project settings have loaded.
  648. bool use_hidden_directory = GLOBAL_GET("application/config/use_hidden_project_data_directory");
  649. project_data_dir_name = (use_hidden_directory ? "." : "") + PROJECT_DATA_DIR_NAME_SUFFIX;
  650. // Using GLOBAL_GET on every block for compressing can be slow, so assigning here.
  651. Compression::zstd_long_distance_matching = GLOBAL_GET("compression/formats/zstd/long_distance_matching");
  652. Compression::zstd_level = GLOBAL_GET("compression/formats/zstd/compression_level");
  653. Compression::zstd_window_log_size = GLOBAL_GET("compression/formats/zstd/window_log_size");
  654. Compression::zlib_level = GLOBAL_GET("compression/formats/zlib/compression_level");
  655. Compression::gzip_level = GLOBAL_GET("compression/formats/gzip/compression_level");
  656. load_scene_groups_cache();
  657. project_loaded = err == OK;
  658. return err;
  659. }
  660. bool ProjectSettings::has_setting(const String &p_var) const {
  661. _THREAD_SAFE_METHOD_
  662. return props.has(p_var);
  663. }
  664. Error ProjectSettings::_load_settings_binary(const String &p_path) {
  665. Error err;
  666. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);
  667. if (err != OK) {
  668. return err;
  669. }
  670. uint8_t hdr[4];
  671. f->get_buffer(hdr, 4);
  672. ERR_FAIL_COND_V_MSG((hdr[0] != 'E' || hdr[1] != 'C' || hdr[2] != 'F' || hdr[3] != 'G'), ERR_FILE_CORRUPT, "Corrupted header in binary project.binary (not ECFG).");
  673. uint32_t count = f->get_32();
  674. for (uint32_t i = 0; i < count; i++) {
  675. uint32_t slen = f->get_32();
  676. CharString cs;
  677. cs.resize(slen + 1);
  678. cs[slen] = 0;
  679. f->get_buffer((uint8_t *)cs.ptr(), slen);
  680. String key = String::utf8(cs.ptr(), slen);
  681. uint32_t vlen = f->get_32();
  682. Vector<uint8_t> d;
  683. d.resize(vlen);
  684. f->get_buffer(d.ptrw(), vlen);
  685. Variant value;
  686. err = decode_variant(value, d.ptr(), d.size(), nullptr, true);
  687. ERR_CONTINUE_MSG(err != OK, vformat("Error decoding property: '%s'.", key));
  688. set(key, value);
  689. }
  690. return OK;
  691. }
  692. Error ProjectSettings::_load_settings_text(const String &p_path) {
  693. Error err;
  694. Ref<FileAccess> f = FileAccess::open(p_path, FileAccess::READ, &err);
  695. if (f.is_null()) {
  696. // FIXME: Above 'err' error code is ERR_FILE_CANT_OPEN if the file is missing
  697. // This needs to be streamlined if we want decent error reporting
  698. return ERR_FILE_NOT_FOUND;
  699. }
  700. VariantParser::StreamFile stream;
  701. stream.f = f;
  702. String assign;
  703. Variant value;
  704. VariantParser::Tag next_tag;
  705. int lines = 0;
  706. String error_text;
  707. String section;
  708. int config_version = 0;
  709. while (true) {
  710. assign = Variant();
  711. next_tag.fields.clear();
  712. next_tag.name = String();
  713. err = VariantParser::parse_tag_assign_eof(&stream, lines, error_text, next_tag, assign, value, nullptr, true);
  714. if (err == ERR_FILE_EOF) {
  715. // If we're loading a project.godot from source code, we can operate some
  716. // ProjectSettings conversions if need be.
  717. _convert_to_last_version(config_version);
  718. last_save_time = FileAccess::get_modified_time(get_resource_path().path_join("project.godot"));
  719. return OK;
  720. }
  721. ERR_FAIL_COND_V_MSG(err != OK, err, vformat("Error parsing '%s' at line %d: %s File might be corrupted.", p_path, lines, error_text));
  722. if (!assign.is_empty()) {
  723. if (section.is_empty() && assign == "config_version") {
  724. config_version = value;
  725. ERR_FAIL_COND_V_MSG(config_version > CONFIG_VERSION, ERR_FILE_CANT_OPEN, vformat("Can't open project at '%s', its `config_version` (%d) is from a more recent and incompatible version of the engine. Expected config version: %d.", p_path, config_version, CONFIG_VERSION));
  726. } else {
  727. if (section.is_empty()) {
  728. set(assign, value);
  729. } else {
  730. set(section + "/" + assign, value);
  731. }
  732. }
  733. } else if (!next_tag.name.is_empty()) {
  734. section = next_tag.name;
  735. }
  736. }
  737. }
  738. Error ProjectSettings::_load_settings_text_or_binary(const String &p_text_path, const String &p_bin_path) {
  739. // Attempt first to load the binary project.godot file.
  740. Error err = _load_settings_binary(p_bin_path);
  741. if (err == OK) {
  742. return OK;
  743. } else if (err != ERR_FILE_NOT_FOUND) {
  744. // If the file exists but can't be loaded, we want to know it.
  745. ERR_PRINT(vformat("Couldn't load file '%s', error code %d.", p_bin_path, err));
  746. }
  747. // Fallback to text-based project.godot file if binary was not found.
  748. err = _load_settings_text(p_text_path);
  749. if (err == OK) {
  750. return OK;
  751. } else if (err != ERR_FILE_NOT_FOUND) {
  752. ERR_PRINT(vformat("Couldn't load file '%s', error code %d.", p_text_path, err));
  753. }
  754. return err;
  755. }
  756. Error ProjectSettings::load_custom(const String &p_path) {
  757. if (p_path.ends_with(".binary")) {
  758. return _load_settings_binary(p_path);
  759. }
  760. return _load_settings_text(p_path);
  761. }
  762. int ProjectSettings::get_order(const String &p_name) const {
  763. ERR_FAIL_COND_V_MSG(!props.has(p_name), -1, vformat("Request for nonexistent project setting: '%s'.", p_name));
  764. return props[p_name].order;
  765. }
  766. void ProjectSettings::set_order(const String &p_name, int p_order) {
  767. ERR_FAIL_COND_MSG(!props.has(p_name), vformat("Request for nonexistent project setting: '%s'.", p_name));
  768. props[p_name].order = p_order;
  769. }
  770. void ProjectSettings::set_builtin_order(const String &p_name) {
  771. ERR_FAIL_COND_MSG(!props.has(p_name), vformat("Request for nonexistent project setting: '%s'.", p_name));
  772. if (props[p_name].order >= NO_BUILTIN_ORDER_BASE) {
  773. props[p_name].order = last_builtin_order++;
  774. }
  775. }
  776. bool ProjectSettings::is_builtin_setting(const String &p_name) const {
  777. // Return true because a false negative is worse than a false positive.
  778. ERR_FAIL_COND_V_MSG(!props.has(p_name), true, vformat("Request for nonexistent project setting: '%s'.", p_name));
  779. return props[p_name].order < NO_BUILTIN_ORDER_BASE;
  780. }
  781. void ProjectSettings::clear(const String &p_name) {
  782. ERR_FAIL_COND_MSG(!props.has(p_name), vformat("Request for nonexistent project setting: '%s'.", p_name));
  783. props.erase(p_name);
  784. }
  785. Error ProjectSettings::save() {
  786. Error error = save_custom(get_resource_path().path_join("project.godot"));
  787. if (error == OK) {
  788. last_save_time = FileAccess::get_modified_time(get_resource_path().path_join("project.godot"));
  789. }
  790. return error;
  791. }
  792. Error ProjectSettings::_save_settings_binary(const String &p_file, const RBMap<String, List<String>> &p_props, const CustomMap &p_custom, const String &p_custom_features) {
  793. Error err;
  794. Ref<FileAccess> file = FileAccess::open(p_file, FileAccess::WRITE, &err);
  795. ERR_FAIL_COND_V_MSG(err != OK, err, vformat("Couldn't save project.binary at '%s'.", p_file));
  796. uint8_t hdr[4] = { 'E', 'C', 'F', 'G' };
  797. file->store_buffer(hdr, 4);
  798. int count = 0;
  799. for (const KeyValue<String, List<String>> &E : p_props) {
  800. count += E.value.size();
  801. }
  802. if (!p_custom_features.is_empty()) {
  803. // Store how many properties are saved, add one for custom features, which must always go first.
  804. file->store_32(uint32_t(count + 1));
  805. String key = CoreStringName(_custom_features);
  806. file->store_pascal_string(key);
  807. int len;
  808. err = encode_variant(p_custom_features, nullptr, len, false);
  809. ERR_FAIL_COND_V(err != OK, err);
  810. Vector<uint8_t> buff;
  811. buff.resize(len);
  812. err = encode_variant(p_custom_features, buff.ptrw(), len, false);
  813. ERR_FAIL_COND_V(err != OK, err);
  814. file->store_32(uint32_t(len));
  815. file->store_buffer(buff.ptr(), buff.size());
  816. } else {
  817. // Store how many properties are saved.
  818. file->store_32(uint32_t(count));
  819. }
  820. for (const KeyValue<String, List<String>> &E : p_props) {
  821. for (const String &key : E.value) {
  822. String k = key;
  823. if (!E.key.is_empty()) {
  824. k = E.key + "/" + k;
  825. }
  826. Variant value;
  827. if (p_custom.has(k)) {
  828. value = p_custom[k];
  829. } else {
  830. value = get(k);
  831. }
  832. file->store_pascal_string(k);
  833. int len;
  834. err = encode_variant(value, nullptr, len, true);
  835. ERR_FAIL_COND_V_MSG(err != OK, ERR_INVALID_DATA, "Error when trying to encode Variant.");
  836. Vector<uint8_t> buff;
  837. buff.resize(len);
  838. err = encode_variant(value, buff.ptrw(), len, true);
  839. ERR_FAIL_COND_V_MSG(err != OK, ERR_INVALID_DATA, "Error when trying to encode Variant.");
  840. file->store_32(uint32_t(len));
  841. file->store_buffer(buff.ptr(), buff.size());
  842. }
  843. }
  844. return OK;
  845. }
  846. Error ProjectSettings::_save_settings_text(const String &p_file, const RBMap<String, List<String>> &p_props, const CustomMap &p_custom, const String &p_custom_features) {
  847. Error err;
  848. Ref<FileAccess> file = FileAccess::open(p_file, FileAccess::WRITE, &err);
  849. ERR_FAIL_COND_V_MSG(err != OK, err, vformat("Couldn't save project.godot - %s.", p_file));
  850. file->store_line("; Engine configuration file.");
  851. file->store_line("; It's best edited using the editor UI and not directly,");
  852. file->store_line("; since the parameters that go here are not all obvious.");
  853. file->store_line(";");
  854. file->store_line("; Format:");
  855. file->store_line("; [section] ; section goes between []");
  856. file->store_line("; param=value ; assign values to parameters");
  857. file->store_line("");
  858. file->store_string("config_version=" + itos(CONFIG_VERSION) + "\n");
  859. if (!p_custom_features.is_empty()) {
  860. file->store_string("custom_features=\"" + p_custom_features + "\"\n");
  861. }
  862. file->store_string("\n");
  863. for (const KeyValue<String, List<String>> &E : p_props) {
  864. if (E.key != p_props.begin()->key) {
  865. file->store_string("\n");
  866. }
  867. if (!E.key.is_empty()) {
  868. file->store_string("[" + E.key + "]\n\n");
  869. }
  870. for (const String &F : E.value) {
  871. String key = F;
  872. if (!E.key.is_empty()) {
  873. key = E.key + "/" + key;
  874. }
  875. Variant value;
  876. if (p_custom.has(key)) {
  877. value = p_custom[key];
  878. } else {
  879. value = get(key);
  880. }
  881. String vstr;
  882. VariantWriter::write_to_string(value, vstr);
  883. file->store_string(F.property_name_encode() + "=" + vstr + "\n");
  884. }
  885. }
  886. return OK;
  887. }
  888. Error ProjectSettings::_save_custom_bnd(const String &p_file) { // add other params as dictionary and array?
  889. return save_custom(p_file);
  890. }
  891. #ifdef TOOLS_ENABLED
  892. bool _csproj_exists(const String &p_root_dir) {
  893. Ref<DirAccess> dir = DirAccess::open(p_root_dir);
  894. ERR_FAIL_COND_V(dir.is_null(), false);
  895. dir->list_dir_begin();
  896. String file_name = dir->_get_next();
  897. while (file_name != "") {
  898. if (!dir->current_is_dir() && file_name.get_extension() == "csproj") {
  899. return true;
  900. }
  901. file_name = dir->_get_next();
  902. }
  903. return false;
  904. }
  905. #endif // TOOLS_ENABLED
  906. Error ProjectSettings::save_custom(const String &p_path, const CustomMap &p_custom, const Vector<String> &p_custom_features, bool p_merge_with_current) {
  907. ERR_FAIL_COND_V_MSG(p_path.is_empty(), ERR_INVALID_PARAMETER, "Project settings save path cannot be empty.");
  908. #ifdef TOOLS_ENABLED
  909. PackedStringArray project_features = get_setting("application/config/features");
  910. // If there is no feature list currently present, force one to generate.
  911. if (project_features.is_empty()) {
  912. project_features = ProjectSettings::get_required_features();
  913. }
  914. // Check the rendering API.
  915. const String rendering_api = has_setting("rendering/renderer/rendering_method") ? (String)get_setting("rendering/renderer/rendering_method") : String();
  916. if (!rendering_api.is_empty()) {
  917. // Add the rendering API as a project feature if it doesn't already exist.
  918. if (!project_features.has(rendering_api)) {
  919. project_features.append(rendering_api);
  920. }
  921. }
  922. // Check for the existence of a csproj file.
  923. if (_csproj_exists(get_resource_path())) {
  924. // If there is a csproj file, add the C# feature if it doesn't already exist.
  925. if (!project_features.has("C#")) {
  926. project_features.append("C#");
  927. }
  928. } else {
  929. // If there isn't a csproj file, remove the C# feature if it exists.
  930. if (project_features.has("C#")) {
  931. project_features.remove_at(project_features.find("C#"));
  932. }
  933. }
  934. project_features = _trim_to_supported_features(project_features);
  935. set_setting("application/config/features", project_features);
  936. #endif // TOOLS_ENABLED
  937. RBSet<_VCSort> vclist;
  938. if (p_merge_with_current) {
  939. for (const KeyValue<StringName, VariantContainer> &G : props) {
  940. const VariantContainer *v = &G.value;
  941. if (v->hide_from_editor) {
  942. continue;
  943. }
  944. if (p_custom.has(G.key)) {
  945. continue;
  946. }
  947. _VCSort vc;
  948. vc.name = G.key; //*k;
  949. vc.order = v->order;
  950. vc.type = v->variant.get_type();
  951. vc.flags = PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_STORAGE;
  952. if (v->variant == v->initial) {
  953. continue;
  954. }
  955. vclist.insert(vc);
  956. }
  957. }
  958. for (const KeyValue<String, Variant> &E : p_custom) {
  959. // Lookup global prop to store in the same order
  960. RBMap<StringName, VariantContainer>::Iterator global_prop = props.find(E.key);
  961. _VCSort vc;
  962. vc.name = E.key;
  963. vc.order = global_prop ? global_prop->value.order : 0xFFFFFFF;
  964. vc.type = E.value.get_type();
  965. vc.flags = PROPERTY_USAGE_STORAGE;
  966. vclist.insert(vc);
  967. }
  968. RBMap<String, List<String>> save_props;
  969. for (const _VCSort &E : vclist) {
  970. String category = E.name;
  971. String name = E.name;
  972. int div = category.find_char('/');
  973. if (div < 0) {
  974. category = "";
  975. } else {
  976. category = category.substr(0, div);
  977. name = name.substr(div + 1);
  978. }
  979. save_props[category].push_back(name);
  980. }
  981. String save_features;
  982. for (int i = 0; i < p_custom_features.size(); i++) {
  983. if (i > 0) {
  984. save_features += ",";
  985. }
  986. String f = p_custom_features[i].strip_edges().remove_char('\"');
  987. save_features += f;
  988. }
  989. if (p_path.ends_with(".godot") || p_path.ends_with("override.cfg")) {
  990. return _save_settings_text(p_path, save_props, p_custom, save_features);
  991. } else if (p_path.ends_with(".binary")) {
  992. return _save_settings_binary(p_path, save_props, p_custom, save_features);
  993. } else {
  994. ERR_FAIL_V_MSG(ERR_FILE_UNRECOGNIZED, vformat("Unknown config file format: '%s'.", p_path));
  995. }
  996. }
  997. Variant _GLOBAL_DEF(const String &p_var, const Variant &p_default, bool p_restart_if_changed, bool p_ignore_value_in_docs, bool p_basic, bool p_internal) {
  998. Variant ret;
  999. if (!ProjectSettings::get_singleton()->has_setting(p_var)) {
  1000. ProjectSettings::get_singleton()->set(p_var, p_default);
  1001. }
  1002. ret = GLOBAL_GET(p_var);
  1003. ProjectSettings::get_singleton()->set_initial_value(p_var, p_default);
  1004. ProjectSettings::get_singleton()->set_builtin_order(p_var);
  1005. ProjectSettings::get_singleton()->set_as_basic(p_var, p_basic);
  1006. ProjectSettings::get_singleton()->set_restart_if_changed(p_var, p_restart_if_changed);
  1007. ProjectSettings::get_singleton()->set_ignore_value_in_docs(p_var, p_ignore_value_in_docs);
  1008. ProjectSettings::get_singleton()->set_as_internal(p_var, p_internal);
  1009. return ret;
  1010. }
  1011. Variant _GLOBAL_DEF(const PropertyInfo &p_info, const Variant &p_default, bool p_restart_if_changed, bool p_ignore_value_in_docs, bool p_basic, bool p_internal) {
  1012. Variant ret = _GLOBAL_DEF(p_info.name, p_default, p_restart_if_changed, p_ignore_value_in_docs, p_basic, p_internal);
  1013. ProjectSettings::get_singleton()->set_custom_property_info(p_info);
  1014. return ret;
  1015. }
  1016. void ProjectSettings::_add_property_info_bind(const Dictionary &p_info) {
  1017. ERR_FAIL_COND(!p_info.has("name"));
  1018. ERR_FAIL_COND(!p_info.has("type"));
  1019. PropertyInfo pinfo;
  1020. pinfo.name = p_info["name"];
  1021. ERR_FAIL_COND(!props.has(pinfo.name));
  1022. pinfo.type = Variant::Type(p_info["type"].operator int());
  1023. ERR_FAIL_INDEX(pinfo.type, Variant::VARIANT_MAX);
  1024. if (p_info.has("hint")) {
  1025. pinfo.hint = PropertyHint(p_info["hint"].operator int());
  1026. }
  1027. if (p_info.has("hint_string")) {
  1028. pinfo.hint_string = p_info["hint_string"];
  1029. }
  1030. set_custom_property_info(pinfo);
  1031. }
  1032. void ProjectSettings::set_custom_property_info(const PropertyInfo &p_info) {
  1033. const String &prop_name = p_info.name;
  1034. ERR_FAIL_COND(!props.has(prop_name));
  1035. custom_prop_info[prop_name] = p_info;
  1036. }
  1037. const HashMap<StringName, PropertyInfo> &ProjectSettings::get_custom_property_info() const {
  1038. return custom_prop_info;
  1039. }
  1040. bool ProjectSettings::is_using_datapack() const {
  1041. return using_datapack;
  1042. }
  1043. bool ProjectSettings::is_project_loaded() const {
  1044. return project_loaded;
  1045. }
  1046. bool ProjectSettings::_property_can_revert(const StringName &p_name) const {
  1047. return props.has(p_name);
  1048. }
  1049. bool ProjectSettings::_property_get_revert(const StringName &p_name, Variant &r_property) const {
  1050. const RBMap<StringName, ProjectSettings::VariantContainer>::Element *value = props.find(p_name);
  1051. if (value) {
  1052. r_property = value->value().initial.duplicate();
  1053. return true;
  1054. }
  1055. return false;
  1056. }
  1057. void ProjectSettings::set_setting(const String &p_setting, const Variant &p_value) {
  1058. set(p_setting, p_value);
  1059. }
  1060. Variant ProjectSettings::get_setting(const String &p_setting, const Variant &p_default_value) const {
  1061. if (has_setting(p_setting)) {
  1062. return get(p_setting);
  1063. } else {
  1064. return p_default_value;
  1065. }
  1066. }
  1067. void ProjectSettings::refresh_global_class_list() {
  1068. // This is called after mounting a new PCK file to pick up class changes.
  1069. is_global_class_list_loaded = false; // Make sure we read from the freshly mounted PCK.
  1070. Array script_classes = get_global_class_list();
  1071. for (int i = 0; i < script_classes.size(); i++) {
  1072. Dictionary c = script_classes[i];
  1073. if (!c.has("class") || !c.has("language") || !c.has("path") || !c.has("base") || !c.has("is_abstract") || !c.has("is_tool")) {
  1074. continue;
  1075. }
  1076. ScriptServer::add_global_class(c["class"], c["base"], c["language"], c["path"], c["is_abstract"], c["is_tool"]);
  1077. }
  1078. }
  1079. TypedArray<Dictionary> ProjectSettings::get_global_class_list() {
  1080. if (is_global_class_list_loaded) {
  1081. return global_class_list;
  1082. }
  1083. Ref<ConfigFile> cf;
  1084. cf.instantiate();
  1085. if (cf->load(get_global_class_list_path()) == OK) {
  1086. global_class_list = cf->get_value("", "list", Array());
  1087. } else {
  1088. #ifndef TOOLS_ENABLED
  1089. // Script classes can't be recreated in exported project, so print an error.
  1090. ERR_PRINT("Could not load global script cache.");
  1091. #endif
  1092. }
  1093. // File read succeeded or failed. If it failed, assume everything is still okay.
  1094. // We will later receive updated class data in store_global_class_list().
  1095. is_global_class_list_loaded = true;
  1096. return global_class_list;
  1097. }
  1098. String ProjectSettings::get_global_class_list_path() const {
  1099. return get_project_data_path().path_join("global_script_class_cache.cfg");
  1100. }
  1101. void ProjectSettings::store_global_class_list(const Array &p_classes) {
  1102. Ref<ConfigFile> cf;
  1103. cf.instantiate();
  1104. cf->set_value("", "list", p_classes);
  1105. cf->save(get_global_class_list_path());
  1106. global_class_list = p_classes;
  1107. }
  1108. bool ProjectSettings::has_custom_feature(const String &p_feature) const {
  1109. return custom_features.has(p_feature);
  1110. }
  1111. const HashMap<StringName, ProjectSettings::AutoloadInfo> &ProjectSettings::get_autoload_list() const {
  1112. return autoloads;
  1113. }
  1114. void ProjectSettings::add_autoload(const AutoloadInfo &p_autoload) {
  1115. ERR_FAIL_COND_MSG(p_autoload.name == StringName(), "Trying to add autoload with no name.");
  1116. autoloads[p_autoload.name] = p_autoload;
  1117. }
  1118. void ProjectSettings::remove_autoload(const StringName &p_autoload) {
  1119. ERR_FAIL_COND_MSG(!autoloads.has(p_autoload), "Trying to remove non-existent autoload.");
  1120. autoloads.erase(p_autoload);
  1121. }
  1122. bool ProjectSettings::has_autoload(const StringName &p_autoload) const {
  1123. return autoloads.has(p_autoload);
  1124. }
  1125. ProjectSettings::AutoloadInfo ProjectSettings::get_autoload(const StringName &p_name) const {
  1126. ERR_FAIL_COND_V_MSG(!autoloads.has(p_name), AutoloadInfo(), "Trying to get non-existent autoload.");
  1127. return autoloads[p_name];
  1128. }
  1129. const HashMap<StringName, String> &ProjectSettings::get_global_groups_list() const {
  1130. return global_groups;
  1131. }
  1132. void ProjectSettings::add_global_group(const StringName &p_name, const String &p_description) {
  1133. ERR_FAIL_COND_MSG(p_name == StringName(), "Trying to add global group with no name.");
  1134. global_groups[p_name] = p_description;
  1135. }
  1136. void ProjectSettings::remove_global_group(const StringName &p_name) {
  1137. ERR_FAIL_COND_MSG(!global_groups.has(p_name), "Trying to remove non-existent global group.");
  1138. global_groups.erase(p_name);
  1139. }
  1140. bool ProjectSettings::has_global_group(const StringName &p_name) const {
  1141. return global_groups.has(p_name);
  1142. }
  1143. void ProjectSettings::remove_scene_groups_cache(const StringName &p_path) {
  1144. scene_groups_cache.erase(p_path);
  1145. }
  1146. void ProjectSettings::add_scene_groups_cache(const StringName &p_path, const HashSet<StringName> &p_cache) {
  1147. scene_groups_cache[p_path] = p_cache;
  1148. }
  1149. void ProjectSettings::save_scene_groups_cache() {
  1150. Ref<ConfigFile> cf;
  1151. cf.instantiate();
  1152. for (const KeyValue<StringName, HashSet<StringName>> &E : scene_groups_cache) {
  1153. if (E.value.is_empty()) {
  1154. continue;
  1155. }
  1156. Array list;
  1157. for (const StringName &group : E.value) {
  1158. list.push_back(group);
  1159. }
  1160. cf->set_value(E.key, "groups", list);
  1161. }
  1162. cf->save(get_scene_groups_cache_path());
  1163. }
  1164. String ProjectSettings::get_scene_groups_cache_path() const {
  1165. return get_project_data_path().path_join("scene_groups_cache.cfg");
  1166. }
  1167. void ProjectSettings::load_scene_groups_cache() {
  1168. Ref<ConfigFile> cf;
  1169. cf.instantiate();
  1170. if (cf->load(get_scene_groups_cache_path()) == OK) {
  1171. Vector<String> scene_paths = cf->get_sections();
  1172. for (const String &E : scene_paths) {
  1173. Array scene_groups = cf->get_value(E, "groups", Array());
  1174. HashSet<StringName> cache;
  1175. for (const Variant &scene_group : scene_groups) {
  1176. cache.insert(scene_group);
  1177. }
  1178. add_scene_groups_cache(E, cache);
  1179. }
  1180. }
  1181. }
  1182. const HashMap<StringName, HashSet<StringName>> &ProjectSettings::get_scene_groups_cache() const {
  1183. return scene_groups_cache;
  1184. }
  1185. #ifdef TOOLS_ENABLED
  1186. void ProjectSettings::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
  1187. const String pf = p_function;
  1188. if (p_idx == 0) {
  1189. if (pf == "has_setting" || pf == "set_setting" || pf == "get_setting" || pf == "get_setting_with_override" ||
  1190. pf == "set_order" || pf == "get_order" || pf == "set_initial_value" || pf == "set_as_basic" ||
  1191. pf == "set_as_internal" || pf == "set_restart_if_changed" || pf == "clear") {
  1192. for (const KeyValue<StringName, VariantContainer> &E : props) {
  1193. if (E.value.hide_from_editor) {
  1194. continue;
  1195. }
  1196. r_options->push_back(String(E.key).quote());
  1197. }
  1198. }
  1199. }
  1200. Object::get_argument_options(p_function, p_idx, r_options);
  1201. }
  1202. #endif
  1203. void ProjectSettings::_bind_methods() {
  1204. ClassDB::bind_method(D_METHOD("has_setting", "name"), &ProjectSettings::has_setting);
  1205. ClassDB::bind_method(D_METHOD("set_setting", "name", "value"), &ProjectSettings::set_setting);
  1206. ClassDB::bind_method(D_METHOD("get_setting", "name", "default_value"), &ProjectSettings::get_setting, DEFVAL(Variant()));
  1207. ClassDB::bind_method(D_METHOD("get_setting_with_override", "name"), &ProjectSettings::get_setting_with_override);
  1208. ClassDB::bind_method(D_METHOD("get_global_class_list"), &ProjectSettings::get_global_class_list);
  1209. ClassDB::bind_method(D_METHOD("get_setting_with_override_and_custom_features", "name", "features"), &ProjectSettings::get_setting_with_override_and_custom_features);
  1210. ClassDB::bind_method(D_METHOD("set_order", "name", "position"), &ProjectSettings::set_order);
  1211. ClassDB::bind_method(D_METHOD("get_order", "name"), &ProjectSettings::get_order);
  1212. ClassDB::bind_method(D_METHOD("set_initial_value", "name", "value"), &ProjectSettings::set_initial_value);
  1213. ClassDB::bind_method(D_METHOD("set_as_basic", "name", "basic"), &ProjectSettings::set_as_basic);
  1214. ClassDB::bind_method(D_METHOD("set_as_internal", "name", "internal"), &ProjectSettings::set_as_internal);
  1215. ClassDB::bind_method(D_METHOD("add_property_info", "hint"), &ProjectSettings::_add_property_info_bind);
  1216. ClassDB::bind_method(D_METHOD("set_restart_if_changed", "name", "restart"), &ProjectSettings::set_restart_if_changed);
  1217. ClassDB::bind_method(D_METHOD("clear", "name"), &ProjectSettings::clear);
  1218. ClassDB::bind_method(D_METHOD("localize_path", "path"), &ProjectSettings::localize_path);
  1219. ClassDB::bind_method(D_METHOD("globalize_path", "path"), &ProjectSettings::globalize_path);
  1220. ClassDB::bind_method(D_METHOD("save"), &ProjectSettings::save);
  1221. ClassDB::bind_method(D_METHOD("load_resource_pack", "pack", "replace_files", "offset"), &ProjectSettings::load_resource_pack, DEFVAL(true), DEFVAL(0));
  1222. ClassDB::bind_method(D_METHOD("save_custom", "file"), &ProjectSettings::_save_custom_bnd);
  1223. ADD_SIGNAL(MethodInfo("settings_changed"));
  1224. }
  1225. void ProjectSettings::_add_builtin_input_map() {
  1226. if (InputMap::get_singleton()) {
  1227. HashMap<String, List<Ref<InputEvent>>> builtins = InputMap::get_singleton()->get_builtins();
  1228. for (KeyValue<String, List<Ref<InputEvent>>> &E : builtins) {
  1229. Array events;
  1230. // Convert list of input events into array
  1231. for (const Ref<InputEvent> &event : E.value) {
  1232. events.push_back(event);
  1233. }
  1234. Dictionary action;
  1235. action["deadzone"] = Variant(InputMap::DEFAULT_TOGGLE_DEADZONE);
  1236. action["events"] = events;
  1237. String action_name = "input/" + E.key;
  1238. GLOBAL_DEF(action_name, action);
  1239. input_presets.push_back(action_name);
  1240. }
  1241. }
  1242. }
  1243. ProjectSettings::ProjectSettings() {
  1244. // Initialization of engine variables should be done in the setup() method,
  1245. // so that the values can be overridden from project.godot or project.binary.
  1246. CRASH_COND_MSG(singleton != nullptr, "Instantiating a new ProjectSettings singleton is not supported.");
  1247. singleton = this;
  1248. #ifdef TOOLS_ENABLED
  1249. // Available only at runtime in editor builds. Needs to be processed before anything else to work properly.
  1250. if (!Engine::get_singleton()->is_editor_hint()) {
  1251. String editor_features = OS::get_singleton()->get_environment("GODOT_EDITOR_CUSTOM_FEATURES");
  1252. if (!editor_features.is_empty()) {
  1253. PackedStringArray feature_list = editor_features.split(",");
  1254. for (const String &s : feature_list) {
  1255. custom_features.insert(s);
  1256. }
  1257. }
  1258. }
  1259. #endif
  1260. GLOBAL_DEF_BASIC("application/config/name", "");
  1261. GLOBAL_DEF_BASIC(PropertyInfo(Variant::DICTIONARY, "application/config/name_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary());
  1262. GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "application/config/description", PROPERTY_HINT_MULTILINE_TEXT), "");
  1263. GLOBAL_DEF_BASIC("application/config/version", "");
  1264. GLOBAL_DEF_INTERNAL(PropertyInfo(Variant::STRING, "application/config/tags"), PackedStringArray());
  1265. GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "application/run/main_scene", PROPERTY_HINT_FILE, "*.tscn,*.scn,*.res"), "");
  1266. GLOBAL_DEF("application/run/disable_stdout", false);
  1267. GLOBAL_DEF("application/run/disable_stderr", false);
  1268. GLOBAL_DEF("application/run/print_header", true);
  1269. GLOBAL_DEF("application/run/enable_alt_space_menu", false);
  1270. GLOBAL_DEF_RST("application/config/use_hidden_project_data_directory", true);
  1271. GLOBAL_DEF("application/config/use_custom_user_dir", false);
  1272. GLOBAL_DEF("application/config/custom_user_dir_name", "");
  1273. GLOBAL_DEF("application/config/project_settings_override", "");
  1274. GLOBAL_DEF("application/run/main_loop_type", "SceneTree");
  1275. GLOBAL_DEF("application/config/auto_accept_quit", true);
  1276. GLOBAL_DEF("application/config/quit_on_go_back", true);
  1277. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "accessibility/general/accessibility_support", PROPERTY_HINT_ENUM, "Auto (When Screen Reader is Running),Always Active,Disabled"), 0);
  1278. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "accessibility/general/updates_per_second", PROPERTY_HINT_RANGE, "1,100,1"), 60);
  1279. // The default window size is tuned to:
  1280. // - Have a 16:9 aspect ratio,
  1281. // - Have both dimensions divisible by 8 to better play along with video recording,
  1282. // - Be displayable correctly in windowed mode on a 1366×768 display (tested on Windows 10 with default settings).
  1283. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "display/window/size/viewport_width", PROPERTY_HINT_RANGE, "1,7680,1,or_greater"), 1152); // 8K resolution
  1284. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "display/window/size/viewport_height", PROPERTY_HINT_RANGE, "1,4320,1,or_greater"), 648); // 8K resolution
  1285. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "display/window/size/mode", PROPERTY_HINT_ENUM, "Windowed,Minimized,Maximized,Fullscreen,Exclusive Fullscreen"), 0);
  1286. // Keep the enum values in sync with the `Window::WINDOW_INITIAL_POSITION_` enum.
  1287. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "display/window/size/initial_position_type", PROPERTY_HINT_ENUM, "Absolute:0,Center of Primary Screen:1,Center of Other Screen:3,Center of Screen With Mouse Pointer:4,Center of Screen With Keyboard Focus:5"), 1);
  1288. GLOBAL_DEF_BASIC(PropertyInfo(Variant::VECTOR2I, "display/window/size/initial_position"), Vector2i());
  1289. // Keep the enum values in sync with the `DisplayServer::SCREEN_` enum.
  1290. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "display/window/size/initial_screen", PROPERTY_HINT_RANGE, "0,64,1,or_greater"), 0);
  1291. GLOBAL_DEF_BASIC("display/window/size/resizable", true);
  1292. GLOBAL_DEF_BASIC("display/window/size/borderless", false);
  1293. GLOBAL_DEF("display/window/size/always_on_top", false);
  1294. GLOBAL_DEF("display/window/size/transparent", false);
  1295. GLOBAL_DEF("display/window/size/extend_to_title", false);
  1296. GLOBAL_DEF("display/window/size/no_focus", false);
  1297. GLOBAL_DEF("display/window/size/sharp_corners", false);
  1298. GLOBAL_DEF("display/window/size/minimize_disabled", false);
  1299. GLOBAL_DEF("display/window/size/maximize_disabled", false);
  1300. GLOBAL_DEF(PropertyInfo(Variant::INT, "display/window/size/window_width_override", PROPERTY_HINT_RANGE, "0,7680,1,or_greater"), 0); // 8K resolution
  1301. GLOBAL_DEF(PropertyInfo(Variant::INT, "display/window/size/window_height_override", PROPERTY_HINT_RANGE, "0,4320,1,or_greater"), 0); // 8K resolution
  1302. GLOBAL_DEF("display/window/energy_saving/keep_screen_on", true);
  1303. GLOBAL_DEF("animation/warnings/check_invalid_track_paths", true);
  1304. GLOBAL_DEF("animation/warnings/check_angle_interpolation_type_conflicting", true);
  1305. GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "audio/buses/default_bus_layout", PROPERTY_HINT_FILE, "*.tres"), "res://default_bus_layout.tres");
  1306. GLOBAL_DEF(PropertyInfo(Variant::INT, "audio/general/default_playback_type", PROPERTY_HINT_ENUM, "Stream,Sample"), 0);
  1307. GLOBAL_DEF(PropertyInfo(Variant::INT, "audio/general/default_playback_type.web", PROPERTY_HINT_ENUM, "Stream,Sample"), 1);
  1308. GLOBAL_DEF_RST("audio/general/text_to_speech", false);
  1309. GLOBAL_DEF_RST(PropertyInfo(Variant::FLOAT, "audio/general/2d_panning_strength", PROPERTY_HINT_RANGE, "0,2,0.01"), 0.5f);
  1310. GLOBAL_DEF_RST(PropertyInfo(Variant::FLOAT, "audio/general/3d_panning_strength", PROPERTY_HINT_RANGE, "0,2,0.01"), 0.5f);
  1311. GLOBAL_DEF(PropertyInfo(Variant::INT, "audio/general/ios/session_category", PROPERTY_HINT_ENUM, "Ambient,Multi Route,Play and Record,Playback,Record,Solo Ambient"), 0);
  1312. GLOBAL_DEF("audio/general/ios/mix_with_others", false);
  1313. _add_builtin_input_map();
  1314. // Keep the enum values in sync with the `DisplayServer::ScreenOrientation` enum.
  1315. custom_prop_info["display/window/handheld/orientation"] = PropertyInfo(Variant::INT, "display/window/handheld/orientation", PROPERTY_HINT_ENUM, "Landscape,Portrait,Reverse Landscape,Reverse Portrait,Sensor Landscape,Sensor Portrait,Sensor");
  1316. GLOBAL_DEF("display/window/subwindows/embed_subwindows", true);
  1317. // Keep the enum values in sync with the `DisplayServer::VSyncMode` enum.
  1318. custom_prop_info["display/window/vsync/vsync_mode"] = PropertyInfo(Variant::INT, "display/window/vsync/vsync_mode", PROPERTY_HINT_ENUM, "Disabled,Enabled,Adaptive,Mailbox");
  1319. GLOBAL_DEF("display/window/frame_pacing/android/enable_frame_pacing", true);
  1320. GLOBAL_DEF(PropertyInfo(Variant::INT, "display/window/frame_pacing/android/swappy_mode", PROPERTY_HINT_ENUM, "pipeline_forced_on,auto_fps_pipeline_forced_on,auto_fps_auto_pipeline"), 2);
  1321. #ifdef DISABLE_DEPRECATED
  1322. custom_prop_info["rendering/driver/threads/thread_model"] = PropertyInfo(Variant::INT, "rendering/driver/threads/thread_model", PROPERTY_HINT_ENUM, "Safe:1,Separate");
  1323. #else
  1324. custom_prop_info["rendering/driver/threads/thread_model"] = PropertyInfo(Variant::INT, "rendering/driver/threads/thread_model", PROPERTY_HINT_ENUM, "Unsafe (deprecated),Safe,Separate");
  1325. #endif
  1326. #ifndef PHYSICS_2D_DISABLED
  1327. GLOBAL_DEF("physics/2d/run_on_separate_thread", false);
  1328. #endif // PHYSICS_2D_DISABLED
  1329. #ifndef PHYSICS_3D_DISABLED
  1330. GLOBAL_DEF("physics/3d/run_on_separate_thread", false);
  1331. #endif // PHYSICS_3D_DISABLED
  1332. GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "display/window/stretch/mode", PROPERTY_HINT_ENUM, "disabled,canvas_items,viewport"), "disabled");
  1333. GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "display/window/stretch/aspect", PROPERTY_HINT_ENUM, "ignore,keep,keep_width,keep_height,expand"), "keep");
  1334. GLOBAL_DEF_BASIC(PropertyInfo(Variant::FLOAT, "display/window/stretch/scale", PROPERTY_HINT_RANGE, "0.5,8.0,0.01"), 1.0);
  1335. GLOBAL_DEF_BASIC(PropertyInfo(Variant::STRING, "display/window/stretch/scale_mode", PROPERTY_HINT_ENUM, "fractional,integer"), "fractional");
  1336. GLOBAL_DEF(PropertyInfo(Variant::INT, "debug/settings/profiler/max_functions", PROPERTY_HINT_RANGE, "128,65535,1"), 16384);
  1337. GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "debug/settings/profiler/max_timestamp_query_elements", PROPERTY_HINT_RANGE, "256,65535,1"), 256);
  1338. GLOBAL_DEF(PropertyInfo(Variant::BOOL, "compression/formats/zstd/long_distance_matching"), Compression::zstd_long_distance_matching);
  1339. GLOBAL_DEF(PropertyInfo(Variant::INT, "compression/formats/zstd/compression_level", PROPERTY_HINT_RANGE, "1,22,1"), Compression::zstd_level);
  1340. GLOBAL_DEF(PropertyInfo(Variant::INT, "compression/formats/zstd/window_log_size", PROPERTY_HINT_RANGE, "10,30,1"), Compression::zstd_window_log_size);
  1341. GLOBAL_DEF(PropertyInfo(Variant::INT, "compression/formats/zlib/compression_level", PROPERTY_HINT_RANGE, "-1,9,1"), Compression::zlib_level);
  1342. GLOBAL_DEF(PropertyInfo(Variant::INT, "compression/formats/gzip/compression_level", PROPERTY_HINT_RANGE, "-1,9,1"), Compression::gzip_level);
  1343. GLOBAL_DEF("debug/settings/crash_handler/message",
  1344. String("Please include this when reporting the bug to the project developer."));
  1345. GLOBAL_DEF("debug/settings/crash_handler/message.editor",
  1346. String("Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"));
  1347. GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "rendering/occlusion_culling/bvh_build_quality", PROPERTY_HINT_ENUM, "Low,Medium,High"), 2);
  1348. GLOBAL_DEF_RST("rendering/occlusion_culling/jitter_projection", true);
  1349. GLOBAL_DEF_RST("internationalization/rendering/force_right_to_left_layout_direction", false);
  1350. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "internationalization/rendering/root_node_layout_direction", PROPERTY_HINT_ENUM, "Based on Application Locale,Left-to-Right,Right-to-Left,Based on System Locale"), 0);
  1351. GLOBAL_DEF_BASIC("internationalization/rendering/root_node_auto_translate", true);
  1352. GLOBAL_DEF(PropertyInfo(Variant::INT, "gui/timers/incremental_search_max_interval_msec", PROPERTY_HINT_RANGE, "0,10000,1,or_greater"), 2000);
  1353. GLOBAL_DEF(PropertyInfo(Variant::FLOAT, "gui/timers/tooltip_delay_sec", PROPERTY_HINT_RANGE, "0,5,0.01,or_greater"), 0.5);
  1354. #ifdef TOOLS_ENABLED
  1355. GLOBAL_DEF("gui/timers/tooltip_delay_sec.editor_hint", 0.5);
  1356. #endif
  1357. GLOBAL_DEF_BASIC("gui/common/snap_controls_to_pixels", true);
  1358. GLOBAL_DEF_BASIC("gui/fonts/dynamic_fonts/use_oversampling", true);
  1359. GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "rendering/rendering_device/vsync/frame_queue_size", PROPERTY_HINT_RANGE, "2,3,1"), 2);
  1360. GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "rendering/rendering_device/vsync/swapchain_image_count", PROPERTY_HINT_RANGE, "2,4,1"), 3);
  1361. GLOBAL_DEF(PropertyInfo(Variant::INT, "rendering/rendering_device/staging_buffer/block_size_kb", PROPERTY_HINT_RANGE, "4,2048,1,or_greater"), 256);
  1362. GLOBAL_DEF(PropertyInfo(Variant::INT, "rendering/rendering_device/staging_buffer/max_size_mb", PROPERTY_HINT_RANGE, "1,1024,1,or_greater"), 128);
  1363. GLOBAL_DEF(PropertyInfo(Variant::INT, "rendering/rendering_device/staging_buffer/texture_upload_region_size_px", PROPERTY_HINT_RANGE, "1,256,1,or_greater"), 64);
  1364. GLOBAL_DEF(PropertyInfo(Variant::INT, "rendering/rendering_device/staging_buffer/texture_download_region_size_px", PROPERTY_HINT_RANGE, "1,256,1,or_greater"), 64);
  1365. GLOBAL_DEF_RST(PropertyInfo(Variant::BOOL, "rendering/rendering_device/pipeline_cache/enable"), true);
  1366. GLOBAL_DEF(PropertyInfo(Variant::FLOAT, "rendering/rendering_device/pipeline_cache/save_chunk_size_mb", PROPERTY_HINT_RANGE, "0.000001,64.0,0.001,or_greater"), 3.0);
  1367. GLOBAL_DEF(PropertyInfo(Variant::INT, "rendering/rendering_device/vulkan/max_descriptors_per_pool", PROPERTY_HINT_RANGE, "1,256,1,or_greater"), 64);
  1368. GLOBAL_DEF_RST("rendering/rendering_device/d3d12/max_resource_descriptors_per_frame", 16384);
  1369. custom_prop_info["rendering/rendering_device/d3d12/max_resource_descriptors_per_frame"] = PropertyInfo(Variant::INT, "rendering/rendering_device/d3d12/max_resource_descriptors_per_frame", PROPERTY_HINT_RANGE, "512,262144");
  1370. GLOBAL_DEF_RST("rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame", 1024);
  1371. custom_prop_info["rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame"] = PropertyInfo(Variant::INT, "rendering/rendering_device/d3d12/max_sampler_descriptors_per_frame", PROPERTY_HINT_RANGE, "256,2048");
  1372. GLOBAL_DEF_RST("rendering/rendering_device/d3d12/max_misc_descriptors_per_frame", 512);
  1373. custom_prop_info["rendering/rendering_device/d3d12/max_misc_descriptors_per_frame"] = PropertyInfo(Variant::INT, "rendering/rendering_device/d3d12/max_misc_descriptors_per_frame", PROPERTY_HINT_RANGE, "32,4096");
  1374. // The default value must match the minor part of the Agility SDK version
  1375. // installed by the scripts provided in the repository
  1376. // (check `misc/scripts/install_d3d12_sdk_windows.py`).
  1377. // For example, if the script installs 1.613.3, the default value must be 613.
  1378. GLOBAL_DEF_RST(PropertyInfo(Variant::INT, "rendering/rendering_device/d3d12/agility_sdk_version", PROPERTY_HINT_RANGE, "0,10000,1,or_greater,hide_slider"), 613);
  1379. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "rendering/textures/canvas_textures/default_texture_filter", PROPERTY_HINT_ENUM, "Nearest,Linear,Linear Mipmap,Nearest Mipmap"), 1);
  1380. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "rendering/textures/canvas_textures/default_texture_repeat", PROPERTY_HINT_ENUM, "Disable,Enable,Mirror"), 0);
  1381. GLOBAL_DEF("collada/use_ambient", false);
  1382. // Input settings
  1383. GLOBAL_DEF_BASIC("input_devices/pointing/android/enable_long_press_as_right_click", false);
  1384. GLOBAL_DEF_BASIC("input_devices/pointing/android/enable_pan_and_scale_gestures", false);
  1385. GLOBAL_DEF_BASIC(PropertyInfo(Variant::INT, "input_devices/pointing/android/rotary_input_scroll_axis", PROPERTY_HINT_ENUM, "Horizontal,Vertical"), 1);
  1386. GLOBAL_DEF("input_devices/pointing/android/override_volume_buttons", false);
  1387. GLOBAL_DEF_BASIC("input_devices/pointing/android/disable_scroll_deadzone", false);
  1388. // These properties will not show up in the dialog. If you want to exclude whole groups, use add_hidden_prefix().
  1389. GLOBAL_DEF_INTERNAL("application/config/features", PackedStringArray());
  1390. GLOBAL_DEF_INTERNAL("internationalization/locale/translation_remaps", PackedStringArray());
  1391. GLOBAL_DEF_INTERNAL("internationalization/locale/translations", PackedStringArray());
  1392. GLOBAL_DEF_INTERNAL("internationalization/locale/translations_pot_files", PackedStringArray());
  1393. GLOBAL_DEF_INTERNAL("internationalization/locale/translation_add_builtin_strings_to_pot", false);
  1394. #if !defined(NAVIGATION_2D_DISABLED) || !defined(NAVIGATION_3D_DISABLED)
  1395. GLOBAL_DEF("navigation/world/map_use_async_iterations", true);
  1396. GLOBAL_DEF("navigation/avoidance/thread_model/avoidance_use_multiple_threads", true);
  1397. GLOBAL_DEF("navigation/avoidance/thread_model/avoidance_use_high_priority_threads", true);
  1398. GLOBAL_DEF("navigation/pathfinding/max_threads", 4);
  1399. GLOBAL_DEF("navigation/baking/use_crash_prevention_checks", true);
  1400. GLOBAL_DEF("navigation/baking/thread_model/baking_use_multiple_threads", true);
  1401. GLOBAL_DEF("navigation/baking/thread_model/baking_use_high_priority_threads", true);
  1402. #endif // !defined(NAVIGATION_2D_DISABLED) || !defined(NAVIGATION_3D_DISABLED)
  1403. ProjectSettings::get_singleton()->add_hidden_prefix("input/");
  1404. }
  1405. ProjectSettings::ProjectSettings(const String &p_path) {
  1406. if (load_custom(p_path) == OK) {
  1407. resource_path = p_path.get_base_dir();
  1408. project_loaded = true;
  1409. }
  1410. }
  1411. ProjectSettings::~ProjectSettings() {
  1412. if (singleton == this) {
  1413. singleton = nullptr;
  1414. }
  1415. }