core_bind.cpp 86 KB

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