project_settings.cpp 51 KB

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