core_bind.cpp 84 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146
  1. /**************************************************************************/
  2. /* core_bind.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 "core_bind.h"
  31. #include "core_bind.compat.inc"
  32. #include "core/config/project_settings.h"
  33. #include "core/crypto/crypto_core.h"
  34. #include "core/debugger/engine_debugger.h"
  35. #include "core/debugger/script_debugger.h"
  36. #include "core/io/file_access_compressed.h"
  37. #include "core/io/file_access_encrypted.h"
  38. #include "core/io/marshalls.h"
  39. #include "core/math/geometry_2d.h"
  40. #include "core/math/geometry_3d.h"
  41. #include "core/os/keyboard.h"
  42. #include "core/os/thread_safe.h"
  43. #include "core/variant/typed_array.h"
  44. namespace core_bind {
  45. ////// ResourceLoader //////
  46. ResourceLoader *ResourceLoader::singleton = nullptr;
  47. Error ResourceLoader::load_threaded_request(const String &p_path, const String &p_type_hint, bool p_use_sub_threads, CacheMode p_cache_mode) {
  48. return ::ResourceLoader::load_threaded_request(p_path, p_type_hint, p_use_sub_threads, ResourceFormatLoader::CacheMode(p_cache_mode));
  49. }
  50. ResourceLoader::ThreadLoadStatus ResourceLoader::load_threaded_get_status(const String &p_path, Array r_progress) {
  51. float progress = 0;
  52. ::ResourceLoader::ThreadLoadStatus tls = ::ResourceLoader::load_threaded_get_status(p_path, &progress);
  53. // Default array should never be modified, it causes the hash of the method to change.
  54. if (!ClassDB::is_default_array_arg(r_progress)) {
  55. r_progress.resize(1);
  56. r_progress[0] = progress;
  57. }
  58. return (ThreadLoadStatus)tls;
  59. }
  60. Ref<Resource> ResourceLoader::load_threaded_get(const String &p_path) {
  61. Error error;
  62. Ref<Resource> res = ::ResourceLoader::load_threaded_get(p_path, &error);
  63. return res;
  64. }
  65. Ref<Resource> ResourceLoader::load(const String &p_path, const String &p_type_hint, CacheMode p_cache_mode) {
  66. Error err = OK;
  67. Ref<Resource> ret = ::ResourceLoader::load(p_path, p_type_hint, ResourceFormatLoader::CacheMode(p_cache_mode), &err);
  68. ERR_FAIL_COND_V_MSG(err != OK, ret, vformat("Error loading resource: '%s'.", p_path));
  69. return ret;
  70. }
  71. Vector<String> ResourceLoader::get_recognized_extensions_for_type(const String &p_type) {
  72. List<String> exts;
  73. ::ResourceLoader::get_recognized_extensions_for_type(p_type, &exts);
  74. Vector<String> ret;
  75. for (const String &E : exts) {
  76. ret.push_back(E);
  77. }
  78. return ret;
  79. }
  80. void ResourceLoader::add_resource_format_loader(Ref<ResourceFormatLoader> p_format_loader, bool p_at_front) {
  81. ::ResourceLoader::add_resource_format_loader(p_format_loader, p_at_front);
  82. }
  83. void ResourceLoader::remove_resource_format_loader(Ref<ResourceFormatLoader> p_format_loader) {
  84. ::ResourceLoader::remove_resource_format_loader(p_format_loader);
  85. }
  86. void ResourceLoader::set_abort_on_missing_resources(bool p_abort) {
  87. ::ResourceLoader::set_abort_on_missing_resources(p_abort);
  88. }
  89. PackedStringArray ResourceLoader::get_dependencies(const String &p_path) {
  90. List<String> deps;
  91. ::ResourceLoader::get_dependencies(p_path, &deps);
  92. PackedStringArray ret;
  93. for (const String &E : deps) {
  94. ret.push_back(E);
  95. }
  96. return ret;
  97. }
  98. bool ResourceLoader::has_cached(const String &p_path) {
  99. String local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  100. return ResourceCache::has(local_path);
  101. }
  102. Ref<Resource> ResourceLoader::get_cached_ref(const String &p_path) {
  103. String local_path = ProjectSettings::get_singleton()->localize_path(p_path);
  104. return ResourceCache::get_ref(local_path);
  105. }
  106. bool ResourceLoader::exists(const String &p_path, const String &p_type_hint) {
  107. return ::ResourceLoader::exists(p_path, p_type_hint);
  108. }
  109. ResourceUID::ID ResourceLoader::get_resource_uid(const String &p_path) {
  110. return ::ResourceLoader::get_resource_uid(p_path);
  111. }
  112. void ResourceLoader::_bind_methods() {
  113. ClassDB::bind_method(D_METHOD("load_threaded_request", "path", "type_hint", "use_sub_threads", "cache_mode"), &ResourceLoader::load_threaded_request, DEFVAL(""), DEFVAL(false), DEFVAL(CACHE_MODE_REUSE));
  114. ClassDB::bind_method(D_METHOD("load_threaded_get_status", "path", "progress"), &ResourceLoader::load_threaded_get_status, DEFVAL_ARRAY);
  115. ClassDB::bind_method(D_METHOD("load_threaded_get", "path"), &ResourceLoader::load_threaded_get);
  116. ClassDB::bind_method(D_METHOD("load", "path", "type_hint", "cache_mode"), &ResourceLoader::load, DEFVAL(""), DEFVAL(CACHE_MODE_REUSE));
  117. ClassDB::bind_method(D_METHOD("get_recognized_extensions_for_type", "type"), &ResourceLoader::get_recognized_extensions_for_type);
  118. ClassDB::bind_method(D_METHOD("add_resource_format_loader", "format_loader", "at_front"), &ResourceLoader::add_resource_format_loader, DEFVAL(false));
  119. ClassDB::bind_method(D_METHOD("remove_resource_format_loader", "format_loader"), &ResourceLoader::remove_resource_format_loader);
  120. ClassDB::bind_method(D_METHOD("set_abort_on_missing_resources", "abort"), &ResourceLoader::set_abort_on_missing_resources);
  121. ClassDB::bind_method(D_METHOD("get_dependencies", "path"), &ResourceLoader::get_dependencies);
  122. ClassDB::bind_method(D_METHOD("has_cached", "path"), &ResourceLoader::has_cached);
  123. ClassDB::bind_method(D_METHOD("get_cached_ref", "path"), &ResourceLoader::get_cached_ref);
  124. ClassDB::bind_method(D_METHOD("exists", "path", "type_hint"), &ResourceLoader::exists, DEFVAL(""));
  125. ClassDB::bind_method(D_METHOD("get_resource_uid", "path"), &ResourceLoader::get_resource_uid);
  126. BIND_ENUM_CONSTANT(THREAD_LOAD_INVALID_RESOURCE);
  127. BIND_ENUM_CONSTANT(THREAD_LOAD_IN_PROGRESS);
  128. BIND_ENUM_CONSTANT(THREAD_LOAD_FAILED);
  129. BIND_ENUM_CONSTANT(THREAD_LOAD_LOADED);
  130. BIND_ENUM_CONSTANT(CACHE_MODE_IGNORE);
  131. BIND_ENUM_CONSTANT(CACHE_MODE_REUSE);
  132. BIND_ENUM_CONSTANT(CACHE_MODE_REPLACE);
  133. BIND_ENUM_CONSTANT(CACHE_MODE_IGNORE_DEEP);
  134. BIND_ENUM_CONSTANT(CACHE_MODE_REPLACE_DEEP);
  135. }
  136. ////// ResourceSaver //////
  137. Error ResourceSaver::save(const Ref<Resource> &p_resource, const String &p_path, BitField<SaverFlags> p_flags) {
  138. return ::ResourceSaver::save(p_resource, p_path, p_flags);
  139. }
  140. Vector<String> ResourceSaver::get_recognized_extensions(const Ref<Resource> &p_resource) {
  141. List<String> exts;
  142. ::ResourceSaver::get_recognized_extensions(p_resource, &exts);
  143. Vector<String> ret;
  144. for (const String &E : exts) {
  145. ret.push_back(E);
  146. }
  147. return ret;
  148. }
  149. void ResourceSaver::add_resource_format_saver(Ref<ResourceFormatSaver> p_format_saver, bool p_at_front) {
  150. ::ResourceSaver::add_resource_format_saver(p_format_saver, p_at_front);
  151. }
  152. void ResourceSaver::remove_resource_format_saver(Ref<ResourceFormatSaver> p_format_saver) {
  153. ::ResourceSaver::remove_resource_format_saver(p_format_saver);
  154. }
  155. ResourceUID::ID ResourceSaver::get_resource_id_for_path(const String &p_path, bool p_generate) {
  156. return ::ResourceSaver::get_resource_id_for_path(p_path, p_generate);
  157. }
  158. ResourceSaver *ResourceSaver::singleton = nullptr;
  159. void ResourceSaver::_bind_methods() {
  160. ClassDB::bind_method(D_METHOD("save", "resource", "path", "flags"), &ResourceSaver::save, DEFVAL(""), DEFVAL((uint32_t)FLAG_NONE));
  161. ClassDB::bind_method(D_METHOD("get_recognized_extensions", "type"), &ResourceSaver::get_recognized_extensions);
  162. ClassDB::bind_method(D_METHOD("add_resource_format_saver", "format_saver", "at_front"), &ResourceSaver::add_resource_format_saver, DEFVAL(false));
  163. ClassDB::bind_method(D_METHOD("remove_resource_format_saver", "format_saver"), &ResourceSaver::remove_resource_format_saver);
  164. ClassDB::bind_method(D_METHOD("get_resource_id_for_path", "path", "generate"), &ResourceSaver::get_resource_id_for_path, DEFVAL(false));
  165. BIND_BITFIELD_FLAG(FLAG_NONE);
  166. BIND_BITFIELD_FLAG(FLAG_RELATIVE_PATHS);
  167. BIND_BITFIELD_FLAG(FLAG_BUNDLE_RESOURCES);
  168. BIND_BITFIELD_FLAG(FLAG_CHANGE_PATH);
  169. BIND_BITFIELD_FLAG(FLAG_OMIT_EDITOR_PROPERTIES);
  170. BIND_BITFIELD_FLAG(FLAG_SAVE_BIG_ENDIAN);
  171. BIND_BITFIELD_FLAG(FLAG_COMPRESS);
  172. BIND_BITFIELD_FLAG(FLAG_REPLACE_SUBRESOURCE_PATHS);
  173. }
  174. ////// OS //////
  175. PackedByteArray OS::get_entropy(int p_bytes) {
  176. PackedByteArray pba;
  177. pba.resize(p_bytes);
  178. Error err = ::OS::get_singleton()->get_entropy(pba.ptrw(), p_bytes);
  179. ERR_FAIL_COND_V(err != OK, PackedByteArray());
  180. return pba;
  181. }
  182. String OS::get_system_ca_certificates() {
  183. return ::OS::get_singleton()->get_system_ca_certificates();
  184. }
  185. PackedStringArray OS::get_connected_midi_inputs() {
  186. return ::OS::get_singleton()->get_connected_midi_inputs();
  187. }
  188. void OS::open_midi_inputs() {
  189. ::OS::get_singleton()->open_midi_inputs();
  190. }
  191. void OS::close_midi_inputs() {
  192. ::OS::get_singleton()->close_midi_inputs();
  193. }
  194. void OS::set_use_file_access_save_and_swap(bool p_enable) {
  195. FileAccess::set_backup_save(p_enable);
  196. }
  197. void OS::set_low_processor_usage_mode(bool p_enabled) {
  198. ::OS::get_singleton()->set_low_processor_usage_mode(p_enabled);
  199. }
  200. bool OS::is_in_low_processor_usage_mode() const {
  201. return ::OS::get_singleton()->is_in_low_processor_usage_mode();
  202. }
  203. void OS::set_low_processor_usage_mode_sleep_usec(int p_usec) {
  204. ::OS::get_singleton()->set_low_processor_usage_mode_sleep_usec(p_usec);
  205. }
  206. int OS::get_low_processor_usage_mode_sleep_usec() const {
  207. return ::OS::get_singleton()->get_low_processor_usage_mode_sleep_usec();
  208. }
  209. void OS::set_delta_smoothing(bool p_enabled) {
  210. ::OS::get_singleton()->set_delta_smoothing(p_enabled);
  211. }
  212. bool OS::is_delta_smoothing_enabled() const {
  213. return ::OS::get_singleton()->is_delta_smoothing_enabled();
  214. }
  215. void OS::alert(const String &p_alert, const String &p_title) {
  216. ::OS::get_singleton()->alert(p_alert, p_title);
  217. }
  218. void OS::crash(const String &p_message) {
  219. CRASH_NOW_MSG(p_message);
  220. }
  221. Vector<String> OS::get_system_fonts() const {
  222. return ::OS::get_singleton()->get_system_fonts();
  223. }
  224. String OS::get_system_font_path(const String &p_font_name, int p_weight, int p_stretch, bool p_italic) const {
  225. return ::OS::get_singleton()->get_system_font_path(p_font_name, p_weight, p_stretch, p_italic);
  226. }
  227. Vector<String> OS::get_system_font_path_for_text(const String &p_font_name, const String &p_text, const String &p_locale, const String &p_script, int p_weight, int p_stretch, bool p_italic) const {
  228. return ::OS::get_singleton()->get_system_font_path_for_text(p_font_name, p_text, p_locale, p_script, p_weight, p_stretch, p_italic);
  229. }
  230. String OS::get_executable_path() const {
  231. return ::OS::get_singleton()->get_executable_path();
  232. }
  233. Error OS::shell_open(const String &p_uri) {
  234. if (p_uri.begins_with("res://")) {
  235. WARN_PRINT("Attempting to open an URL with the \"res://\" protocol. Use `ProjectSettings.globalize_path()` to convert a Godot-specific path to a system path before opening it with `OS.shell_open()`.");
  236. } else if (p_uri.begins_with("user://")) {
  237. WARN_PRINT("Attempting to open an URL with the \"user://\" protocol. Use `ProjectSettings.globalize_path()` to convert a Godot-specific path to a system path before opening it with `OS.shell_open()`.");
  238. }
  239. return ::OS::get_singleton()->shell_open(p_uri);
  240. }
  241. Error OS::shell_show_in_file_manager(const String &p_path, bool p_open_folder) {
  242. if (p_path.begins_with("res://")) {
  243. WARN_PRINT("Attempting to explore file path with the \"res://\" protocol. Use `ProjectSettings.globalize_path()` to convert a Godot-specific path to a system path before opening it with `OS.shell_show_in_file_manager()`.");
  244. } else if (p_path.begins_with("user://")) {
  245. WARN_PRINT("Attempting to explore file path with the \"user://\" protocol. Use `ProjectSettings.globalize_path()` to convert a Godot-specific path to a system path before opening it with `OS.shell_show_in_file_manager()`.");
  246. }
  247. return ::OS::get_singleton()->shell_show_in_file_manager(p_path, p_open_folder);
  248. }
  249. String OS::read_string_from_stdin() {
  250. return ::OS::get_singleton()->get_stdin_string();
  251. }
  252. int OS::execute(const String &p_path, const Vector<String> &p_arguments, Array r_output, bool p_read_stderr, bool p_open_console) {
  253. List<String> args;
  254. for (const String &arg : p_arguments) {
  255. args.push_back(arg);
  256. }
  257. String pipe;
  258. int exitcode = 0;
  259. Error err = ::OS::get_singleton()->execute(p_path, args, &pipe, &exitcode, p_read_stderr, nullptr, p_open_console);
  260. // Default array should never be modified, it causes the hash of the method to change.
  261. if (!ClassDB::is_default_array_arg(r_output)) {
  262. r_output.push_back(pipe);
  263. }
  264. if (err != OK) {
  265. return -1;
  266. }
  267. return exitcode;
  268. }
  269. Dictionary OS::execute_with_pipe(const String &p_path, const Vector<String> &p_arguments, bool p_blocking) {
  270. List<String> args;
  271. for (const String &arg : p_arguments) {
  272. args.push_back(arg);
  273. }
  274. return ::OS::get_singleton()->execute_with_pipe(p_path, args, p_blocking);
  275. }
  276. int OS::create_instance(const Vector<String> &p_arguments) {
  277. List<String> args;
  278. for (const String &arg : p_arguments) {
  279. args.push_back(arg);
  280. }
  281. ::OS::ProcessID pid = 0;
  282. Error err = ::OS::get_singleton()->create_instance(args, &pid);
  283. if (err != OK) {
  284. return -1;
  285. }
  286. return pid;
  287. }
  288. int OS::create_process(const String &p_path, const Vector<String> &p_arguments, bool p_open_console) {
  289. List<String> args;
  290. for (const String &arg : p_arguments) {
  291. args.push_back(arg);
  292. }
  293. ::OS::ProcessID pid = 0;
  294. Error err = ::OS::get_singleton()->create_process(p_path, args, &pid, p_open_console);
  295. if (err != OK) {
  296. return -1;
  297. }
  298. return pid;
  299. }
  300. Error OS::kill(int p_pid) {
  301. return ::OS::get_singleton()->kill(p_pid);
  302. }
  303. bool OS::is_process_running(int p_pid) const {
  304. return ::OS::get_singleton()->is_process_running(p_pid);
  305. }
  306. int OS::get_process_exit_code(int p_pid) const {
  307. return ::OS::get_singleton()->get_process_exit_code(p_pid);
  308. }
  309. int OS::get_process_id() const {
  310. return ::OS::get_singleton()->get_process_id();
  311. }
  312. bool OS::has_environment(const String &p_var) const {
  313. return ::OS::get_singleton()->has_environment(p_var);
  314. }
  315. String OS::get_environment(const String &p_var) const {
  316. return ::OS::get_singleton()->get_environment(p_var);
  317. }
  318. void OS::set_environment(const String &p_var, const String &p_value) const {
  319. ::OS::get_singleton()->set_environment(p_var, p_value);
  320. }
  321. void OS::unset_environment(const String &p_var) const {
  322. ::OS::get_singleton()->unset_environment(p_var);
  323. }
  324. String OS::get_name() const {
  325. return ::OS::get_singleton()->get_name();
  326. }
  327. String OS::get_distribution_name() const {
  328. return ::OS::get_singleton()->get_distribution_name();
  329. }
  330. String OS::get_version() const {
  331. return ::OS::get_singleton()->get_version();
  332. }
  333. Vector<String> OS::get_video_adapter_driver_info() const {
  334. return ::OS::get_singleton()->get_video_adapter_driver_info();
  335. }
  336. Vector<String> OS::get_cmdline_args() {
  337. List<String> cmdline = ::OS::get_singleton()->get_cmdline_args();
  338. Vector<String> cmdlinev;
  339. for (const String &E : cmdline) {
  340. cmdlinev.push_back(E);
  341. }
  342. return cmdlinev;
  343. }
  344. Vector<String> OS::get_cmdline_user_args() {
  345. List<String> cmdline = ::OS::get_singleton()->get_cmdline_user_args();
  346. Vector<String> cmdlinev;
  347. for (const String &E : cmdline) {
  348. cmdlinev.push_back(E);
  349. }
  350. return cmdlinev;
  351. }
  352. void OS::set_restart_on_exit(bool p_restart, const Vector<String> &p_restart_arguments) {
  353. List<String> args_list;
  354. for (const String &restart_argument : p_restart_arguments) {
  355. args_list.push_back(restart_argument);
  356. }
  357. ::OS::get_singleton()->set_restart_on_exit(p_restart, args_list);
  358. }
  359. bool OS::is_restart_on_exit_set() const {
  360. return ::OS::get_singleton()->is_restart_on_exit_set();
  361. }
  362. Vector<String> OS::get_restart_on_exit_arguments() const {
  363. List<String> args = ::OS::get_singleton()->get_restart_on_exit_arguments();
  364. Vector<String> args_vector;
  365. for (List<String>::Element *E = args.front(); E; E = E->next()) {
  366. args_vector.push_back(E->get());
  367. }
  368. return args_vector;
  369. }
  370. String OS::get_locale() const {
  371. return ::OS::get_singleton()->get_locale();
  372. }
  373. String OS::get_locale_language() const {
  374. return ::OS::get_singleton()->get_locale_language();
  375. }
  376. String OS::get_model_name() const {
  377. return ::OS::get_singleton()->get_model_name();
  378. }
  379. Error OS::set_thread_name(const String &p_name) {
  380. return ::Thread::set_name(p_name);
  381. }
  382. ::Thread::ID OS::get_thread_caller_id() const {
  383. return ::Thread::get_caller_id();
  384. }
  385. ::Thread::ID OS::get_main_thread_id() const {
  386. return ::Thread::get_main_id();
  387. }
  388. bool OS::has_feature(const String &p_feature) const {
  389. const bool *value_ptr = feature_cache.getptr(p_feature);
  390. if (value_ptr) {
  391. return *value_ptr;
  392. } else {
  393. const bool has = ::OS::get_singleton()->has_feature(p_feature);
  394. feature_cache[p_feature] = has;
  395. return has;
  396. }
  397. }
  398. bool OS::is_sandboxed() const {
  399. return ::OS::get_singleton()->is_sandboxed();
  400. }
  401. uint64_t OS::get_static_memory_usage() const {
  402. return ::OS::get_singleton()->get_static_memory_usage();
  403. }
  404. uint64_t OS::get_static_memory_peak_usage() const {
  405. return ::OS::get_singleton()->get_static_memory_peak_usage();
  406. }
  407. Dictionary OS::get_memory_info() const {
  408. return ::OS::get_singleton()->get_memory_info();
  409. }
  410. /** This method uses a signed argument for better error reporting as it's used from the scripting API. */
  411. void OS::delay_usec(int p_usec) const {
  412. ERR_FAIL_COND_MSG(
  413. p_usec < 0,
  414. vformat("Can't sleep for %d microseconds. The delay provided must be greater than or equal to 0 microseconds.", p_usec));
  415. ::OS::get_singleton()->delay_usec(p_usec);
  416. }
  417. /** This method uses a signed argument for better error reporting as it's used from the scripting API. */
  418. void OS::delay_msec(int p_msec) const {
  419. ERR_FAIL_COND_MSG(
  420. p_msec < 0,
  421. vformat("Can't sleep for %d milliseconds. The delay provided must be greater than or equal to 0 milliseconds.", p_msec));
  422. ::OS::get_singleton()->delay_usec(int64_t(p_msec) * 1000);
  423. }
  424. bool OS::is_userfs_persistent() const {
  425. return ::OS::get_singleton()->is_userfs_persistent();
  426. }
  427. int OS::get_processor_count() const {
  428. return ::OS::get_singleton()->get_processor_count();
  429. }
  430. String OS::get_processor_name() const {
  431. return ::OS::get_singleton()->get_processor_name();
  432. }
  433. bool OS::is_stdout_verbose() const {
  434. return ::OS::get_singleton()->is_stdout_verbose();
  435. }
  436. Error OS::move_to_trash(const String &p_path) const {
  437. return ::OS::get_singleton()->move_to_trash(p_path);
  438. }
  439. String OS::get_user_data_dir() const {
  440. return ::OS::get_singleton()->get_user_data_dir();
  441. }
  442. String OS::get_config_dir() const {
  443. // Exposed as `get_config_dir()` instead of `get_config_path()` for consistency with other exposed OS methods.
  444. return ::OS::get_singleton()->get_config_path();
  445. }
  446. String OS::get_data_dir() const {
  447. // Exposed as `get_data_dir()` instead of `get_data_path()` for consistency with other exposed OS methods.
  448. return ::OS::get_singleton()->get_data_path();
  449. }
  450. String OS::get_cache_dir() const {
  451. // Exposed as `get_cache_dir()` instead of `get_cache_path()` for consistency with other exposed OS methods.
  452. return ::OS::get_singleton()->get_cache_path();
  453. }
  454. bool OS::is_debug_build() const {
  455. #ifdef DEBUG_ENABLED
  456. return true;
  457. #else
  458. return false;
  459. #endif
  460. }
  461. String OS::get_system_dir(SystemDir p_dir, bool p_shared_storage) const {
  462. return ::OS::get_singleton()->get_system_dir(::OS::SystemDir(p_dir), p_shared_storage);
  463. }
  464. String OS::get_keycode_string(Key p_code) const {
  465. return ::keycode_get_string(p_code);
  466. }
  467. bool OS::is_keycode_unicode(char32_t p_unicode) const {
  468. return ::keycode_has_unicode((Key)p_unicode);
  469. }
  470. Key OS::find_keycode_from_string(const String &p_code) const {
  471. return find_keycode(p_code);
  472. }
  473. bool OS::request_permission(const String &p_name) {
  474. return ::OS::get_singleton()->request_permission(p_name);
  475. }
  476. bool OS::request_permissions() {
  477. return ::OS::get_singleton()->request_permissions();
  478. }
  479. Vector<String> OS::get_granted_permissions() const {
  480. return ::OS::get_singleton()->get_granted_permissions();
  481. }
  482. void OS::revoke_granted_permissions() {
  483. ::OS::get_singleton()->revoke_granted_permissions();
  484. }
  485. String OS::get_unique_id() const {
  486. return ::OS::get_singleton()->get_unique_id();
  487. }
  488. OS *OS::singleton = nullptr;
  489. void OS::_bind_methods() {
  490. ClassDB::bind_method(D_METHOD("get_entropy", "size"), &OS::get_entropy);
  491. ClassDB::bind_method(D_METHOD("get_system_ca_certificates"), &OS::get_system_ca_certificates);
  492. ClassDB::bind_method(D_METHOD("get_connected_midi_inputs"), &OS::get_connected_midi_inputs);
  493. ClassDB::bind_method(D_METHOD("open_midi_inputs"), &OS::open_midi_inputs);
  494. ClassDB::bind_method(D_METHOD("close_midi_inputs"), &OS::close_midi_inputs);
  495. ClassDB::bind_method(D_METHOD("alert", "text", "title"), &OS::alert, DEFVAL("Alert!"));
  496. ClassDB::bind_method(D_METHOD("crash", "message"), &OS::crash);
  497. ClassDB::bind_method(D_METHOD("set_low_processor_usage_mode", "enable"), &OS::set_low_processor_usage_mode);
  498. ClassDB::bind_method(D_METHOD("is_in_low_processor_usage_mode"), &OS::is_in_low_processor_usage_mode);
  499. ClassDB::bind_method(D_METHOD("set_low_processor_usage_mode_sleep_usec", "usec"), &OS::set_low_processor_usage_mode_sleep_usec);
  500. ClassDB::bind_method(D_METHOD("get_low_processor_usage_mode_sleep_usec"), &OS::get_low_processor_usage_mode_sleep_usec);
  501. ClassDB::bind_method(D_METHOD("set_delta_smoothing", "delta_smoothing_enabled"), &OS::set_delta_smoothing);
  502. ClassDB::bind_method(D_METHOD("is_delta_smoothing_enabled"), &OS::is_delta_smoothing_enabled);
  503. ClassDB::bind_method(D_METHOD("get_processor_count"), &OS::get_processor_count);
  504. ClassDB::bind_method(D_METHOD("get_processor_name"), &OS::get_processor_name);
  505. ClassDB::bind_method(D_METHOD("get_system_fonts"), &OS::get_system_fonts);
  506. ClassDB::bind_method(D_METHOD("get_system_font_path", "font_name", "weight", "stretch", "italic"), &OS::get_system_font_path, DEFVAL(400), DEFVAL(100), DEFVAL(false));
  507. ClassDB::bind_method(D_METHOD("get_system_font_path_for_text", "font_name", "text", "locale", "script", "weight", "stretch", "italic"), &OS::get_system_font_path_for_text, DEFVAL(String()), DEFVAL(String()), DEFVAL(400), DEFVAL(100), DEFVAL(false));
  508. ClassDB::bind_method(D_METHOD("get_executable_path"), &OS::get_executable_path);
  509. ClassDB::bind_method(D_METHOD("read_string_from_stdin"), &OS::read_string_from_stdin);
  510. ClassDB::bind_method(D_METHOD("execute", "path", "arguments", "output", "read_stderr", "open_console"), &OS::execute, DEFVAL_ARRAY, DEFVAL(false), DEFVAL(false));
  511. ClassDB::bind_method(D_METHOD("execute_with_pipe", "path", "arguments", "blocking"), &OS::execute_with_pipe, DEFVAL(true));
  512. ClassDB::bind_method(D_METHOD("create_process", "path", "arguments", "open_console"), &OS::create_process, DEFVAL(false));
  513. ClassDB::bind_method(D_METHOD("create_instance", "arguments"), &OS::create_instance);
  514. ClassDB::bind_method(D_METHOD("kill", "pid"), &OS::kill);
  515. ClassDB::bind_method(D_METHOD("shell_open", "uri"), &OS::shell_open);
  516. ClassDB::bind_method(D_METHOD("shell_show_in_file_manager", "file_or_dir_path", "open_folder"), &OS::shell_show_in_file_manager, DEFVAL(true));
  517. ClassDB::bind_method(D_METHOD("is_process_running", "pid"), &OS::is_process_running);
  518. ClassDB::bind_method(D_METHOD("get_process_exit_code", "pid"), &OS::get_process_exit_code);
  519. ClassDB::bind_method(D_METHOD("get_process_id"), &OS::get_process_id);
  520. ClassDB::bind_method(D_METHOD("has_environment", "variable"), &OS::has_environment);
  521. ClassDB::bind_method(D_METHOD("get_environment", "variable"), &OS::get_environment);
  522. ClassDB::bind_method(D_METHOD("set_environment", "variable", "value"), &OS::set_environment);
  523. ClassDB::bind_method(D_METHOD("unset_environment", "variable"), &OS::unset_environment);
  524. ClassDB::bind_method(D_METHOD("get_name"), &OS::get_name);
  525. ClassDB::bind_method(D_METHOD("get_distribution_name"), &OS::get_distribution_name);
  526. ClassDB::bind_method(D_METHOD("get_version"), &OS::get_version);
  527. ClassDB::bind_method(D_METHOD("get_cmdline_args"), &OS::get_cmdline_args);
  528. ClassDB::bind_method(D_METHOD("get_cmdline_user_args"), &OS::get_cmdline_user_args);
  529. ClassDB::bind_method(D_METHOD("get_video_adapter_driver_info"), &OS::get_video_adapter_driver_info);
  530. ClassDB::bind_method(D_METHOD("set_restart_on_exit", "restart", "arguments"), &OS::set_restart_on_exit, DEFVAL(Vector<String>()));
  531. ClassDB::bind_method(D_METHOD("is_restart_on_exit_set"), &OS::is_restart_on_exit_set);
  532. ClassDB::bind_method(D_METHOD("get_restart_on_exit_arguments"), &OS::get_restart_on_exit_arguments);
  533. ClassDB::bind_method(D_METHOD("delay_usec", "usec"), &OS::delay_usec);
  534. ClassDB::bind_method(D_METHOD("delay_msec", "msec"), &OS::delay_msec);
  535. ClassDB::bind_method(D_METHOD("get_locale"), &OS::get_locale);
  536. ClassDB::bind_method(D_METHOD("get_locale_language"), &OS::get_locale_language);
  537. ClassDB::bind_method(D_METHOD("get_model_name"), &OS::get_model_name);
  538. ClassDB::bind_method(D_METHOD("is_userfs_persistent"), &OS::is_userfs_persistent);
  539. ClassDB::bind_method(D_METHOD("is_stdout_verbose"), &OS::is_stdout_verbose);
  540. ClassDB::bind_method(D_METHOD("is_debug_build"), &OS::is_debug_build);
  541. ClassDB::bind_method(D_METHOD("get_static_memory_usage"), &OS::get_static_memory_usage);
  542. ClassDB::bind_method(D_METHOD("get_static_memory_peak_usage"), &OS::get_static_memory_peak_usage);
  543. ClassDB::bind_method(D_METHOD("get_memory_info"), &OS::get_memory_info);
  544. ClassDB::bind_method(D_METHOD("move_to_trash", "path"), &OS::move_to_trash);
  545. ClassDB::bind_method(D_METHOD("get_user_data_dir"), &OS::get_user_data_dir);
  546. ClassDB::bind_method(D_METHOD("get_system_dir", "dir", "shared_storage"), &OS::get_system_dir, DEFVAL(true));
  547. ClassDB::bind_method(D_METHOD("get_config_dir"), &OS::get_config_dir);
  548. ClassDB::bind_method(D_METHOD("get_data_dir"), &OS::get_data_dir);
  549. ClassDB::bind_method(D_METHOD("get_cache_dir"), &OS::get_cache_dir);
  550. ClassDB::bind_method(D_METHOD("get_unique_id"), &OS::get_unique_id);
  551. ClassDB::bind_method(D_METHOD("get_keycode_string", "code"), &OS::get_keycode_string);
  552. ClassDB::bind_method(D_METHOD("is_keycode_unicode", "code"), &OS::is_keycode_unicode);
  553. ClassDB::bind_method(D_METHOD("find_keycode_from_string", "string"), &OS::find_keycode_from_string);
  554. ClassDB::bind_method(D_METHOD("set_use_file_access_save_and_swap", "enabled"), &OS::set_use_file_access_save_and_swap);
  555. ClassDB::bind_method(D_METHOD("set_thread_name", "name"), &OS::set_thread_name);
  556. ClassDB::bind_method(D_METHOD("get_thread_caller_id"), &OS::get_thread_caller_id);
  557. ClassDB::bind_method(D_METHOD("get_main_thread_id"), &OS::get_main_thread_id);
  558. ClassDB::bind_method(D_METHOD("has_feature", "tag_name"), &OS::has_feature);
  559. ClassDB::bind_method(D_METHOD("is_sandboxed"), &OS::is_sandboxed);
  560. ClassDB::bind_method(D_METHOD("request_permission", "name"), &OS::request_permission);
  561. ClassDB::bind_method(D_METHOD("request_permissions"), &OS::request_permissions);
  562. ClassDB::bind_method(D_METHOD("get_granted_permissions"), &OS::get_granted_permissions);
  563. ClassDB::bind_method(D_METHOD("revoke_granted_permissions"), &OS::revoke_granted_permissions);
  564. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "low_processor_usage_mode"), "set_low_processor_usage_mode", "is_in_low_processor_usage_mode");
  565. ADD_PROPERTY(PropertyInfo(Variant::INT, "low_processor_usage_mode_sleep_usec"), "set_low_processor_usage_mode_sleep_usec", "get_low_processor_usage_mode_sleep_usec");
  566. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "delta_smoothing"), "set_delta_smoothing", "is_delta_smoothing_enabled");
  567. // Those default values need to be specified for the docs generator,
  568. // to avoid using values from the documentation writer's own OS instance.
  569. ADD_PROPERTY_DEFAULT("low_processor_usage_mode", false);
  570. ADD_PROPERTY_DEFAULT("low_processor_usage_mode_sleep_usec", 6900);
  571. BIND_ENUM_CONSTANT(RENDERING_DRIVER_VULKAN);
  572. BIND_ENUM_CONSTANT(RENDERING_DRIVER_OPENGL3);
  573. BIND_ENUM_CONSTANT(RENDERING_DRIVER_D3D12);
  574. BIND_ENUM_CONSTANT(RENDERING_DRIVER_METAL);
  575. BIND_ENUM_CONSTANT(SYSTEM_DIR_DESKTOP);
  576. BIND_ENUM_CONSTANT(SYSTEM_DIR_DCIM);
  577. BIND_ENUM_CONSTANT(SYSTEM_DIR_DOCUMENTS);
  578. BIND_ENUM_CONSTANT(SYSTEM_DIR_DOWNLOADS);
  579. BIND_ENUM_CONSTANT(SYSTEM_DIR_MOVIES);
  580. BIND_ENUM_CONSTANT(SYSTEM_DIR_MUSIC);
  581. BIND_ENUM_CONSTANT(SYSTEM_DIR_PICTURES);
  582. BIND_ENUM_CONSTANT(SYSTEM_DIR_RINGTONES);
  583. }
  584. ////// Geometry2D //////
  585. Geometry2D *Geometry2D::singleton = nullptr;
  586. Geometry2D *Geometry2D::get_singleton() {
  587. return singleton;
  588. }
  589. bool Geometry2D::is_point_in_circle(const Vector2 &p_point, const Vector2 &p_circle_pos, real_t p_circle_radius) {
  590. return ::Geometry2D::is_point_in_circle(p_point, p_circle_pos, p_circle_radius);
  591. }
  592. real_t Geometry2D::segment_intersects_circle(const Vector2 &p_from, const Vector2 &p_to, const Vector2 &p_circle_pos, real_t p_circle_radius) {
  593. return ::Geometry2D::segment_intersects_circle(p_from, p_to, p_circle_pos, p_circle_radius);
  594. }
  595. Variant Geometry2D::segment_intersects_segment(const Vector2 &p_from_a, const Vector2 &p_to_a, const Vector2 &p_from_b, const Vector2 &p_to_b) {
  596. Vector2 result;
  597. if (::Geometry2D::segment_intersects_segment(p_from_a, p_to_a, p_from_b, p_to_b, &result)) {
  598. return result;
  599. } else {
  600. return Variant();
  601. }
  602. }
  603. Variant Geometry2D::line_intersects_line(const Vector2 &p_from_a, const Vector2 &p_dir_a, const Vector2 &p_from_b, const Vector2 &p_dir_b) {
  604. Vector2 result;
  605. if (::Geometry2D::line_intersects_line(p_from_a, p_dir_a, p_from_b, p_dir_b, result)) {
  606. return result;
  607. } else {
  608. return Variant();
  609. }
  610. }
  611. Vector<Vector2> Geometry2D::get_closest_points_between_segments(const Vector2 &p1, const Vector2 &q1, const Vector2 &p2, const Vector2 &q2) {
  612. Vector2 r1, r2;
  613. ::Geometry2D::get_closest_points_between_segments(p1, q1, p2, q2, r1, r2);
  614. Vector<Vector2> r = { r1, r2 };
  615. return r;
  616. }
  617. Vector2 Geometry2D::get_closest_point_to_segment(const Vector2 &p_point, const Vector2 &p_a, const Vector2 &p_b) {
  618. Vector2 s[2] = { p_a, p_b };
  619. return ::Geometry2D::get_closest_point_to_segment(p_point, s);
  620. }
  621. Vector2 Geometry2D::get_closest_point_to_segment_uncapped(const Vector2 &p_point, const Vector2 &p_a, const Vector2 &p_b) {
  622. Vector2 s[2] = { p_a, p_b };
  623. return ::Geometry2D::get_closest_point_to_segment_uncapped(p_point, s);
  624. }
  625. bool Geometry2D::point_is_inside_triangle(const Vector2 &s, const Vector2 &a, const Vector2 &b, const Vector2 &c) const {
  626. return ::Geometry2D::is_point_in_triangle(s, a, b, c);
  627. }
  628. bool Geometry2D::is_polygon_clockwise(const Vector<Vector2> &p_polygon) {
  629. return ::Geometry2D::is_polygon_clockwise(p_polygon);
  630. }
  631. bool Geometry2D::is_point_in_polygon(const Point2 &p_point, const Vector<Vector2> &p_polygon) {
  632. return ::Geometry2D::is_point_in_polygon(p_point, p_polygon);
  633. }
  634. Vector<int> Geometry2D::triangulate_polygon(const Vector<Vector2> &p_polygon) {
  635. return ::Geometry2D::triangulate_polygon(p_polygon);
  636. }
  637. Vector<int> Geometry2D::triangulate_delaunay(const Vector<Vector2> &p_points) {
  638. return ::Geometry2D::triangulate_delaunay(p_points);
  639. }
  640. Vector<Point2> Geometry2D::convex_hull(const Vector<Point2> &p_points) {
  641. return ::Geometry2D::convex_hull(p_points);
  642. }
  643. TypedArray<PackedVector2Array> Geometry2D::decompose_polygon_in_convex(const Vector<Vector2> &p_polygon) {
  644. Vector<Vector<Point2>> decomp = ::Geometry2D::decompose_polygon_in_convex(p_polygon);
  645. TypedArray<PackedVector2Array> ret;
  646. for (int i = 0; i < decomp.size(); ++i) {
  647. ret.push_back(decomp[i]);
  648. }
  649. return ret;
  650. }
  651. TypedArray<PackedVector2Array> Geometry2D::merge_polygons(const Vector<Vector2> &p_polygon_a, const Vector<Vector2> &p_polygon_b) {
  652. Vector<Vector<Point2>> polys = ::Geometry2D::merge_polygons(p_polygon_a, p_polygon_b);
  653. TypedArray<PackedVector2Array> ret;
  654. for (int i = 0; i < polys.size(); ++i) {
  655. ret.push_back(polys[i]);
  656. }
  657. return ret;
  658. }
  659. TypedArray<PackedVector2Array> Geometry2D::clip_polygons(const Vector<Vector2> &p_polygon_a, const Vector<Vector2> &p_polygon_b) {
  660. Vector<Vector<Point2>> polys = ::Geometry2D::clip_polygons(p_polygon_a, p_polygon_b);
  661. TypedArray<PackedVector2Array> ret;
  662. for (int i = 0; i < polys.size(); ++i) {
  663. ret.push_back(polys[i]);
  664. }
  665. return ret;
  666. }
  667. TypedArray<PackedVector2Array> Geometry2D::intersect_polygons(const Vector<Vector2> &p_polygon_a, const Vector<Vector2> &p_polygon_b) {
  668. Vector<Vector<Point2>> polys = ::Geometry2D::intersect_polygons(p_polygon_a, p_polygon_b);
  669. TypedArray<PackedVector2Array> ret;
  670. for (int i = 0; i < polys.size(); ++i) {
  671. ret.push_back(polys[i]);
  672. }
  673. return ret;
  674. }
  675. TypedArray<PackedVector2Array> Geometry2D::exclude_polygons(const Vector<Vector2> &p_polygon_a, const Vector<Vector2> &p_polygon_b) {
  676. Vector<Vector<Point2>> polys = ::Geometry2D::exclude_polygons(p_polygon_a, p_polygon_b);
  677. TypedArray<PackedVector2Array> ret;
  678. for (int i = 0; i < polys.size(); ++i) {
  679. ret.push_back(polys[i]);
  680. }
  681. return ret;
  682. }
  683. TypedArray<PackedVector2Array> Geometry2D::clip_polyline_with_polygon(const Vector<Vector2> &p_polyline, const Vector<Vector2> &p_polygon) {
  684. Vector<Vector<Point2>> polys = ::Geometry2D::clip_polyline_with_polygon(p_polyline, p_polygon);
  685. TypedArray<PackedVector2Array> ret;
  686. for (int i = 0; i < polys.size(); ++i) {
  687. ret.push_back(polys[i]);
  688. }
  689. return ret;
  690. }
  691. TypedArray<PackedVector2Array> Geometry2D::intersect_polyline_with_polygon(const Vector<Vector2> &p_polyline, const Vector<Vector2> &p_polygon) {
  692. Vector<Vector<Point2>> polys = ::Geometry2D::intersect_polyline_with_polygon(p_polyline, p_polygon);
  693. TypedArray<PackedVector2Array> ret;
  694. for (int i = 0; i < polys.size(); ++i) {
  695. ret.push_back(polys[i]);
  696. }
  697. return ret;
  698. }
  699. TypedArray<PackedVector2Array> Geometry2D::offset_polygon(const Vector<Vector2> &p_polygon, real_t p_delta, PolyJoinType p_join_type) {
  700. Vector<Vector<Point2>> polys = ::Geometry2D::offset_polygon(p_polygon, p_delta, ::Geometry2D::PolyJoinType(p_join_type));
  701. TypedArray<PackedVector2Array> ret;
  702. for (int i = 0; i < polys.size(); ++i) {
  703. ret.push_back(polys[i]);
  704. }
  705. return ret;
  706. }
  707. TypedArray<PackedVector2Array> Geometry2D::offset_polyline(const Vector<Vector2> &p_polygon, real_t p_delta, PolyJoinType p_join_type, PolyEndType p_end_type) {
  708. Vector<Vector<Point2>> polys = ::Geometry2D::offset_polyline(p_polygon, p_delta, ::Geometry2D::PolyJoinType(p_join_type), ::Geometry2D::PolyEndType(p_end_type));
  709. TypedArray<PackedVector2Array> ret;
  710. for (int i = 0; i < polys.size(); ++i) {
  711. ret.push_back(polys[i]);
  712. }
  713. return ret;
  714. }
  715. Dictionary Geometry2D::make_atlas(const Vector<Size2> &p_rects) {
  716. Dictionary ret;
  717. Vector<Size2i> rects;
  718. for (int i = 0; i < p_rects.size(); i++) {
  719. rects.push_back(p_rects[i]);
  720. }
  721. Vector<Point2i> result;
  722. Size2i size;
  723. ::Geometry2D::make_atlas(rects, result, size);
  724. Vector<Point2> r_result;
  725. for (int i = 0; i < result.size(); i++) {
  726. r_result.push_back(result[i]);
  727. }
  728. ret["points"] = r_result;
  729. ret["size"] = size;
  730. return ret;
  731. }
  732. TypedArray<Point2i> Geometry2D::bresenham_line(const Point2i &p_from, const Point2i &p_to) {
  733. Vector<Point2i> points = ::Geometry2D::bresenham_line(p_from, p_to);
  734. TypedArray<Point2i> result;
  735. result.resize(points.size());
  736. for (int i = 0; i < points.size(); i++) {
  737. result[i] = points[i];
  738. }
  739. return result;
  740. }
  741. void Geometry2D::_bind_methods() {
  742. ClassDB::bind_method(D_METHOD("is_point_in_circle", "point", "circle_position", "circle_radius"), &Geometry2D::is_point_in_circle);
  743. ClassDB::bind_method(D_METHOD("segment_intersects_circle", "segment_from", "segment_to", "circle_position", "circle_radius"), &Geometry2D::segment_intersects_circle);
  744. ClassDB::bind_method(D_METHOD("segment_intersects_segment", "from_a", "to_a", "from_b", "to_b"), &Geometry2D::segment_intersects_segment);
  745. ClassDB::bind_method(D_METHOD("line_intersects_line", "from_a", "dir_a", "from_b", "dir_b"), &Geometry2D::line_intersects_line);
  746. ClassDB::bind_method(D_METHOD("get_closest_points_between_segments", "p1", "q1", "p2", "q2"), &Geometry2D::get_closest_points_between_segments);
  747. ClassDB::bind_method(D_METHOD("get_closest_point_to_segment", "point", "s1", "s2"), &Geometry2D::get_closest_point_to_segment);
  748. ClassDB::bind_method(D_METHOD("get_closest_point_to_segment_uncapped", "point", "s1", "s2"), &Geometry2D::get_closest_point_to_segment_uncapped);
  749. ClassDB::bind_method(D_METHOD("point_is_inside_triangle", "point", "a", "b", "c"), &Geometry2D::point_is_inside_triangle);
  750. ClassDB::bind_method(D_METHOD("is_polygon_clockwise", "polygon"), &Geometry2D::is_polygon_clockwise);
  751. ClassDB::bind_method(D_METHOD("is_point_in_polygon", "point", "polygon"), &Geometry2D::is_point_in_polygon);
  752. ClassDB::bind_method(D_METHOD("triangulate_polygon", "polygon"), &Geometry2D::triangulate_polygon);
  753. ClassDB::bind_method(D_METHOD("triangulate_delaunay", "points"), &Geometry2D::triangulate_delaunay);
  754. ClassDB::bind_method(D_METHOD("convex_hull", "points"), &Geometry2D::convex_hull);
  755. ClassDB::bind_method(D_METHOD("decompose_polygon_in_convex", "polygon"), &Geometry2D::decompose_polygon_in_convex);
  756. ClassDB::bind_method(D_METHOD("merge_polygons", "polygon_a", "polygon_b"), &Geometry2D::merge_polygons);
  757. ClassDB::bind_method(D_METHOD("clip_polygons", "polygon_a", "polygon_b"), &Geometry2D::clip_polygons);
  758. ClassDB::bind_method(D_METHOD("intersect_polygons", "polygon_a", "polygon_b"), &Geometry2D::intersect_polygons);
  759. ClassDB::bind_method(D_METHOD("exclude_polygons", "polygon_a", "polygon_b"), &Geometry2D::exclude_polygons);
  760. ClassDB::bind_method(D_METHOD("clip_polyline_with_polygon", "polyline", "polygon"), &Geometry2D::clip_polyline_with_polygon);
  761. ClassDB::bind_method(D_METHOD("intersect_polyline_with_polygon", "polyline", "polygon"), &Geometry2D::intersect_polyline_with_polygon);
  762. ClassDB::bind_method(D_METHOD("offset_polygon", "polygon", "delta", "join_type"), &Geometry2D::offset_polygon, DEFVAL(JOIN_SQUARE));
  763. ClassDB::bind_method(D_METHOD("offset_polyline", "polyline", "delta", "join_type", "end_type"), &Geometry2D::offset_polyline, DEFVAL(JOIN_SQUARE), DEFVAL(END_SQUARE));
  764. ClassDB::bind_method(D_METHOD("make_atlas", "sizes"), &Geometry2D::make_atlas);
  765. ClassDB::bind_method(D_METHOD("bresenham_line", "from", "to"), &Geometry2D::bresenham_line);
  766. BIND_ENUM_CONSTANT(OPERATION_UNION);
  767. BIND_ENUM_CONSTANT(OPERATION_DIFFERENCE);
  768. BIND_ENUM_CONSTANT(OPERATION_INTERSECTION);
  769. BIND_ENUM_CONSTANT(OPERATION_XOR);
  770. BIND_ENUM_CONSTANT(JOIN_SQUARE);
  771. BIND_ENUM_CONSTANT(JOIN_ROUND);
  772. BIND_ENUM_CONSTANT(JOIN_MITER);
  773. BIND_ENUM_CONSTANT(END_POLYGON);
  774. BIND_ENUM_CONSTANT(END_JOINED);
  775. BIND_ENUM_CONSTANT(END_BUTT);
  776. BIND_ENUM_CONSTANT(END_SQUARE);
  777. BIND_ENUM_CONSTANT(END_ROUND);
  778. }
  779. ////// Geometry3D //////
  780. Geometry3D *Geometry3D::singleton = nullptr;
  781. Geometry3D *Geometry3D::get_singleton() {
  782. return singleton;
  783. }
  784. Vector<Vector3> Geometry3D::compute_convex_mesh_points(const TypedArray<Plane> &p_planes) {
  785. Vector<Plane> planes_vec;
  786. int size = p_planes.size();
  787. planes_vec.resize(size);
  788. for (int i = 0; i < size; ++i) {
  789. planes_vec.set(i, p_planes[i]);
  790. }
  791. Variant ret = ::Geometry3D::compute_convex_mesh_points(planes_vec.ptr(), size);
  792. return ret;
  793. }
  794. TypedArray<Plane> Geometry3D::build_box_planes(const Vector3 &p_extents) {
  795. Variant ret = ::Geometry3D::build_box_planes(p_extents);
  796. return ret;
  797. }
  798. TypedArray<Plane> Geometry3D::build_cylinder_planes(float p_radius, float p_height, int p_sides, Vector3::Axis p_axis) {
  799. Variant ret = ::Geometry3D::build_cylinder_planes(p_radius, p_height, p_sides, p_axis);
  800. return ret;
  801. }
  802. TypedArray<Plane> Geometry3D::build_capsule_planes(float p_radius, float p_height, int p_sides, int p_lats, Vector3::Axis p_axis) {
  803. Variant ret = ::Geometry3D::build_capsule_planes(p_radius, p_height, p_sides, p_lats, p_axis);
  804. return ret;
  805. }
  806. Vector<Vector3> Geometry3D::get_closest_points_between_segments(const Vector3 &p1, const Vector3 &p2, const Vector3 &q1, const Vector3 &q2) {
  807. Vector3 r1, r2;
  808. ::Geometry3D::get_closest_points_between_segments(p1, p2, q1, q2, r1, r2);
  809. Vector<Vector3> r = { r1, r2 };
  810. return r;
  811. }
  812. Vector3 Geometry3D::get_closest_point_to_segment(const Vector3 &p_point, const Vector3 &p_a, const Vector3 &p_b) {
  813. Vector3 s[2] = { p_a, p_b };
  814. return ::Geometry3D::get_closest_point_to_segment(p_point, s);
  815. }
  816. Vector3 Geometry3D::get_closest_point_to_segment_uncapped(const Vector3 &p_point, const Vector3 &p_a, const Vector3 &p_b) {
  817. Vector3 s[2] = { p_a, p_b };
  818. return ::Geometry3D::get_closest_point_to_segment_uncapped(p_point, s);
  819. }
  820. Vector3 Geometry3D::get_triangle_barycentric_coords(const Vector3 &p_point, const Vector3 &p_v0, const Vector3 &p_v1, const Vector3 &p_v2) {
  821. Vector3 res = ::Geometry3D::triangle_get_barycentric_coords(p_v0, p_v1, p_v2, p_point);
  822. return res;
  823. }
  824. Variant Geometry3D::ray_intersects_triangle(const Vector3 &p_from, const Vector3 &p_dir, const Vector3 &p_v0, const Vector3 &p_v1, const Vector3 &p_v2) {
  825. Vector3 res;
  826. if (::Geometry3D::ray_intersects_triangle(p_from, p_dir, p_v0, p_v1, p_v2, &res)) {
  827. return res;
  828. } else {
  829. return Variant();
  830. }
  831. }
  832. Variant Geometry3D::segment_intersects_triangle(const Vector3 &p_from, const Vector3 &p_to, const Vector3 &p_v0, const Vector3 &p_v1, const Vector3 &p_v2) {
  833. Vector3 res;
  834. if (::Geometry3D::segment_intersects_triangle(p_from, p_to, p_v0, p_v1, p_v2, &res)) {
  835. return res;
  836. } else {
  837. return Variant();
  838. }
  839. }
  840. Vector<Vector3> Geometry3D::segment_intersects_sphere(const Vector3 &p_from, const Vector3 &p_to, const Vector3 &p_sphere_pos, real_t p_sphere_radius) {
  841. Vector<Vector3> r;
  842. Vector3 res, norm;
  843. if (!::Geometry3D::segment_intersects_sphere(p_from, p_to, p_sphere_pos, p_sphere_radius, &res, &norm)) {
  844. return r;
  845. }
  846. r.resize(2);
  847. r.set(0, res);
  848. r.set(1, norm);
  849. return r;
  850. }
  851. Vector<Vector3> Geometry3D::segment_intersects_cylinder(const Vector3 &p_from, const Vector3 &p_to, float p_height, float p_radius) {
  852. Vector<Vector3> r;
  853. Vector3 res, norm;
  854. if (!::Geometry3D::segment_intersects_cylinder(p_from, p_to, p_height, p_radius, &res, &norm)) {
  855. return r;
  856. }
  857. r.resize(2);
  858. r.set(0, res);
  859. r.set(1, norm);
  860. return r;
  861. }
  862. Vector<Vector3> Geometry3D::segment_intersects_convex(const Vector3 &p_from, const Vector3 &p_to, const TypedArray<Plane> &p_planes) {
  863. Vector<Vector3> r;
  864. Vector3 res, norm;
  865. Vector<Plane> planes = Variant(p_planes);
  866. if (!::Geometry3D::segment_intersects_convex(p_from, p_to, planes.ptr(), planes.size(), &res, &norm)) {
  867. return r;
  868. }
  869. r.resize(2);
  870. r.set(0, res);
  871. r.set(1, norm);
  872. return r;
  873. }
  874. Vector<Vector3> Geometry3D::clip_polygon(const Vector<Vector3> &p_points, const Plane &p_plane) {
  875. return ::Geometry3D::clip_polygon(p_points, p_plane);
  876. }
  877. Vector<int32_t> Geometry3D::tetrahedralize_delaunay(const Vector<Vector3> &p_points) {
  878. return ::Geometry3D::tetrahedralize_delaunay(p_points);
  879. }
  880. void Geometry3D::_bind_methods() {
  881. ClassDB::bind_method(D_METHOD("compute_convex_mesh_points", "planes"), &Geometry3D::compute_convex_mesh_points);
  882. ClassDB::bind_method(D_METHOD("build_box_planes", "extents"), &Geometry3D::build_box_planes);
  883. ClassDB::bind_method(D_METHOD("build_cylinder_planes", "radius", "height", "sides", "axis"), &Geometry3D::build_cylinder_planes, DEFVAL(Vector3::AXIS_Z));
  884. ClassDB::bind_method(D_METHOD("build_capsule_planes", "radius", "height", "sides", "lats", "axis"), &Geometry3D::build_capsule_planes, DEFVAL(Vector3::AXIS_Z));
  885. ClassDB::bind_method(D_METHOD("get_closest_points_between_segments", "p1", "p2", "q1", "q2"), &Geometry3D::get_closest_points_between_segments);
  886. ClassDB::bind_method(D_METHOD("get_closest_point_to_segment", "point", "s1", "s2"), &Geometry3D::get_closest_point_to_segment);
  887. ClassDB::bind_method(D_METHOD("get_closest_point_to_segment_uncapped", "point", "s1", "s2"), &Geometry3D::get_closest_point_to_segment_uncapped);
  888. ClassDB::bind_method(D_METHOD("get_triangle_barycentric_coords", "point", "a", "b", "c"), &Geometry3D::get_triangle_barycentric_coords);
  889. ClassDB::bind_method(D_METHOD("ray_intersects_triangle", "from", "dir", "a", "b", "c"), &Geometry3D::ray_intersects_triangle);
  890. ClassDB::bind_method(D_METHOD("segment_intersects_triangle", "from", "to", "a", "b", "c"), &Geometry3D::segment_intersects_triangle);
  891. ClassDB::bind_method(D_METHOD("segment_intersects_sphere", "from", "to", "sphere_position", "sphere_radius"), &Geometry3D::segment_intersects_sphere);
  892. ClassDB::bind_method(D_METHOD("segment_intersects_cylinder", "from", "to", "height", "radius"), &Geometry3D::segment_intersects_cylinder);
  893. ClassDB::bind_method(D_METHOD("segment_intersects_convex", "from", "to", "planes"), &Geometry3D::segment_intersects_convex);
  894. ClassDB::bind_method(D_METHOD("clip_polygon", "points", "plane"), &Geometry3D::clip_polygon);
  895. ClassDB::bind_method(D_METHOD("tetrahedralize_delaunay", "points"), &Geometry3D::tetrahedralize_delaunay);
  896. }
  897. ////// Marshalls //////
  898. Marshalls *Marshalls::singleton = nullptr;
  899. Marshalls *Marshalls::get_singleton() {
  900. return singleton;
  901. }
  902. String Marshalls::variant_to_base64(const Variant &p_var, bool p_full_objects) {
  903. int len;
  904. Error err = encode_variant(p_var, nullptr, len, p_full_objects);
  905. ERR_FAIL_COND_V_MSG(err != OK, "", "Error when trying to encode Variant.");
  906. Vector<uint8_t> buff;
  907. buff.resize(len);
  908. uint8_t *w = buff.ptrw();
  909. err = encode_variant(p_var, &w[0], len, p_full_objects);
  910. ERR_FAIL_COND_V_MSG(err != OK, "", "Error when trying to encode Variant.");
  911. String ret = CryptoCore::b64_encode_str(&w[0], len);
  912. ERR_FAIL_COND_V(ret.is_empty(), ret);
  913. return ret;
  914. }
  915. Variant Marshalls::base64_to_variant(const String &p_str, bool p_allow_objects) {
  916. int strlen = p_str.length();
  917. CharString cstr = p_str.ascii();
  918. Vector<uint8_t> buf;
  919. buf.resize(strlen / 4 * 3 + 1);
  920. uint8_t *w = buf.ptrw();
  921. size_t len = 0;
  922. ERR_FAIL_COND_V(CryptoCore::b64_decode(&w[0], buf.size(), &len, (unsigned char *)cstr.get_data(), strlen) != OK, Variant());
  923. Variant v;
  924. Error err = decode_variant(v, &w[0], len, nullptr, p_allow_objects);
  925. ERR_FAIL_COND_V_MSG(err != OK, Variant(), "Error when trying to decode Variant.");
  926. return v;
  927. }
  928. String Marshalls::raw_to_base64(const Vector<uint8_t> &p_arr) {
  929. String ret = CryptoCore::b64_encode_str(p_arr.ptr(), p_arr.size());
  930. ERR_FAIL_COND_V(ret.is_empty(), ret);
  931. return ret;
  932. }
  933. Vector<uint8_t> Marshalls::base64_to_raw(const String &p_str) {
  934. int strlen = p_str.length();
  935. CharString cstr = p_str.ascii();
  936. size_t arr_len = 0;
  937. Vector<uint8_t> buf;
  938. {
  939. buf.resize(strlen / 4 * 3 + 1);
  940. uint8_t *w = buf.ptrw();
  941. ERR_FAIL_COND_V(CryptoCore::b64_decode(&w[0], buf.size(), &arr_len, (unsigned char *)cstr.get_data(), strlen) != OK, Vector<uint8_t>());
  942. }
  943. buf.resize(arr_len);
  944. return buf;
  945. }
  946. String Marshalls::utf8_to_base64(const String &p_str) {
  947. CharString cstr = p_str.utf8();
  948. String ret = CryptoCore::b64_encode_str((unsigned char *)cstr.get_data(), cstr.length());
  949. ERR_FAIL_COND_V(ret.is_empty(), ret);
  950. return ret;
  951. }
  952. String Marshalls::base64_to_utf8(const String &p_str) {
  953. int strlen = p_str.length();
  954. CharString cstr = p_str.ascii();
  955. Vector<uint8_t> buf;
  956. buf.resize(strlen / 4 * 3 + 1 + 1);
  957. uint8_t *w = buf.ptrw();
  958. size_t len = 0;
  959. ERR_FAIL_COND_V(CryptoCore::b64_decode(&w[0], buf.size(), &len, (unsigned char *)cstr.get_data(), strlen) != OK, String());
  960. w[len] = 0;
  961. String ret = String::utf8((char *)&w[0]);
  962. return ret;
  963. }
  964. void Marshalls::_bind_methods() {
  965. ClassDB::bind_method(D_METHOD("variant_to_base64", "variant", "full_objects"), &Marshalls::variant_to_base64, DEFVAL(false));
  966. ClassDB::bind_method(D_METHOD("base64_to_variant", "base64_str", "allow_objects"), &Marshalls::base64_to_variant, DEFVAL(false));
  967. ClassDB::bind_method(D_METHOD("raw_to_base64", "array"), &Marshalls::raw_to_base64);
  968. ClassDB::bind_method(D_METHOD("base64_to_raw", "base64_str"), &Marshalls::base64_to_raw);
  969. ClassDB::bind_method(D_METHOD("utf8_to_base64", "utf8_str"), &Marshalls::utf8_to_base64);
  970. ClassDB::bind_method(D_METHOD("base64_to_utf8", "base64_str"), &Marshalls::base64_to_utf8);
  971. }
  972. ////// Semaphore //////
  973. void Semaphore::wait() {
  974. semaphore.wait();
  975. }
  976. bool Semaphore::try_wait() {
  977. return semaphore.try_wait();
  978. }
  979. void Semaphore::post(int p_count) {
  980. ERR_FAIL_COND(p_count <= 0);
  981. semaphore.post(p_count);
  982. }
  983. void Semaphore::_bind_methods() {
  984. ClassDB::bind_method(D_METHOD("wait"), &Semaphore::wait);
  985. ClassDB::bind_method(D_METHOD("try_wait"), &Semaphore::try_wait);
  986. ClassDB::bind_method(D_METHOD("post", "count"), &Semaphore::post, DEFVAL(1));
  987. }
  988. ////// Mutex //////
  989. void Mutex::lock() {
  990. mutex.lock();
  991. }
  992. bool Mutex::try_lock() {
  993. return mutex.try_lock();
  994. }
  995. void Mutex::unlock() {
  996. mutex.unlock();
  997. }
  998. void Mutex::_bind_methods() {
  999. ClassDB::bind_method(D_METHOD("lock"), &Mutex::lock);
  1000. ClassDB::bind_method(D_METHOD("try_lock"), &Mutex::try_lock);
  1001. ClassDB::bind_method(D_METHOD("unlock"), &Mutex::unlock);
  1002. }
  1003. ////// Thread //////
  1004. void Thread::_start_func(void *ud) {
  1005. Ref<Thread> *tud = (Ref<Thread> *)ud;
  1006. Ref<Thread> t = *tud;
  1007. memdelete(tud);
  1008. if (!t->target_callable.is_valid()) {
  1009. t->running.clear();
  1010. ERR_FAIL_MSG(vformat("Could not call function '%s' on previously freed instance to start thread %s.", t->target_callable.get_method(), t->get_id()));
  1011. }
  1012. // Finding out a suitable name for the thread can involve querying a node, if the target is one.
  1013. // We know this is safe (unless the user is causing life cycle race conditions, which would be a bug on their part).
  1014. set_current_thread_safe_for_nodes(true);
  1015. String func_name = t->target_callable.is_custom() ? t->target_callable.get_custom()->get_as_text() : String(t->target_callable.get_method());
  1016. set_current_thread_safe_for_nodes(false);
  1017. ::Thread::set_name(func_name);
  1018. // To avoid a circular reference between the thread and the script which can possibly contain a reference
  1019. // to the thread, we will do the call (keeping a reference up to that point) and then break chains with it.
  1020. // When the call returns, we will reference the thread again if possible.
  1021. ObjectID th_instance_id = t->get_instance_id();
  1022. Callable target_callable = t->target_callable;
  1023. t = Ref<Thread>();
  1024. Callable::CallError ce;
  1025. Variant ret;
  1026. target_callable.callp(nullptr, 0, ret, ce);
  1027. // If script properly kept a reference to the thread, we should be able to re-reference it now
  1028. // (well, or if the call failed, since we had to break chains anyway because the outcome isn't known upfront).
  1029. t = Ref<Thread>(ObjectDB::get_instance(th_instance_id));
  1030. if (t.is_valid()) {
  1031. t->ret = ret;
  1032. t->running.clear();
  1033. } else {
  1034. // We could print a warning here, but the Thread object will be eventually destroyed
  1035. // noticing wait_to_finish() hasn't been called on it, and it will print a warning itself.
  1036. }
  1037. if (ce.error != Callable::CallError::CALL_OK) {
  1038. ERR_FAIL_MSG(vformat("Could not call function '%s' to start thread %d: %s.", func_name, t->get_id(), Variant::get_callable_error_text(t->target_callable, nullptr, 0, ce)));
  1039. }
  1040. }
  1041. Error Thread::start(const Callable &p_callable, Priority p_priority) {
  1042. ERR_FAIL_COND_V_MSG(is_started(), ERR_ALREADY_IN_USE, "Thread already started.");
  1043. ERR_FAIL_COND_V(!p_callable.is_valid(), ERR_INVALID_PARAMETER);
  1044. ERR_FAIL_INDEX_V(p_priority, PRIORITY_MAX, ERR_INVALID_PARAMETER);
  1045. ret = Variant();
  1046. target_callable = p_callable;
  1047. running.set();
  1048. Ref<Thread> *ud = memnew(Ref<Thread>(this));
  1049. ::Thread::Settings s;
  1050. s.priority = (::Thread::Priority)p_priority;
  1051. thread.start(_start_func, ud, s);
  1052. return OK;
  1053. }
  1054. String Thread::get_id() const {
  1055. return itos(thread.get_id());
  1056. }
  1057. bool Thread::is_started() const {
  1058. return thread.is_started();
  1059. }
  1060. bool Thread::is_alive() const {
  1061. return running.is_set();
  1062. }
  1063. Variant Thread::wait_to_finish() {
  1064. ERR_FAIL_COND_V_MSG(!is_started(), Variant(), "Thread must have been started to wait for its completion.");
  1065. thread.wait_to_finish();
  1066. Variant r = ret;
  1067. target_callable = Callable();
  1068. return r;
  1069. }
  1070. void Thread::set_thread_safety_checks_enabled(bool p_enabled) {
  1071. ERR_FAIL_COND_MSG(::Thread::is_main_thread(), "This call is forbidden on the main thread.");
  1072. set_current_thread_safe_for_nodes(!p_enabled);
  1073. }
  1074. void Thread::_bind_methods() {
  1075. ClassDB::bind_method(D_METHOD("start", "callable", "priority"), &Thread::start, DEFVAL(PRIORITY_NORMAL));
  1076. ClassDB::bind_method(D_METHOD("get_id"), &Thread::get_id);
  1077. ClassDB::bind_method(D_METHOD("is_started"), &Thread::is_started);
  1078. ClassDB::bind_method(D_METHOD("is_alive"), &Thread::is_alive);
  1079. ClassDB::bind_method(D_METHOD("wait_to_finish"), &Thread::wait_to_finish);
  1080. ClassDB::bind_static_method("Thread", D_METHOD("set_thread_safety_checks_enabled", "enabled"), &Thread::set_thread_safety_checks_enabled);
  1081. BIND_ENUM_CONSTANT(PRIORITY_LOW);
  1082. BIND_ENUM_CONSTANT(PRIORITY_NORMAL);
  1083. BIND_ENUM_CONSTANT(PRIORITY_HIGH);
  1084. }
  1085. namespace special {
  1086. ////// ClassDB //////
  1087. PackedStringArray ClassDB::get_class_list() const {
  1088. List<StringName> classes;
  1089. ::ClassDB::get_class_list(&classes);
  1090. PackedStringArray ret;
  1091. ret.resize(classes.size());
  1092. int idx = 0;
  1093. for (const StringName &E : classes) {
  1094. ret.set(idx++, E);
  1095. }
  1096. return ret;
  1097. }
  1098. PackedStringArray ClassDB::get_inheriters_from_class(const StringName &p_class) const {
  1099. List<StringName> classes;
  1100. ::ClassDB::get_inheriters_from_class(p_class, &classes);
  1101. PackedStringArray ret;
  1102. ret.resize(classes.size());
  1103. int idx = 0;
  1104. for (const StringName &E : classes) {
  1105. ret.set(idx++, E);
  1106. }
  1107. return ret;
  1108. }
  1109. StringName ClassDB::get_parent_class(const StringName &p_class) const {
  1110. return ::ClassDB::get_parent_class(p_class);
  1111. }
  1112. bool ClassDB::class_exists(const StringName &p_class) const {
  1113. return ::ClassDB::class_exists(p_class);
  1114. }
  1115. bool ClassDB::is_parent_class(const StringName &p_class, const StringName &p_inherits) const {
  1116. return ::ClassDB::is_parent_class(p_class, p_inherits);
  1117. }
  1118. bool ClassDB::can_instantiate(const StringName &p_class) const {
  1119. return ::ClassDB::can_instantiate(p_class);
  1120. }
  1121. Variant ClassDB::instantiate(const StringName &p_class) const {
  1122. Object *obj = ::ClassDB::instantiate(p_class);
  1123. if (!obj) {
  1124. return Variant();
  1125. }
  1126. RefCounted *r = Object::cast_to<RefCounted>(obj);
  1127. if (r) {
  1128. return Ref<RefCounted>(r);
  1129. } else {
  1130. return obj;
  1131. }
  1132. }
  1133. ClassDB::APIType ClassDB::class_get_api_type(const StringName &p_class) const {
  1134. ::ClassDB::APIType api_type = ::ClassDB::get_api_type(p_class);
  1135. return (APIType)api_type;
  1136. }
  1137. bool ClassDB::class_has_signal(const StringName &p_class, const StringName &p_signal) const {
  1138. return ::ClassDB::has_signal(p_class, p_signal);
  1139. }
  1140. Dictionary ClassDB::class_get_signal(const StringName &p_class, const StringName &p_signal) const {
  1141. MethodInfo signal;
  1142. if (::ClassDB::get_signal(p_class, p_signal, &signal)) {
  1143. return signal.operator Dictionary();
  1144. } else {
  1145. return Dictionary();
  1146. }
  1147. }
  1148. TypedArray<Dictionary> ClassDB::class_get_signal_list(const StringName &p_class, bool p_no_inheritance) const {
  1149. List<MethodInfo> signals;
  1150. ::ClassDB::get_signal_list(p_class, &signals, p_no_inheritance);
  1151. TypedArray<Dictionary> ret;
  1152. for (const MethodInfo &E : signals) {
  1153. ret.push_back(E.operator Dictionary());
  1154. }
  1155. return ret;
  1156. }
  1157. TypedArray<Dictionary> ClassDB::class_get_property_list(const StringName &p_class, bool p_no_inheritance) const {
  1158. List<PropertyInfo> plist;
  1159. ::ClassDB::get_property_list(p_class, &plist, p_no_inheritance);
  1160. TypedArray<Dictionary> ret;
  1161. for (const PropertyInfo &E : plist) {
  1162. ret.push_back(E.operator Dictionary());
  1163. }
  1164. return ret;
  1165. }
  1166. StringName ClassDB::class_get_property_getter(const StringName &p_class, const StringName &p_property) {
  1167. return ::ClassDB::get_property_getter(p_class, p_property);
  1168. }
  1169. StringName ClassDB::class_get_property_setter(const StringName &p_class, const StringName &p_property) {
  1170. return ::ClassDB::get_property_setter(p_class, p_property);
  1171. }
  1172. Variant ClassDB::class_get_property(Object *p_object, const StringName &p_property) const {
  1173. Variant ret;
  1174. ::ClassDB::get_property(p_object, p_property, ret);
  1175. return ret;
  1176. }
  1177. Error ClassDB::class_set_property(Object *p_object, const StringName &p_property, const Variant &p_value) const {
  1178. Variant ret;
  1179. bool valid;
  1180. if (!::ClassDB::set_property(p_object, p_property, p_value, &valid)) {
  1181. return ERR_UNAVAILABLE;
  1182. } else if (!valid) {
  1183. return ERR_INVALID_DATA;
  1184. }
  1185. return OK;
  1186. }
  1187. Variant ClassDB::class_get_property_default_value(const StringName &p_class, const StringName &p_property) const {
  1188. bool valid;
  1189. Variant ret = ::ClassDB::class_get_default_property_value(p_class, p_property, &valid);
  1190. if (valid) {
  1191. return ret;
  1192. }
  1193. return Variant();
  1194. }
  1195. bool ClassDB::class_has_method(const StringName &p_class, const StringName &p_method, bool p_no_inheritance) const {
  1196. return ::ClassDB::has_method(p_class, p_method, p_no_inheritance);
  1197. }
  1198. int ClassDB::class_get_method_argument_count(const StringName &p_class, const StringName &p_method, bool p_no_inheritance) const {
  1199. return ::ClassDB::get_method_argument_count(p_class, p_method, nullptr, p_no_inheritance);
  1200. }
  1201. TypedArray<Dictionary> ClassDB::class_get_method_list(const StringName &p_class, bool p_no_inheritance) const {
  1202. List<MethodInfo> methods;
  1203. ::ClassDB::get_method_list(p_class, &methods, p_no_inheritance);
  1204. TypedArray<Dictionary> ret;
  1205. for (const MethodInfo &E : methods) {
  1206. #ifdef DEBUG_METHODS_ENABLED
  1207. ret.push_back(E.operator Dictionary());
  1208. #else
  1209. Dictionary dict;
  1210. dict["name"] = E.name;
  1211. ret.push_back(dict);
  1212. #endif
  1213. }
  1214. return ret;
  1215. }
  1216. Variant ClassDB::class_call_static_method(const Variant **p_arguments, int p_argcount, Callable::CallError &r_call_error) {
  1217. if (p_argcount < 2) {
  1218. r_call_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1219. return Variant::NIL;
  1220. }
  1221. if (!p_arguments[0]->is_string() || !p_arguments[1]->is_string()) {
  1222. r_call_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  1223. return Variant::NIL;
  1224. }
  1225. StringName class_ = *p_arguments[0];
  1226. StringName method = *p_arguments[1];
  1227. const MethodBind *bind = ::ClassDB::get_method(class_, method);
  1228. ERR_FAIL_NULL_V_MSG(bind, Variant::NIL, "Cannot find static method.");
  1229. ERR_FAIL_COND_V_MSG(!bind->is_static(), Variant::NIL, "Method is not static.");
  1230. return bind->call(nullptr, p_arguments + 2, p_argcount - 2, r_call_error);
  1231. }
  1232. PackedStringArray ClassDB::class_get_integer_constant_list(const StringName &p_class, bool p_no_inheritance) const {
  1233. List<String> constants;
  1234. ::ClassDB::get_integer_constant_list(p_class, &constants, p_no_inheritance);
  1235. PackedStringArray ret;
  1236. ret.resize(constants.size());
  1237. int idx = 0;
  1238. for (const String &E : constants) {
  1239. ret.set(idx++, E);
  1240. }
  1241. return ret;
  1242. }
  1243. bool ClassDB::class_has_integer_constant(const StringName &p_class, const StringName &p_name) const {
  1244. bool success;
  1245. ::ClassDB::get_integer_constant(p_class, p_name, &success);
  1246. return success;
  1247. }
  1248. int64_t ClassDB::class_get_integer_constant(const StringName &p_class, const StringName &p_name) const {
  1249. bool found;
  1250. int64_t c = ::ClassDB::get_integer_constant(p_class, p_name, &found);
  1251. ERR_FAIL_COND_V(!found, 0);
  1252. return c;
  1253. }
  1254. bool ClassDB::class_has_enum(const StringName &p_class, const StringName &p_name, bool p_no_inheritance) const {
  1255. return ::ClassDB::has_enum(p_class, p_name, p_no_inheritance);
  1256. }
  1257. PackedStringArray ClassDB::class_get_enum_list(const StringName &p_class, bool p_no_inheritance) const {
  1258. List<StringName> enums;
  1259. ::ClassDB::get_enum_list(p_class, &enums, p_no_inheritance);
  1260. PackedStringArray ret;
  1261. ret.resize(enums.size());
  1262. int idx = 0;
  1263. for (const StringName &E : enums) {
  1264. ret.set(idx++, E);
  1265. }
  1266. return ret;
  1267. }
  1268. PackedStringArray ClassDB::class_get_enum_constants(const StringName &p_class, const StringName &p_enum, bool p_no_inheritance) const {
  1269. List<StringName> constants;
  1270. ::ClassDB::get_enum_constants(p_class, p_enum, &constants, p_no_inheritance);
  1271. PackedStringArray ret;
  1272. ret.resize(constants.size());
  1273. int idx = 0;
  1274. for (const StringName &E : constants) {
  1275. ret.set(idx++, E);
  1276. }
  1277. return ret;
  1278. }
  1279. StringName ClassDB::class_get_integer_constant_enum(const StringName &p_class, const StringName &p_name, bool p_no_inheritance) const {
  1280. return ::ClassDB::get_integer_constant_enum(p_class, p_name, p_no_inheritance);
  1281. }
  1282. bool ClassDB::is_class_enum_bitfield(const StringName &p_class, const StringName &p_enum, bool p_no_inheritance) const {
  1283. return ::ClassDB::is_enum_bitfield(p_class, p_enum, p_no_inheritance);
  1284. }
  1285. bool ClassDB::is_class_enabled(const StringName &p_class) const {
  1286. return ::ClassDB::is_class_enabled(p_class);
  1287. }
  1288. #ifdef TOOLS_ENABLED
  1289. void ClassDB::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
  1290. const String pf = p_function;
  1291. bool first_argument_is_class = false;
  1292. if (p_idx == 0) {
  1293. first_argument_is_class = (pf == "get_inheriters_from_class" || pf == "get_parent_class" ||
  1294. pf == "class_exists" || pf == "can_instantiate" || pf == "instantiate" ||
  1295. pf == "class_has_signal" || pf == "class_get_signal" || pf == "class_get_signal_list" ||
  1296. pf == "class_get_property_list" || pf == "class_get_property" || pf == "class_set_property" ||
  1297. pf == "class_has_method" || pf == "class_get_method_list" ||
  1298. pf == "class_get_integer_constant_list" || pf == "class_has_integer_constant" || pf == "class_get_integer_constant" ||
  1299. pf == "class_has_enum" || pf == "class_get_enum_list" || pf == "class_get_enum_constants" || pf == "class_get_integer_constant_enum" ||
  1300. pf == "is_class_enabled" || pf == "is_class_enum_bitfield" || pf == "class_get_api_type");
  1301. }
  1302. if (first_argument_is_class || pf == "is_parent_class") {
  1303. for (const String &E : get_class_list()) {
  1304. r_options->push_back(E.quote());
  1305. }
  1306. }
  1307. Object::get_argument_options(p_function, p_idx, r_options);
  1308. }
  1309. #endif
  1310. void ClassDB::_bind_methods() {
  1311. ::ClassDB::bind_method(D_METHOD("get_class_list"), &ClassDB::get_class_list);
  1312. ::ClassDB::bind_method(D_METHOD("get_inheriters_from_class", "class"), &ClassDB::get_inheriters_from_class);
  1313. ::ClassDB::bind_method(D_METHOD("get_parent_class", "class"), &ClassDB::get_parent_class);
  1314. ::ClassDB::bind_method(D_METHOD("class_exists", "class"), &ClassDB::class_exists);
  1315. ::ClassDB::bind_method(D_METHOD("is_parent_class", "class", "inherits"), &ClassDB::is_parent_class);
  1316. ::ClassDB::bind_method(D_METHOD("can_instantiate", "class"), &ClassDB::can_instantiate);
  1317. ::ClassDB::bind_method(D_METHOD("instantiate", "class"), &ClassDB::instantiate);
  1318. ::ClassDB::bind_method(D_METHOD("class_get_api_type", "class"), &ClassDB::class_get_api_type);
  1319. ::ClassDB::bind_method(D_METHOD("class_has_signal", "class", "signal"), &ClassDB::class_has_signal);
  1320. ::ClassDB::bind_method(D_METHOD("class_get_signal", "class", "signal"), &ClassDB::class_get_signal);
  1321. ::ClassDB::bind_method(D_METHOD("class_get_signal_list", "class", "no_inheritance"), &ClassDB::class_get_signal_list, DEFVAL(false));
  1322. ::ClassDB::bind_method(D_METHOD("class_get_property_list", "class", "no_inheritance"), &ClassDB::class_get_property_list, DEFVAL(false));
  1323. ::ClassDB::bind_method(D_METHOD("class_get_property_getter", "class", "property"), &ClassDB::class_get_property_getter);
  1324. ::ClassDB::bind_method(D_METHOD("class_get_property_setter", "class", "property"), &ClassDB::class_get_property_setter);
  1325. ::ClassDB::bind_method(D_METHOD("class_get_property", "object", "property"), &ClassDB::class_get_property);
  1326. ::ClassDB::bind_method(D_METHOD("class_set_property", "object", "property", "value"), &ClassDB::class_set_property);
  1327. ::ClassDB::bind_method(D_METHOD("class_get_property_default_value", "class", "property"), &ClassDB::class_get_property_default_value);
  1328. ::ClassDB::bind_method(D_METHOD("class_has_method", "class", "method", "no_inheritance"), &ClassDB::class_has_method, DEFVAL(false));
  1329. ::ClassDB::bind_method(D_METHOD("class_get_method_argument_count", "class", "method", "no_inheritance"), &ClassDB::class_get_method_argument_count, DEFVAL(false));
  1330. ::ClassDB::bind_method(D_METHOD("class_get_method_list", "class", "no_inheritance"), &ClassDB::class_get_method_list, DEFVAL(false));
  1331. ::ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "class_call_static_method", &ClassDB::class_call_static_method, MethodInfo("class_call_static_method", PropertyInfo(Variant::STRING_NAME, "class"), PropertyInfo(Variant::STRING_NAME, "method")));
  1332. ::ClassDB::bind_method(D_METHOD("class_get_integer_constant_list", "class", "no_inheritance"), &ClassDB::class_get_integer_constant_list, DEFVAL(false));
  1333. ::ClassDB::bind_method(D_METHOD("class_has_integer_constant", "class", "name"), &ClassDB::class_has_integer_constant);
  1334. ::ClassDB::bind_method(D_METHOD("class_get_integer_constant", "class", "name"), &ClassDB::class_get_integer_constant);
  1335. ::ClassDB::bind_method(D_METHOD("class_has_enum", "class", "name", "no_inheritance"), &ClassDB::class_has_enum, DEFVAL(false));
  1336. ::ClassDB::bind_method(D_METHOD("class_get_enum_list", "class", "no_inheritance"), &ClassDB::class_get_enum_list, DEFVAL(false));
  1337. ::ClassDB::bind_method(D_METHOD("class_get_enum_constants", "class", "enum", "no_inheritance"), &ClassDB::class_get_enum_constants, DEFVAL(false));
  1338. ::ClassDB::bind_method(D_METHOD("class_get_integer_constant_enum", "class", "name", "no_inheritance"), &ClassDB::class_get_integer_constant_enum, DEFVAL(false));
  1339. ::ClassDB::bind_method(D_METHOD("is_class_enum_bitfield", "class", "enum", "no_inheritance"), &ClassDB::is_class_enum_bitfield, DEFVAL(false));
  1340. ::ClassDB::bind_method(D_METHOD("is_class_enabled", "class"), &ClassDB::is_class_enabled);
  1341. BIND_ENUM_CONSTANT(API_CORE);
  1342. BIND_ENUM_CONSTANT(API_EDITOR);
  1343. BIND_ENUM_CONSTANT(API_EXTENSION);
  1344. BIND_ENUM_CONSTANT(API_EDITOR_EXTENSION);
  1345. BIND_ENUM_CONSTANT(API_NONE);
  1346. }
  1347. } // namespace special
  1348. ////// Engine //////
  1349. void Engine::set_physics_ticks_per_second(int p_ips) {
  1350. ::Engine::get_singleton()->set_physics_ticks_per_second(p_ips);
  1351. }
  1352. int Engine::get_physics_ticks_per_second() const {
  1353. return ::Engine::get_singleton()->get_physics_ticks_per_second();
  1354. }
  1355. void Engine::set_max_physics_steps_per_frame(int p_max_physics_steps) {
  1356. ::Engine::get_singleton()->set_max_physics_steps_per_frame(p_max_physics_steps);
  1357. }
  1358. int Engine::get_max_physics_steps_per_frame() const {
  1359. return ::Engine::get_singleton()->get_max_physics_steps_per_frame();
  1360. }
  1361. void Engine::set_physics_jitter_fix(double p_threshold) {
  1362. ::Engine::get_singleton()->set_physics_jitter_fix(p_threshold);
  1363. }
  1364. double Engine::get_physics_jitter_fix() const {
  1365. return ::Engine::get_singleton()->get_physics_jitter_fix();
  1366. }
  1367. double Engine::get_physics_interpolation_fraction() const {
  1368. return ::Engine::get_singleton()->get_physics_interpolation_fraction();
  1369. }
  1370. void Engine::set_max_fps(int p_fps) {
  1371. ::Engine::get_singleton()->set_max_fps(p_fps);
  1372. }
  1373. int Engine::get_max_fps() const {
  1374. return ::Engine::get_singleton()->get_max_fps();
  1375. }
  1376. double Engine::get_frames_per_second() const {
  1377. return ::Engine::get_singleton()->get_frames_per_second();
  1378. }
  1379. uint64_t Engine::get_physics_frames() const {
  1380. return ::Engine::get_singleton()->get_physics_frames();
  1381. }
  1382. uint64_t Engine::get_process_frames() const {
  1383. return ::Engine::get_singleton()->get_process_frames();
  1384. }
  1385. void Engine::set_time_scale(double p_scale) {
  1386. ::Engine::get_singleton()->set_time_scale(p_scale);
  1387. }
  1388. double Engine::get_time_scale() {
  1389. return ::Engine::get_singleton()->get_time_scale();
  1390. }
  1391. int Engine::get_frames_drawn() {
  1392. return ::Engine::get_singleton()->get_frames_drawn();
  1393. }
  1394. MainLoop *Engine::get_main_loop() const {
  1395. // Needs to remain in OS, since it's actually OS that interacts with it, but it's better exposed here
  1396. return ::OS::get_singleton()->get_main_loop();
  1397. }
  1398. Dictionary Engine::get_version_info() const {
  1399. return ::Engine::get_singleton()->get_version_info();
  1400. }
  1401. Dictionary Engine::get_author_info() const {
  1402. return ::Engine::get_singleton()->get_author_info();
  1403. }
  1404. TypedArray<Dictionary> Engine::get_copyright_info() const {
  1405. return ::Engine::get_singleton()->get_copyright_info();
  1406. }
  1407. Dictionary Engine::get_donor_info() const {
  1408. return ::Engine::get_singleton()->get_donor_info();
  1409. }
  1410. Dictionary Engine::get_license_info() const {
  1411. return ::Engine::get_singleton()->get_license_info();
  1412. }
  1413. String Engine::get_license_text() const {
  1414. return ::Engine::get_singleton()->get_license_text();
  1415. }
  1416. String Engine::get_architecture_name() const {
  1417. return ::Engine::get_singleton()->get_architecture_name();
  1418. }
  1419. bool Engine::is_in_physics_frame() const {
  1420. return ::Engine::get_singleton()->is_in_physics_frame();
  1421. }
  1422. bool Engine::has_singleton(const StringName &p_name) const {
  1423. return ::Engine::get_singleton()->has_singleton(p_name);
  1424. }
  1425. Object *Engine::get_singleton_object(const StringName &p_name) const {
  1426. return ::Engine::get_singleton()->get_singleton_object(p_name);
  1427. }
  1428. void Engine::register_singleton(const StringName &p_name, Object *p_object) {
  1429. ERR_FAIL_COND_MSG(has_singleton(p_name), vformat("Singleton already registered: '%s'.", String(p_name)));
  1430. ERR_FAIL_COND_MSG(!String(p_name).is_valid_ascii_identifier(), vformat("Singleton name is not a valid identifier: '%s'.", p_name));
  1431. ::Engine::Singleton s;
  1432. s.class_name = p_name;
  1433. s.name = p_name;
  1434. s.ptr = p_object;
  1435. s.user_created = true;
  1436. ::Engine::get_singleton()->add_singleton(s);
  1437. }
  1438. void Engine::unregister_singleton(const StringName &p_name) {
  1439. ERR_FAIL_COND_MSG(!has_singleton(p_name), vformat("Attempt to remove unregistered singleton: '%s'.", String(p_name)));
  1440. ERR_FAIL_COND_MSG(!::Engine::get_singleton()->is_singleton_user_created(p_name), vformat("Attempt to remove non-user created singleton: '%s'.", String(p_name)));
  1441. ::Engine::get_singleton()->remove_singleton(p_name);
  1442. }
  1443. Vector<String> Engine::get_singleton_list() const {
  1444. List<::Engine::Singleton> singletons;
  1445. ::Engine::get_singleton()->get_singletons(&singletons);
  1446. Vector<String> ret;
  1447. for (List<::Engine::Singleton>::Element *E = singletons.front(); E; E = E->next()) {
  1448. ret.push_back(E->get().name);
  1449. }
  1450. return ret;
  1451. }
  1452. Error Engine::register_script_language(ScriptLanguage *p_language) {
  1453. return ScriptServer::register_language(p_language);
  1454. }
  1455. Error Engine::unregister_script_language(const ScriptLanguage *p_language) {
  1456. return ScriptServer::unregister_language(p_language);
  1457. }
  1458. int Engine::get_script_language_count() {
  1459. return ScriptServer::get_language_count();
  1460. }
  1461. ScriptLanguage *Engine::get_script_language(int p_index) const {
  1462. return ScriptServer::get_language(p_index);
  1463. }
  1464. void Engine::set_editor_hint(bool p_enabled) {
  1465. ::Engine::get_singleton()->set_editor_hint(p_enabled);
  1466. }
  1467. bool Engine::is_editor_hint() const {
  1468. return ::Engine::get_singleton()->is_editor_hint();
  1469. }
  1470. String Engine::get_write_movie_path() const {
  1471. return ::Engine::get_singleton()->get_write_movie_path();
  1472. }
  1473. void Engine::set_print_to_stdout(bool p_enabled) {
  1474. ::Engine::get_singleton()->set_print_to_stdout(p_enabled);
  1475. }
  1476. bool Engine::is_printing_to_stdout() const {
  1477. return ::Engine::get_singleton()->is_printing_to_stdout();
  1478. }
  1479. void Engine::set_print_error_messages(bool p_enabled) {
  1480. ::Engine::get_singleton()->set_print_error_messages(p_enabled);
  1481. }
  1482. bool Engine::is_printing_error_messages() const {
  1483. return ::Engine::get_singleton()->is_printing_error_messages();
  1484. }
  1485. #ifdef TOOLS_ENABLED
  1486. void Engine::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
  1487. const String pf = p_function;
  1488. if (p_idx == 0 && (pf == "has_singleton" || pf == "get_singleton" || pf == "unregister_singleton")) {
  1489. for (const String &E : get_singleton_list()) {
  1490. r_options->push_back(E.quote());
  1491. }
  1492. }
  1493. Object::get_argument_options(p_function, p_idx, r_options);
  1494. }
  1495. #endif
  1496. void Engine::_bind_methods() {
  1497. ClassDB::bind_method(D_METHOD("set_physics_ticks_per_second", "physics_ticks_per_second"), &Engine::set_physics_ticks_per_second);
  1498. ClassDB::bind_method(D_METHOD("get_physics_ticks_per_second"), &Engine::get_physics_ticks_per_second);
  1499. ClassDB::bind_method(D_METHOD("set_max_physics_steps_per_frame", "max_physics_steps"), &Engine::set_max_physics_steps_per_frame);
  1500. ClassDB::bind_method(D_METHOD("get_max_physics_steps_per_frame"), &Engine::get_max_physics_steps_per_frame);
  1501. ClassDB::bind_method(D_METHOD("set_physics_jitter_fix", "physics_jitter_fix"), &Engine::set_physics_jitter_fix);
  1502. ClassDB::bind_method(D_METHOD("get_physics_jitter_fix"), &Engine::get_physics_jitter_fix);
  1503. ClassDB::bind_method(D_METHOD("get_physics_interpolation_fraction"), &Engine::get_physics_interpolation_fraction);
  1504. ClassDB::bind_method(D_METHOD("set_max_fps", "max_fps"), &Engine::set_max_fps);
  1505. ClassDB::bind_method(D_METHOD("get_max_fps"), &Engine::get_max_fps);
  1506. ClassDB::bind_method(D_METHOD("set_time_scale", "time_scale"), &Engine::set_time_scale);
  1507. ClassDB::bind_method(D_METHOD("get_time_scale"), &Engine::get_time_scale);
  1508. ClassDB::bind_method(D_METHOD("get_frames_drawn"), &Engine::get_frames_drawn);
  1509. ClassDB::bind_method(D_METHOD("get_frames_per_second"), &Engine::get_frames_per_second);
  1510. ClassDB::bind_method(D_METHOD("get_physics_frames"), &Engine::get_physics_frames);
  1511. ClassDB::bind_method(D_METHOD("get_process_frames"), &Engine::get_process_frames);
  1512. ClassDB::bind_method(D_METHOD("get_main_loop"), &Engine::get_main_loop);
  1513. ClassDB::bind_method(D_METHOD("get_version_info"), &Engine::get_version_info);
  1514. ClassDB::bind_method(D_METHOD("get_author_info"), &Engine::get_author_info);
  1515. ClassDB::bind_method(D_METHOD("get_copyright_info"), &Engine::get_copyright_info);
  1516. ClassDB::bind_method(D_METHOD("get_donor_info"), &Engine::get_donor_info);
  1517. ClassDB::bind_method(D_METHOD("get_license_info"), &Engine::get_license_info);
  1518. ClassDB::bind_method(D_METHOD("get_license_text"), &Engine::get_license_text);
  1519. ClassDB::bind_method(D_METHOD("get_architecture_name"), &Engine::get_architecture_name);
  1520. ClassDB::bind_method(D_METHOD("is_in_physics_frame"), &Engine::is_in_physics_frame);
  1521. ClassDB::bind_method(D_METHOD("has_singleton", "name"), &Engine::has_singleton);
  1522. ClassDB::bind_method(D_METHOD("get_singleton", "name"), &Engine::get_singleton_object);
  1523. ClassDB::bind_method(D_METHOD("register_singleton", "name", "instance"), &Engine::register_singleton);
  1524. ClassDB::bind_method(D_METHOD("unregister_singleton", "name"), &Engine::unregister_singleton);
  1525. ClassDB::bind_method(D_METHOD("get_singleton_list"), &Engine::get_singleton_list);
  1526. ClassDB::bind_method(D_METHOD("register_script_language", "language"), &Engine::register_script_language);
  1527. ClassDB::bind_method(D_METHOD("unregister_script_language", "language"), &Engine::unregister_script_language);
  1528. ClassDB::bind_method(D_METHOD("get_script_language_count"), &Engine::get_script_language_count);
  1529. ClassDB::bind_method(D_METHOD("get_script_language", "index"), &Engine::get_script_language);
  1530. ClassDB::bind_method(D_METHOD("is_editor_hint"), &Engine::is_editor_hint);
  1531. ClassDB::bind_method(D_METHOD("get_write_movie_path"), &Engine::get_write_movie_path);
  1532. ClassDB::bind_method(D_METHOD("set_print_to_stdout", "enabled"), &Engine::set_print_to_stdout);
  1533. ClassDB::bind_method(D_METHOD("is_printing_to_stdout"), &Engine::is_printing_to_stdout);
  1534. ClassDB::bind_method(D_METHOD("set_print_error_messages", "enabled"), &Engine::set_print_error_messages);
  1535. ClassDB::bind_method(D_METHOD("is_printing_error_messages"), &Engine::is_printing_error_messages);
  1536. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "print_error_messages"), "set_print_error_messages", "is_printing_error_messages");
  1537. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "print_to_stdout"), "set_print_to_stdout", "is_printing_to_stdout");
  1538. ADD_PROPERTY(PropertyInfo(Variant::INT, "physics_ticks_per_second"), "set_physics_ticks_per_second", "get_physics_ticks_per_second");
  1539. ADD_PROPERTY(PropertyInfo(Variant::INT, "max_physics_steps_per_frame"), "set_max_physics_steps_per_frame", "get_max_physics_steps_per_frame");
  1540. ADD_PROPERTY(PropertyInfo(Variant::INT, "max_fps"), "set_max_fps", "get_max_fps");
  1541. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "time_scale"), "set_time_scale", "get_time_scale");
  1542. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "physics_jitter_fix"), "set_physics_jitter_fix", "get_physics_jitter_fix");
  1543. }
  1544. Engine *Engine::singleton = nullptr;
  1545. ////// EngineDebugger //////
  1546. bool EngineDebugger::is_active() {
  1547. return ::EngineDebugger::is_active();
  1548. }
  1549. void EngineDebugger::register_profiler(const StringName &p_name, Ref<EngineProfiler> p_profiler) {
  1550. ERR_FAIL_COND(p_profiler.is_null());
  1551. ERR_FAIL_COND_MSG(p_profiler->is_bound(), "Profiler already registered.");
  1552. ERR_FAIL_COND_MSG(profilers.has(p_name) || has_profiler(p_name), vformat("Profiler name already in use: '%s'.", p_name));
  1553. Error err = p_profiler->bind(p_name);
  1554. ERR_FAIL_COND_MSG(err != OK, vformat("Profiler failed to register with error: %d.", err));
  1555. profilers.insert(p_name, p_profiler);
  1556. }
  1557. void EngineDebugger::unregister_profiler(const StringName &p_name) {
  1558. ERR_FAIL_COND_MSG(!profilers.has(p_name), vformat("Profiler not registered: '%s'.", p_name));
  1559. profilers[p_name]->unbind();
  1560. profilers.erase(p_name);
  1561. }
  1562. bool EngineDebugger::is_profiling(const StringName &p_name) {
  1563. return ::EngineDebugger::is_profiling(p_name);
  1564. }
  1565. bool EngineDebugger::has_profiler(const StringName &p_name) {
  1566. return ::EngineDebugger::has_profiler(p_name);
  1567. }
  1568. void EngineDebugger::profiler_add_frame_data(const StringName &p_name, const Array &p_data) {
  1569. ::EngineDebugger::profiler_add_frame_data(p_name, p_data);
  1570. }
  1571. void EngineDebugger::profiler_enable(const StringName &p_name, bool p_enabled, const Array &p_opts) {
  1572. if (::EngineDebugger::get_singleton()) {
  1573. ::EngineDebugger::get_singleton()->profiler_enable(p_name, p_enabled, p_opts);
  1574. }
  1575. }
  1576. void EngineDebugger::register_message_capture(const StringName &p_name, const Callable &p_callable) {
  1577. ERR_FAIL_COND_MSG(captures.has(p_name) || has_capture(p_name), vformat("Capture already registered: '%s'.", p_name));
  1578. captures.insert(p_name, p_callable);
  1579. Callable &c = captures[p_name];
  1580. ::EngineDebugger::Capture capture(&c, &EngineDebugger::call_capture);
  1581. ::EngineDebugger::register_message_capture(p_name, capture);
  1582. }
  1583. void EngineDebugger::unregister_message_capture(const StringName &p_name) {
  1584. ERR_FAIL_COND_MSG(!captures.has(p_name), vformat("Capture not registered: '%s'.", p_name));
  1585. ::EngineDebugger::unregister_message_capture(p_name);
  1586. captures.erase(p_name);
  1587. }
  1588. bool EngineDebugger::has_capture(const StringName &p_name) {
  1589. return ::EngineDebugger::has_capture(p_name);
  1590. }
  1591. void EngineDebugger::send_message(const String &p_msg, const Array &p_data) {
  1592. ERR_FAIL_COND_MSG(!::EngineDebugger::is_active(), "Can't send message. No active debugger");
  1593. ::EngineDebugger::get_singleton()->send_message(p_msg, p_data);
  1594. }
  1595. void EngineDebugger::debug(bool p_can_continue, bool p_is_error_breakpoint) {
  1596. ERR_FAIL_COND_MSG(!::EngineDebugger::is_active(), "Can't send debug. No active debugger");
  1597. ::EngineDebugger::get_singleton()->debug(p_can_continue, p_is_error_breakpoint);
  1598. }
  1599. void EngineDebugger::script_debug(ScriptLanguage *p_lang, bool p_can_continue, bool p_is_error_breakpoint) {
  1600. ERR_FAIL_COND_MSG(!::EngineDebugger::get_script_debugger(), "Can't send debug. No active debugger");
  1601. ::EngineDebugger::get_script_debugger()->debug(p_lang, p_can_continue, p_is_error_breakpoint);
  1602. }
  1603. Error EngineDebugger::call_capture(void *p_user, const String &p_cmd, const Array &p_data, bool &r_captured) {
  1604. Callable &capture = *(Callable *)p_user;
  1605. if (!capture.is_valid()) {
  1606. return FAILED;
  1607. }
  1608. Variant cmd = p_cmd, data = p_data;
  1609. const Variant *args[2] = { &cmd, &data };
  1610. Variant retval;
  1611. Callable::CallError err;
  1612. capture.callp(args, 2, retval, err);
  1613. ERR_FAIL_COND_V_MSG(err.error != Callable::CallError::CALL_OK, FAILED, vformat("Error calling 'capture' to callable: %s.", Variant::get_callable_error_text(capture, args, 2, err)));
  1614. ERR_FAIL_COND_V_MSG(retval.get_type() != Variant::BOOL, FAILED, vformat("Error calling 'capture' to callable: '%s'. Return type is not bool.", String(capture)));
  1615. r_captured = retval;
  1616. return OK;
  1617. }
  1618. void EngineDebugger::line_poll() {
  1619. ERR_FAIL_COND_MSG(!::EngineDebugger::is_active(), "Can't poll. No active debugger");
  1620. ::EngineDebugger::get_singleton()->line_poll();
  1621. }
  1622. void EngineDebugger::set_lines_left(int p_lines) {
  1623. ERR_FAIL_COND_MSG(!::EngineDebugger::get_script_debugger(), "Can't set lines left. No active debugger");
  1624. ::EngineDebugger::get_script_debugger()->set_lines_left(p_lines);
  1625. }
  1626. int EngineDebugger::get_lines_left() const {
  1627. ERR_FAIL_COND_V_MSG(!::EngineDebugger::get_script_debugger(), 0, "Can't get lines left. No active debugger");
  1628. return ::EngineDebugger::get_script_debugger()->get_lines_left();
  1629. }
  1630. void EngineDebugger::set_depth(int p_depth) {
  1631. ERR_FAIL_COND_MSG(!::EngineDebugger::get_script_debugger(), "Can't set depth. No active debugger");
  1632. ::EngineDebugger::get_script_debugger()->set_depth(p_depth);
  1633. }
  1634. int EngineDebugger::get_depth() const {
  1635. ERR_FAIL_COND_V_MSG(!::EngineDebugger::get_script_debugger(), 0, "Can't get depth. No active debugger");
  1636. return ::EngineDebugger::get_script_debugger()->get_depth();
  1637. }
  1638. bool EngineDebugger::is_breakpoint(int p_line, const StringName &p_source) const {
  1639. ERR_FAIL_COND_V_MSG(!::EngineDebugger::get_script_debugger(), false, "Can't check breakpoint. No active debugger");
  1640. return ::EngineDebugger::get_script_debugger()->is_breakpoint(p_line, p_source);
  1641. }
  1642. bool EngineDebugger::is_skipping_breakpoints() const {
  1643. ERR_FAIL_COND_V_MSG(!::EngineDebugger::get_script_debugger(), false, "Can't check skipping breakpoint. No active debugger");
  1644. return ::EngineDebugger::get_script_debugger()->is_skipping_breakpoints();
  1645. }
  1646. void EngineDebugger::insert_breakpoint(int p_line, const StringName &p_source) {
  1647. ERR_FAIL_COND_MSG(!::EngineDebugger::get_script_debugger(), "Can't insert breakpoint. No active debugger");
  1648. ::EngineDebugger::get_script_debugger()->insert_breakpoint(p_line, p_source);
  1649. }
  1650. void EngineDebugger::remove_breakpoint(int p_line, const StringName &p_source) {
  1651. ERR_FAIL_COND_MSG(!::EngineDebugger::get_script_debugger(), "Can't remove breakpoint. No active debugger");
  1652. ::EngineDebugger::get_script_debugger()->remove_breakpoint(p_line, p_source);
  1653. }
  1654. void EngineDebugger::clear_breakpoints() {
  1655. ERR_FAIL_COND_MSG(!::EngineDebugger::get_script_debugger(), "Can't clear breakpoints. No active debugger");
  1656. ::EngineDebugger::get_script_debugger()->clear_breakpoints();
  1657. }
  1658. EngineDebugger::~EngineDebugger() {
  1659. for (const KeyValue<StringName, Callable> &E : captures) {
  1660. ::EngineDebugger::unregister_message_capture(E.key);
  1661. }
  1662. captures.clear();
  1663. }
  1664. EngineDebugger *EngineDebugger::singleton = nullptr;
  1665. void EngineDebugger::_bind_methods() {
  1666. ClassDB::bind_method(D_METHOD("is_active"), &EngineDebugger::is_active);
  1667. ClassDB::bind_method(D_METHOD("register_profiler", "name", "profiler"), &EngineDebugger::register_profiler);
  1668. ClassDB::bind_method(D_METHOD("unregister_profiler", "name"), &EngineDebugger::unregister_profiler);
  1669. ClassDB::bind_method(D_METHOD("is_profiling", "name"), &EngineDebugger::is_profiling);
  1670. ClassDB::bind_method(D_METHOD("has_profiler", "name"), &EngineDebugger::has_profiler);
  1671. ClassDB::bind_method(D_METHOD("profiler_add_frame_data", "name", "data"), &EngineDebugger::profiler_add_frame_data);
  1672. ClassDB::bind_method(D_METHOD("profiler_enable", "name", "enable", "arguments"), &EngineDebugger::profiler_enable, DEFVAL(Array()));
  1673. ClassDB::bind_method(D_METHOD("register_message_capture", "name", "callable"), &EngineDebugger::register_message_capture);
  1674. ClassDB::bind_method(D_METHOD("unregister_message_capture", "name"), &EngineDebugger::unregister_message_capture);
  1675. ClassDB::bind_method(D_METHOD("has_capture", "name"), &EngineDebugger::has_capture);
  1676. ClassDB::bind_method(D_METHOD("line_poll"), &EngineDebugger::line_poll);
  1677. ClassDB::bind_method(D_METHOD("send_message", "message", "data"), &EngineDebugger::send_message);
  1678. ClassDB::bind_method(D_METHOD("debug", "can_continue", "is_error_breakpoint"), &EngineDebugger::debug, DEFVAL(true), DEFVAL(false));
  1679. ClassDB::bind_method(D_METHOD("script_debug", "language", "can_continue", "is_error_breakpoint"), &EngineDebugger::script_debug, DEFVAL(true), DEFVAL(false));
  1680. ClassDB::bind_method(D_METHOD("set_lines_left", "lines"), &EngineDebugger::set_lines_left);
  1681. ClassDB::bind_method(D_METHOD("get_lines_left"), &EngineDebugger::get_lines_left);
  1682. ClassDB::bind_method(D_METHOD("set_depth", "depth"), &EngineDebugger::set_depth);
  1683. ClassDB::bind_method(D_METHOD("get_depth"), &EngineDebugger::get_depth);
  1684. ClassDB::bind_method(D_METHOD("is_breakpoint", "line", "source"), &EngineDebugger::is_breakpoint);
  1685. ClassDB::bind_method(D_METHOD("is_skipping_breakpoints"), &EngineDebugger::is_skipping_breakpoints);
  1686. ClassDB::bind_method(D_METHOD("insert_breakpoint", "line", "source"), &EngineDebugger::insert_breakpoint);
  1687. ClassDB::bind_method(D_METHOD("remove_breakpoint", "line", "source"), &EngineDebugger::remove_breakpoint);
  1688. ClassDB::bind_method(D_METHOD("clear_breakpoints"), &EngineDebugger::clear_breakpoints);
  1689. }
  1690. } // namespace core_bind