visual_script.cpp 78 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506
  1. /*************************************************************************/
  2. /* visual_script.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "visual_script.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/core_string_names.h"
  33. #include "core/os/os.h"
  34. #include "scene/main/node.h"
  35. #include "visual_script_nodes.h"
  36. // Used by editor, this is not really saved.
  37. void VisualScriptNode::set_breakpoint(bool p_breakpoint) {
  38. breakpoint = p_breakpoint;
  39. }
  40. bool VisualScriptNode::is_breakpoint() const {
  41. return breakpoint;
  42. }
  43. void VisualScriptNode::ports_changed_notify() {
  44. emit_signal(SNAME("ports_changed"));
  45. }
  46. void VisualScriptNode::set_default_input_value(int p_port, const Variant &p_value) {
  47. ERR_FAIL_INDEX(p_port, default_input_values.size());
  48. default_input_values[p_port] = p_value;
  49. #ifdef TOOLS_ENABLED
  50. if (script_used.is_valid()) {
  51. script_used->set_edited(true);
  52. }
  53. #endif
  54. }
  55. Variant VisualScriptNode::get_default_input_value(int p_port) const {
  56. ERR_FAIL_INDEX_V(p_port, default_input_values.size(), Variant());
  57. return default_input_values[p_port];
  58. }
  59. void VisualScriptNode::_set_default_input_values(Array p_values) {
  60. default_input_values = p_values;
  61. }
  62. void VisualScriptNode::validate_input_default_values() {
  63. default_input_values.resize(MAX(default_input_values.size(), get_input_value_port_count())); //let it grow as big as possible, we don't want to lose values on resize
  64. // Actually validate on save.
  65. for (int i = 0; i < get_input_value_port_count(); i++) {
  66. Variant::Type expected = get_input_value_port_info(i).type;
  67. if (expected == Variant::NIL || expected == default_input_values[i].get_type()) {
  68. continue;
  69. } else {
  70. // Not the same, reconvert.
  71. Callable::CallError ce;
  72. Variant existing = default_input_values[i];
  73. const Variant *existingp = &existing;
  74. Variant::construct(expected, default_input_values[i], &existingp, 1, ce);
  75. if (ce.error != Callable::CallError::CALL_OK) {
  76. //could not convert? force..
  77. Variant::construct(expected, default_input_values[i], nullptr, 0, ce);
  78. }
  79. }
  80. }
  81. }
  82. Array VisualScriptNode::_get_default_input_values() const {
  83. // Validate on save, since on load there is little info about this.
  84. Array values = default_input_values;
  85. values.resize(get_input_value_port_count());
  86. return values;
  87. }
  88. String VisualScriptNode::get_text() const {
  89. return "";
  90. }
  91. void VisualScriptNode::_bind_methods() {
  92. ClassDB::bind_method(D_METHOD("get_visual_script"), &VisualScriptNode::get_visual_script);
  93. ClassDB::bind_method(D_METHOD("set_default_input_value", "port_idx", "value"), &VisualScriptNode::set_default_input_value);
  94. ClassDB::bind_method(D_METHOD("get_default_input_value", "port_idx"), &VisualScriptNode::get_default_input_value);
  95. ClassDB::bind_method(D_METHOD("ports_changed_notify"), &VisualScriptNode::ports_changed_notify);
  96. ClassDB::bind_method(D_METHOD("_set_default_input_values", "values"), &VisualScriptNode::_set_default_input_values);
  97. ClassDB::bind_method(D_METHOD("_get_default_input_values"), &VisualScriptNode::_get_default_input_values);
  98. ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "_default_input_values", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL), "_set_default_input_values", "_get_default_input_values");
  99. ADD_SIGNAL(MethodInfo("ports_changed"));
  100. }
  101. VisualScriptNode::TypeGuess VisualScriptNode::guess_output_type(TypeGuess *p_inputs, int p_output) const {
  102. ERR_FAIL_COND_V(get_output_value_port_count() <= p_output, TypeGuess());
  103. PropertyInfo pinfo = get_output_value_port_info(p_output);
  104. TypeGuess tg;
  105. tg.type = pinfo.type;
  106. if (pinfo.hint == PROPERTY_HINT_RESOURCE_TYPE) {
  107. tg.gdclass = pinfo.hint_string;
  108. }
  109. return tg;
  110. }
  111. Ref<VisualScript> VisualScriptNode::get_visual_script() const {
  112. return script_used;
  113. }
  114. VisualScriptNode::VisualScriptNode() {
  115. }
  116. ////////////////
  117. /////////////////////
  118. VisualScriptNodeInstance::VisualScriptNodeInstance() {
  119. }
  120. VisualScriptNodeInstance::~VisualScriptNodeInstance() {
  121. if (sequence_outputs) {
  122. memdelete_arr(sequence_outputs);
  123. }
  124. if (input_ports) {
  125. memdelete_arr(input_ports);
  126. }
  127. if (output_ports) {
  128. memdelete_arr(output_ports);
  129. }
  130. }
  131. void VisualScript::add_function(const StringName &p_name, int p_func_node_id) {
  132. ERR_FAIL_COND(instances.size());
  133. ERR_FAIL_COND(!String(p_name).is_valid_identifier());
  134. ERR_FAIL_COND(functions.has(p_name));
  135. ERR_FAIL_COND(variables.has(p_name));
  136. ERR_FAIL_COND(custom_signals.has(p_name));
  137. functions[p_name] = Function();
  138. functions[p_name].func_id = p_func_node_id;
  139. }
  140. bool VisualScript::has_function(const StringName &p_name) const {
  141. return functions.has(p_name);
  142. }
  143. void VisualScript::remove_function(const StringName &p_name) {
  144. ERR_FAIL_COND(instances.size());
  145. ERR_FAIL_COND(!functions.has(p_name));
  146. // Let the editor handle the node removal.
  147. functions.erase(p_name);
  148. }
  149. void VisualScript::rename_function(const StringName &p_name, const StringName &p_new_name) {
  150. ERR_FAIL_COND(instances.size());
  151. ERR_FAIL_COND(!functions.has(p_name));
  152. if (p_new_name == p_name) {
  153. return;
  154. }
  155. ERR_FAIL_COND(!String(p_new_name).is_valid_identifier());
  156. ERR_FAIL_COND(functions.has(p_new_name));
  157. ERR_FAIL_COND(variables.has(p_new_name));
  158. ERR_FAIL_COND(custom_signals.has(p_new_name));
  159. functions[p_new_name] = functions[p_name];
  160. functions.erase(p_name);
  161. }
  162. void VisualScript::set_scroll(const Vector2 &p_scroll) {
  163. scroll = p_scroll;
  164. }
  165. Vector2 VisualScript::get_scroll() const {
  166. return scroll;
  167. }
  168. void VisualScript::get_function_list(List<StringName> *r_functions) const {
  169. for (const KeyValue<StringName, Function> &E : functions) {
  170. r_functions->push_back(E.key);
  171. }
  172. }
  173. int VisualScript::get_function_node_id(const StringName &p_name) const {
  174. ERR_FAIL_COND_V(!functions.has(p_name), -1);
  175. return functions[p_name].func_id;
  176. }
  177. void VisualScript::_node_ports_changed(int p_id) {
  178. Ref<VisualScriptNode> vsn = nodes[p_id].node;
  179. vsn->validate_input_default_values();
  180. // Must revalidate all the functions.
  181. {
  182. List<SequenceConnection> to_remove;
  183. for (const SequenceConnection &E : sequence_connections) {
  184. if (E.from_node == p_id && E.from_output >= vsn->get_output_sequence_port_count()) {
  185. to_remove.push_back(E);
  186. }
  187. if (E.to_node == p_id && !vsn->has_input_sequence_port()) {
  188. to_remove.push_back(E);
  189. }
  190. }
  191. while (to_remove.size()) {
  192. sequence_connections.erase(to_remove.front()->get());
  193. to_remove.pop_front();
  194. }
  195. }
  196. {
  197. List<DataConnection> to_remove;
  198. for (const DataConnection &E : data_connections) {
  199. if (E.from_node == p_id && E.from_port >= vsn->get_output_value_port_count()) {
  200. to_remove.push_back(E);
  201. }
  202. if (E.to_node == p_id && E.to_port >= vsn->get_input_value_port_count()) {
  203. to_remove.push_back(E);
  204. }
  205. }
  206. while (to_remove.size()) {
  207. data_connections.erase(to_remove.front()->get());
  208. to_remove.pop_front();
  209. }
  210. }
  211. #ifdef TOOLS_ENABLED
  212. set_edited(true); // Something changed, let's set as edited.
  213. emit_signal(SNAME("node_ports_changed"), p_id);
  214. #endif
  215. }
  216. void VisualScript::add_node(int p_id, const Ref<VisualScriptNode> &p_node, const Point2 &p_pos) {
  217. ERR_FAIL_COND(instances.size());
  218. ERR_FAIL_COND(nodes.has(p_id)); // ID can exist only one in script.
  219. ERR_FAIL_COND(p_node.is_null());
  220. NodeData nd;
  221. nd.node = p_node;
  222. nd.pos = p_pos;
  223. Ref<VisualScriptNode> vsn = p_node;
  224. vsn->connect("ports_changed", callable_mp(this, &VisualScript::_node_ports_changed).bind(p_id));
  225. vsn->script_used = Ref<VisualScript>(this);
  226. vsn->validate_input_default_values(); // Validate when fully loaded.
  227. nodes[p_id] = nd;
  228. }
  229. void VisualScript::remove_node(int p_id) {
  230. ERR_FAIL_COND(instances.size());
  231. ERR_FAIL_COND(!nodes.has(p_id));
  232. {
  233. List<SequenceConnection> to_remove;
  234. for (const SequenceConnection &E : sequence_connections) {
  235. if (E.from_node == p_id || E.to_node == p_id) {
  236. to_remove.push_back(E);
  237. }
  238. }
  239. while (to_remove.size()) {
  240. sequence_connections.erase(to_remove.front()->get());
  241. to_remove.pop_front();
  242. }
  243. }
  244. {
  245. List<DataConnection> to_remove;
  246. for (const DataConnection &E : data_connections) {
  247. if (E.from_node == p_id || E.to_node == p_id) {
  248. to_remove.push_back(E);
  249. }
  250. }
  251. while (to_remove.size()) {
  252. data_connections.erase(to_remove.front()->get());
  253. to_remove.pop_front();
  254. }
  255. }
  256. nodes[p_id].node->disconnect("ports_changed", callable_mp(this, &VisualScript::_node_ports_changed));
  257. nodes[p_id].node->script_used.unref();
  258. nodes.erase(p_id);
  259. }
  260. bool VisualScript::has_node(int p_id) const {
  261. return nodes.has(p_id);
  262. }
  263. Ref<VisualScriptNode> VisualScript::get_node(int p_id) const {
  264. ERR_FAIL_COND_V(!nodes.has(p_id), Ref<VisualScriptNode>());
  265. return nodes[p_id].node;
  266. }
  267. void VisualScript::set_node_position(int p_id, const Point2 &p_pos) {
  268. ERR_FAIL_COND(instances.size());
  269. ERR_FAIL_COND(!nodes.has(p_id));
  270. nodes[p_id].pos = p_pos;
  271. }
  272. Point2 VisualScript::get_node_position(int p_id) const {
  273. ERR_FAIL_COND_V(!nodes.has(p_id), Point2());
  274. return nodes[p_id].pos;
  275. }
  276. void VisualScript::get_node_list(List<int> *r_nodes) const {
  277. for (const KeyValue<int, NodeData> &E : nodes) {
  278. r_nodes->push_back(E.key);
  279. }
  280. }
  281. void VisualScript::sequence_connect(int p_from_node, int p_from_output, int p_to_node) {
  282. ERR_FAIL_COND(instances.size());
  283. SequenceConnection sc;
  284. sc.from_node = p_from_node;
  285. sc.from_output = p_from_output;
  286. sc.to_node = p_to_node;
  287. ERR_FAIL_COND(sequence_connections.has(sc));
  288. sequence_connections.insert(sc);
  289. }
  290. void VisualScript::sequence_disconnect(int p_from_node, int p_from_output, int p_to_node) {
  291. SequenceConnection sc;
  292. sc.from_node = p_from_node;
  293. sc.from_output = p_from_output;
  294. sc.to_node = p_to_node;
  295. ERR_FAIL_COND(!sequence_connections.has(sc));
  296. sequence_connections.erase(sc);
  297. }
  298. bool VisualScript::has_sequence_connection(int p_from_node, int p_from_output, int p_to_node) const {
  299. SequenceConnection sc;
  300. sc.from_node = p_from_node;
  301. sc.from_output = p_from_output;
  302. sc.to_node = p_to_node;
  303. return sequence_connections.has(sc);
  304. }
  305. void VisualScript::get_sequence_connection_list(List<SequenceConnection> *r_connection) const {
  306. for (const SequenceConnection &E : sequence_connections) {
  307. r_connection->push_back(E);
  308. }
  309. }
  310. void VisualScript::data_connect(int p_from_node, int p_from_port, int p_to_node, int p_to_port) {
  311. ERR_FAIL_COND(instances.size());
  312. DataConnection dc;
  313. dc.from_node = p_from_node;
  314. dc.from_port = p_from_port;
  315. dc.to_node = p_to_node;
  316. dc.to_port = p_to_port;
  317. ERR_FAIL_COND(data_connections.has(dc));
  318. data_connections.insert(dc);
  319. }
  320. void VisualScript::data_disconnect(int p_from_node, int p_from_port, int p_to_node, int p_to_port) {
  321. DataConnection dc;
  322. dc.from_node = p_from_node;
  323. dc.from_port = p_from_port;
  324. dc.to_node = p_to_node;
  325. dc.to_port = p_to_port;
  326. ERR_FAIL_COND(!data_connections.has(dc));
  327. data_connections.erase(dc);
  328. }
  329. bool VisualScript::has_data_connection(int p_from_node, int p_from_port, int p_to_node, int p_to_port) const {
  330. DataConnection dc;
  331. dc.from_node = p_from_node;
  332. dc.from_port = p_from_port;
  333. dc.to_node = p_to_node;
  334. dc.to_port = p_to_port;
  335. return data_connections.has(dc);
  336. }
  337. bool VisualScript::is_input_value_port_connected(int p_node, int p_port) const {
  338. for (const DataConnection &E : data_connections) {
  339. if (E.to_node == p_node && E.to_port == p_port) {
  340. return true;
  341. }
  342. }
  343. return false;
  344. }
  345. bool VisualScript::get_input_value_port_connection_source(int p_node, int p_port, int *r_node, int *r_port) const {
  346. for (const DataConnection &E : data_connections) {
  347. if (E.to_node == p_node && E.to_port == p_port) {
  348. *r_node = E.from_node;
  349. *r_port = E.from_port;
  350. return true;
  351. }
  352. }
  353. return false;
  354. }
  355. void VisualScript::get_data_connection_list(List<DataConnection> *r_connection) const {
  356. for (const DataConnection &E : data_connections) {
  357. r_connection->push_back(E);
  358. }
  359. }
  360. void VisualScript::set_tool_enabled(bool p_enabled) {
  361. is_tool_script = p_enabled;
  362. }
  363. void VisualScript::add_variable(const StringName &p_name, const Variant &p_default_value, bool p_export) {
  364. ERR_FAIL_COND(instances.size());
  365. ERR_FAIL_COND(!String(p_name).is_valid_identifier());
  366. ERR_FAIL_COND(variables.has(p_name));
  367. Variable v;
  368. v.default_value = p_default_value;
  369. v.info.type = p_default_value.get_type();
  370. v.info.name = p_name;
  371. v.info.hint = PROPERTY_HINT_NONE;
  372. v._export = p_export;
  373. variables[p_name] = v;
  374. #ifdef TOOLS_ENABLED
  375. _update_placeholders();
  376. #endif
  377. }
  378. bool VisualScript::has_variable(const StringName &p_name) const {
  379. return variables.has(p_name);
  380. }
  381. void VisualScript::remove_variable(const StringName &p_name) {
  382. ERR_FAIL_COND(!variables.has(p_name));
  383. variables.erase(p_name);
  384. #ifdef TOOLS_ENABLED
  385. _update_placeholders();
  386. #endif
  387. }
  388. void VisualScript::set_variable_default_value(const StringName &p_name, const Variant &p_value) {
  389. ERR_FAIL_COND(!variables.has(p_name));
  390. variables[p_name].default_value = p_value;
  391. #ifdef TOOLS_ENABLED
  392. _update_placeholders();
  393. #endif
  394. }
  395. Variant VisualScript::get_variable_default_value(const StringName &p_name) const {
  396. ERR_FAIL_COND_V(!variables.has(p_name), Variant());
  397. return variables[p_name].default_value;
  398. }
  399. void VisualScript::set_variable_info(const StringName &p_name, const PropertyInfo &p_info) {
  400. ERR_FAIL_COND(instances.size());
  401. ERR_FAIL_COND(!variables.has(p_name));
  402. variables[p_name].info = p_info;
  403. variables[p_name].info.name = p_name;
  404. #ifdef TOOLS_ENABLED
  405. _update_placeholders();
  406. #endif
  407. }
  408. PropertyInfo VisualScript::get_variable_info(const StringName &p_name) const {
  409. ERR_FAIL_COND_V(!variables.has(p_name), PropertyInfo());
  410. return variables[p_name].info;
  411. }
  412. void VisualScript::set_variable_export(const StringName &p_name, bool p_export) {
  413. ERR_FAIL_COND(!variables.has(p_name));
  414. variables[p_name]._export = p_export;
  415. #ifdef TOOLS_ENABLED
  416. _update_placeholders();
  417. #endif
  418. }
  419. bool VisualScript::get_variable_export(const StringName &p_name) const {
  420. ERR_FAIL_COND_V(!variables.has(p_name), false);
  421. return variables[p_name]._export;
  422. }
  423. void VisualScript::_set_variable_info(const StringName &p_name, const Dictionary &p_info) {
  424. PropertyInfo pinfo;
  425. if (p_info.has("type")) {
  426. pinfo.type = Variant::Type(int(p_info["type"]));
  427. }
  428. if (p_info.has("name")) {
  429. pinfo.name = p_info["name"];
  430. }
  431. if (p_info.has("hint")) {
  432. pinfo.hint = PropertyHint(int(p_info["hint"]));
  433. }
  434. if (p_info.has("hint_string")) {
  435. pinfo.hint_string = p_info["hint_string"];
  436. }
  437. if (p_info.has("usage")) {
  438. pinfo.usage = p_info["usage"];
  439. }
  440. set_variable_info(p_name, pinfo);
  441. }
  442. Dictionary VisualScript::_get_variable_info(const StringName &p_name) const {
  443. PropertyInfo pinfo = get_variable_info(p_name);
  444. Dictionary d;
  445. d["type"] = pinfo.type;
  446. d["name"] = pinfo.name;
  447. d["hint"] = pinfo.hint;
  448. d["hint_string"] = pinfo.hint_string;
  449. d["usage"] = pinfo.usage;
  450. return d;
  451. }
  452. void VisualScript::get_variable_list(List<StringName> *r_variables) const {
  453. for (const KeyValue<StringName, Variable> &E : variables) {
  454. r_variables->push_back(E.key);
  455. }
  456. }
  457. void VisualScript::set_instance_base_type(const StringName &p_type) {
  458. ERR_FAIL_COND(instances.size());
  459. base_type = p_type;
  460. }
  461. void VisualScript::rename_variable(const StringName &p_name, const StringName &p_new_name) {
  462. ERR_FAIL_COND(instances.size());
  463. ERR_FAIL_COND(!variables.has(p_name));
  464. if (p_new_name == p_name) {
  465. return;
  466. }
  467. ERR_FAIL_COND(!String(p_new_name).is_valid_identifier());
  468. ERR_FAIL_COND(functions.has(p_new_name));
  469. ERR_FAIL_COND(variables.has(p_new_name));
  470. ERR_FAIL_COND(custom_signals.has(p_new_name));
  471. variables[p_new_name] = variables[p_name];
  472. variables.erase(p_name);
  473. List<int> ids;
  474. get_node_list(&ids);
  475. for (int &E : ids) {
  476. Ref<VisualScriptVariableGet> nodeget = get_node(E);
  477. if (nodeget.is_valid()) {
  478. if (nodeget->get_variable() == p_name) {
  479. nodeget->set_variable(p_new_name);
  480. }
  481. } else {
  482. Ref<VisualScriptVariableSet> nodeset = get_node(E);
  483. if (nodeset.is_valid()) {
  484. if (nodeset->get_variable() == p_name) {
  485. nodeset->set_variable(p_new_name);
  486. }
  487. }
  488. }
  489. }
  490. }
  491. void VisualScript::add_custom_signal(const StringName &p_name) {
  492. ERR_FAIL_COND(instances.size());
  493. ERR_FAIL_COND(!String(p_name).is_valid_identifier());
  494. ERR_FAIL_COND(custom_signals.has(p_name));
  495. custom_signals[p_name] = Vector<Argument>();
  496. }
  497. bool VisualScript::has_custom_signal(const StringName &p_name) const {
  498. return custom_signals.has(p_name);
  499. }
  500. void VisualScript::custom_signal_add_argument(const StringName &p_func, Variant::Type p_type, const String &p_name, int p_index) {
  501. ERR_FAIL_COND(instances.size());
  502. ERR_FAIL_COND(!custom_signals.has(p_func));
  503. Argument arg;
  504. arg.type = p_type;
  505. arg.name = p_name;
  506. if (p_index < 0) {
  507. custom_signals[p_func].push_back(arg);
  508. } else {
  509. custom_signals[p_func].insert(0, arg);
  510. }
  511. }
  512. void VisualScript::custom_signal_set_argument_type(const StringName &p_func, int p_argidx, Variant::Type p_type) {
  513. ERR_FAIL_COND(instances.size());
  514. ERR_FAIL_COND(!custom_signals.has(p_func));
  515. ERR_FAIL_INDEX(p_argidx, custom_signals[p_func].size());
  516. custom_signals[p_func].write[p_argidx].type = p_type;
  517. }
  518. Variant::Type VisualScript::custom_signal_get_argument_type(const StringName &p_func, int p_argidx) const {
  519. ERR_FAIL_COND_V(!custom_signals.has(p_func), Variant::NIL);
  520. ERR_FAIL_INDEX_V(p_argidx, custom_signals[p_func].size(), Variant::NIL);
  521. return custom_signals[p_func][p_argidx].type;
  522. }
  523. void VisualScript::custom_signal_set_argument_name(const StringName &p_func, int p_argidx, const String &p_name) {
  524. ERR_FAIL_COND(instances.size());
  525. ERR_FAIL_COND(!custom_signals.has(p_func));
  526. ERR_FAIL_INDEX(p_argidx, custom_signals[p_func].size());
  527. custom_signals[p_func].write[p_argidx].name = p_name;
  528. }
  529. String VisualScript::custom_signal_get_argument_name(const StringName &p_func, int p_argidx) const {
  530. ERR_FAIL_COND_V(!custom_signals.has(p_func), String());
  531. ERR_FAIL_INDEX_V(p_argidx, custom_signals[p_func].size(), String());
  532. return custom_signals[p_func][p_argidx].name;
  533. }
  534. void VisualScript::custom_signal_remove_argument(const StringName &p_func, int p_argidx) {
  535. ERR_FAIL_COND(instances.size());
  536. ERR_FAIL_COND(!custom_signals.has(p_func));
  537. ERR_FAIL_INDEX(p_argidx, custom_signals[p_func].size());
  538. custom_signals[p_func].remove_at(p_argidx);
  539. }
  540. int VisualScript::custom_signal_get_argument_count(const StringName &p_func) const {
  541. ERR_FAIL_COND_V(!custom_signals.has(p_func), 0);
  542. return custom_signals[p_func].size();
  543. }
  544. void VisualScript::custom_signal_swap_argument(const StringName &p_func, int p_argidx, int p_with_argidx) {
  545. ERR_FAIL_COND(instances.size());
  546. ERR_FAIL_COND(!custom_signals.has(p_func));
  547. ERR_FAIL_INDEX(p_argidx, custom_signals[p_func].size());
  548. ERR_FAIL_INDEX(p_with_argidx, custom_signals[p_func].size());
  549. SWAP(custom_signals[p_func].write[p_argidx], custom_signals[p_func].write[p_with_argidx]);
  550. }
  551. void VisualScript::remove_custom_signal(const StringName &p_name) {
  552. ERR_FAIL_COND(instances.size());
  553. ERR_FAIL_COND(!custom_signals.has(p_name));
  554. custom_signals.erase(p_name);
  555. }
  556. void VisualScript::rename_custom_signal(const StringName &p_name, const StringName &p_new_name) {
  557. ERR_FAIL_COND(instances.size());
  558. ERR_FAIL_COND(!custom_signals.has(p_name));
  559. if (p_new_name == p_name) {
  560. return;
  561. }
  562. ERR_FAIL_COND(!String(p_new_name).is_valid_identifier());
  563. ERR_FAIL_COND(functions.has(p_new_name));
  564. ERR_FAIL_COND(variables.has(p_new_name));
  565. ERR_FAIL_COND(custom_signals.has(p_new_name));
  566. custom_signals[p_new_name] = custom_signals[p_name];
  567. custom_signals.erase(p_name);
  568. }
  569. void VisualScript::get_custom_signal_list(List<StringName> *r_custom_signals) const {
  570. for (const KeyValue<StringName, Vector<Argument>> &E : custom_signals) {
  571. r_custom_signals->push_back(E.key);
  572. }
  573. r_custom_signals->sort_custom<StringName::AlphCompare>();
  574. }
  575. int VisualScript::get_available_id() const {
  576. // This is infinitely increasing,
  577. // so one might want to implement a better solution,
  578. // if the there is a case for huge number of nodes to be added to visual script.
  579. int max = -1;
  580. for (const KeyValue<int, NodeData> &E : nodes) {
  581. if (E.key > max) {
  582. max = E.key;
  583. }
  584. }
  585. return (max + 1);
  586. }
  587. /////////////////////////////////
  588. bool VisualScript::can_instantiate() const {
  589. return true; // ScriptServer::is_scripting_enabled();
  590. }
  591. StringName VisualScript::get_instance_base_type() const {
  592. return base_type;
  593. }
  594. Ref<Script> VisualScript::get_base_script() const {
  595. return Ref<Script>(); // No inheritance in visual script.
  596. }
  597. #ifdef TOOLS_ENABLED
  598. void VisualScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
  599. placeholders.erase(p_placeholder);
  600. }
  601. void VisualScript::_update_placeholders() {
  602. if (placeholders.size() == 0) {
  603. return; // No bother if no placeholders.
  604. }
  605. List<PropertyInfo> pinfo;
  606. HashMap<StringName, Variant> values;
  607. for (const KeyValue<StringName, Variable> &E : variables) {
  608. if (!variables[E.key]._export) {
  609. continue;
  610. }
  611. PropertyInfo p = variables[E.key].info;
  612. p.name = String(E.key);
  613. pinfo.push_back(p);
  614. values[p.name] = variables[E.key].default_value;
  615. }
  616. for (PlaceHolderScriptInstance *E : placeholders) {
  617. E->update(pinfo, values);
  618. }
  619. }
  620. #endif
  621. ScriptInstance *VisualScript::instance_create(Object *p_this) {
  622. #ifdef TOOLS_ENABLED
  623. if (!ScriptServer::is_scripting_enabled() && !is_tool_script) {
  624. PlaceHolderScriptInstance *sins = memnew(PlaceHolderScriptInstance(VisualScriptLanguage::singleton, Ref<Script>((Script *)this), p_this));
  625. placeholders.insert(sins);
  626. List<PropertyInfo> pinfo;
  627. HashMap<StringName, Variant> values;
  628. for (const KeyValue<StringName, Variable> &E : variables) {
  629. if (!variables[E.key]._export) {
  630. continue;
  631. }
  632. PropertyInfo p = variables[E.key].info;
  633. p.name = String(E.key);
  634. pinfo.push_back(p);
  635. values[p.name] = variables[E.key].default_value;
  636. }
  637. sins->update(pinfo, values);
  638. return sins;
  639. }
  640. #endif
  641. VisualScriptInstance *instance = memnew(VisualScriptInstance);
  642. instance->create(Ref<VisualScript>(this), p_this);
  643. {
  644. MutexLock lock(VisualScriptLanguage::singleton->lock);
  645. instances[p_this] = instance;
  646. }
  647. return instance;
  648. }
  649. bool VisualScript::instance_has(const Object *p_this) const {
  650. return instances.has((Object *)p_this);
  651. }
  652. bool VisualScript::has_source_code() const {
  653. return false;
  654. }
  655. String VisualScript::get_source_code() const {
  656. return String();
  657. }
  658. void VisualScript::set_source_code(const String &p_code) {
  659. }
  660. Error VisualScript::reload(bool p_keep_state) {
  661. return OK;
  662. }
  663. bool VisualScript::is_tool() const {
  664. return is_tool_script;
  665. }
  666. bool VisualScript::is_valid() const {
  667. return true; // Always valid.
  668. }
  669. ScriptLanguage *VisualScript::get_language() const {
  670. return VisualScriptLanguage::singleton;
  671. }
  672. bool VisualScript::has_script_signal(const StringName &p_signal) const {
  673. return custom_signals.has(p_signal);
  674. }
  675. void VisualScript::get_script_signal_list(List<MethodInfo> *r_signals) const {
  676. for (const KeyValue<StringName, Vector<Argument>> &E : custom_signals) {
  677. MethodInfo mi;
  678. mi.name = E.key;
  679. for (int i = 0; i < E.value.size(); i++) {
  680. PropertyInfo arg;
  681. arg.type = E.value[i].type;
  682. arg.name = E.value[i].name;
  683. mi.arguments.push_back(arg);
  684. }
  685. r_signals->push_back(mi);
  686. }
  687. }
  688. bool VisualScript::get_property_default_value(const StringName &p_property, Variant &r_value) const {
  689. if (!variables.has(p_property)) {
  690. return false;
  691. }
  692. r_value = variables[p_property].default_value;
  693. return true;
  694. }
  695. void VisualScript::get_script_method_list(List<MethodInfo> *p_list) const {
  696. for (const KeyValue<StringName, Function> &E : functions) {
  697. MethodInfo mi;
  698. mi.name = E.key;
  699. if (functions[E.key].func_id >= 0) {
  700. Ref<VisualScriptFunction> func = nodes[functions[E.key].func_id].node;
  701. if (func.is_valid()) {
  702. for (int i = 0; i < func->get_argument_count(); i++) {
  703. PropertyInfo arg;
  704. arg.name = func->get_argument_name(i);
  705. arg.type = func->get_argument_type(i);
  706. mi.arguments.push_back(arg);
  707. }
  708. p_list->push_back(mi);
  709. }
  710. }
  711. }
  712. }
  713. bool VisualScript::has_method(const StringName &p_method) const {
  714. return functions.has(p_method);
  715. }
  716. MethodInfo VisualScript::get_method_info(const StringName &p_method) const {
  717. const Function funct = functions[p_method];
  718. if (funct.func_id == -1) {
  719. return MethodInfo();
  720. }
  721. MethodInfo mi;
  722. mi.name = p_method;
  723. if (funct.func_id >= 0) {
  724. Ref<VisualScriptFunction> func = nodes[funct.func_id].node;
  725. if (func.is_valid()) {
  726. for (int i = 0; i < func->get_argument_count(); i++) {
  727. PropertyInfo arg;
  728. arg.name = func->get_argument_name(i);
  729. arg.type = func->get_argument_type(i);
  730. mi.arguments.push_back(arg);
  731. }
  732. if (!func->is_sequenced()) {
  733. mi.flags |= METHOD_FLAG_CONST;
  734. }
  735. }
  736. }
  737. return mi;
  738. }
  739. void VisualScript::get_script_property_list(List<PropertyInfo> *p_list) const {
  740. List<StringName> vars;
  741. get_variable_list(&vars);
  742. for (const StringName &E : vars) {
  743. if (!variables[E]._export) {
  744. continue;
  745. }
  746. PropertyInfo pi = variables[E].info;
  747. pi.usage |= PROPERTY_USAGE_SCRIPT_VARIABLE;
  748. p_list->push_back(pi);
  749. }
  750. }
  751. int VisualScript::get_member_line(const StringName &p_member) const {
  752. return functions[p_member].func_id; // will be -1 if not found
  753. }
  754. #ifdef TOOLS_ENABLED
  755. bool VisualScript::are_subnodes_edited() const {
  756. for (const KeyValue<int, NodeData> &F : nodes) {
  757. if (F.value.node->is_edited()) {
  758. return true;
  759. }
  760. }
  761. return false;
  762. }
  763. #endif
  764. const Variant VisualScript::get_rpc_config() const {
  765. return rpc_functions;
  766. }
  767. void VisualScript::_set_data(const Dictionary &p_data) {
  768. Dictionary d = p_data;
  769. if (d.has("base_type")) {
  770. base_type = d["base_type"];
  771. }
  772. variables.clear();
  773. Array vars = d["variables"];
  774. for (int i = 0; i < vars.size(); i++) {
  775. Dictionary v = vars[i];
  776. StringName name = v["name"];
  777. add_variable(name);
  778. _set_variable_info(name, v);
  779. set_variable_default_value(name, v["default_value"]);
  780. set_variable_export(name, v.has("export") && bool(v["export"]));
  781. }
  782. custom_signals.clear();
  783. Array sigs = d["signals"];
  784. for (int i = 0; i < sigs.size(); i++) {
  785. Dictionary cs = sigs[i];
  786. add_custom_signal(cs["name"]);
  787. Array args = cs["arguments"];
  788. for (int j = 0; j < args.size(); j += 2) {
  789. custom_signal_add_argument(cs["name"], Variant::Type(int(args[j + 1])), args[j]);
  790. }
  791. }
  792. Array funcs = d["functions"];
  793. functions.clear();
  794. for (int i = 0; i < funcs.size(); i++) {
  795. Dictionary func = funcs[i];
  796. add_function(func["name"], func["function_id"]);
  797. }
  798. {
  799. Array nodes = d["nodes"];
  800. for (int i = 0; i < nodes.size(); i += 3) {
  801. add_node(nodes[i], nodes[i + 2], nodes[i + 1]);
  802. }
  803. Array sequence_connections = d["sequence_connections"];
  804. for (int j = 0; j < sequence_connections.size(); j += 3) {
  805. sequence_connect(sequence_connections[j + 0], sequence_connections[j + 1], sequence_connections[j + 2]);
  806. }
  807. Array data_connections = d["data_connections"];
  808. for (int j = 0; j < data_connections.size(); j += 4) {
  809. data_connect(data_connections[j + 0], data_connections[j + 1], data_connections[j + 2], data_connections[j + 3]);
  810. }
  811. }
  812. is_tool_script = d["is_tool_script"];
  813. scroll = d["scroll"];
  814. // Takes all the rpc methods.
  815. rpc_functions.clear();
  816. for (const KeyValue<StringName, Function> &E : functions) {
  817. if (E.value.func_id >= 0 && nodes.has(E.value.func_id)) {
  818. Ref<VisualScriptFunction> vsf = nodes[E.value.func_id].node;
  819. if (!vsf.is_valid() || vsf->get_rpc_mode() == MultiplayerAPI::RPC_MODE_DISABLED) {
  820. continue;
  821. }
  822. Dictionary nd;
  823. nd["rpc_mode"] = vsf->get_rpc_mode();
  824. nd["transfer_mode"] = MultiplayerPeer::TRANSFER_MODE_RELIABLE; // TODO
  825. nd["call_local"] = false; // TODO
  826. rpc_functions[E.key] = nd;
  827. }
  828. }
  829. }
  830. Dictionary VisualScript::_get_data() const {
  831. Dictionary d;
  832. d["base_type"] = base_type;
  833. Array vars;
  834. for (const KeyValue<StringName, Variable> &E : variables) {
  835. Dictionary var = _get_variable_info(E.key);
  836. var["name"] = E.key; // Make sure it's the right one.
  837. var["default_value"] = E.value.default_value;
  838. var["export"] = E.value._export;
  839. vars.push_back(var);
  840. }
  841. d["variables"] = vars;
  842. Array sigs;
  843. for (const KeyValue<StringName, Vector<Argument>> &E : custom_signals) {
  844. Dictionary cs;
  845. cs["name"] = E.key;
  846. Array args;
  847. for (int i = 0; i < E.value.size(); i++) {
  848. args.push_back(E.value[i].name);
  849. args.push_back(E.value[i].type);
  850. }
  851. cs["arguments"] = args;
  852. sigs.push_back(cs);
  853. }
  854. d["signals"] = sigs;
  855. Array funcs;
  856. for (const KeyValue<StringName, Function> &E : functions) {
  857. Dictionary func;
  858. func["name"] = E.key;
  859. func["function_id"] = E.value.func_id;
  860. funcs.push_back(func);
  861. }
  862. d["functions"] = funcs;
  863. Array nds;
  864. for (const KeyValue<int, NodeData> &F : nodes) {
  865. nds.push_back(F.key);
  866. nds.push_back(F.value.pos);
  867. nds.push_back(F.value.node);
  868. }
  869. d["nodes"] = nds;
  870. Array seqconns;
  871. for (const SequenceConnection &F : sequence_connections) {
  872. seqconns.push_back(F.from_node);
  873. seqconns.push_back(F.from_output);
  874. seqconns.push_back(F.to_node);
  875. }
  876. d["sequence_connections"] = seqconns;
  877. Array dataconns;
  878. for (const DataConnection &F : data_connections) {
  879. dataconns.push_back(F.from_node);
  880. dataconns.push_back(F.from_port);
  881. dataconns.push_back(F.to_node);
  882. dataconns.push_back(F.to_port);
  883. }
  884. d["data_connections"] = dataconns;
  885. d["is_tool_script"] = is_tool_script;
  886. d["scroll"] = scroll;
  887. return d;
  888. }
  889. void VisualScript::_bind_methods() {
  890. ClassDB::bind_method(D_METHOD("add_function", "name", "func_node_id"), &VisualScript::add_function);
  891. ClassDB::bind_method(D_METHOD("has_function", "name"), &VisualScript::has_function);
  892. ClassDB::bind_method(D_METHOD("remove_function", "name"), &VisualScript::remove_function);
  893. ClassDB::bind_method(D_METHOD("rename_function", "name", "new_name"), &VisualScript::rename_function);
  894. ClassDB::bind_method(D_METHOD("set_scroll", "offset"), &VisualScript::set_scroll);
  895. ClassDB::bind_method(D_METHOD("get_scroll"), &VisualScript::get_scroll);
  896. ClassDB::bind_method(D_METHOD("add_node", "id", "node", "position"), &VisualScript::add_node, DEFVAL(Point2()));
  897. ClassDB::bind_method(D_METHOD("remove_node", "id"), &VisualScript::remove_node);
  898. ClassDB::bind_method(D_METHOD("get_function_node_id", "name"), &VisualScript::get_function_node_id);
  899. ClassDB::bind_method(D_METHOD("get_node", "id"), &VisualScript::get_node);
  900. ClassDB::bind_method(D_METHOD("has_node", "id"), &VisualScript::has_node);
  901. ClassDB::bind_method(D_METHOD("set_node_position", "id", "position"), &VisualScript::set_node_position);
  902. ClassDB::bind_method(D_METHOD("get_node_position", "id"), &VisualScript::get_node_position);
  903. ClassDB::bind_method(D_METHOD("sequence_connect", "from_node", "from_output", "to_node"), &VisualScript::sequence_connect);
  904. ClassDB::bind_method(D_METHOD("sequence_disconnect", "from_node", "from_output", "to_node"), &VisualScript::sequence_disconnect);
  905. ClassDB::bind_method(D_METHOD("has_sequence_connection", "from_node", "from_output", "to_node"), &VisualScript::has_sequence_connection);
  906. ClassDB::bind_method(D_METHOD("data_connect", "from_node", "from_port", "to_node", "to_port"), &VisualScript::data_connect);
  907. ClassDB::bind_method(D_METHOD("data_disconnect", "from_node", "from_port", "to_node", "to_port"), &VisualScript::data_disconnect);
  908. ClassDB::bind_method(D_METHOD("has_data_connection", "from_node", "from_port", "to_node", "to_port"), &VisualScript::has_data_connection);
  909. ClassDB::bind_method(D_METHOD("add_variable", "name", "default_value", "export"), &VisualScript::add_variable, DEFVAL(Variant()), DEFVAL(false));
  910. ClassDB::bind_method(D_METHOD("has_variable", "name"), &VisualScript::has_variable);
  911. ClassDB::bind_method(D_METHOD("remove_variable", "name"), &VisualScript::remove_variable);
  912. ClassDB::bind_method(D_METHOD("set_variable_default_value", "name", "value"), &VisualScript::set_variable_default_value);
  913. ClassDB::bind_method(D_METHOD("get_variable_default_value", "name"), &VisualScript::get_variable_default_value);
  914. ClassDB::bind_method(D_METHOD("set_variable_info", "name", "value"), &VisualScript::_set_variable_info);
  915. ClassDB::bind_method(D_METHOD("get_variable_info", "name"), &VisualScript::_get_variable_info);
  916. ClassDB::bind_method(D_METHOD("set_variable_export", "name", "enable"), &VisualScript::set_variable_export);
  917. ClassDB::bind_method(D_METHOD("get_variable_export", "name"), &VisualScript::get_variable_export);
  918. ClassDB::bind_method(D_METHOD("rename_variable", "name", "new_name"), &VisualScript::rename_variable);
  919. ClassDB::bind_method(D_METHOD("add_custom_signal", "name"), &VisualScript::add_custom_signal);
  920. ClassDB::bind_method(D_METHOD("has_custom_signal", "name"), &VisualScript::has_custom_signal);
  921. ClassDB::bind_method(D_METHOD("custom_signal_add_argument", "name", "type", "argname", "index"), &VisualScript::custom_signal_add_argument, DEFVAL(-1));
  922. ClassDB::bind_method(D_METHOD("custom_signal_set_argument_type", "name", "argidx", "type"), &VisualScript::custom_signal_set_argument_type);
  923. ClassDB::bind_method(D_METHOD("custom_signal_get_argument_type", "name", "argidx"), &VisualScript::custom_signal_get_argument_type);
  924. ClassDB::bind_method(D_METHOD("custom_signal_set_argument_name", "name", "argidx", "argname"), &VisualScript::custom_signal_set_argument_name);
  925. ClassDB::bind_method(D_METHOD("custom_signal_get_argument_name", "name", "argidx"), &VisualScript::custom_signal_get_argument_name);
  926. ClassDB::bind_method(D_METHOD("custom_signal_remove_argument", "name", "argidx"), &VisualScript::custom_signal_remove_argument);
  927. ClassDB::bind_method(D_METHOD("custom_signal_get_argument_count", "name"), &VisualScript::custom_signal_get_argument_count);
  928. ClassDB::bind_method(D_METHOD("custom_signal_swap_argument", "name", "argidx", "withidx"), &VisualScript::custom_signal_swap_argument);
  929. ClassDB::bind_method(D_METHOD("remove_custom_signal", "name"), &VisualScript::remove_custom_signal);
  930. ClassDB::bind_method(D_METHOD("rename_custom_signal", "name", "new_name"), &VisualScript::rename_custom_signal);
  931. ClassDB::bind_method(D_METHOD("set_instance_base_type", "type"), &VisualScript::set_instance_base_type);
  932. ClassDB::bind_method(D_METHOD("_set_data", "data"), &VisualScript::_set_data);
  933. ClassDB::bind_method(D_METHOD("_get_data"), &VisualScript::_get_data);
  934. ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY, "data", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL), "_set_data", "_get_data");
  935. ADD_SIGNAL(MethodInfo("node_ports_changed", PropertyInfo(Variant::INT, "id")));
  936. }
  937. VisualScript::VisualScript() {
  938. base_type = "Object";
  939. is_tool_script = false;
  940. }
  941. bool VisualScript::inherits_script(const Ref<Script> &p_script) const {
  942. return this == p_script.ptr(); // There is no inheritance in visual scripts, so this is enough.
  943. }
  944. RBSet<int> VisualScript::get_output_sequence_ports_connected(int from_node) {
  945. List<VisualScript::SequenceConnection> *sc = memnew(List<VisualScript::SequenceConnection>);
  946. get_sequence_connection_list(sc);
  947. RBSet<int> connected;
  948. for (List<VisualScript::SequenceConnection>::Element *E = sc->front(); E; E = E->next()) {
  949. if (E->get().from_node == from_node) {
  950. connected.insert(E->get().from_output);
  951. }
  952. }
  953. memdelete(sc);
  954. return connected;
  955. }
  956. VisualScript::~VisualScript() {
  957. // Remove all nodes and stuff that hold data refs.
  958. for (const KeyValue<int, NodeData> &E : nodes) {
  959. remove_node(E.key);
  960. }
  961. }
  962. ////////////////////////////////////////////
  963. bool VisualScriptInstance::set(const StringName &p_name, const Variant &p_value) {
  964. HashMap<StringName, Variant>::Iterator E = variables.find(p_name);
  965. if (!E) {
  966. return false;
  967. }
  968. E->value = p_value;
  969. return true;
  970. }
  971. bool VisualScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
  972. HashMap<StringName, Variant>::ConstIterator E = variables.find(p_name);
  973. if (!E) {
  974. return false;
  975. }
  976. r_ret = E->value;
  977. return true;
  978. }
  979. void VisualScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  980. #ifdef TOOLS_ENABLED
  981. p_properties->push_back(script->get_class_category());
  982. #endif // TOOLS_ENABLED
  983. for (const KeyValue<StringName, VisualScript::Variable> &E : script->variables) {
  984. if (!E.value._export) {
  985. continue;
  986. }
  987. PropertyInfo p = E.value.info;
  988. p.name = String(E.key);
  989. p.usage |= PROPERTY_USAGE_SCRIPT_VARIABLE;
  990. p_properties->push_back(p);
  991. }
  992. }
  993. Variant::Type VisualScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  994. if (!script->variables.has(p_name)) {
  995. if (r_is_valid) {
  996. *r_is_valid = false;
  997. }
  998. ERR_FAIL_V(Variant::NIL);
  999. }
  1000. if (r_is_valid) {
  1001. *r_is_valid = true;
  1002. }
  1003. return script->variables[p_name].info.type;
  1004. }
  1005. void VisualScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
  1006. for (const KeyValue<StringName, VisualScript::Function> &E : script->functions) {
  1007. MethodInfo mi;
  1008. mi.name = E.key;
  1009. if (E.value.func_id >= 0 && script->nodes.has(E.value.func_id)) {
  1010. Ref<VisualScriptFunction> vsf = script->nodes[E.value.func_id].node;
  1011. if (vsf.is_valid()) {
  1012. for (int i = 0; i < vsf->get_argument_count(); i++) {
  1013. PropertyInfo arg;
  1014. arg.name = vsf->get_argument_name(i);
  1015. arg.type = vsf->get_argument_type(i);
  1016. mi.arguments.push_back(arg);
  1017. }
  1018. if (!vsf->is_sequenced()) { // Assumed constant if not sequenced.
  1019. mi.flags |= METHOD_FLAG_CONST;
  1020. }
  1021. }
  1022. }
  1023. p_list->push_back(mi);
  1024. }
  1025. }
  1026. bool VisualScriptInstance::has_method(const StringName &p_method) const {
  1027. return script->functions.has(p_method);
  1028. }
  1029. //#define VSDEBUG(m_text) print_line(m_text)
  1030. #define VSDEBUG(m_text)
  1031. void VisualScriptInstance::_dependency_step(VisualScriptNodeInstance *node, int p_pass, int *pass_stack, const Variant **input_args, Variant **output_args, Variant *variant_stack, Callable::CallError &r_error, String &error_str, VisualScriptNodeInstance **r_error_node) {
  1032. ERR_FAIL_COND(node->pass_idx == -1);
  1033. if (pass_stack[node->pass_idx] == p_pass) {
  1034. return;
  1035. }
  1036. pass_stack[node->pass_idx] = p_pass;
  1037. if (!node->dependencies.is_empty()) {
  1038. int dc = node->dependencies.size();
  1039. VisualScriptNodeInstance **deps = node->dependencies.ptrw();
  1040. for (int i = 0; i < dc; i++) {
  1041. _dependency_step(deps[i], p_pass, pass_stack, input_args, output_args, variant_stack, r_error, error_str, r_error_node);
  1042. if (r_error.error != Callable::CallError::CALL_OK) {
  1043. return;
  1044. }
  1045. }
  1046. }
  1047. for (int i = 0; i < node->input_port_count; i++) {
  1048. int index = node->input_ports[i] & VisualScriptNodeInstance::INPUT_MASK;
  1049. if (node->input_ports[i] & VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT) {
  1050. // Is a default value (unassigned input port).
  1051. input_args[i] = &default_values[index];
  1052. } else {
  1053. // Regular temporary in stack.
  1054. input_args[i] = &variant_stack[index];
  1055. }
  1056. }
  1057. for (int i = 0; i < node->output_port_count; i++) {
  1058. output_args[i] = &variant_stack[node->output_ports[i]];
  1059. }
  1060. Variant *working_mem = node->working_mem_idx >= 0 ? &variant_stack[node->working_mem_idx] : (Variant *)nullptr;
  1061. node->step(input_args, output_args, VisualScriptNodeInstance::START_MODE_BEGIN_SEQUENCE, working_mem, r_error, error_str);
  1062. // Ignore return.
  1063. if (r_error.error != Callable::CallError::CALL_OK) {
  1064. *r_error_node = node;
  1065. }
  1066. }
  1067. Variant VisualScriptInstance::_call_internal(const StringName &p_method, void *p_stack, int p_stack_size, VisualScriptNodeInstance *p_node, int p_flow_stack_pos, int p_pass, bool p_resuming_yield, Callable::CallError &r_error) {
  1068. HashMap<StringName, Function>::Iterator F = functions.find(p_method);
  1069. ERR_FAIL_COND_V(!F, Variant());
  1070. Function *f = &F->value;
  1071. // This call goes separate, so it can be yielded and suspended.
  1072. Variant *variant_stack = (Variant *)p_stack;
  1073. bool *sequence_bits = (bool *)(variant_stack + f->max_stack);
  1074. const Variant **input_args = (const Variant **)(sequence_bits + f->node_count);
  1075. Variant **output_args = (Variant **)(input_args + max_input_args);
  1076. int flow_max = f->flow_stack_size;
  1077. int *flow_stack = flow_max ? (int *)(output_args + max_output_args) : (int *)nullptr;
  1078. int *pass_stack = flow_stack ? (int *)(flow_stack + flow_max) : (int *)nullptr;
  1079. String error_str;
  1080. VisualScriptNodeInstance *node = p_node;
  1081. bool error = false;
  1082. int current_node_id = f->node;
  1083. Variant return_value;
  1084. Variant *working_mem = nullptr;
  1085. int flow_stack_pos = p_flow_stack_pos;
  1086. #ifdef DEBUG_ENABLED
  1087. if (EngineDebugger::is_active()) {
  1088. VisualScriptLanguage::singleton->enter_function(this, &p_method, variant_stack, &working_mem, &current_node_id);
  1089. }
  1090. #endif
  1091. while (true) {
  1092. p_pass++; // Increment pass.
  1093. current_node_id = node->get_id();
  1094. VSDEBUG("==========AT NODE: " + itos(current_node_id) + " base: " + node->get_base_node()->get_class_name());
  1095. VSDEBUG("AT STACK POS: " + itos(flow_stack_pos));
  1096. // Setup working mem.
  1097. working_mem = node->working_mem_idx >= 0 ? &variant_stack[node->working_mem_idx] : (Variant *)nullptr;
  1098. VSDEBUG("WORKING MEM: " + itos(node->working_mem_idx));
  1099. if (current_node_id == f->node) {
  1100. // If function node, set up function arguments from beginning of stack.
  1101. for (int i = 0; i < f->argument_count; i++) {
  1102. input_args[i] = &variant_stack[i];
  1103. }
  1104. } else {
  1105. // Run dependencies first.
  1106. if (!node->dependencies.is_empty()) {
  1107. int dc = node->dependencies.size();
  1108. VisualScriptNodeInstance **deps = node->dependencies.ptrw();
  1109. for (int i = 0; i < dc; i++) {
  1110. _dependency_step(deps[i], p_pass, pass_stack, input_args, output_args, variant_stack, r_error, error_str, &node);
  1111. if (r_error.error != Callable::CallError::CALL_OK) {
  1112. error = true;
  1113. current_node_id = node->id;
  1114. break;
  1115. }
  1116. }
  1117. }
  1118. if (!error) {
  1119. // Setup input pointers normally.
  1120. VSDEBUG("INPUT PORTS: " + itos(node->input_port_count));
  1121. for (int i = 0; i < node->input_port_count; i++) {
  1122. int index = node->input_ports[i] & VisualScriptNodeInstance::INPUT_MASK;
  1123. if (node->input_ports[i] & VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT) {
  1124. // Is a default value (unassigned input port).
  1125. input_args[i] = &default_values[index];
  1126. VSDEBUG("\tPORT " + itos(i) + " DEFAULT VAL");
  1127. } else {
  1128. // Regular temporary in stack.
  1129. input_args[i] = &variant_stack[index];
  1130. VSDEBUG("PORT " + itos(i) + " AT STACK " + itos(index));
  1131. }
  1132. }
  1133. }
  1134. }
  1135. if (error) {
  1136. break;
  1137. }
  1138. // Setup output pointers.
  1139. VSDEBUG("OUTPUT PORTS: " + itos(node->output_port_count));
  1140. for (int i = 0; i < node->output_port_count; i++) {
  1141. output_args[i] = &variant_stack[node->output_ports[i]];
  1142. VSDEBUG("PORT " + itos(i) + " AT STACK " + itos(node->output_ports[i]));
  1143. }
  1144. // Do step.
  1145. VisualScriptNodeInstance::StartMode start_mode;
  1146. {
  1147. if (p_resuming_yield) {
  1148. start_mode = VisualScriptNodeInstance::START_MODE_RESUME_YIELD;
  1149. p_resuming_yield = false; // Should resume only the first time.
  1150. } else if (flow_stack && (flow_stack[flow_stack_pos] & VisualScriptNodeInstance::FLOW_STACK_PUSHED_BIT)) {
  1151. // If there is a push bit, it means we are continuing a sequence.
  1152. start_mode = VisualScriptNodeInstance::START_MODE_CONTINUE_SEQUENCE;
  1153. } else {
  1154. start_mode = VisualScriptNodeInstance::START_MODE_BEGIN_SEQUENCE;
  1155. }
  1156. }
  1157. VSDEBUG("STEP - STARTSEQ: " + itos(start_mode));
  1158. int ret = node->step(input_args, output_args, start_mode, working_mem, r_error, error_str);
  1159. if (r_error.error != Callable::CallError::CALL_OK) {
  1160. // Use error from step.
  1161. error = true;
  1162. break;
  1163. }
  1164. if (ret & VisualScriptNodeInstance::STEP_YIELD_BIT) {
  1165. // Yielded!
  1166. if (node->get_working_memory_size() == 0) {
  1167. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1168. error_str = RTR("A node yielded without working memory, please read the docs on how to yield properly!");
  1169. error = true;
  1170. break;
  1171. } else {
  1172. Ref<VisualScriptFunctionState> state = *working_mem;
  1173. if (!state.is_valid()) {
  1174. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1175. error_str = RTR("Node yielded, but did not return a function state in the first working memory.");
  1176. error = true;
  1177. break;
  1178. }
  1179. // Step 1, capture all state.
  1180. state->instance_id = get_owner_ptr()->get_instance_id();
  1181. state->script_id = get_script()->get_instance_id();
  1182. state->instance = this;
  1183. state->function = p_method;
  1184. state->working_mem_index = node->working_mem_idx;
  1185. state->variant_stack_size = f->max_stack;
  1186. state->node = node;
  1187. state->flow_stack_pos = flow_stack_pos;
  1188. state->stack.resize(p_stack_size);
  1189. state->pass = p_pass;
  1190. memcpy(state->stack.ptrw(), p_stack, p_stack_size);
  1191. // Step 2, run away, return directly.
  1192. r_error.error = Callable::CallError::CALL_OK;
  1193. #ifdef DEBUG_ENABLED
  1194. // Will re-enter later, so exiting.
  1195. if (EngineDebugger::is_active()) {
  1196. VisualScriptLanguage::singleton->exit_function();
  1197. }
  1198. #endif
  1199. return state;
  1200. }
  1201. }
  1202. #ifdef DEBUG_ENABLED
  1203. if (EngineDebugger::is_active()) {
  1204. // line
  1205. bool do_break = false;
  1206. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0) {
  1207. if (EngineDebugger::get_script_debugger()->get_depth() <= 0) {
  1208. EngineDebugger::get_script_debugger()->set_lines_left(EngineDebugger::get_script_debugger()->get_lines_left() - 1);
  1209. }
  1210. if (EngineDebugger::get_script_debugger()->get_lines_left() <= 0) {
  1211. do_break = true;
  1212. }
  1213. }
  1214. if (EngineDebugger::get_script_debugger()->is_breakpoint(current_node_id, source)) {
  1215. do_break = true;
  1216. }
  1217. if (do_break) {
  1218. VisualScriptLanguage::singleton->debug_break("Breakpoint", true);
  1219. }
  1220. EngineDebugger::get_singleton()->line_poll();
  1221. }
  1222. #endif
  1223. int output = ret & VisualScriptNodeInstance::STEP_MASK;
  1224. VSDEBUG("STEP RETURN: " + itos(ret));
  1225. if (ret & VisualScriptNodeInstance::STEP_EXIT_FUNCTION_BIT) {
  1226. if (node->get_working_memory_size() == 0) {
  1227. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1228. error_str = RTR("Return value must be assigned to first element of node working memory! Fix your node please.");
  1229. error = true;
  1230. } else {
  1231. // Assign from working memory, first element.
  1232. return_value = *working_mem;
  1233. }
  1234. VSDEBUG("EXITING FUNCTION - VALUE " + String(return_value));
  1235. break; // Exit function requested, bye
  1236. }
  1237. VisualScriptNodeInstance *next = nullptr; // Next node.
  1238. if ((ret == output || ret & VisualScriptNodeInstance::STEP_FLAG_PUSH_STACK_BIT) && node->sequence_output_count) {
  1239. // If no exit bit was set, and has sequence outputs, guess next node.
  1240. if (output >= node->sequence_output_count) {
  1241. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1242. error_str = RTR("Node returned an invalid sequence output:") + " " + itos(output);
  1243. error = true;
  1244. break;
  1245. }
  1246. next = node->sequence_outputs[output];
  1247. VSDEBUG("GOT NEXT NODE - " + (next ? itos(next->get_id()) : "Null"));
  1248. }
  1249. if (flow_stack) {
  1250. // Update flow stack pos (may have changed).
  1251. flow_stack[flow_stack_pos] = current_node_id;
  1252. // Add stack push bit if requested.
  1253. if (ret & VisualScriptNodeInstance::STEP_FLAG_PUSH_STACK_BIT) {
  1254. flow_stack[flow_stack_pos] |= VisualScriptNodeInstance::FLOW_STACK_PUSHED_BIT;
  1255. sequence_bits[node->sequence_index] = true; // Remember sequence bit.
  1256. VSDEBUG("NEXT SEQ - FLAG BIT");
  1257. } else {
  1258. sequence_bits[node->sequence_index] = false; // Forget sequence bit.
  1259. VSDEBUG("NEXT SEQ - NORMAL");
  1260. }
  1261. if (ret & VisualScriptNodeInstance::STEP_FLAG_GO_BACK_BIT) {
  1262. // Go back request.
  1263. if (flow_stack_pos > 0) {
  1264. flow_stack_pos--;
  1265. node = instances[flow_stack[flow_stack_pos] & VisualScriptNodeInstance::FLOW_STACK_MASK];
  1266. VSDEBUG("NEXT IS GO BACK");
  1267. } else {
  1268. VSDEBUG("NEXT IS GO BACK, BUT NO NEXT SO EXIT");
  1269. break; // Simply exit without value or error.
  1270. }
  1271. } else if (next) {
  1272. if (sequence_bits[next->sequence_index]) {
  1273. // What happened here is that we are entering a node that is in the middle of doing a sequence (pushed stack) from the front
  1274. // because each node has a working memory, we can't really do a sub-sequence
  1275. // as a result, the sequence will be restarted and the stack will roll back to find where this node
  1276. // started the sequence.
  1277. bool found = false;
  1278. for (int i = flow_stack_pos; i >= 0; i--) {
  1279. if ((flow_stack[i] & VisualScriptNodeInstance::FLOW_STACK_MASK) == next->get_id()) {
  1280. flow_stack_pos = i; // Roll back and remove bit.
  1281. flow_stack[i] = next->get_id();
  1282. sequence_bits[next->sequence_index] = false;
  1283. found = true;
  1284. }
  1285. }
  1286. if (!found) {
  1287. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1288. error_str = RTR("Found sequence bit but not the node in the stack (please report).");
  1289. error = true;
  1290. break;
  1291. }
  1292. node = next;
  1293. VSDEBUG("RE-ENTERED A LOOP, RETURNED STACK POS TO - " + itos(flow_stack_pos));
  1294. } else {
  1295. // Check for stack overflow.
  1296. if (flow_stack_pos + 1 >= flow_max) {
  1297. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1298. error_str = vformat(RTR("Stack overflow (stack size: %s). Check for infinite recursion in your script."), output);
  1299. error = true;
  1300. break;
  1301. }
  1302. node = next;
  1303. flow_stack_pos++;
  1304. flow_stack[flow_stack_pos] = node->get_id();
  1305. VSDEBUG("INCREASE FLOW STACK");
  1306. }
  1307. } else {
  1308. // No next node, try to go back in stack to pushed bit.
  1309. bool found = false;
  1310. for (int i = flow_stack_pos; i >= 0; i--) {
  1311. VSDEBUG("FS " + itos(i) + " - " + itos(flow_stack[i]));
  1312. if (flow_stack[i] & VisualScriptNodeInstance::FLOW_STACK_PUSHED_BIT) {
  1313. node = instances[flow_stack[i] & VisualScriptNodeInstance::FLOW_STACK_MASK];
  1314. flow_stack_pos = i;
  1315. found = true;
  1316. break;
  1317. }
  1318. }
  1319. if (!found) {
  1320. VSDEBUG("NO NEXT NODE, NO GO BACK, EXITING");
  1321. break; // Done, couldn't find a push stack bit.
  1322. }
  1323. VSDEBUG("NO NEXT NODE, GO BACK TO: " + itos(flow_stack_pos));
  1324. }
  1325. } else {
  1326. node = next; // Stackless mode, simply assign next node.
  1327. }
  1328. }
  1329. if (error) {
  1330. // Error
  1331. // Function, file, line, error, explanation.
  1332. String err_file = script->get_path();
  1333. String err_func = p_method;
  1334. int err_line = current_node_id; // Not a line but it works as one.
  1335. if (node && (r_error.error != Callable::CallError::CALL_ERROR_INVALID_METHOD || error_str.is_empty())) {
  1336. if (!error_str.is_empty()) {
  1337. error_str += " ";
  1338. }
  1339. if (r_error.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1340. int errorarg = r_error.argument;
  1341. error_str += "Cannot convert argument " + itos(errorarg + 1) + " to " + Variant::get_type_name(Variant::Type(r_error.expected)) + ".";
  1342. } else if (r_error.error == Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS) {
  1343. error_str += "Expected " + itos(r_error.argument) + " arguments.";
  1344. } else if (r_error.error == Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS) {
  1345. error_str += "Expected " + itos(r_error.argument) + " arguments.";
  1346. } else if (r_error.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  1347. error_str += "Invalid Call.";
  1348. } else if (r_error.error == Callable::CallError::CALL_ERROR_METHOD_NOT_CONST) {
  1349. error_str += "Method not const in a const instance.";
  1350. } else if (r_error.error == Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL) {
  1351. error_str += "Base Instance is null";
  1352. }
  1353. }
  1354. //if (!GDScriptLanguage::get_singleton()->debug_break(err_text,false)) {
  1355. // debugger break did not happen
  1356. if (!VisualScriptLanguage::singleton->debug_break(error_str, false)) {
  1357. _err_print_error(err_func.utf8().get_data(), err_file.utf8().get_data(), err_line, error_str.utf8().get_data(), false, ERR_HANDLER_SCRIPT);
  1358. }
  1359. //}
  1360. } else {
  1361. //return_value=
  1362. }
  1363. #ifdef DEBUG_ENABLED
  1364. if (EngineDebugger::is_active()) {
  1365. VisualScriptLanguage::singleton->exit_function();
  1366. }
  1367. #endif
  1368. // Clean up variant stack.
  1369. for (int i = 0; i < f->max_stack; i++) {
  1370. variant_stack[i].~Variant();
  1371. }
  1372. return return_value;
  1373. }
  1374. Variant VisualScriptInstance::callp(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1375. r_error.error = Callable::CallError::CALL_OK; //ok by default
  1376. HashMap<StringName, Function>::Iterator F = functions.find(p_method);
  1377. if (!F) {
  1378. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1379. return Variant();
  1380. }
  1381. VSDEBUG("CALLING: " + String(p_method));
  1382. Function *f = &F->value;
  1383. int total_stack_size = 0;
  1384. total_stack_size += f->max_stack * sizeof(Variant); //variants
  1385. total_stack_size += f->node_count * sizeof(bool);
  1386. total_stack_size += (max_input_args + max_output_args) * sizeof(Variant *); //arguments
  1387. total_stack_size += f->flow_stack_size * sizeof(int); //flow
  1388. total_stack_size += f->pass_stack_size * sizeof(int);
  1389. VSDEBUG("STACK SIZE: " + itos(total_stack_size));
  1390. VSDEBUG("STACK VARIANTS: : " + itos(f->max_stack));
  1391. VSDEBUG("SEQBITS: : " + itos(f->node_count));
  1392. VSDEBUG("MAX INPUT: " + itos(max_input_args));
  1393. VSDEBUG("MAX OUTPUT: " + itos(max_output_args));
  1394. VSDEBUG("FLOW STACK SIZE: " + itos(f->flow_stack_size));
  1395. VSDEBUG("PASS STACK SIZE: " + itos(f->pass_stack_size));
  1396. void *stack = alloca(total_stack_size);
  1397. Variant *variant_stack = (Variant *)stack;
  1398. bool *sequence_bits = (bool *)(variant_stack + f->max_stack);
  1399. const Variant **input_args = (const Variant **)(sequence_bits + f->node_count);
  1400. Variant **output_args = (Variant **)(input_args + max_input_args);
  1401. int flow_max = f->flow_stack_size;
  1402. int *flow_stack = flow_max ? (int *)(output_args + max_output_args) : (int *)nullptr;
  1403. int *pass_stack = flow_stack ? (int *)(flow_stack + flow_max) : (int *)nullptr;
  1404. for (int i = 0; i < f->node_count; i++) {
  1405. sequence_bits[i] = false; // All starts as false.
  1406. }
  1407. memset(pass_stack, 0, f->pass_stack_size * sizeof(int));
  1408. HashMap<int, VisualScriptNodeInstance *>::Iterator E = instances.find(f->node);
  1409. if (!E) {
  1410. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1411. ERR_FAIL_V_MSG(Variant(), "No VisualScriptFunction node in function.");
  1412. }
  1413. VisualScriptNodeInstance *node = E->value;
  1414. if (flow_stack) {
  1415. flow_stack[0] = node->get_id();
  1416. }
  1417. VSDEBUG("ARGUMENTS: " + itos(f->argument_count) = " RECEIVED: " + itos(p_argcount));
  1418. if (p_argcount < f->argument_count) {
  1419. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1420. r_error.argument = node->get_input_port_count();
  1421. return Variant();
  1422. }
  1423. if (p_argcount > f->argument_count) {
  1424. r_error.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  1425. r_error.argument = node->get_input_port_count();
  1426. return Variant();
  1427. }
  1428. // Allocate variant stack.
  1429. for (int i = 0; i < f->max_stack; i++) {
  1430. memnew_placement(&variant_stack[i], Variant);
  1431. }
  1432. // Allocate function arguments (must be copied for yield to work properly).
  1433. for (int i = 0; i < p_argcount; i++) {
  1434. variant_stack[i] = *p_args[i];
  1435. }
  1436. return _call_internal(p_method, stack, total_stack_size, node, 0, 0, false, r_error);
  1437. }
  1438. void VisualScriptInstance::notification(int p_notification) {
  1439. // Do nothing as this is called using virtual.
  1440. Variant what = p_notification;
  1441. const Variant *whatp = &what;
  1442. Callable::CallError ce;
  1443. callp(VisualScriptLanguage::singleton->notification, &whatp, 1, ce); // Do as call.
  1444. }
  1445. String VisualScriptInstance::to_string(bool *r_valid) {
  1446. if (has_method(CoreStringNames::get_singleton()->_to_string)) {
  1447. Callable::CallError ce;
  1448. Variant ret = callp(CoreStringNames::get_singleton()->_to_string, nullptr, 0, ce);
  1449. if (ce.error == Callable::CallError::CALL_OK) {
  1450. if (ret.get_type() != Variant::STRING) {
  1451. if (r_valid) {
  1452. *r_valid = false;
  1453. }
  1454. ERR_FAIL_V_MSG(String(), "Wrong type for " + CoreStringNames::get_singleton()->_to_string + ", must be a String.");
  1455. }
  1456. if (r_valid) {
  1457. *r_valid = true;
  1458. }
  1459. return ret.operator String();
  1460. }
  1461. }
  1462. if (r_valid) {
  1463. *r_valid = false;
  1464. }
  1465. return String();
  1466. }
  1467. Ref<Script> VisualScriptInstance::get_script() const {
  1468. return script;
  1469. }
  1470. const Variant VisualScriptInstance::get_rpc_config() const {
  1471. return script->get_rpc_config();
  1472. }
  1473. void VisualScriptInstance::create(const Ref<VisualScript> &p_script, Object *p_owner) {
  1474. script = p_script;
  1475. owner = p_owner;
  1476. source = p_script->get_path();
  1477. max_input_args = 0;
  1478. max_output_args = 0;
  1479. // Setup variables.
  1480. {
  1481. for (const KeyValue<StringName, VisualScript::Variable> &E : script->variables) {
  1482. variables[E.key] = E.value.default_value;
  1483. }
  1484. }
  1485. // Setup functions from sequence trees.
  1486. {
  1487. for (const KeyValue<StringName, VisualScript::Function> &E : script->functions) {
  1488. const VisualScript::Function &vsfn = E.value;
  1489. Function function;
  1490. function.node = vsfn.func_id;
  1491. function.max_stack = 0;
  1492. function.flow_stack_size = 0;
  1493. function.pass_stack_size = 0;
  1494. function.node_count = 0;
  1495. HashMap<StringName, int> local_var_indices;
  1496. if (function.node < 0) {
  1497. VisualScriptLanguage::singleton->debug_break_parse(get_script()->get_path(), 0, "No start node in function: " + String(E.key));
  1498. ERR_CONTINUE(function.node < 0);
  1499. }
  1500. {
  1501. Ref<VisualScriptFunction> func_node = script->get_node(vsfn.func_id);
  1502. if (func_node.is_null()) {
  1503. VisualScriptLanguage::singleton->debug_break_parse(get_script()->get_path(), 0, "No VisualScriptFunction typed start node in function: " + String(E.key));
  1504. }
  1505. ERR_CONTINUE(!func_node.is_valid());
  1506. function.argument_count = func_node->get_argument_count();
  1507. function.max_stack += function.argument_count;
  1508. function.flow_stack_size = func_node->is_stack_less() ? 0 : func_node->get_stack_size();
  1509. max_input_args = MAX(max_input_args, function.argument_count);
  1510. }
  1511. // Function nodes graphs.
  1512. RBSet<VisualScript::SequenceConnection> seqconns;
  1513. RBSet<VisualScript::DataConnection> dataconns;
  1514. RBSet<int> node_ids;
  1515. node_ids.insert(function.node);
  1516. {
  1517. List<int> nd_queue;
  1518. nd_queue.push_back(function.node);
  1519. while (!nd_queue.is_empty()) {
  1520. for (const VisualScript::SequenceConnection &F : script->sequence_connections) {
  1521. if (nd_queue.front()->get() == F.from_node && !node_ids.has(F.to_node)) {
  1522. nd_queue.push_back(F.to_node);
  1523. node_ids.insert(F.to_node);
  1524. }
  1525. if (nd_queue.front()->get() == F.from_node && !seqconns.has(F)) {
  1526. seqconns.insert(F);
  1527. }
  1528. }
  1529. nd_queue.pop_front();
  1530. }
  1531. HashMap<int, HashMap<int, Pair<int, int>>> dc_lut; // :: to -> to_port -> (from, from_port)
  1532. for (const VisualScript::DataConnection &F : script->data_connections) {
  1533. dc_lut[F.to_node][F.to_port] = Pair<int, int>(F.from_node, F.from_port);
  1534. }
  1535. for (const int &F : node_ids) {
  1536. nd_queue.push_back(F);
  1537. }
  1538. List<int> dc_keys;
  1539. while (!nd_queue.is_empty()) {
  1540. int ky = nd_queue.front()->get();
  1541. for (const KeyValue<int, Pair<int, int>> &F : dc_lut[ky]) {
  1542. VisualScript::DataConnection dc;
  1543. dc.from_node = F.value.first;
  1544. dc.from_port = F.value.second;
  1545. dc.to_node = ky;
  1546. dc.to_port = F.key;
  1547. dataconns.insert(dc);
  1548. nd_queue.push_back(dc.from_node);
  1549. node_ids.insert(dc.from_node);
  1550. }
  1551. dc_keys.clear(); // Necessary as get_key_list does a push_back not a set.
  1552. nd_queue.pop_front();
  1553. }
  1554. }
  1555. //Multiple passes are required to set up this complex thing..
  1556. //First create the nodes.
  1557. for (const int &F : node_ids) {
  1558. Ref<VisualScriptNode> node = script->nodes[F].node;
  1559. VisualScriptNodeInstance *instance = node->instantiate(this); // Create instance.
  1560. ERR_FAIL_COND(!instance);
  1561. instance->base = node.ptr();
  1562. instance->id = F;
  1563. instance->input_port_count = node->get_input_value_port_count();
  1564. instance->input_ports = nullptr;
  1565. instance->output_port_count = node->get_output_value_port_count();
  1566. instance->output_ports = nullptr;
  1567. instance->sequence_output_count = node->get_output_sequence_port_count();
  1568. instance->sequence_index = function.node_count++;
  1569. instance->sequence_outputs = nullptr;
  1570. instance->pass_idx = -1;
  1571. if (instance->input_port_count) {
  1572. instance->input_ports = memnew_arr(int, instance->input_port_count);
  1573. for (int i = 0; i < instance->input_port_count; i++) {
  1574. instance->input_ports[i] = -1; // If not assigned, will become default value.
  1575. }
  1576. }
  1577. if (instance->output_port_count) {
  1578. instance->output_ports = memnew_arr(int, instance->output_port_count);
  1579. for (int i = 0; i < instance->output_port_count; i++) {
  1580. instance->output_ports[i] = -1; // If not assigned, will output to trash.
  1581. }
  1582. }
  1583. if (instance->sequence_output_count) {
  1584. instance->sequence_outputs = memnew_arr(VisualScriptNodeInstance *, instance->sequence_output_count);
  1585. for (int i = 0; i < instance->sequence_output_count; i++) {
  1586. instance->sequence_outputs[i] = nullptr; // If it remains null, flow ends here.
  1587. }
  1588. }
  1589. if (Object::cast_to<VisualScriptLocalVar>(node.ptr()) || Object::cast_to<VisualScriptLocalVarSet>(*node)) {
  1590. // Working memory is shared only for this node, for the same variables.
  1591. Ref<VisualScriptLocalVar> vslv = node;
  1592. StringName var_name;
  1593. if (Object::cast_to<VisualScriptLocalVar>(*node)) {
  1594. var_name = String(Object::cast_to<VisualScriptLocalVar>(*node)->get_var_name()).strip_edges();
  1595. } else {
  1596. var_name = String(Object::cast_to<VisualScriptLocalVarSet>(*node)->get_var_name()).strip_edges();
  1597. }
  1598. if (!local_var_indices.has(var_name)) {
  1599. local_var_indices[var_name] = function.max_stack;
  1600. function.max_stack++;
  1601. }
  1602. instance->working_mem_idx = local_var_indices[var_name];
  1603. } else if (instance->get_working_memory_size()) {
  1604. instance->working_mem_idx = function.max_stack;
  1605. function.max_stack += instance->get_working_memory_size();
  1606. } else {
  1607. instance->working_mem_idx = -1; //no working mem
  1608. }
  1609. max_input_args = MAX(max_input_args, instance->input_port_count);
  1610. max_output_args = MAX(max_output_args, instance->output_port_count);
  1611. instances[F] = instance;
  1612. }
  1613. function.trash_pos = function.max_stack++; // create pos for trash
  1614. // Second pass, do data connections.
  1615. for (const VisualScript::DataConnection &F : dataconns) {
  1616. VisualScript::DataConnection dc = F;
  1617. ERR_CONTINUE(!instances.has(dc.from_node));
  1618. VisualScriptNodeInstance *from = instances[dc.from_node];
  1619. ERR_CONTINUE(!instances.has(dc.to_node));
  1620. VisualScriptNodeInstance *to = instances[dc.to_node];
  1621. ERR_CONTINUE(dc.from_port >= from->output_port_count);
  1622. ERR_CONTINUE(dc.to_port >= to->input_port_count);
  1623. if (from->output_ports[dc.from_port] == -1) {
  1624. int stack_pos = function.max_stack++;
  1625. from->output_ports[dc.from_port] = stack_pos;
  1626. }
  1627. if (from->get_sequence_output_count() == 0 && to->dependencies.find(from) == -1) {
  1628. // If the node we are reading from has no output sequence, we must call step() before reading from it.
  1629. if (from->pass_idx == -1) {
  1630. from->pass_idx = function.pass_stack_size;
  1631. function.pass_stack_size++;
  1632. }
  1633. to->dependencies.push_back(from);
  1634. }
  1635. to->input_ports[dc.to_port] = from->output_ports[dc.from_port]; // Read from wherever the stack is.
  1636. }
  1637. // Third pass, do sequence connections.
  1638. for (const VisualScript::SequenceConnection &F : seqconns) {
  1639. VisualScript::SequenceConnection sc = F;
  1640. ERR_CONTINUE(!instances.has(sc.from_node));
  1641. VisualScriptNodeInstance *from = instances[sc.from_node];
  1642. ERR_CONTINUE(!instances.has(sc.to_node));
  1643. VisualScriptNodeInstance *to = instances[sc.to_node];
  1644. ERR_CONTINUE(sc.from_output >= from->sequence_output_count);
  1645. from->sequence_outputs[sc.from_output] = to;
  1646. }
  1647. //fourth pass:
  1648. // 1) unassigned input ports to default values
  1649. // 2) connect unassigned output ports to trash
  1650. for (const int &F : node_ids) {
  1651. ERR_CONTINUE(!instances.has(F));
  1652. Ref<VisualScriptNode> node = script->nodes[F].node;
  1653. VisualScriptNodeInstance *instance = instances[F];
  1654. // Connect to default values.
  1655. for (int i = 0; i < instance->input_port_count; i++) {
  1656. if (instance->input_ports[i] == -1) {
  1657. // Unassigned, connect to default val.
  1658. instance->input_ports[i] = default_values.size() | VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT;
  1659. default_values.push_back(node->get_default_input_value(i));
  1660. }
  1661. }
  1662. // Connect to trash.
  1663. for (int i = 0; i < instance->output_port_count; i++) {
  1664. if (instance->output_ports[i] == -1) {
  1665. instance->output_ports[i] = function.trash_pos; //trash is same for all
  1666. }
  1667. }
  1668. }
  1669. functions[E.key] = function;
  1670. }
  1671. }
  1672. }
  1673. ScriptLanguage *VisualScriptInstance::get_language() {
  1674. return VisualScriptLanguage::singleton;
  1675. }
  1676. VisualScriptInstance::VisualScriptInstance() {
  1677. }
  1678. VisualScriptInstance::~VisualScriptInstance() {
  1679. {
  1680. MutexLock lock(VisualScriptLanguage::singleton->lock);
  1681. script->instances.erase(owner);
  1682. }
  1683. for (const KeyValue<int, VisualScriptNodeInstance *> &E : instances) {
  1684. memdelete(E.value);
  1685. }
  1686. }
  1687. /////////////////////////////////////////////
  1688. /////////////////////
  1689. Variant VisualScriptFunctionState::_signal_callback(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1690. ERR_FAIL_COND_V(function == StringName(), Variant());
  1691. #ifdef DEBUG_ENABLED
  1692. ERR_FAIL_COND_V_MSG(instance_id.is_valid() && !ObjectDB::get_instance(instance_id), Variant(), "Resumed after yield, but class instance is gone.");
  1693. ERR_FAIL_COND_V_MSG(script_id.is_valid() && !ObjectDB::get_instance(script_id), Variant(), "Resumed after yield, but script is gone.");
  1694. #endif
  1695. r_error.error = Callable::CallError::CALL_OK;
  1696. Array args;
  1697. if (p_argcount == 0) {
  1698. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1699. r_error.argument = 1;
  1700. return Variant();
  1701. } else if (p_argcount == 1) {
  1702. //noooneee, reserved for me, me and only me.
  1703. } else {
  1704. for (int i = 0; i < p_argcount - 1; i++) {
  1705. args.push_back(*p_args[i]);
  1706. }
  1707. }
  1708. Ref<VisualScriptFunctionState> self = *p_args[p_argcount - 1]; //hi, I'm myself, needed this to remain alive.
  1709. if (self.is_null()) {
  1710. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  1711. r_error.argument = p_argcount - 1;
  1712. r_error.expected = Variant::OBJECT;
  1713. return Variant();
  1714. }
  1715. r_error.error = Callable::CallError::CALL_OK;
  1716. Variant *working_mem = ((Variant *)stack.ptr()) + working_mem_index;
  1717. *working_mem = args; // Arguments go to working mem.
  1718. Variant ret = instance->_call_internal(function, stack.ptrw(), stack.size(), node, flow_stack_pos, pass, true, r_error);
  1719. function = StringName(); //invalidate
  1720. return ret;
  1721. }
  1722. void VisualScriptFunctionState::connect_to_signal(Object *p_obj, const String &p_signal, Array p_binds) {
  1723. ERR_FAIL_NULL(p_obj);
  1724. Vector<Variant> binds;
  1725. for (int i = 0; i < p_binds.size(); i++) {
  1726. binds.push_back(p_binds[i]);
  1727. }
  1728. binds.push_back(Ref<VisualScriptFunctionState>(this)); //add myself on the back to avoid dying from unreferencing
  1729. Vector<const Variant *> bind_ptrs;
  1730. bind_ptrs.resize(p_binds.size());
  1731. for (int i = 0; i < bind_ptrs.size(); i++) {
  1732. bind_ptrs.write[i] = &binds.write[i];
  1733. }
  1734. p_obj->connect(p_signal, Callable(this, "_signal_callback").bindp((const Variant **)bind_ptrs.ptr(), bind_ptrs.size()), CONNECT_ONESHOT);
  1735. }
  1736. bool VisualScriptFunctionState::is_valid() const {
  1737. return function != StringName();
  1738. }
  1739. Variant VisualScriptFunctionState::resume(Array p_args) {
  1740. ERR_FAIL_COND_V(function == StringName(), Variant());
  1741. #ifdef DEBUG_ENABLED
  1742. ERR_FAIL_COND_V_MSG(instance_id.is_valid() && !ObjectDB::get_instance(instance_id), Variant(), "Resumed after yield, but class instance is gone.");
  1743. ERR_FAIL_COND_V_MSG(script_id.is_valid() && !ObjectDB::get_instance(script_id), Variant(), "Resumed after yield, but script is gone.");
  1744. #endif
  1745. Callable::CallError r_error;
  1746. r_error.error = Callable::CallError::CALL_OK;
  1747. Variant *working_mem = ((Variant *)stack.ptr()) + working_mem_index;
  1748. *working_mem = p_args; // Arguments go to working mem.
  1749. Variant ret = instance->_call_internal(function, stack.ptrw(), stack.size(), node, flow_stack_pos, pass, true, r_error);
  1750. function = StringName(); //invalidate
  1751. return ret;
  1752. }
  1753. void VisualScriptFunctionState::_bind_methods() {
  1754. ClassDB::bind_method(D_METHOD("connect_to_signal", "obj", "signals", "args"), &VisualScriptFunctionState::connect_to_signal);
  1755. ClassDB::bind_method(D_METHOD("resume", "args"), &VisualScriptFunctionState::resume, DEFVAL(Array()));
  1756. ClassDB::bind_method(D_METHOD("is_valid"), &VisualScriptFunctionState::is_valid);
  1757. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "_signal_callback", &VisualScriptFunctionState::_signal_callback, MethodInfo("_signal_callback"));
  1758. }
  1759. VisualScriptFunctionState::VisualScriptFunctionState() {
  1760. }
  1761. VisualScriptFunctionState::~VisualScriptFunctionState() {
  1762. if (function != StringName()) {
  1763. Variant *s = ((Variant *)stack.ptr());
  1764. for (int i = 0; i < variant_stack_size; i++) {
  1765. s[i].~Variant();
  1766. }
  1767. }
  1768. }
  1769. ///////////////////////////////////////////////
  1770. String VisualScriptLanguage::get_name() const {
  1771. return "VisualScript";
  1772. }
  1773. /* LANGUAGE FUNCTIONS */
  1774. void VisualScriptLanguage::init() {
  1775. }
  1776. String VisualScriptLanguage::get_type() const {
  1777. return "VisualScript";
  1778. }
  1779. String VisualScriptLanguage::get_extension() const {
  1780. return "vs";
  1781. }
  1782. Error VisualScriptLanguage::execute_file(const String &p_path) {
  1783. return OK;
  1784. }
  1785. void VisualScriptLanguage::finish() {
  1786. }
  1787. /* EDITOR FUNCTIONS */
  1788. void VisualScriptLanguage::get_reserved_words(List<String> *p_words) const {
  1789. }
  1790. bool VisualScriptLanguage::is_control_flow_keyword(String p_keyword) const {
  1791. return false;
  1792. }
  1793. void VisualScriptLanguage::get_comment_delimiters(List<String> *p_delimiters) const {
  1794. }
  1795. void VisualScriptLanguage::get_string_delimiters(List<String> *p_delimiters) const {
  1796. }
  1797. bool VisualScriptLanguage::is_using_templates() {
  1798. return false;
  1799. }
  1800. Ref<Script> VisualScriptLanguage::make_template(const String &p_template, const String &p_class_name, const String &p_base_class_name) const {
  1801. Ref<VisualScript> script;
  1802. script.instantiate();
  1803. script->set_instance_base_type(p_base_class_name);
  1804. return script;
  1805. }
  1806. bool VisualScriptLanguage::validate(const String &p_script, const String &p_path, List<String> *r_functions, List<ScriptLanguage::ScriptError> *r_errors, List<ScriptLanguage::Warning> *r_warnings, HashSet<int> *r_safe_lines) const {
  1807. return false;
  1808. }
  1809. Script *VisualScriptLanguage::create_script() const {
  1810. return memnew(VisualScript);
  1811. }
  1812. bool VisualScriptLanguage::has_named_classes() const {
  1813. return false;
  1814. }
  1815. bool VisualScriptLanguage::supports_builtin_mode() const {
  1816. return true;
  1817. }
  1818. int VisualScriptLanguage::find_function(const String &p_function, const String &p_code) const {
  1819. return -1;
  1820. }
  1821. String VisualScriptLanguage::make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const {
  1822. return String();
  1823. }
  1824. void VisualScriptLanguage::auto_indent_code(String &p_code, int p_from_line, int p_to_line) const {
  1825. }
  1826. void VisualScriptLanguage::add_global_constant(const StringName &p_variable, const Variant &p_value) {
  1827. }
  1828. /* DEBUGGER FUNCTIONS */
  1829. bool VisualScriptLanguage::debug_break_parse(const String &p_file, int p_node, const String &p_error) {
  1830. // Break because of parse error.
  1831. if (EngineDebugger::is_active() && Thread::get_caller_id() == Thread::get_main_id()) {
  1832. _debug_parse_err_node = p_node;
  1833. _debug_parse_err_file = p_file;
  1834. _debug_error = p_error;
  1835. EngineDebugger::get_script_debugger()->debug(this, false, true);
  1836. return true;
  1837. } else {
  1838. return false;
  1839. }
  1840. }
  1841. bool VisualScriptLanguage::debug_break(const String &p_error, bool p_allow_continue) {
  1842. if (EngineDebugger::is_active() && Thread::get_caller_id() == Thread::get_main_id()) {
  1843. _debug_parse_err_node = -1;
  1844. _debug_parse_err_file = "";
  1845. _debug_error = p_error;
  1846. EngineDebugger::get_script_debugger()->debug(this, p_allow_continue, true);
  1847. return true;
  1848. } else {
  1849. return false;
  1850. }
  1851. }
  1852. String VisualScriptLanguage::debug_get_error() const {
  1853. return _debug_error;
  1854. }
  1855. int VisualScriptLanguage::debug_get_stack_level_count() const {
  1856. if (_debug_parse_err_node >= 0) {
  1857. return 1;
  1858. }
  1859. return _debug_call_stack_pos;
  1860. }
  1861. int VisualScriptLanguage::debug_get_stack_level_line(int p_level) const {
  1862. if (_debug_parse_err_node >= 0) {
  1863. return _debug_parse_err_node;
  1864. }
  1865. ERR_FAIL_INDEX_V(p_level, _debug_call_stack_pos, -1);
  1866. int l = _debug_call_stack_pos - p_level - 1;
  1867. return *(_call_stack[l].current_id);
  1868. }
  1869. String VisualScriptLanguage::debug_get_stack_level_function(int p_level) const {
  1870. if (_debug_parse_err_node >= 0) {
  1871. return "";
  1872. }
  1873. ERR_FAIL_INDEX_V(p_level, _debug_call_stack_pos, "");
  1874. int l = _debug_call_stack_pos - p_level - 1;
  1875. return *_call_stack[l].function;
  1876. }
  1877. String VisualScriptLanguage::debug_get_stack_level_source(int p_level) const {
  1878. if (_debug_parse_err_node >= 0) {
  1879. return _debug_parse_err_file;
  1880. }
  1881. ERR_FAIL_INDEX_V(p_level, _debug_call_stack_pos, "");
  1882. int l = _debug_call_stack_pos - p_level - 1;
  1883. return _call_stack[l].instance->get_script_ptr()->get_path();
  1884. }
  1885. void VisualScriptLanguage::debug_get_stack_level_locals(int p_level, List<String> *p_locals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  1886. if (_debug_parse_err_node >= 0) {
  1887. return;
  1888. }
  1889. ERR_FAIL_INDEX(p_level, _debug_call_stack_pos);
  1890. int l = _debug_call_stack_pos - p_level - 1;
  1891. const StringName *f = _call_stack[l].function;
  1892. ERR_FAIL_COND(!_call_stack[l].instance->functions.has(*f));
  1893. VisualScriptNodeInstance *node = _call_stack[l].instance->instances[*_call_stack[l].current_id];
  1894. ERR_FAIL_COND(!node);
  1895. p_locals->push_back("node_name");
  1896. p_values->push_back(node->get_base_node()->get_text());
  1897. for (int i = 0; i < node->input_port_count; i++) {
  1898. String name = node->get_base_node()->get_input_value_port_info(i).name;
  1899. if (name.is_empty()) {
  1900. name = "in_" + itos(i);
  1901. }
  1902. p_locals->push_back("input/" + name);
  1903. //value is trickier
  1904. int in_from = node->input_ports[i];
  1905. int in_value = in_from & VisualScriptNodeInstance::INPUT_MASK;
  1906. if (in_from & VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT) {
  1907. p_values->push_back(_call_stack[l].instance->default_values[in_value]);
  1908. } else {
  1909. p_values->push_back(_call_stack[l].stack[in_value]);
  1910. }
  1911. }
  1912. for (int i = 0; i < node->output_port_count; i++) {
  1913. String name = node->get_base_node()->get_output_value_port_info(i).name;
  1914. if (name.is_empty()) {
  1915. name = "out_" + itos(i);
  1916. }
  1917. p_locals->push_back("output/" + name);
  1918. //value is trickier
  1919. int in_from = node->output_ports[i];
  1920. p_values->push_back(_call_stack[l].stack[in_from]);
  1921. }
  1922. for (int i = 0; i < node->get_working_memory_size(); i++) {
  1923. p_locals->push_back("working_mem/mem_" + itos(i));
  1924. p_values->push_back((*_call_stack[l].work_mem)[i]);
  1925. }
  1926. }
  1927. void VisualScriptLanguage::debug_get_stack_level_members(int p_level, List<String> *p_members, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  1928. if (_debug_parse_err_node >= 0) {
  1929. return;
  1930. }
  1931. ERR_FAIL_INDEX(p_level, _debug_call_stack_pos);
  1932. int l = _debug_call_stack_pos - p_level - 1;
  1933. Ref<VisualScript> vs = _call_stack[l].instance->get_script();
  1934. if (vs.is_null()) {
  1935. return;
  1936. }
  1937. List<StringName> vars;
  1938. vs->get_variable_list(&vars);
  1939. for (const StringName &E : vars) {
  1940. Variant v;
  1941. if (_call_stack[l].instance->get_variable(E, &v)) {
  1942. p_members->push_back("variables/" + E);
  1943. p_values->push_back(v);
  1944. }
  1945. }
  1946. }
  1947. void VisualScriptLanguage::debug_get_globals(List<String> *p_locals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  1948. // No globals are really reachable in gdscript.
  1949. }
  1950. String VisualScriptLanguage::debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems, int p_max_depth) {
  1951. return "";
  1952. }
  1953. void VisualScriptLanguage::reload_all_scripts() {
  1954. }
  1955. void VisualScriptLanguage::reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) {
  1956. }
  1957. /* LOADER FUNCTIONS */
  1958. void VisualScriptLanguage::get_recognized_extensions(List<String> *p_extensions) const {
  1959. p_extensions->push_back("vs");
  1960. }
  1961. void VisualScriptLanguage::get_public_functions(List<MethodInfo> *p_functions) const {
  1962. }
  1963. void VisualScriptLanguage::get_public_constants(List<Pair<String, Variant>> *p_constants) const {
  1964. }
  1965. void VisualScriptLanguage::get_public_annotations(List<MethodInfo> *p_annotations) const {
  1966. }
  1967. void VisualScriptLanguage::profiling_start() {
  1968. }
  1969. void VisualScriptLanguage::profiling_stop() {
  1970. }
  1971. int VisualScriptLanguage::profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) {
  1972. return 0;
  1973. }
  1974. int VisualScriptLanguage::profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) {
  1975. return 0;
  1976. }
  1977. VisualScriptLanguage *VisualScriptLanguage::singleton = nullptr;
  1978. void VisualScriptLanguage::add_register_func(const String &p_name, VisualScriptNodeRegisterFunc p_func) {
  1979. ERR_FAIL_COND(register_funcs.has(p_name));
  1980. register_funcs[p_name] = p_func;
  1981. }
  1982. void VisualScriptLanguage::remove_register_func(const String &p_name) {
  1983. ERR_FAIL_COND(!register_funcs.has(p_name));
  1984. register_funcs.erase(p_name);
  1985. }
  1986. Ref<VisualScriptNode> VisualScriptLanguage::create_node_from_name(const String &p_name) {
  1987. ERR_FAIL_COND_V(!register_funcs.has(p_name), Ref<VisualScriptNode>());
  1988. return register_funcs[p_name](p_name);
  1989. }
  1990. void VisualScriptLanguage::get_registered_node_names(List<String> *r_names) {
  1991. for (const KeyValue<String, VisualScriptNodeRegisterFunc> &E : register_funcs) {
  1992. r_names->push_back(E.key);
  1993. }
  1994. }
  1995. VisualScriptLanguage::VisualScriptLanguage() {
  1996. singleton = this;
  1997. int dmcs = GLOBAL_DEF("debug/settings/visual_script/max_call_stack", 1024);
  1998. ProjectSettings::get_singleton()->set_custom_property_info("debug/settings/visual_script/max_call_stack", PropertyInfo(Variant::INT, "debug/settings/visual_script/max_call_stack", PROPERTY_HINT_RANGE, "1024,4096,1,or_greater")); //minimum is 1024
  1999. if (EngineDebugger::is_active()) {
  2000. // Debugging enabled!
  2001. _debug_max_call_stack = dmcs;
  2002. _call_stack = memnew_arr(CallLevel, _debug_max_call_stack + 1);
  2003. } else {
  2004. _debug_max_call_stack = 0;
  2005. _call_stack = nullptr;
  2006. }
  2007. }
  2008. VisualScriptLanguage::~VisualScriptLanguage() {
  2009. if (_call_stack) {
  2010. memdelete_arr(_call_stack);
  2011. }
  2012. singleton = nullptr;
  2013. }