project_settings.cpp 60 KB

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