project_settings.cpp 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257
  1. /*************************************************************************/
  2. /* project_settings.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "project_settings.h"
  31. #include "core/bind/core_bind.h"
  32. #include "core/core_string_names.h"
  33. #include "core/io/file_access_network.h"
  34. #include "core/io/file_access_pack.h"
  35. #include "core/io/marshalls.h"
  36. #include "core/os/dir_access.h"
  37. #include "core/os/file_access.h"
  38. #include "core/os/keyboard.h"
  39. #include "core/os/os.h"
  40. #include "core/variant_parser.h"
  41. #include <zlib.h>
  42. ProjectSettings *ProjectSettings::singleton = NULL;
  43. ProjectSettings *ProjectSettings::get_singleton() {
  44. return singleton;
  45. }
  46. String ProjectSettings::get_resource_path() const {
  47. return resource_path;
  48. };
  49. String ProjectSettings::localize_path(const String &p_path) const {
  50. if (resource_path == "")
  51. return p_path; //not initialized yet
  52. if (p_path.begins_with("res://") || p_path.begins_with("user://") ||
  53. (p_path.is_abs_path() && !p_path.begins_with(resource_path)))
  54. return p_path.simplify_path();
  55. DirAccess *dir = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  56. String path = p_path.replace("\\", "/").simplify_path();
  57. if (dir->change_dir(path) == OK) {
  58. String cwd = dir->get_current_dir();
  59. cwd = cwd.replace("\\", "/");
  60. memdelete(dir);
  61. // Ensure that we end with a '/'.
  62. // This is important to ensure that we do not wrongly localize the resource path
  63. // in an absolute path that just happens to contain this string but points to a
  64. // different folder (e.g. "/my/project" as resource_path would be contained in
  65. // "/my/project_data", even though the latter is not part of res://.
  66. // `plus_file("")` is an easy way to ensure we have a trailing '/'.
  67. const String res_path = resource_path.plus_file("");
  68. // DirAccess::get_current_dir() is not guaranteed to return a path that with a trailing '/',
  69. // so we must make sure we have it as well in order to compare with 'res_path'.
  70. cwd = cwd.plus_file("");
  71. if (!cwd.begins_with(res_path)) {
  72. return p_path;
  73. };
  74. return cwd.replace_first(res_path, "res://");
  75. } else {
  76. memdelete(dir);
  77. int sep = path.find_last("/");
  78. if (sep == -1) {
  79. return "res://" + path;
  80. };
  81. String parent = path.substr(0, sep);
  82. String plocal = localize_path(parent);
  83. if (plocal == "") {
  84. return "";
  85. };
  86. // Only strip the starting '/' from 'path' if its parent ('plocal') ends with '/'
  87. if (plocal[plocal.length() - 1] == '/') {
  88. sep += 1;
  89. }
  90. return plocal + path.substr(sep, path.size() - sep);
  91. };
  92. }
  93. void ProjectSettings::set_initial_value(const String &p_name, const Variant &p_value) {
  94. ERR_FAIL_COND_MSG(!props.has(p_name), "Request for nonexistent project setting: " + p_name + ".");
  95. props[p_name].initial = p_value;
  96. }
  97. void ProjectSettings::set_restart_if_changed(const String &p_name, bool p_restart) {
  98. ERR_FAIL_COND_MSG(!props.has(p_name), "Request for nonexistent project setting: " + p_name + ".");
  99. props[p_name].restart_if_changed = p_restart;
  100. }
  101. String ProjectSettings::globalize_path(const String &p_path) const {
  102. if (p_path.begins_with("res://")) {
  103. if (resource_path != "") {
  104. return p_path.replace("res:/", resource_path);
  105. };
  106. return p_path.replace("res://", "");
  107. } else if (p_path.begins_with("user://")) {
  108. String data_dir = OS::get_singleton()->get_user_data_dir();
  109. if (data_dir != "") {
  110. return p_path.replace("user:/", data_dir);
  111. };
  112. return p_path.replace("user://", "");
  113. }
  114. return p_path;
  115. }
  116. bool ProjectSettings::_set(const StringName &p_name, const Variant &p_value) {
  117. _THREAD_SAFE_METHOD_
  118. if (p_value.get_type() == Variant::NIL)
  119. props.erase(p_name);
  120. else {
  121. if (p_name == CoreStringNames::get_singleton()->_custom_features) {
  122. Vector<String> custom_feature_array = String(p_value).split(",");
  123. for (int i = 0; i < custom_feature_array.size(); i++) {
  124. custom_features.insert(custom_feature_array[i]);
  125. }
  126. return true;
  127. }
  128. if (!disable_feature_overrides) {
  129. int dot = p_name.operator String().find(".");
  130. if (dot != -1) {
  131. Vector<String> s = p_name.operator String().split(".");
  132. bool override_valid = false;
  133. for (int i = 1; i < s.size(); i++) {
  134. String feature = s[i].strip_edges();
  135. if (OS::get_singleton()->has_feature(feature) || custom_features.has(feature)) {
  136. override_valid = true;
  137. break;
  138. }
  139. }
  140. if (override_valid) {
  141. feature_overrides[s[0]] = p_name;
  142. }
  143. }
  144. }
  145. if (props.has(p_name)) {
  146. if (!props[p_name].overridden)
  147. props[p_name].variant = p_value;
  148. } else {
  149. props[p_name] = VariantContainer(p_value, last_order++);
  150. }
  151. }
  152. return true;
  153. }
  154. bool ProjectSettings::_get(const StringName &p_name, Variant &r_ret) const {
  155. _THREAD_SAFE_METHOD_
  156. StringName name = p_name;
  157. if (!disable_feature_overrides && feature_overrides.has(name)) {
  158. name = feature_overrides[name];
  159. }
  160. if (!props.has(name)) {
  161. WARN_PRINTS("Property not found: " + String(name));
  162. return false;
  163. }
  164. r_ret = props[name].variant;
  165. return true;
  166. }
  167. struct _VCSort {
  168. String name;
  169. Variant::Type type;
  170. int order;
  171. int flags;
  172. bool operator<(const _VCSort &p_vcs) const { return order == p_vcs.order ? name < p_vcs.name : order < p_vcs.order; }
  173. };
  174. void ProjectSettings::_get_property_list(List<PropertyInfo> *p_list) const {
  175. _THREAD_SAFE_METHOD_
  176. Set<_VCSort> vclist;
  177. for (Map<StringName, VariantContainer>::Element *E = props.front(); E; E = E->next()) {
  178. const VariantContainer *v = &E->get();
  179. if (v->hide_from_editor)
  180. continue;
  181. _VCSort vc;
  182. vc.name = E->key();
  183. vc.order = v->order;
  184. vc.type = v->variant.get_type();
  185. if (vc.name.begins_with("input/") || vc.name.begins_with("import/") || vc.name.begins_with("export/") || vc.name.begins_with("/remap") || vc.name.begins_with("/locale") || vc.name.begins_with("/autoload"))
  186. vc.flags = PROPERTY_USAGE_STORAGE;
  187. else
  188. vc.flags = PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_STORAGE;
  189. if (v->restart_if_changed) {
  190. vc.flags |= PROPERTY_USAGE_RESTART_IF_CHANGED;
  191. }
  192. vclist.insert(vc);
  193. }
  194. for (Set<_VCSort>::Element *E = vclist.front(); E; E = E->next()) {
  195. String prop_info_name = E->get().name;
  196. int dot = prop_info_name.find(".");
  197. if (dot != -1)
  198. prop_info_name = prop_info_name.substr(0, dot);
  199. if (custom_prop_info.has(prop_info_name)) {
  200. PropertyInfo pi = custom_prop_info[prop_info_name];
  201. pi.name = E->get().name;
  202. pi.usage = E->get().flags;
  203. p_list->push_back(pi);
  204. } else
  205. p_list->push_back(PropertyInfo(E->get().type, E->get().name, PROPERTY_HINT_NONE, "", E->get().flags));
  206. }
  207. }
  208. bool ProjectSettings::_load_resource_pack(const String &p_pack, bool p_replace_files, int p_offset) {
  209. if (PackedData::get_singleton()->is_disabled())
  210. return false;
  211. bool ok = PackedData::get_singleton()->add_pack(p_pack, p_replace_files, p_offset) == OK;
  212. if (!ok)
  213. return false;
  214. //if data.pck is found, all directory access will be from here
  215. DirAccess::make_default<DirAccessPack>(DirAccess::ACCESS_RESOURCES);
  216. using_datapack = true;
  217. return true;
  218. }
  219. void ProjectSettings::_convert_to_last_version(int p_from_version) {
  220. if (p_from_version <= 3) {
  221. // Converts the actions from array to dictionary (array of events to dictionary with deadzone + events)
  222. for (Map<StringName, ProjectSettings::VariantContainer>::Element *E = props.front(); E; E = E->next()) {
  223. Variant value = E->get().variant;
  224. if (String(E->key()).begins_with("input/") && value.get_type() == Variant::ARRAY) {
  225. Array array = value;
  226. Dictionary action;
  227. action["deadzone"] = Variant(0.5f);
  228. action["events"] = array;
  229. E->get().variant = action;
  230. }
  231. }
  232. }
  233. }
  234. /*
  235. * This method is responsible for loading a project.godot file and/or data file
  236. * using the following merit order:
  237. * - If using NetworkClient, try to lookup project file or fail.
  238. * - If --main-pack was passed by the user (`p_main_pack`), load it or fail.
  239. * - Search for project PCKs automatically. For each step we try loading a potential
  240. * PCK, and if it doesn't work, we proceed to the next step. If any step succeeds,
  241. * we try loading the project settings, and abort if it fails. Steps:
  242. * o Bundled PCK in the executable.
  243. * o [macOS only] PCK with same basename as the binary in the .app resource dir.
  244. * o PCK with same basename as the binary in the binary's directory. We handle both
  245. * changing the extension to '.pck' (e.g. 'win_game.exe' -> 'win_game.pck') and
  246. * appending '.pck' to the binary name (e.g. 'linux_game' -> 'linux_game.pck').
  247. * o PCK with the same basename as the binary in the current working directory.
  248. * Same as above for the two possible PCK file names.
  249. * - On relevant platforms (Android/iOS), lookup project file in OS resource path.
  250. * If found, load it or fail.
  251. * - Lookup project file in passed `p_path` (--path passed by the user), i.e. we
  252. * are running from source code.
  253. * If not found and `p_upwards` is true (--upwards passed by the user), look for
  254. * project files in parent folders up to the system root (used to run a game
  255. * from command line while in a subfolder).
  256. * If a project file is found, load it or fail.
  257. * If nothing was found, error out.
  258. */
  259. Error ProjectSettings::_setup(const String &p_path, const String &p_main_pack, bool p_upwards) {
  260. // If looking for files in a network client, use it directly
  261. if (FileAccessNetworkClient::get_singleton()) {
  262. Error err = _load_settings_text_or_binary("res://project.godot", "res://project.binary");
  263. if (err == OK) {
  264. // Optional, we don't mind if it fails
  265. _load_settings_text("res://override.cfg");
  266. }
  267. return err;
  268. }
  269. // Attempt with a user-defined main pack first
  270. if (p_main_pack != "") {
  271. bool ok = _load_resource_pack(p_main_pack);
  272. ERR_FAIL_COND_V_MSG(!ok, ERR_CANT_OPEN, "Cannot open resource pack '" + p_main_pack + "'.");
  273. Error err = _load_settings_text_or_binary("res://project.godot", "res://project.binary");
  274. if (err == OK) {
  275. // Load override from location of the main pack
  276. // Optional, we don't mind if it fails
  277. _load_settings_text(p_main_pack.get_base_dir().plus_file("override.cfg"));
  278. }
  279. return err;
  280. }
  281. String exec_path = OS::get_singleton()->get_executable_path();
  282. if (exec_path != "") {
  283. // We do several tests sequentially until one succeeds to find a PCK,
  284. // and if so we attempt loading it at the end.
  285. // Attempt with PCK bundled into executable.
  286. bool found = _load_resource_pack(exec_path);
  287. // Attempt with exec_name.pck.
  288. // (This is the usual case when distributing a Godot game.)
  289. String exec_dir = exec_path.get_base_dir();
  290. String exec_filename = exec_path.get_file();
  291. String exec_basename = exec_filename.get_basename();
  292. // Based on the OS, it can be the exec path + '.pck' (Linux w/o extension, macOS in .app bundle)
  293. // or the exec path's basename + '.pck' (Windows).
  294. // We need to test both possibilities as extensions for Linux binaries are optional
  295. // (so both 'mygame.bin' and 'mygame' should be able to find 'mygame.pck').
  296. #ifdef OSX_ENABLED
  297. if (!found) {
  298. // Attempt to load PCK from macOS .app bundle resources.
  299. found = _load_resource_pack(OS::get_singleton()->get_bundle_resource_dir().plus_file(exec_basename + ".pck")) || _load_resource_pack(OS::get_singleton()->get_bundle_resource_dir().plus_file(exec_filename + ".pck"));
  300. }
  301. #endif
  302. if (!found) {
  303. // Try to load data pack at the location of the executable.
  304. // As mentioned above, we have two potential names to attempt.
  305. found = _load_resource_pack(exec_dir.plus_file(exec_basename + ".pck")) || _load_resource_pack(exec_dir.plus_file(exec_filename + ".pck"));
  306. }
  307. if (!found) {
  308. // If we couldn't find them next to the executable, we attempt
  309. // the current working directory. Same story, two tests.
  310. found = _load_resource_pack(exec_basename + ".pck") || _load_resource_pack(exec_filename + ".pck");
  311. }
  312. // If we opened our package, try and load our project.
  313. if (found) {
  314. Error err = _load_settings_text_or_binary("res://project.godot", "res://project.binary");
  315. if (err == OK) {
  316. // Load override from location of the executable.
  317. // Optional, we don't mind if it fails.
  318. _load_settings_text(exec_path.get_base_dir().plus_file("override.cfg"));
  319. }
  320. return err;
  321. }
  322. }
  323. // Try to use the filesystem for files, according to OS.
  324. // (Only Android -when reading from pck- and iOS use this.)
  325. if (OS::get_singleton()->get_resource_dir() != "") {
  326. // OS will call ProjectSettings->get_resource_path which will be empty if not overridden!
  327. // If the OS would rather use a specific location, then it will not be empty.
  328. resource_path = OS::get_singleton()->get_resource_dir().replace("\\", "/");
  329. if (resource_path != "" && resource_path[resource_path.length() - 1] == '/') {
  330. resource_path = resource_path.substr(0, resource_path.length() - 1); // Chop end.
  331. }
  332. Error err = _load_settings_text_or_binary("res://project.godot", "res://project.binary");
  333. if (err == OK) {
  334. // Optional, we don't mind if it fails.
  335. _load_settings_text("res://override.cfg");
  336. }
  337. return err;
  338. }
  339. // Nothing was found, try to find a project file in provided path (`p_path`)
  340. // or, if requested (`p_upwards`) in parent directories.
  341. DirAccess *d = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  342. ERR_FAIL_COND_V_MSG(!d, ERR_CANT_CREATE, "Cannot create DirAccess for path '" + p_path + "'.");
  343. d->change_dir(p_path);
  344. String current_dir = d->get_current_dir();
  345. String candidate = current_dir;
  346. bool found = false;
  347. Error err;
  348. while (true) {
  349. err = _load_settings_text_or_binary(current_dir.plus_file("project.godot"), current_dir.plus_file("project.binary"));
  350. if (err == OK) {
  351. // Optional, we don't mind if it fails.
  352. _load_settings_text(current_dir.plus_file("override.cfg"));
  353. candidate = current_dir;
  354. found = true;
  355. break;
  356. }
  357. if (p_upwards) {
  358. // Try to load settings ascending through parent directories
  359. d->change_dir("..");
  360. if (d->get_current_dir() == current_dir)
  361. break; // not doing anything useful
  362. current_dir = d->get_current_dir();
  363. } else {
  364. break;
  365. }
  366. }
  367. resource_path = candidate;
  368. resource_path = resource_path.replace("\\", "/"); // Windows path to Unix path just in case.
  369. memdelete(d);
  370. if (!found)
  371. return err;
  372. if (resource_path.length() && resource_path[resource_path.length() - 1] == '/') {
  373. resource_path = resource_path.substr(0, resource_path.length() - 1); // Chop end.
  374. }
  375. return OK;
  376. }
  377. Error ProjectSettings::setup(const String &p_path, const String &p_main_pack, bool p_upwards) {
  378. Error err = _setup(p_path, p_main_pack, p_upwards);
  379. if (err == OK) {
  380. String custom_settings = GLOBAL_DEF("application/config/project_settings_override", "");
  381. if (custom_settings != "") {
  382. _load_settings_text(custom_settings);
  383. }
  384. }
  385. // Using GLOBAL_GET on every block for compressing can be slow, so assigning here.
  386. Compression::zstd_long_distance_matching = GLOBAL_GET("compression/formats/zstd/long_distance_matching");
  387. Compression::zstd_level = GLOBAL_GET("compression/formats/zstd/compression_level");
  388. Compression::zstd_window_log_size = GLOBAL_GET("compression/formats/zstd/window_log_size");
  389. Compression::zlib_level = GLOBAL_GET("compression/formats/zlib/compression_level");
  390. Compression::gzip_level = GLOBAL_GET("compression/formats/gzip/compression_level");
  391. return err;
  392. }
  393. bool ProjectSettings::has_setting(String p_var) const {
  394. _THREAD_SAFE_METHOD_
  395. return props.has(p_var);
  396. }
  397. void ProjectSettings::set_registering_order(bool p_enable) {
  398. registering_order = p_enable;
  399. }
  400. Error ProjectSettings::_load_settings_binary(const String &p_path) {
  401. Error err;
  402. FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
  403. if (err != OK) {
  404. return err;
  405. }
  406. uint8_t hdr[4];
  407. f->get_buffer(hdr, 4);
  408. if (hdr[0] != 'E' || hdr[1] != 'C' || hdr[2] != 'F' || hdr[3] != 'G') {
  409. memdelete(f);
  410. ERR_FAIL_V_MSG(ERR_FILE_CORRUPT, "Corrupted header in binary project.binary (not ECFG).");
  411. }
  412. uint32_t count = f->get_32();
  413. for (uint32_t i = 0; i < count; i++) {
  414. uint32_t slen = f->get_32();
  415. CharString cs;
  416. cs.resize(slen + 1);
  417. cs[slen] = 0;
  418. f->get_buffer((uint8_t *)cs.ptr(), slen);
  419. String key;
  420. key.parse_utf8(cs.ptr());
  421. uint32_t vlen = f->get_32();
  422. Vector<uint8_t> d;
  423. d.resize(vlen);
  424. f->get_buffer(d.ptrw(), vlen);
  425. Variant value;
  426. err = decode_variant(value, d.ptr(), d.size(), NULL, true);
  427. ERR_CONTINUE_MSG(err != OK, "Error decoding property: " + key + ".");
  428. set(key, value);
  429. }
  430. f->close();
  431. memdelete(f);
  432. return OK;
  433. }
  434. Error ProjectSettings::_load_settings_text(const String &p_path) {
  435. Error err;
  436. FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
  437. if (!f) {
  438. // FIXME: Above 'err' error code is ERR_FILE_CANT_OPEN if the file is missing
  439. // This needs to be streamlined if we want decent error reporting
  440. return ERR_FILE_NOT_FOUND;
  441. }
  442. VariantParser::StreamFile stream;
  443. stream.f = f;
  444. String assign;
  445. Variant value;
  446. VariantParser::Tag next_tag;
  447. int lines = 0;
  448. String error_text;
  449. String section;
  450. int config_version = 0;
  451. while (true) {
  452. assign = Variant();
  453. next_tag.fields.clear();
  454. next_tag.name = String();
  455. err = VariantParser::parse_tag_assign_eof(&stream, lines, error_text, next_tag, assign, value, NULL, true);
  456. if (err == ERR_FILE_EOF) {
  457. memdelete(f);
  458. // If we're loading a project.godot from source code, we can operate some
  459. // ProjectSettings conversions if need be.
  460. _convert_to_last_version(config_version);
  461. last_save_time = FileAccess::get_modified_time(get_resource_path().plus_file("project.godot"));
  462. return OK;
  463. } else if (err != OK) {
  464. ERR_PRINTS("Error parsing " + p_path + " at line " + itos(lines) + ": " + error_text + " File might be corrupted.");
  465. memdelete(f);
  466. return err;
  467. }
  468. if (assign != String()) {
  469. if (section == String() && assign == "config_version") {
  470. config_version = value;
  471. if (config_version > CONFIG_VERSION) {
  472. memdelete(f);
  473. ERR_FAIL_V_MSG(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));
  474. }
  475. } else {
  476. if (section == String()) {
  477. set(assign, value);
  478. } else {
  479. set(section + "/" + assign, value);
  480. }
  481. }
  482. } else if (next_tag.name != String()) {
  483. section = next_tag.name;
  484. }
  485. }
  486. }
  487. Error ProjectSettings::_load_settings_text_or_binary(const String &p_text_path, const String &p_bin_path) {
  488. // Attempt first to load the binary project.godot file.
  489. Error err = _load_settings_binary(p_bin_path);
  490. if (err == OK) {
  491. return OK;
  492. } else if (err != ERR_FILE_NOT_FOUND) {
  493. // If the file exists but can't be loaded, we want to know it.
  494. ERR_PRINT("Couldn't load file '" + p_bin_path + "', error code " + itos(err) + ".");
  495. }
  496. // Fallback to text-based project.godot file if binary was not found.
  497. err = _load_settings_text(p_text_path);
  498. if (err == OK) {
  499. return OK;
  500. } else if (err != ERR_FILE_NOT_FOUND) {
  501. ERR_PRINT("Couldn't load file '" + p_text_path + "', error code " + itos(err) + ".");
  502. }
  503. return err;
  504. }
  505. int ProjectSettings::get_order(const String &p_name) const {
  506. ERR_FAIL_COND_V_MSG(!props.has(p_name), -1, "Request for nonexistent project setting: " + p_name + ".");
  507. return props[p_name].order;
  508. }
  509. void ProjectSettings::set_order(const String &p_name, int p_order) {
  510. ERR_FAIL_COND_MSG(!props.has(p_name), "Request for nonexistent project setting: " + p_name + ".");
  511. props[p_name].order = p_order;
  512. }
  513. void ProjectSettings::set_builtin_order(const String &p_name) {
  514. ERR_FAIL_COND_MSG(!props.has(p_name), "Request for nonexistent project setting: " + p_name + ".");
  515. if (props[p_name].order >= NO_BUILTIN_ORDER_BASE) {
  516. props[p_name].order = last_builtin_order++;
  517. }
  518. }
  519. void ProjectSettings::clear(const String &p_name) {
  520. ERR_FAIL_COND_MSG(!props.has(p_name), "Request for nonexistent project setting: " + p_name + ".");
  521. props.erase(p_name);
  522. }
  523. Error ProjectSettings::save() {
  524. Error error = save_custom(get_resource_path().plus_file("project.godot"));
  525. if (error == OK) {
  526. last_save_time = FileAccess::get_modified_time(get_resource_path().plus_file("project.godot"));
  527. }
  528. return error;
  529. }
  530. Error ProjectSettings::_save_settings_binary(const String &p_file, const Map<String, List<String> > &props, const CustomMap &p_custom, const String &p_custom_features) {
  531. Error err;
  532. FileAccess *file = FileAccess::open(p_file, FileAccess::WRITE, &err);
  533. ERR_FAIL_COND_V_MSG(err != OK, err, "Couldn't save project.binary at " + p_file + ".");
  534. uint8_t hdr[4] = { 'E', 'C', 'F', 'G' };
  535. file->store_buffer(hdr, 4);
  536. int count = 0;
  537. for (Map<String, List<String> >::Element *E = props.front(); E; E = E->next()) {
  538. for (List<String>::Element *F = E->get().front(); F; F = F->next()) {
  539. count++;
  540. }
  541. }
  542. if (p_custom_features != String()) {
  543. file->store_32(count + 1);
  544. //store how many properties are saved, add one for custom featuers, which must always go first
  545. String key = CoreStringNames::get_singleton()->_custom_features;
  546. file->store_pascal_string(key);
  547. int len;
  548. err = encode_variant(p_custom_features, NULL, len, false);
  549. if (err != OK) {
  550. memdelete(file);
  551. ERR_FAIL_V(err);
  552. }
  553. Vector<uint8_t> buff;
  554. buff.resize(len);
  555. err = encode_variant(p_custom_features, buff.ptrw(), len, false);
  556. if (err != OK) {
  557. memdelete(file);
  558. ERR_FAIL_V(err);
  559. }
  560. file->store_32(len);
  561. file->store_buffer(buff.ptr(), buff.size());
  562. } else {
  563. file->store_32(count); //store how many properties are saved
  564. }
  565. for (Map<String, List<String> >::Element *E = props.front(); E; E = E->next()) {
  566. for (List<String>::Element *F = E->get().front(); F; F = F->next()) {
  567. String key = F->get();
  568. if (E->key() != "")
  569. key = E->key() + "/" + key;
  570. Variant value;
  571. if (p_custom.has(key))
  572. value = p_custom[key];
  573. else
  574. value = get(key);
  575. file->store_pascal_string(key);
  576. int len;
  577. err = encode_variant(value, NULL, len, true);
  578. if (err != OK)
  579. memdelete(file);
  580. ERR_FAIL_COND_V_MSG(err != OK, ERR_INVALID_DATA, "Error when trying to encode Variant.");
  581. Vector<uint8_t> buff;
  582. buff.resize(len);
  583. err = encode_variant(value, buff.ptrw(), len, true);
  584. if (err != OK)
  585. memdelete(file);
  586. ERR_FAIL_COND_V_MSG(err != OK, ERR_INVALID_DATA, "Error when trying to encode Variant.");
  587. file->store_32(len);
  588. file->store_buffer(buff.ptr(), buff.size());
  589. }
  590. }
  591. file->close();
  592. memdelete(file);
  593. return OK;
  594. }
  595. Error ProjectSettings::_save_settings_text(const String &p_file, const Map<String, List<String> > &props, const CustomMap &p_custom, const String &p_custom_features) {
  596. Error err;
  597. FileAccess *file = FileAccess::open(p_file, FileAccess::WRITE, &err);
  598. ERR_FAIL_COND_V_MSG(err != OK, err, "Couldn't save project.godot - " + p_file + ".");
  599. file->store_line("; Engine configuration file.");
  600. file->store_line("; It's best edited using the editor UI and not directly,");
  601. file->store_line("; since the parameters that go here are not all obvious.");
  602. file->store_line(";");
  603. file->store_line("; Format:");
  604. file->store_line("; [section] ; section goes between []");
  605. file->store_line("; param=value ; assign values to parameters");
  606. file->store_line("");
  607. file->store_string("config_version=" + itos(CONFIG_VERSION) + "\n");
  608. if (p_custom_features != String())
  609. file->store_string("custom_features=\"" + p_custom_features + "\"\n");
  610. file->store_string("\n");
  611. for (Map<String, List<String> >::Element *E = props.front(); E; E = E->next()) {
  612. if (E != props.front())
  613. file->store_string("\n");
  614. if (E->key() != "")
  615. file->store_string("[" + E->key() + "]\n\n");
  616. for (List<String>::Element *F = E->get().front(); F; F = F->next()) {
  617. String key = F->get();
  618. if (E->key() != "")
  619. key = E->key() + "/" + key;
  620. Variant value;
  621. if (p_custom.has(key))
  622. value = p_custom[key];
  623. else
  624. value = get(key);
  625. String vstr;
  626. VariantWriter::write_to_string(value, vstr);
  627. file->store_string(F->get().property_name_encode() + "=" + vstr + "\n");
  628. }
  629. }
  630. file->close();
  631. memdelete(file);
  632. return OK;
  633. }
  634. Error ProjectSettings::_save_custom_bnd(const String &p_file) { // add other params as dictionary and array?
  635. return save_custom(p_file);
  636. };
  637. Error ProjectSettings::save_custom(const String &p_path, const CustomMap &p_custom, const Vector<String> &p_custom_features, bool p_merge_with_current) {
  638. ERR_FAIL_COND_V_MSG(p_path == "", ERR_INVALID_PARAMETER, "Project settings save path cannot be empty.");
  639. Set<_VCSort> vclist;
  640. if (p_merge_with_current) {
  641. for (Map<StringName, VariantContainer>::Element *G = props.front(); G; G = G->next()) {
  642. const VariantContainer *v = &G->get();
  643. if (v->hide_from_editor)
  644. continue;
  645. if (p_custom.has(G->key()))
  646. continue;
  647. _VCSort vc;
  648. vc.name = G->key(); //*k;
  649. vc.order = v->order;
  650. vc.type = v->variant.get_type();
  651. vc.flags = PROPERTY_USAGE_EDITOR | PROPERTY_USAGE_STORAGE;
  652. if (v->variant == v->initial)
  653. continue;
  654. vclist.insert(vc);
  655. }
  656. }
  657. for (const Map<String, Variant>::Element *E = p_custom.front(); E; E = E->next()) {
  658. // Lookup global prop to store in the same order
  659. Map<StringName, VariantContainer>::Element *global_prop = props.find(E->key());
  660. _VCSort vc;
  661. vc.name = E->key();
  662. vc.order = global_prop ? global_prop->get().order : 0xFFFFFFF;
  663. vc.type = E->get().get_type();
  664. vc.flags = PROPERTY_USAGE_STORAGE;
  665. vclist.insert(vc);
  666. }
  667. Map<String, List<String> > props;
  668. for (Set<_VCSort>::Element *E = vclist.front(); E; E = E->next()) {
  669. String category = E->get().name;
  670. String name = E->get().name;
  671. int div = category.find("/");
  672. if (div < 0)
  673. category = "";
  674. else {
  675. category = category.substr(0, div);
  676. name = name.substr(div + 1, name.size());
  677. }
  678. props[category].push_back(name);
  679. }
  680. String custom_features;
  681. for (int i = 0; i < p_custom_features.size(); i++) {
  682. if (i > 0)
  683. custom_features += ",";
  684. String f = p_custom_features[i].strip_edges().replace("\"", "");
  685. custom_features += f;
  686. }
  687. if (p_path.ends_with(".godot") || p_path.ends_with("override.cfg")) {
  688. return _save_settings_text(p_path, props, p_custom, custom_features);
  689. } else if (p_path.ends_with(".binary")) {
  690. return _save_settings_binary(p_path, props, p_custom, custom_features);
  691. } else {
  692. ERR_FAIL_V_MSG(ERR_FILE_UNRECOGNIZED, "Unknown config file format: " + p_path + ".");
  693. }
  694. }
  695. Variant _GLOBAL_DEF_ALIAS(const String &p_var, const String &p_old_name, const Variant &p_default, bool p_restart_if_changed) {
  696. // if the new name setting isn't present, try the old one
  697. if (!ProjectSettings::get_singleton()->has_setting(p_var)) {
  698. if (ProjectSettings::get_singleton()->has_setting(p_old_name)) {
  699. // if the old setting is present, get the value and set it in the new setting
  700. Variant value = ProjectSettings::get_singleton()->get(p_old_name);
  701. ProjectSettings::get_singleton()->set(p_var, value);
  702. }
  703. }
  704. return _GLOBAL_DEF(p_var, p_default, p_restart_if_changed);
  705. }
  706. Variant _GLOBAL_DEF(const String &p_var, const Variant &p_default, bool p_restart_if_changed) {
  707. Variant ret;
  708. if (!ProjectSettings::get_singleton()->has_setting(p_var)) {
  709. ProjectSettings::get_singleton()->set(p_var, p_default);
  710. }
  711. ret = ProjectSettings::get_singleton()->get(p_var);
  712. ProjectSettings::get_singleton()->set_initial_value(p_var, p_default);
  713. ProjectSettings::get_singleton()->set_builtin_order(p_var);
  714. ProjectSettings::get_singleton()->set_restart_if_changed(p_var, p_restart_if_changed);
  715. return ret;
  716. }
  717. Vector<String> ProjectSettings::get_optimizer_presets() const {
  718. List<PropertyInfo> pi;
  719. ProjectSettings::get_singleton()->get_property_list(&pi);
  720. Vector<String> names;
  721. for (List<PropertyInfo>::Element *E = pi.front(); E; E = E->next()) {
  722. if (!E->get().name.begins_with("optimizer_presets/"))
  723. continue;
  724. names.push_back(E->get().name.get_slicec('/', 1));
  725. }
  726. names.sort();
  727. return names;
  728. }
  729. void ProjectSettings::_add_property_info_bind(const Dictionary &p_info) {
  730. ERR_FAIL_COND(!p_info.has("name"));
  731. ERR_FAIL_COND(!p_info.has("type"));
  732. PropertyInfo pinfo;
  733. pinfo.name = p_info["name"];
  734. ERR_FAIL_COND(!props.has(pinfo.name));
  735. pinfo.type = Variant::Type(p_info["type"].operator int());
  736. ERR_FAIL_INDEX(pinfo.type, Variant::VARIANT_MAX);
  737. if (p_info.has("hint"))
  738. pinfo.hint = PropertyHint(p_info["hint"].operator int());
  739. if (p_info.has("hint_string"))
  740. pinfo.hint_string = p_info["hint_string"];
  741. set_custom_property_info(pinfo.name, pinfo);
  742. }
  743. void ProjectSettings::set_custom_property_info(const String &p_prop, const PropertyInfo &p_info) {
  744. ERR_FAIL_COND(!props.has(p_prop));
  745. custom_prop_info[p_prop] = p_info;
  746. custom_prop_info[p_prop].name = p_prop;
  747. }
  748. const Map<StringName, PropertyInfo> &ProjectSettings::get_custom_property_info() const {
  749. return custom_prop_info;
  750. }
  751. void ProjectSettings::set_disable_feature_overrides(bool p_disable) {
  752. disable_feature_overrides = p_disable;
  753. }
  754. bool ProjectSettings::is_using_datapack() const {
  755. return using_datapack;
  756. }
  757. bool ProjectSettings::property_can_revert(const String &p_name) {
  758. if (!props.has(p_name))
  759. return false;
  760. return props[p_name].initial != props[p_name].variant;
  761. }
  762. Variant ProjectSettings::property_get_revert(const String &p_name) {
  763. if (!props.has(p_name))
  764. return Variant();
  765. return props[p_name].initial;
  766. }
  767. void ProjectSettings::set_setting(const String &p_setting, const Variant &p_value) {
  768. set(p_setting, p_value);
  769. }
  770. Variant ProjectSettings::get_setting(const String &p_setting) const {
  771. return get(p_setting);
  772. }
  773. bool ProjectSettings::has_custom_feature(const String &p_feature) const {
  774. return custom_features.has(p_feature);
  775. }
  776. void ProjectSettings::_bind_methods() {
  777. ClassDB::bind_method(D_METHOD("has_setting", "name"), &ProjectSettings::has_setting);
  778. ClassDB::bind_method(D_METHOD("set_setting", "name", "value"), &ProjectSettings::set_setting);
  779. ClassDB::bind_method(D_METHOD("get_setting", "name"), &ProjectSettings::get_setting);
  780. ClassDB::bind_method(D_METHOD("set_order", "name", "position"), &ProjectSettings::set_order);
  781. ClassDB::bind_method(D_METHOD("get_order", "name"), &ProjectSettings::get_order);
  782. ClassDB::bind_method(D_METHOD("set_initial_value", "name", "value"), &ProjectSettings::set_initial_value);
  783. ClassDB::bind_method(D_METHOD("add_property_info", "hint"), &ProjectSettings::_add_property_info_bind);
  784. ClassDB::bind_method(D_METHOD("clear", "name"), &ProjectSettings::clear);
  785. ClassDB::bind_method(D_METHOD("localize_path", "path"), &ProjectSettings::localize_path);
  786. ClassDB::bind_method(D_METHOD("globalize_path", "path"), &ProjectSettings::globalize_path);
  787. ClassDB::bind_method(D_METHOD("save"), &ProjectSettings::save);
  788. ClassDB::bind_method(D_METHOD("load_resource_pack", "pack", "replace_files", "offset"), &ProjectSettings::_load_resource_pack, DEFVAL(true), DEFVAL(0));
  789. ClassDB::bind_method(D_METHOD("property_can_revert", "name"), &ProjectSettings::property_can_revert);
  790. ClassDB::bind_method(D_METHOD("property_get_revert", "name"), &ProjectSettings::property_get_revert);
  791. ClassDB::bind_method(D_METHOD("save_custom", "file"), &ProjectSettings::_save_custom_bnd);
  792. }
  793. ProjectSettings::ProjectSettings() {
  794. // Initialization of engine variables should be done in the setup() method,
  795. // so that the values can be overridden from project.godot or project.binary.
  796. singleton = this;
  797. last_order = NO_BUILTIN_ORDER_BASE;
  798. last_builtin_order = 0;
  799. disable_feature_overrides = false;
  800. registering_order = true;
  801. Array events;
  802. Dictionary action;
  803. Ref<InputEventKey> key;
  804. Ref<InputEventJoypadButton> joyb;
  805. GLOBAL_DEF("application/config/name", "");
  806. GLOBAL_DEF("application/config/description", "");
  807. custom_prop_info["application/config/description"] = PropertyInfo(Variant::STRING, "application/config/description", PROPERTY_HINT_MULTILINE_TEXT);
  808. GLOBAL_DEF("application/run/main_scene", "");
  809. custom_prop_info["application/run/main_scene"] = PropertyInfo(Variant::STRING, "application/run/main_scene", PROPERTY_HINT_FILE, "*.tscn,*.scn,*.res");
  810. GLOBAL_DEF("application/run/disable_stdout", false);
  811. GLOBAL_DEF("application/run/disable_stderr", false);
  812. GLOBAL_DEF("application/config/use_custom_user_dir", false);
  813. GLOBAL_DEF("application/config/custom_user_dir_name", "");
  814. GLOBAL_DEF("application/config/project_settings_override", "");
  815. GLOBAL_DEF("audio/default_bus_layout", "res://default_bus_layout.tres");
  816. custom_prop_info["audio/default_bus_layout"] = PropertyInfo(Variant::STRING, "audio/default_bus_layout", PROPERTY_HINT_FILE, "*.tres");
  817. PoolStringArray extensions = PoolStringArray();
  818. extensions.push_back("gd");
  819. if (Engine::get_singleton()->has_singleton("GodotSharp"))
  820. extensions.push_back("cs");
  821. extensions.push_back("gdshader");
  822. extensions.push_back("shader");
  823. GLOBAL_DEF("editor/search_in_file_extensions", extensions);
  824. custom_prop_info["editor/search_in_file_extensions"] = PropertyInfo(Variant::POOL_STRING_ARRAY, "editor/search_in_file_extensions");
  825. GLOBAL_DEF("editor/script_templates_search_path", "res://script_templates");
  826. custom_prop_info["editor/script_templates_search_path"] = PropertyInfo(Variant::STRING, "editor/script_templates_search_path", PROPERTY_HINT_DIR);
  827. action = Dictionary();
  828. action["deadzone"] = Variant(0.5f);
  829. events = Array();
  830. key.instance();
  831. key->set_scancode(KEY_ENTER);
  832. events.push_back(key);
  833. key.instance();
  834. key->set_scancode(KEY_KP_ENTER);
  835. events.push_back(key);
  836. key.instance();
  837. key->set_scancode(KEY_SPACE);
  838. events.push_back(key);
  839. joyb.instance();
  840. joyb->set_button_index(JOY_BUTTON_0);
  841. events.push_back(joyb);
  842. action["events"] = events;
  843. GLOBAL_DEF("input/ui_accept", action);
  844. input_presets.push_back("input/ui_accept");
  845. action = Dictionary();
  846. action["deadzone"] = Variant(0.5f);
  847. events = Array();
  848. key.instance();
  849. key->set_scancode(KEY_SPACE);
  850. events.push_back(key);
  851. joyb.instance();
  852. joyb->set_button_index(JOY_BUTTON_3);
  853. events.push_back(joyb);
  854. action["events"] = events;
  855. GLOBAL_DEF("input/ui_select", action);
  856. input_presets.push_back("input/ui_select");
  857. action = Dictionary();
  858. action["deadzone"] = Variant(0.5f);
  859. events = Array();
  860. key.instance();
  861. key->set_scancode(KEY_ESCAPE);
  862. events.push_back(key);
  863. joyb.instance();
  864. joyb->set_button_index(JOY_BUTTON_1);
  865. events.push_back(joyb);
  866. action["events"] = events;
  867. GLOBAL_DEF("input/ui_cancel", action);
  868. input_presets.push_back("input/ui_cancel");
  869. action = Dictionary();
  870. action["deadzone"] = Variant(0.5f);
  871. events = Array();
  872. key.instance();
  873. key->set_scancode(KEY_TAB);
  874. events.push_back(key);
  875. action["events"] = events;
  876. GLOBAL_DEF("input/ui_focus_next", action);
  877. input_presets.push_back("input/ui_focus_next");
  878. action = Dictionary();
  879. action["deadzone"] = Variant(0.5f);
  880. events = Array();
  881. key.instance();
  882. key->set_scancode(KEY_TAB);
  883. key->set_shift(true);
  884. events.push_back(key);
  885. action["events"] = events;
  886. GLOBAL_DEF("input/ui_focus_prev", action);
  887. input_presets.push_back("input/ui_focus_prev");
  888. action = Dictionary();
  889. action["deadzone"] = Variant(0.5f);
  890. events = Array();
  891. key.instance();
  892. key->set_scancode(KEY_LEFT);
  893. events.push_back(key);
  894. joyb.instance();
  895. joyb->set_button_index(JOY_DPAD_LEFT);
  896. events.push_back(joyb);
  897. action["events"] = events;
  898. GLOBAL_DEF("input/ui_left", action);
  899. input_presets.push_back("input/ui_left");
  900. action = Dictionary();
  901. action["deadzone"] = Variant(0.5f);
  902. events = Array();
  903. key.instance();
  904. key->set_scancode(KEY_RIGHT);
  905. events.push_back(key);
  906. joyb.instance();
  907. joyb->set_button_index(JOY_DPAD_RIGHT);
  908. events.push_back(joyb);
  909. action["events"] = events;
  910. GLOBAL_DEF("input/ui_right", action);
  911. input_presets.push_back("input/ui_right");
  912. action = Dictionary();
  913. action["deadzone"] = Variant(0.5f);
  914. events = Array();
  915. key.instance();
  916. key->set_scancode(KEY_UP);
  917. events.push_back(key);
  918. joyb.instance();
  919. joyb->set_button_index(JOY_DPAD_UP);
  920. events.push_back(joyb);
  921. action["events"] = events;
  922. GLOBAL_DEF("input/ui_up", action);
  923. input_presets.push_back("input/ui_up");
  924. action = Dictionary();
  925. action["deadzone"] = Variant(0.5f);
  926. events = Array();
  927. key.instance();
  928. key->set_scancode(KEY_DOWN);
  929. events.push_back(key);
  930. joyb.instance();
  931. joyb->set_button_index(JOY_DPAD_DOWN);
  932. events.push_back(joyb);
  933. action["events"] = events;
  934. GLOBAL_DEF("input/ui_down", action);
  935. input_presets.push_back("input/ui_down");
  936. action = Dictionary();
  937. action["deadzone"] = Variant(0.5f);
  938. events = Array();
  939. key.instance();
  940. key->set_scancode(KEY_PAGEUP);
  941. events.push_back(key);
  942. action["events"] = events;
  943. GLOBAL_DEF("input/ui_page_up", action);
  944. input_presets.push_back("input/ui_page_up");
  945. action = Dictionary();
  946. action["deadzone"] = Variant(0.5f);
  947. events = Array();
  948. key.instance();
  949. key->set_scancode(KEY_PAGEDOWN);
  950. events.push_back(key);
  951. action["events"] = events;
  952. GLOBAL_DEF("input/ui_page_down", action);
  953. input_presets.push_back("input/ui_page_down");
  954. action = Dictionary();
  955. action["deadzone"] = Variant(0.5f);
  956. events = Array();
  957. key.instance();
  958. key->set_scancode(KEY_HOME);
  959. events.push_back(key);
  960. action["events"] = events;
  961. GLOBAL_DEF("input/ui_home", action);
  962. input_presets.push_back("input/ui_home");
  963. action = Dictionary();
  964. action["deadzone"] = Variant(0.5f);
  965. events = Array();
  966. key.instance();
  967. key->set_scancode(KEY_END);
  968. events.push_back(key);
  969. action["events"] = events;
  970. GLOBAL_DEF("input/ui_end", action);
  971. input_presets.push_back("input/ui_end");
  972. custom_prop_info["display/window/handheld/orientation"] = PropertyInfo(Variant::STRING, "display/window/handheld/orientation", PROPERTY_HINT_ENUM, "landscape,portrait,reverse_landscape,reverse_portrait,sensor_landscape,sensor_portrait,sensor");
  973. custom_prop_info["rendering/threads/thread_model"] = PropertyInfo(Variant::INT, "rendering/threads/thread_model", PROPERTY_HINT_ENUM, "Single-Unsafe,Single-Safe,Multi-Threaded");
  974. custom_prop_info["physics/2d/thread_model"] = PropertyInfo(Variant::INT, "physics/2d/thread_model", PROPERTY_HINT_ENUM, "Single-Unsafe,Single-Safe,Multi-Threaded");
  975. custom_prop_info["rendering/quality/intended_usage/framebuffer_allocation"] = PropertyInfo(Variant::INT, "rendering/quality/intended_usage/framebuffer_allocation", PROPERTY_HINT_ENUM, "2D,2D Without Sampling,3D,3D Without Effects");
  976. GLOBAL_DEF("debug/settings/profiler/max_functions", 16384);
  977. custom_prop_info["debug/settings/profiler/max_functions"] = PropertyInfo(Variant::INT, "debug/settings/profiler/max_functions", PROPERTY_HINT_RANGE, "128,65535,1");
  978. GLOBAL_DEF("compression/formats/zstd/long_distance_matching", Compression::zstd_long_distance_matching);
  979. custom_prop_info["compression/formats/zstd/long_distance_matching"] = PropertyInfo(Variant::BOOL, "compression/formats/zstd/long_distance_matching");
  980. GLOBAL_DEF("compression/formats/zstd/compression_level", Compression::zstd_level);
  981. custom_prop_info["compression/formats/zstd/compression_level"] = PropertyInfo(Variant::INT, "compression/formats/zstd/compression_level", PROPERTY_HINT_RANGE, "1,22,1");
  982. GLOBAL_DEF("compression/formats/zstd/window_log_size", Compression::zstd_window_log_size);
  983. custom_prop_info["compression/formats/zstd/window_log_size"] = PropertyInfo(Variant::INT, "compression/formats/zstd/window_log_size", PROPERTY_HINT_RANGE, "10,30,1");
  984. GLOBAL_DEF("compression/formats/zlib/compression_level", Compression::zlib_level);
  985. custom_prop_info["compression/formats/zlib/compression_level"] = PropertyInfo(Variant::INT, "compression/formats/zlib/compression_level", PROPERTY_HINT_RANGE, "-1,9,1");
  986. GLOBAL_DEF("compression/formats/gzip/compression_level", Compression::gzip_level);
  987. custom_prop_info["compression/formats/gzip/compression_level"] = PropertyInfo(Variant::INT, "compression/formats/gzip/compression_level", PROPERTY_HINT_RANGE, "-1,9,1");
  988. // Would ideally be defined in an Android-specific file, but then it doesn't appear in the docs
  989. GLOBAL_DEF("android/modules", "");
  990. using_datapack = false;
  991. }
  992. ProjectSettings::~ProjectSettings() {
  993. singleton = NULL;
  994. }