visual_script.cpp 79 KB

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