visual_script.cpp 80 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546
  1. /*************************************************************************/
  2. /* visual_script.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "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_NOEDITOR | 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(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. //if (!variables[E]._export)
  748. // continue;
  749. PropertyInfo pi = variables[E].info;
  750. pi.usage |= PROPERTY_USAGE_SCRIPT_VARIABLE;
  751. p_list->push_back(pi);
  752. }
  753. }
  754. int VisualScript::get_member_line(const StringName &p_member) const {
  755. return functions[p_member].func_id; // will be -1 if not found
  756. }
  757. #ifdef TOOLS_ENABLED
  758. bool VisualScript::are_subnodes_edited() const {
  759. List<int> keys;
  760. nodes.get_key_list(&keys);
  761. for (const int &F : keys) {
  762. if (nodes[F].node->is_edited()) {
  763. return true;
  764. }
  765. }
  766. return false;
  767. }
  768. #endif
  769. const Vector<Multiplayer::RPCConfig> VisualScript::get_rpc_methods() const {
  770. return rpc_functions;
  771. }
  772. void VisualScript::_set_data(const Dictionary &p_data) {
  773. Dictionary d = p_data;
  774. if (d.has("base_type")) {
  775. base_type = d["base_type"];
  776. }
  777. variables.clear();
  778. Array vars = d["variables"];
  779. for (int i = 0; i < vars.size(); i++) {
  780. Dictionary v = vars[i];
  781. StringName name = v["name"];
  782. add_variable(name);
  783. _set_variable_info(name, v);
  784. set_variable_default_value(name, v["default_value"]);
  785. set_variable_export(name, v.has("export") && bool(v["export"]));
  786. }
  787. custom_signals.clear();
  788. Array sigs = d["signals"];
  789. for (int i = 0; i < sigs.size(); i++) {
  790. Dictionary cs = sigs[i];
  791. add_custom_signal(cs["name"]);
  792. Array args = cs["arguments"];
  793. for (int j = 0; j < args.size(); j += 2) {
  794. custom_signal_add_argument(cs["name"], Variant::Type(int(args[j + 1])), args[j]);
  795. }
  796. }
  797. Array funcs = d["functions"];
  798. functions.clear();
  799. for (int i = 0; i < funcs.size(); i++) {
  800. Dictionary func = funcs[i];
  801. add_function(func["name"], func["function_id"]);
  802. }
  803. {
  804. Array nodes = d["nodes"];
  805. for (int i = 0; i < nodes.size(); i += 3) {
  806. add_node(nodes[i], nodes[i + 2], nodes[i + 1]);
  807. }
  808. Array sequence_connections = d["sequence_connections"];
  809. for (int j = 0; j < sequence_connections.size(); j += 3) {
  810. sequence_connect(sequence_connections[j + 0], sequence_connections[j + 1], sequence_connections[j + 2]);
  811. }
  812. Array data_connections = d["data_connections"];
  813. for (int j = 0; j < data_connections.size(); j += 4) {
  814. data_connect(data_connections[j + 0], data_connections[j + 1], data_connections[j + 2], data_connections[j + 3]);
  815. }
  816. }
  817. is_tool_script = d["is_tool_script"];
  818. scroll = d["scroll"];
  819. // Takes all the rpc methods.
  820. rpc_functions.clear();
  821. List<StringName> fns;
  822. functions.get_key_list(&fns);
  823. for (const StringName &E : fns) {
  824. if (functions[E].func_id >= 0 && nodes.has(functions[E].func_id)) {
  825. Ref<VisualScriptFunction> vsf = nodes[functions[E].func_id].node;
  826. if (vsf.is_valid()) {
  827. if (vsf->get_rpc_mode() != Multiplayer::RPC_MODE_DISABLED) {
  828. Multiplayer::RPCConfig nd;
  829. nd.name = E;
  830. nd.rpc_mode = vsf->get_rpc_mode();
  831. nd.transfer_mode = Multiplayer::TRANSFER_MODE_RELIABLE; // TODO
  832. if (rpc_functions.find(nd) == -1) {
  833. rpc_functions.push_back(nd);
  834. }
  835. }
  836. }
  837. }
  838. }
  839. // Sort so we are 100% that they are always the same.
  840. rpc_functions.sort_custom<Multiplayer::SortRPCConfig>();
  841. }
  842. Dictionary VisualScript::_get_data() const {
  843. Dictionary d;
  844. d["base_type"] = base_type;
  845. Array vars;
  846. List<StringName> var_names;
  847. variables.get_key_list(&var_names);
  848. for (const StringName &E : var_names) {
  849. Dictionary var = _get_variable_info(E);
  850. var["name"] = E; // Make sure it's the right one.
  851. var["default_value"] = variables[E].default_value;
  852. var["export"] = variables[E]._export;
  853. vars.push_back(var);
  854. }
  855. d["variables"] = vars;
  856. Array sigs;
  857. for (const KeyValue<StringName, Vector<Argument>> &E : custom_signals) {
  858. Dictionary cs;
  859. cs["name"] = E.key;
  860. Array args;
  861. for (int i = 0; i < E.value.size(); i++) {
  862. args.push_back(E.value[i].name);
  863. args.push_back(E.value[i].type);
  864. }
  865. cs["arguments"] = args;
  866. sigs.push_back(cs);
  867. }
  868. d["signals"] = sigs;
  869. Array funcs;
  870. List<StringName> func_names;
  871. functions.get_key_list(&func_names);
  872. for (const StringName &E : func_names) {
  873. Dictionary func;
  874. func["name"] = E;
  875. func["function_id"] = functions[E].func_id;
  876. funcs.push_back(func);
  877. }
  878. d["functions"] = funcs;
  879. Array nds;
  880. List<int> node_ids;
  881. nodes.get_key_list(&node_ids);
  882. for (const int &F : node_ids) {
  883. nds.push_back(F);
  884. nds.push_back(nodes[F].pos);
  885. nds.push_back(nodes[F].node);
  886. }
  887. d["nodes"] = nds;
  888. Array seqconns;
  889. for (const Set<SequenceConnection>::Element *F = sequence_connections.front(); F; F = F->next()) {
  890. seqconns.push_back(F->get().from_node);
  891. seqconns.push_back(F->get().from_output);
  892. seqconns.push_back(F->get().to_node);
  893. }
  894. d["sequence_connections"] = seqconns;
  895. Array dataconns;
  896. for (const Set<DataConnection>::Element *F = data_connections.front(); F; F = F->next()) {
  897. dataconns.push_back(F->get().from_node);
  898. dataconns.push_back(F->get().from_port);
  899. dataconns.push_back(F->get().to_node);
  900. dataconns.push_back(F->get().to_port);
  901. }
  902. d["data_connections"] = dataconns;
  903. d["is_tool_script"] = is_tool_script;
  904. d["scroll"] = scroll;
  905. return d;
  906. }
  907. void VisualScript::_bind_methods() {
  908. ClassDB::bind_method(D_METHOD("add_function", "name", "func_node_id"), &VisualScript::add_function);
  909. ClassDB::bind_method(D_METHOD("has_function", "name"), &VisualScript::has_function);
  910. ClassDB::bind_method(D_METHOD("remove_function", "name"), &VisualScript::remove_function);
  911. ClassDB::bind_method(D_METHOD("rename_function", "name", "new_name"), &VisualScript::rename_function);
  912. ClassDB::bind_method(D_METHOD("set_scroll", "ofs"), &VisualScript::set_scroll);
  913. ClassDB::bind_method(D_METHOD("get_scroll"), &VisualScript::get_scroll);
  914. ClassDB::bind_method(D_METHOD("add_node", "id", "node", "position"), &VisualScript::add_node, DEFVAL(Point2()));
  915. ClassDB::bind_method(D_METHOD("remove_node", "id"), &VisualScript::remove_node);
  916. ClassDB::bind_method(D_METHOD("get_function_node_id", "name"), &VisualScript::get_function_node_id);
  917. ClassDB::bind_method(D_METHOD("get_node", "id"), &VisualScript::get_node);
  918. ClassDB::bind_method(D_METHOD("has_node", "id"), &VisualScript::has_node);
  919. ClassDB::bind_method(D_METHOD("set_node_position", "id", "position"), &VisualScript::set_node_position);
  920. ClassDB::bind_method(D_METHOD("get_node_position", "id"), &VisualScript::get_node_position);
  921. ClassDB::bind_method(D_METHOD("sequence_connect", "from_node", "from_output", "to_node"), &VisualScript::sequence_connect);
  922. ClassDB::bind_method(D_METHOD("sequence_disconnect", "from_node", "from_output", "to_node"), &VisualScript::sequence_disconnect);
  923. ClassDB::bind_method(D_METHOD("has_sequence_connection", "from_node", "from_output", "to_node"), &VisualScript::has_sequence_connection);
  924. ClassDB::bind_method(D_METHOD("data_connect", "from_node", "from_port", "to_node", "to_port"), &VisualScript::data_connect);
  925. ClassDB::bind_method(D_METHOD("data_disconnect", "from_node", "from_port", "to_node", "to_port"), &VisualScript::data_disconnect);
  926. ClassDB::bind_method(D_METHOD("has_data_connection", "from_node", "from_port", "to_node", "to_port"), &VisualScript::has_data_connection);
  927. ClassDB::bind_method(D_METHOD("add_variable", "name", "default_value", "export"), &VisualScript::add_variable, DEFVAL(Variant()), DEFVAL(false));
  928. ClassDB::bind_method(D_METHOD("has_variable", "name"), &VisualScript::has_variable);
  929. ClassDB::bind_method(D_METHOD("remove_variable", "name"), &VisualScript::remove_variable);
  930. ClassDB::bind_method(D_METHOD("set_variable_default_value", "name", "value"), &VisualScript::set_variable_default_value);
  931. ClassDB::bind_method(D_METHOD("get_variable_default_value", "name"), &VisualScript::get_variable_default_value);
  932. ClassDB::bind_method(D_METHOD("set_variable_info", "name", "value"), &VisualScript::_set_variable_info);
  933. ClassDB::bind_method(D_METHOD("get_variable_info", "name"), &VisualScript::_get_variable_info);
  934. ClassDB::bind_method(D_METHOD("set_variable_export", "name", "enable"), &VisualScript::set_variable_export);
  935. ClassDB::bind_method(D_METHOD("get_variable_export", "name"), &VisualScript::get_variable_export);
  936. ClassDB::bind_method(D_METHOD("rename_variable", "name", "new_name"), &VisualScript::rename_variable);
  937. ClassDB::bind_method(D_METHOD("add_custom_signal", "name"), &VisualScript::add_custom_signal);
  938. ClassDB::bind_method(D_METHOD("has_custom_signal", "name"), &VisualScript::has_custom_signal);
  939. ClassDB::bind_method(D_METHOD("custom_signal_add_argument", "name", "type", "argname", "index"), &VisualScript::custom_signal_add_argument, DEFVAL(-1));
  940. ClassDB::bind_method(D_METHOD("custom_signal_set_argument_type", "name", "argidx", "type"), &VisualScript::custom_signal_set_argument_type);
  941. ClassDB::bind_method(D_METHOD("custom_signal_get_argument_type", "name", "argidx"), &VisualScript::custom_signal_get_argument_type);
  942. ClassDB::bind_method(D_METHOD("custom_signal_set_argument_name", "name", "argidx", "argname"), &VisualScript::custom_signal_set_argument_name);
  943. ClassDB::bind_method(D_METHOD("custom_signal_get_argument_name", "name", "argidx"), &VisualScript::custom_signal_get_argument_name);
  944. ClassDB::bind_method(D_METHOD("custom_signal_remove_argument", "name", "argidx"), &VisualScript::custom_signal_remove_argument);
  945. ClassDB::bind_method(D_METHOD("custom_signal_get_argument_count", "name"), &VisualScript::custom_signal_get_argument_count);
  946. ClassDB::bind_method(D_METHOD("custom_signal_swap_argument", "name", "argidx", "withidx"), &VisualScript::custom_signal_swap_argument);
  947. ClassDB::bind_method(D_METHOD("remove_custom_signal", "name"), &VisualScript::remove_custom_signal);
  948. ClassDB::bind_method(D_METHOD("rename_custom_signal", "name", "new_name"), &VisualScript::rename_custom_signal);
  949. //ClassDB::bind_method(D_METHOD("set_variable_info","name","info"),&VScript::set_variable_info);
  950. //ClassDB::bind_method(D_METHOD("get_variable_info","name"),&VScript::set_variable_info);
  951. ClassDB::bind_method(D_METHOD("set_instance_base_type", "type"), &VisualScript::set_instance_base_type);
  952. ClassDB::bind_method(D_METHOD("_set_data", "data"), &VisualScript::_set_data);
  953. ClassDB::bind_method(D_METHOD("_get_data"), &VisualScript::_get_data);
  954. ADD_PROPERTY(PropertyInfo(Variant::DICTIONARY, "data", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR | PROPERTY_USAGE_INTERNAL), "_set_data", "_get_data");
  955. ADD_SIGNAL(MethodInfo("node_ports_changed", PropertyInfo(Variant::INT, "id")));
  956. }
  957. VisualScript::VisualScript() {
  958. base_type = "Object";
  959. is_tool_script = false;
  960. }
  961. bool VisualScript::inherits_script(const Ref<Script> &p_script) const {
  962. return this == p_script.ptr(); // There is no inheritance in visual scripts, so this is enough.
  963. }
  964. Set<int> VisualScript::get_output_sequence_ports_connected(int from_node) {
  965. List<VisualScript::SequenceConnection> *sc = memnew(List<VisualScript::SequenceConnection>);
  966. get_sequence_connection_list(sc);
  967. Set<int> connected;
  968. for (List<VisualScript::SequenceConnection>::Element *E = sc->front(); E; E = E->next()) {
  969. if (E->get().from_node == from_node) {
  970. connected.insert(E->get().from_output);
  971. }
  972. }
  973. memdelete(sc);
  974. return connected;
  975. }
  976. VisualScript::~VisualScript() {
  977. // Remove all nodes and stuff that hold data refs.
  978. List<int> nds;
  979. nodes.get_key_list(&nds);
  980. for (const int &E : nds) {
  981. remove_node(E);
  982. }
  983. }
  984. ////////////////////////////////////////////
  985. bool VisualScriptInstance::set(const StringName &p_name, const Variant &p_value) {
  986. Map<StringName, Variant>::Element *E = variables.find(p_name);
  987. if (!E) {
  988. return false;
  989. }
  990. E->get() = p_value;
  991. return true;
  992. }
  993. bool VisualScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
  994. const Map<StringName, Variant>::Element *E = variables.find(p_name);
  995. if (!E) {
  996. return false;
  997. }
  998. r_ret = E->get();
  999. return true;
  1000. }
  1001. void VisualScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  1002. List<StringName> vars;
  1003. script->variables.get_key_list(&vars);
  1004. for (const StringName &E : vars) {
  1005. if (!script->variables[E]._export) {
  1006. continue;
  1007. }
  1008. PropertyInfo p = script->variables[E].info;
  1009. p.name = String(E);
  1010. p.usage |= PROPERTY_USAGE_SCRIPT_VARIABLE;
  1011. p_properties->push_back(p);
  1012. }
  1013. }
  1014. Variant::Type VisualScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  1015. if (!script->variables.has(p_name)) {
  1016. if (r_is_valid) {
  1017. *r_is_valid = false;
  1018. }
  1019. ERR_FAIL_V(Variant::NIL);
  1020. }
  1021. if (r_is_valid) {
  1022. *r_is_valid = true;
  1023. }
  1024. return script->variables[p_name].info.type;
  1025. }
  1026. void VisualScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
  1027. List<StringName> fns;
  1028. script->functions.get_key_list(&fns);
  1029. for (const StringName &E : fns) {
  1030. MethodInfo mi;
  1031. mi.name = E;
  1032. if (script->functions[E].func_id >= 0 && script->nodes.has(script->functions[E].func_id)) {
  1033. Ref<VisualScriptFunction> vsf = script->nodes[script->functions[E].func_id].node;
  1034. if (vsf.is_valid()) {
  1035. for (int i = 0; i < vsf->get_argument_count(); i++) {
  1036. PropertyInfo arg;
  1037. arg.name = vsf->get_argument_name(i);
  1038. arg.type = vsf->get_argument_type(i);
  1039. mi.arguments.push_back(arg);
  1040. }
  1041. if (!vsf->is_sequenced()) { // Assumed constant if not sequenced.
  1042. mi.flags |= METHOD_FLAG_CONST;
  1043. }
  1044. }
  1045. }
  1046. p_list->push_back(mi);
  1047. }
  1048. }
  1049. bool VisualScriptInstance::has_method(const StringName &p_method) const {
  1050. return script->functions.has(p_method);
  1051. }
  1052. //#define VSDEBUG(m_text) print_line(m_text)
  1053. #define VSDEBUG(m_text)
  1054. 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) {
  1055. ERR_FAIL_COND(node->pass_idx == -1);
  1056. if (pass_stack[node->pass_idx] == p_pass) {
  1057. return;
  1058. }
  1059. pass_stack[node->pass_idx] = p_pass;
  1060. if (!node->dependencies.is_empty()) {
  1061. int dc = node->dependencies.size();
  1062. VisualScriptNodeInstance **deps = node->dependencies.ptrw();
  1063. for (int i = 0; i < dc; i++) {
  1064. _dependency_step(deps[i], p_pass, pass_stack, input_args, output_args, variant_stack, r_error, error_str, r_error_node);
  1065. if (r_error.error != Callable::CallError::CALL_OK) {
  1066. return;
  1067. }
  1068. }
  1069. }
  1070. for (int i = 0; i < node->input_port_count; i++) {
  1071. int index = node->input_ports[i] & VisualScriptNodeInstance::INPUT_MASK;
  1072. if (node->input_ports[i] & VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT) {
  1073. // Is a default value (unassigned input port).
  1074. input_args[i] = &default_values[index];
  1075. } else {
  1076. // Regular temporary in stack.
  1077. input_args[i] = &variant_stack[index];
  1078. }
  1079. }
  1080. for (int i = 0; i < node->output_port_count; i++) {
  1081. output_args[i] = &variant_stack[node->output_ports[i]];
  1082. }
  1083. Variant *working_mem = node->working_mem_idx >= 0 ? &variant_stack[node->working_mem_idx] : (Variant *)nullptr;
  1084. node->step(input_args, output_args, VisualScriptNodeInstance::START_MODE_BEGIN_SEQUENCE, working_mem, r_error, error_str);
  1085. // Ignore return.
  1086. if (r_error.error != Callable::CallError::CALL_OK) {
  1087. *r_error_node = node;
  1088. }
  1089. }
  1090. 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) {
  1091. Map<StringName, Function>::Element *F = functions.find(p_method);
  1092. ERR_FAIL_COND_V(!F, Variant());
  1093. Function *f = &F->get();
  1094. // This call goes separate, so it can be yielded and suspended.
  1095. Variant *variant_stack = (Variant *)p_stack;
  1096. bool *sequence_bits = (bool *)(variant_stack + f->max_stack);
  1097. const Variant **input_args = (const Variant **)(sequence_bits + f->node_count);
  1098. Variant **output_args = (Variant **)(input_args + max_input_args);
  1099. int flow_max = f->flow_stack_size;
  1100. int *flow_stack = flow_max ? (int *)(output_args + max_output_args) : (int *)nullptr;
  1101. int *pass_stack = flow_stack ? (int *)(flow_stack + flow_max) : (int *)nullptr;
  1102. String error_str;
  1103. VisualScriptNodeInstance *node = p_node;
  1104. bool error = false;
  1105. int current_node_id = f->node;
  1106. Variant return_value;
  1107. Variant *working_mem = nullptr;
  1108. int flow_stack_pos = p_flow_stack_pos;
  1109. #ifdef DEBUG_ENABLED
  1110. if (EngineDebugger::is_active()) {
  1111. VisualScriptLanguage::singleton->enter_function(this, &p_method, variant_stack, &working_mem, &current_node_id);
  1112. }
  1113. #endif
  1114. while (true) {
  1115. p_pass++; // Increment pass.
  1116. current_node_id = node->get_id();
  1117. VSDEBUG("==========AT NODE: " + itos(current_node_id) + " base: " + node->get_base_node()->get_class_name());
  1118. VSDEBUG("AT STACK POS: " + itos(flow_stack_pos));
  1119. // Setup working mem.
  1120. working_mem = node->working_mem_idx >= 0 ? &variant_stack[node->working_mem_idx] : (Variant *)nullptr;
  1121. VSDEBUG("WORKING MEM: " + itos(node->working_mem_idx));
  1122. if (current_node_id == f->node) {
  1123. // If function node, set up function arguments from beginning of stack.
  1124. for (int i = 0; i < f->argument_count; i++) {
  1125. input_args[i] = &variant_stack[i];
  1126. }
  1127. } else {
  1128. // Run dependencies first.
  1129. if (!node->dependencies.is_empty()) {
  1130. int dc = node->dependencies.size();
  1131. VisualScriptNodeInstance **deps = node->dependencies.ptrw();
  1132. for (int i = 0; i < dc; i++) {
  1133. _dependency_step(deps[i], p_pass, pass_stack, input_args, output_args, variant_stack, r_error, error_str, &node);
  1134. if (r_error.error != Callable::CallError::CALL_OK) {
  1135. error = true;
  1136. current_node_id = node->id;
  1137. break;
  1138. }
  1139. }
  1140. }
  1141. if (!error) {
  1142. // Setup input pointers normally.
  1143. VSDEBUG("INPUT PORTS: " + itos(node->input_port_count));
  1144. for (int i = 0; i < node->input_port_count; i++) {
  1145. int index = node->input_ports[i] & VisualScriptNodeInstance::INPUT_MASK;
  1146. if (node->input_ports[i] & VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT) {
  1147. // Is a default value (unassigned input port).
  1148. input_args[i] = &default_values[index];
  1149. VSDEBUG("\tPORT " + itos(i) + " DEFAULT VAL");
  1150. } else {
  1151. // Regular temporary in stack.
  1152. input_args[i] = &variant_stack[index];
  1153. VSDEBUG("PORT " + itos(i) + " AT STACK " + itos(index));
  1154. }
  1155. }
  1156. }
  1157. }
  1158. if (error) {
  1159. break;
  1160. }
  1161. // Setup output pointers.
  1162. VSDEBUG("OUTPUT PORTS: " + itos(node->output_port_count));
  1163. for (int i = 0; i < node->output_port_count; i++) {
  1164. output_args[i] = &variant_stack[node->output_ports[i]];
  1165. VSDEBUG("PORT " + itos(i) + " AT STACK " + itos(node->output_ports[i]));
  1166. }
  1167. // Do step.
  1168. VisualScriptNodeInstance::StartMode start_mode;
  1169. {
  1170. if (p_resuming_yield) {
  1171. start_mode = VisualScriptNodeInstance::START_MODE_RESUME_YIELD;
  1172. p_resuming_yield = false; // Should resume only the first time.
  1173. } else if (flow_stack && (flow_stack[flow_stack_pos] & VisualScriptNodeInstance::FLOW_STACK_PUSHED_BIT)) {
  1174. // If there is a push bit, it means we are continuing a sequence.
  1175. start_mode = VisualScriptNodeInstance::START_MODE_CONTINUE_SEQUENCE;
  1176. } else {
  1177. start_mode = VisualScriptNodeInstance::START_MODE_BEGIN_SEQUENCE;
  1178. }
  1179. }
  1180. VSDEBUG("STEP - STARTSEQ: " + itos(start_mode));
  1181. int ret = node->step(input_args, output_args, start_mode, working_mem, r_error, error_str);
  1182. if (r_error.error != Callable::CallError::CALL_OK) {
  1183. // Use error from step.
  1184. error = true;
  1185. break;
  1186. }
  1187. if (ret & VisualScriptNodeInstance::STEP_YIELD_BIT) {
  1188. // Yielded!
  1189. if (node->get_working_memory_size() == 0) {
  1190. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1191. error_str = RTR("A node yielded without working memory, please read the docs on how to yield properly!");
  1192. error = true;
  1193. break;
  1194. } else {
  1195. Ref<VisualScriptFunctionState> state = *working_mem;
  1196. if (!state.is_valid()) {
  1197. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1198. error_str = RTR("Node yielded, but did not return a function state in the first working memory.");
  1199. error = true;
  1200. break;
  1201. }
  1202. // Step 1, capture all state.
  1203. state->instance_id = get_owner_ptr()->get_instance_id();
  1204. state->script_id = get_script()->get_instance_id();
  1205. state->instance = this;
  1206. state->function = p_method;
  1207. state->working_mem_index = node->working_mem_idx;
  1208. state->variant_stack_size = f->max_stack;
  1209. state->node = node;
  1210. state->flow_stack_pos = flow_stack_pos;
  1211. state->stack.resize(p_stack_size);
  1212. state->pass = p_pass;
  1213. memcpy(state->stack.ptrw(), p_stack, p_stack_size);
  1214. // Step 2, run away, return directly.
  1215. r_error.error = Callable::CallError::CALL_OK;
  1216. #ifdef DEBUG_ENABLED
  1217. // Will re-enter later, so exiting.
  1218. if (EngineDebugger::is_active()) {
  1219. VisualScriptLanguage::singleton->exit_function();
  1220. }
  1221. #endif
  1222. return state;
  1223. }
  1224. }
  1225. #ifdef DEBUG_ENABLED
  1226. if (EngineDebugger::is_active()) {
  1227. // line
  1228. bool do_break = false;
  1229. if (EngineDebugger::get_script_debugger()->get_lines_left() > 0) {
  1230. if (EngineDebugger::get_script_debugger()->get_depth() <= 0) {
  1231. EngineDebugger::get_script_debugger()->set_lines_left(EngineDebugger::get_script_debugger()->get_lines_left() - 1);
  1232. }
  1233. if (EngineDebugger::get_script_debugger()->get_lines_left() <= 0) {
  1234. do_break = true;
  1235. }
  1236. }
  1237. if (EngineDebugger::get_script_debugger()->is_breakpoint(current_node_id, source)) {
  1238. do_break = true;
  1239. }
  1240. if (do_break) {
  1241. VisualScriptLanguage::singleton->debug_break("Breakpoint", true);
  1242. }
  1243. EngineDebugger::get_singleton()->line_poll();
  1244. }
  1245. #endif
  1246. int output = ret & VisualScriptNodeInstance::STEP_MASK;
  1247. VSDEBUG("STEP RETURN: " + itos(ret));
  1248. if (ret & VisualScriptNodeInstance::STEP_EXIT_FUNCTION_BIT) {
  1249. if (node->get_working_memory_size() == 0) {
  1250. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1251. error_str = RTR("Return value must be assigned to first element of node working memory! Fix your node please.");
  1252. error = true;
  1253. } else {
  1254. // Assign from working memory, first element.
  1255. return_value = *working_mem;
  1256. }
  1257. VSDEBUG("EXITING FUNCTION - VALUE " + String(return_value));
  1258. break; // Exit function requested, bye
  1259. }
  1260. VisualScriptNodeInstance *next = nullptr; // Next node.
  1261. if ((ret == output || ret & VisualScriptNodeInstance::STEP_FLAG_PUSH_STACK_BIT) && node->sequence_output_count) {
  1262. // If no exit bit was set, and has sequence outputs, guess next node.
  1263. if (output >= node->sequence_output_count) {
  1264. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1265. error_str = RTR("Node returned an invalid sequence output: ") + itos(output);
  1266. error = true;
  1267. break;
  1268. }
  1269. next = node->sequence_outputs[output];
  1270. VSDEBUG("GOT NEXT NODE - " + (next ? itos(next->get_id()) : "Null"));
  1271. }
  1272. if (flow_stack) {
  1273. // Update flow stack pos (may have changed).
  1274. flow_stack[flow_stack_pos] = current_node_id;
  1275. // Add stack push bit if requested.
  1276. if (ret & VisualScriptNodeInstance::STEP_FLAG_PUSH_STACK_BIT) {
  1277. flow_stack[flow_stack_pos] |= VisualScriptNodeInstance::FLOW_STACK_PUSHED_BIT;
  1278. sequence_bits[node->sequence_index] = true; // Remember sequence bit.
  1279. VSDEBUG("NEXT SEQ - FLAG BIT");
  1280. } else {
  1281. sequence_bits[node->sequence_index] = false; // Forget sequence bit.
  1282. VSDEBUG("NEXT SEQ - NORMAL");
  1283. }
  1284. if (ret & VisualScriptNodeInstance::STEP_FLAG_GO_BACK_BIT) {
  1285. // Go back request.
  1286. if (flow_stack_pos > 0) {
  1287. flow_stack_pos--;
  1288. node = instances[flow_stack[flow_stack_pos] & VisualScriptNodeInstance::FLOW_STACK_MASK];
  1289. VSDEBUG("NEXT IS GO BACK");
  1290. } else {
  1291. VSDEBUG("NEXT IS GO BACK, BUT NO NEXT SO EXIT");
  1292. break; // Simply exit without value or error.
  1293. }
  1294. } else if (next) {
  1295. if (sequence_bits[next->sequence_index]) {
  1296. // What happened here is that we are entering a node that is in the middle of doing a sequence (pushed stack) from the front
  1297. // because each node has a working memory, we can't really do a sub-sequence
  1298. // as a result, the sequence will be restarted and the stack will roll back to find where this node
  1299. // started the sequence.
  1300. bool found = false;
  1301. for (int i = flow_stack_pos; i >= 0; i--) {
  1302. if ((flow_stack[i] & VisualScriptNodeInstance::FLOW_STACK_MASK) == next->get_id()) {
  1303. flow_stack_pos = i; // Roll back and remove bit.
  1304. flow_stack[i] = next->get_id();
  1305. sequence_bits[next->sequence_index] = false;
  1306. found = true;
  1307. }
  1308. }
  1309. if (!found) {
  1310. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1311. error_str = RTR("Found sequence bit but not the node in the stack, report bug!");
  1312. error = true;
  1313. break;
  1314. }
  1315. node = next;
  1316. VSDEBUG("RE-ENTERED A LOOP, RETURNED STACK POS TO - " + itos(flow_stack_pos));
  1317. } else {
  1318. // Check for stack overflow.
  1319. if (flow_stack_pos + 1 >= flow_max) {
  1320. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1321. error_str = RTR("Stack overflow with stack depth: ") + itos(output);
  1322. error = true;
  1323. break;
  1324. }
  1325. node = next;
  1326. flow_stack_pos++;
  1327. flow_stack[flow_stack_pos] = node->get_id();
  1328. VSDEBUG("INCREASE FLOW STACK");
  1329. }
  1330. } else {
  1331. // No next node, try to go back in stack to pushed bit.
  1332. bool found = false;
  1333. for (int i = flow_stack_pos; i >= 0; i--) {
  1334. VSDEBUG("FS " + itos(i) + " - " + itos(flow_stack[i]));
  1335. if (flow_stack[i] & VisualScriptNodeInstance::FLOW_STACK_PUSHED_BIT) {
  1336. node = instances[flow_stack[i] & VisualScriptNodeInstance::FLOW_STACK_MASK];
  1337. flow_stack_pos = i;
  1338. found = true;
  1339. break;
  1340. }
  1341. }
  1342. if (!found) {
  1343. VSDEBUG("NO NEXT NODE, NO GO BACK, EXITING");
  1344. break; // Done, couldn't find a push stack bit.
  1345. }
  1346. VSDEBUG("NO NEXT NODE, GO BACK TO: " + itos(flow_stack_pos));
  1347. }
  1348. } else {
  1349. node = next; // Stackless mode, simply assign next node.
  1350. }
  1351. }
  1352. if (error) {
  1353. // Error
  1354. // Function, file, line, error, explanation.
  1355. String err_file = script->get_path();
  1356. String err_func = p_method;
  1357. int err_line = current_node_id; // Not a line but it works as one.
  1358. if (node && (r_error.error != Callable::CallError::CALL_ERROR_INVALID_METHOD || error_str == String())) {
  1359. if (error_str != String()) {
  1360. error_str += " ";
  1361. }
  1362. if (r_error.error == Callable::CallError::CALL_ERROR_INVALID_ARGUMENT) {
  1363. int errorarg = r_error.argument;
  1364. error_str += "Cannot convert argument " + itos(errorarg + 1) + " to " + Variant::get_type_name(Variant::Type(r_error.expected)) + ".";
  1365. } else if (r_error.error == Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS) {
  1366. error_str += "Expected " + itos(r_error.argument) + " arguments.";
  1367. } else if (r_error.error == Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS) {
  1368. error_str += "Expected " + itos(r_error.argument) + " arguments.";
  1369. } else if (r_error.error == Callable::CallError::CALL_ERROR_INVALID_METHOD) {
  1370. error_str += "Invalid Call.";
  1371. } else if (r_error.error == Callable::CallError::CALL_ERROR_INSTANCE_IS_NULL) {
  1372. error_str += "Base Instance is null";
  1373. }
  1374. }
  1375. //if (!GDScriptLanguage::get_singleton()->debug_break(err_text,false)) {
  1376. // debugger break did not happen
  1377. if (!VisualScriptLanguage::singleton->debug_break(error_str, false)) {
  1378. _err_print_error(err_func.utf8().get_data(), err_file.utf8().get_data(), err_line, error_str.utf8().get_data(), false, ERR_HANDLER_SCRIPT);
  1379. }
  1380. //}
  1381. } else {
  1382. //return_value=
  1383. }
  1384. #ifdef DEBUG_ENABLED
  1385. if (EngineDebugger::is_active()) {
  1386. VisualScriptLanguage::singleton->exit_function();
  1387. }
  1388. #endif
  1389. // Clean up variant stack.
  1390. for (int i = 0; i < f->max_stack; i++) {
  1391. variant_stack[i].~Variant();
  1392. }
  1393. return return_value;
  1394. }
  1395. Variant VisualScriptInstance::call(const StringName &p_method, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1396. r_error.error = Callable::CallError::CALL_OK; //ok by default
  1397. Map<StringName, Function>::Element *F = functions.find(p_method);
  1398. if (!F) {
  1399. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1400. return Variant();
  1401. }
  1402. VSDEBUG("CALLING: " + String(p_method));
  1403. Function *f = &F->get();
  1404. int total_stack_size = 0;
  1405. total_stack_size += f->max_stack * sizeof(Variant); //variants
  1406. total_stack_size += f->node_count * sizeof(bool);
  1407. total_stack_size += (max_input_args + max_output_args) * sizeof(Variant *); //arguments
  1408. total_stack_size += f->flow_stack_size * sizeof(int); //flow
  1409. total_stack_size += f->pass_stack_size * sizeof(int);
  1410. VSDEBUG("STACK SIZE: " + itos(total_stack_size));
  1411. VSDEBUG("STACK VARIANTS: : " + itos(f->max_stack));
  1412. VSDEBUG("SEQBITS: : " + itos(f->node_count));
  1413. VSDEBUG("MAX INPUT: " + itos(max_input_args));
  1414. VSDEBUG("MAX OUTPUT: " + itos(max_output_args));
  1415. VSDEBUG("FLOW STACK SIZE: " + itos(f->flow_stack_size));
  1416. VSDEBUG("PASS STACK SIZE: " + itos(f->pass_stack_size));
  1417. void *stack = alloca(total_stack_size);
  1418. Variant *variant_stack = (Variant *)stack;
  1419. bool *sequence_bits = (bool *)(variant_stack + f->max_stack);
  1420. const Variant **input_args = (const Variant **)(sequence_bits + f->node_count);
  1421. Variant **output_args = (Variant **)(input_args + max_input_args);
  1422. int flow_max = f->flow_stack_size;
  1423. int *flow_stack = flow_max ? (int *)(output_args + max_output_args) : (int *)nullptr;
  1424. int *pass_stack = flow_stack ? (int *)(flow_stack + flow_max) : (int *)nullptr;
  1425. for (int i = 0; i < f->node_count; i++) {
  1426. sequence_bits[i] = false; // All starts as false.
  1427. }
  1428. memset(pass_stack, 0, f->pass_stack_size * sizeof(int));
  1429. Map<int, VisualScriptNodeInstance *>::Element *E = instances.find(f->node);
  1430. if (!E) {
  1431. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1432. ERR_FAIL_V_MSG(Variant(), "No VisualScriptFunction node in function.");
  1433. }
  1434. VisualScriptNodeInstance *node = E->get();
  1435. if (flow_stack) {
  1436. flow_stack[0] = node->get_id();
  1437. }
  1438. VSDEBUG("ARGUMENTS: " + itos(f->argument_count) = " RECEIVED: " + itos(p_argcount));
  1439. if (p_argcount < f->argument_count) {
  1440. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1441. r_error.argument = node->get_input_port_count();
  1442. return Variant();
  1443. }
  1444. if (p_argcount > f->argument_count) {
  1445. r_error.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  1446. r_error.argument = node->get_input_port_count();
  1447. return Variant();
  1448. }
  1449. // Allocate variant stack.
  1450. for (int i = 0; i < f->max_stack; i++) {
  1451. memnew_placement(&variant_stack[i], Variant);
  1452. }
  1453. // Allocate function arguments (must be copied for yield to work properly).
  1454. for (int i = 0; i < p_argcount; i++) {
  1455. variant_stack[i] = *p_args[i];
  1456. }
  1457. return _call_internal(p_method, stack, total_stack_size, node, 0, 0, false, r_error);
  1458. }
  1459. void VisualScriptInstance::notification(int p_notification) {
  1460. // Do nothing as this is called using virtual.
  1461. Variant what = p_notification;
  1462. const Variant *whatp = &what;
  1463. Callable::CallError ce;
  1464. call(VisualScriptLanguage::singleton->notification, &whatp, 1, ce); // Do as call.
  1465. }
  1466. String VisualScriptInstance::to_string(bool *r_valid) {
  1467. if (has_method(CoreStringNames::get_singleton()->_to_string)) {
  1468. Callable::CallError ce;
  1469. Variant ret = call(CoreStringNames::get_singleton()->_to_string, nullptr, 0, ce);
  1470. if (ce.error == Callable::CallError::CALL_OK) {
  1471. if (ret.get_type() != Variant::STRING) {
  1472. if (r_valid) {
  1473. *r_valid = false;
  1474. }
  1475. ERR_FAIL_V_MSG(String(), "Wrong type for " + CoreStringNames::get_singleton()->_to_string + ", must be a String.");
  1476. }
  1477. if (r_valid) {
  1478. *r_valid = true;
  1479. }
  1480. return ret.operator String();
  1481. }
  1482. }
  1483. if (r_valid) {
  1484. *r_valid = false;
  1485. }
  1486. return String();
  1487. }
  1488. Ref<Script> VisualScriptInstance::get_script() const {
  1489. return script;
  1490. }
  1491. const Vector<Multiplayer::RPCConfig> VisualScriptInstance::get_rpc_methods() const {
  1492. return script->get_rpc_methods();
  1493. }
  1494. void VisualScriptInstance::create(const Ref<VisualScript> &p_script, Object *p_owner) {
  1495. script = p_script;
  1496. owner = p_owner;
  1497. source = p_script->get_path();
  1498. max_input_args = 0;
  1499. max_output_args = 0;
  1500. // Setup variables.
  1501. {
  1502. List<StringName> keys;
  1503. script->variables.get_key_list(&keys);
  1504. for (const StringName &E : keys) {
  1505. variables[E] = script->variables[E].default_value;
  1506. }
  1507. }
  1508. // Setup functions from sequence trees.
  1509. {
  1510. List<StringName> keys;
  1511. script->functions.get_key_list(&keys);
  1512. for (const StringName &E : keys) {
  1513. const VisualScript::Function vsfn = p_script->functions[E];
  1514. Function function;
  1515. function.node = vsfn.func_id;
  1516. function.max_stack = 0;
  1517. function.flow_stack_size = 0;
  1518. function.pass_stack_size = 0;
  1519. function.node_count = 0;
  1520. Map<StringName, int> local_var_indices;
  1521. if (function.node < 0) {
  1522. VisualScriptLanguage::singleton->debug_break_parse(get_script()->get_path(), 0, "No start node in function: " + String(E));
  1523. ERR_CONTINUE(function.node < 0);
  1524. }
  1525. {
  1526. Ref<VisualScriptFunction> func_node = script->get_node(vsfn.func_id);
  1527. if (func_node.is_null()) {
  1528. VisualScriptLanguage::singleton->debug_break_parse(get_script()->get_path(), 0, "No VisualScriptFunction typed start node in function: " + String(E));
  1529. }
  1530. ERR_CONTINUE(!func_node.is_valid());
  1531. function.argument_count = func_node->get_argument_count();
  1532. function.max_stack += function.argument_count;
  1533. function.flow_stack_size = func_node->is_stack_less() ? 0 : func_node->get_stack_size();
  1534. max_input_args = MAX(max_input_args, function.argument_count);
  1535. }
  1536. // Function nodes graphs.
  1537. Set<VisualScript::SequenceConnection> seqconns;
  1538. Set<VisualScript::DataConnection> dataconns;
  1539. Set<int> node_ids;
  1540. node_ids.insert(function.node);
  1541. {
  1542. List<int> nd_queue;
  1543. nd_queue.push_back(function.node);
  1544. while (!nd_queue.is_empty()) {
  1545. for (const Set<VisualScript::SequenceConnection>::Element *F = script->sequence_connections.front(); F; F = F->next()) {
  1546. if (nd_queue.front()->get() == F->get().from_node && !node_ids.has(F->get().to_node)) {
  1547. nd_queue.push_back(F->get().to_node);
  1548. node_ids.insert(F->get().to_node);
  1549. }
  1550. if (nd_queue.front()->get() == F->get().from_node && !seqconns.has(F->get())) {
  1551. seqconns.insert(F->get());
  1552. }
  1553. }
  1554. nd_queue.pop_front();
  1555. }
  1556. HashMap<int, HashMap<int, Pair<int, int>>> dc_lut; // :: to -> to_port -> (from, from_port)
  1557. for (const Set<VisualScript::DataConnection>::Element *F = script->data_connections.front(); F; F = F->next()) {
  1558. dc_lut[F->get().to_node][F->get().to_port] = Pair<int, int>(F->get().from_node, F->get().from_port);
  1559. }
  1560. for (const Set<int>::Element *F = node_ids.front(); F; F = F->next()) {
  1561. nd_queue.push_back(F->get());
  1562. }
  1563. List<int> dc_keys;
  1564. while (!nd_queue.is_empty()) {
  1565. int ky = nd_queue.front()->get();
  1566. dc_lut[ky].get_key_list(&dc_keys);
  1567. for (const int &F : dc_keys) {
  1568. VisualScript::DataConnection dc;
  1569. dc.from_node = dc_lut[ky][F].first;
  1570. dc.from_port = dc_lut[ky][F].second;
  1571. dc.to_node = ky;
  1572. dc.to_port = F;
  1573. dataconns.insert(dc);
  1574. nd_queue.push_back(dc.from_node);
  1575. node_ids.insert(dc.from_node);
  1576. }
  1577. dc_keys.clear(); // Necessary as get_key_list does a push_back not a set.
  1578. nd_queue.pop_front();
  1579. }
  1580. }
  1581. //Multiple passes are required to set up this complex thing..
  1582. //First create the nodes.
  1583. for (const Set<int>::Element *F = node_ids.front(); F; F = F->next()) {
  1584. Ref<VisualScriptNode> node = script->nodes[F->get()].node;
  1585. VisualScriptNodeInstance *instance = node->instantiate(this); // Create instance.
  1586. ERR_FAIL_COND(!instance);
  1587. instance->base = node.ptr();
  1588. instance->id = F->get();
  1589. instance->input_port_count = node->get_input_value_port_count();
  1590. instance->input_ports = nullptr;
  1591. instance->output_port_count = node->get_output_value_port_count();
  1592. instance->output_ports = nullptr;
  1593. instance->sequence_output_count = node->get_output_sequence_port_count();
  1594. instance->sequence_index = function.node_count++;
  1595. instance->sequence_outputs = nullptr;
  1596. instance->pass_idx = -1;
  1597. if (instance->input_port_count) {
  1598. instance->input_ports = memnew_arr(int, instance->input_port_count);
  1599. for (int i = 0; i < instance->input_port_count; i++) {
  1600. instance->input_ports[i] = -1; // If not assigned, will become default value.
  1601. }
  1602. }
  1603. if (instance->output_port_count) {
  1604. instance->output_ports = memnew_arr(int, instance->output_port_count);
  1605. for (int i = 0; i < instance->output_port_count; i++) {
  1606. instance->output_ports[i] = -1; // If not assigned, will output to trash.
  1607. }
  1608. }
  1609. if (instance->sequence_output_count) {
  1610. instance->sequence_outputs = memnew_arr(VisualScriptNodeInstance *, instance->sequence_output_count);
  1611. for (int i = 0; i < instance->sequence_output_count; i++) {
  1612. instance->sequence_outputs[i] = nullptr; // If it remains null, flow ends here.
  1613. }
  1614. }
  1615. if (Object::cast_to<VisualScriptLocalVar>(node.ptr()) || Object::cast_to<VisualScriptLocalVarSet>(*node)) {
  1616. // Working memory is shared only for this node, for the same variables.
  1617. Ref<VisualScriptLocalVar> vslv = node;
  1618. StringName var_name;
  1619. if (Object::cast_to<VisualScriptLocalVar>(*node)) {
  1620. var_name = String(Object::cast_to<VisualScriptLocalVar>(*node)->get_var_name()).strip_edges();
  1621. } else {
  1622. var_name = String(Object::cast_to<VisualScriptLocalVarSet>(*node)->get_var_name()).strip_edges();
  1623. }
  1624. if (!local_var_indices.has(var_name)) {
  1625. local_var_indices[var_name] = function.max_stack;
  1626. function.max_stack++;
  1627. }
  1628. instance->working_mem_idx = local_var_indices[var_name];
  1629. } else if (instance->get_working_memory_size()) {
  1630. instance->working_mem_idx = function.max_stack;
  1631. function.max_stack += instance->get_working_memory_size();
  1632. } else {
  1633. instance->working_mem_idx = -1; //no working mem
  1634. }
  1635. max_input_args = MAX(max_input_args, instance->input_port_count);
  1636. max_output_args = MAX(max_output_args, instance->output_port_count);
  1637. instances[F->get()] = instance;
  1638. }
  1639. function.trash_pos = function.max_stack++; // create pos for trash
  1640. // Second pass, do data connections.
  1641. for (const Set<VisualScript::DataConnection>::Element *F = dataconns.front(); F; F = F->next()) {
  1642. VisualScript::DataConnection dc = F->get();
  1643. ERR_CONTINUE(!instances.has(dc.from_node));
  1644. VisualScriptNodeInstance *from = instances[dc.from_node];
  1645. ERR_CONTINUE(!instances.has(dc.to_node));
  1646. VisualScriptNodeInstance *to = instances[dc.to_node];
  1647. ERR_CONTINUE(dc.from_port >= from->output_port_count);
  1648. ERR_CONTINUE(dc.to_port >= to->input_port_count);
  1649. if (from->output_ports[dc.from_port] == -1) {
  1650. int stack_pos = function.max_stack++;
  1651. from->output_ports[dc.from_port] = stack_pos;
  1652. }
  1653. if (from->get_sequence_output_count() == 0 && to->dependencies.find(from) == -1) {
  1654. // If the node we are reading from has no output sequence, we must call step() before reading from it.
  1655. if (from->pass_idx == -1) {
  1656. from->pass_idx = function.pass_stack_size;
  1657. function.pass_stack_size++;
  1658. }
  1659. to->dependencies.push_back(from);
  1660. }
  1661. to->input_ports[dc.to_port] = from->output_ports[dc.from_port]; // Read from wherever the stack is.
  1662. }
  1663. // Third pass, do sequence connections.
  1664. for (const Set<VisualScript::SequenceConnection>::Element *F = seqconns.front(); F; F = F->next()) {
  1665. VisualScript::SequenceConnection sc = F->get();
  1666. ERR_CONTINUE(!instances.has(sc.from_node));
  1667. VisualScriptNodeInstance *from = instances[sc.from_node];
  1668. ERR_CONTINUE(!instances.has(sc.to_node));
  1669. VisualScriptNodeInstance *to = instances[sc.to_node];
  1670. ERR_CONTINUE(sc.from_output >= from->sequence_output_count);
  1671. from->sequence_outputs[sc.from_output] = to;
  1672. }
  1673. //fourth pass:
  1674. // 1) unassigned input ports to default values
  1675. // 2) connect unassigned output ports to trash
  1676. for (const Set<int>::Element *F = node_ids.front(); F; F = F->next()) {
  1677. ERR_CONTINUE(!instances.has(F->get()));
  1678. Ref<VisualScriptNode> node = script->nodes[F->get()].node;
  1679. VisualScriptNodeInstance *instance = instances[F->get()];
  1680. // Connect to default values.
  1681. for (int i = 0; i < instance->input_port_count; i++) {
  1682. if (instance->input_ports[i] == -1) {
  1683. // Unassigned, connect to default val.
  1684. instance->input_ports[i] = default_values.size() | VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT;
  1685. default_values.push_back(node->get_default_input_value(i));
  1686. }
  1687. }
  1688. // Connect to trash.
  1689. for (int i = 0; i < instance->output_port_count; i++) {
  1690. if (instance->output_ports[i] == -1) {
  1691. instance->output_ports[i] = function.trash_pos; //trash is same for all
  1692. }
  1693. }
  1694. }
  1695. functions[E] = function;
  1696. }
  1697. }
  1698. }
  1699. ScriptLanguage *VisualScriptInstance::get_language() {
  1700. return VisualScriptLanguage::singleton;
  1701. }
  1702. VisualScriptInstance::VisualScriptInstance() {
  1703. }
  1704. VisualScriptInstance::~VisualScriptInstance() {
  1705. {
  1706. MutexLock lock(VisualScriptLanguage::singleton->lock);
  1707. script->instances.erase(owner);
  1708. }
  1709. for (const KeyValue<int, VisualScriptNodeInstance *> &E : instances) {
  1710. memdelete(E.value);
  1711. }
  1712. }
  1713. /////////////////////////////////////////////
  1714. /////////////////////
  1715. Variant VisualScriptFunctionState::_signal_callback(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1716. ERR_FAIL_COND_V(function == StringName(), Variant());
  1717. #ifdef DEBUG_ENABLED
  1718. ERR_FAIL_COND_V_MSG(instance_id.is_valid() && !ObjectDB::get_instance(instance_id), Variant(), "Resumed after yield, but class instance is gone.");
  1719. ERR_FAIL_COND_V_MSG(script_id.is_valid() && !ObjectDB::get_instance(script_id), Variant(), "Resumed after yield, but script is gone.");
  1720. #endif
  1721. r_error.error = Callable::CallError::CALL_OK;
  1722. Array args;
  1723. if (p_argcount == 0) {
  1724. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1725. r_error.argument = 1;
  1726. return Variant();
  1727. } else if (p_argcount == 1) {
  1728. //noooneee, reserved for me, me and only me.
  1729. } else {
  1730. for (int i = 0; i < p_argcount - 1; i++) {
  1731. args.push_back(*p_args[i]);
  1732. }
  1733. }
  1734. Ref<VisualScriptFunctionState> self = *p_args[p_argcount - 1]; //hi, I'm myself, needed this to remain alive.
  1735. if (self.is_null()) {
  1736. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  1737. r_error.argument = p_argcount - 1;
  1738. r_error.expected = Variant::OBJECT;
  1739. return Variant();
  1740. }
  1741. r_error.error = Callable::CallError::CALL_OK;
  1742. Variant *working_mem = ((Variant *)stack.ptr()) + working_mem_index;
  1743. *working_mem = args; // Arguments go to working mem.
  1744. Variant ret = instance->_call_internal(function, stack.ptrw(), stack.size(), node, flow_stack_pos, pass, true, r_error);
  1745. function = StringName(); //invalidate
  1746. return ret;
  1747. }
  1748. void VisualScriptFunctionState::connect_to_signal(Object *p_obj, const String &p_signal, Array p_binds) {
  1749. ERR_FAIL_NULL(p_obj);
  1750. Vector<Variant> binds;
  1751. for (int i = 0; i < p_binds.size(); i++) {
  1752. binds.push_back(p_binds[i]);
  1753. }
  1754. binds.push_back(Ref<VisualScriptFunctionState>(this)); //add myself on the back to avoid dying from unreferencing
  1755. p_obj->connect(p_signal, Callable(this, "_signal_callback"), binds, CONNECT_ONESHOT);
  1756. }
  1757. bool VisualScriptFunctionState::is_valid() const {
  1758. return function != StringName();
  1759. }
  1760. Variant VisualScriptFunctionState::resume(Array p_args) {
  1761. ERR_FAIL_COND_V(function == StringName(), Variant());
  1762. #ifdef DEBUG_ENABLED
  1763. ERR_FAIL_COND_V_MSG(instance_id.is_valid() && !ObjectDB::get_instance(instance_id), Variant(), "Resumed after yield, but class instance is gone.");
  1764. ERR_FAIL_COND_V_MSG(script_id.is_valid() && !ObjectDB::get_instance(script_id), Variant(), "Resumed after yield, but script is gone.");
  1765. #endif
  1766. Callable::CallError r_error;
  1767. r_error.error = Callable::CallError::CALL_OK;
  1768. Variant *working_mem = ((Variant *)stack.ptr()) + working_mem_index;
  1769. *working_mem = p_args; // Arguments go to working mem.
  1770. Variant ret = instance->_call_internal(function, stack.ptrw(), stack.size(), node, flow_stack_pos, pass, true, r_error);
  1771. function = StringName(); //invalidate
  1772. return ret;
  1773. }
  1774. void VisualScriptFunctionState::_bind_methods() {
  1775. ClassDB::bind_method(D_METHOD("connect_to_signal", "obj", "signals", "args"), &VisualScriptFunctionState::connect_to_signal);
  1776. ClassDB::bind_method(D_METHOD("resume", "args"), &VisualScriptFunctionState::resume, DEFVAL(Array()));
  1777. ClassDB::bind_method(D_METHOD("is_valid"), &VisualScriptFunctionState::is_valid);
  1778. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "_signal_callback", &VisualScriptFunctionState::_signal_callback, MethodInfo("_signal_callback"));
  1779. }
  1780. VisualScriptFunctionState::VisualScriptFunctionState() {
  1781. }
  1782. VisualScriptFunctionState::~VisualScriptFunctionState() {
  1783. if (function != StringName()) {
  1784. Variant *s = ((Variant *)stack.ptr());
  1785. for (int i = 0; i < variant_stack_size; i++) {
  1786. s[i].~Variant();
  1787. }
  1788. }
  1789. }
  1790. ///////////////////////////////////////////////
  1791. String VisualScriptLanguage::get_name() const {
  1792. return "VisualScript";
  1793. }
  1794. /* LANGUAGE FUNCTIONS */
  1795. void VisualScriptLanguage::init() {
  1796. }
  1797. String VisualScriptLanguage::get_type() const {
  1798. return "VisualScript";
  1799. }
  1800. String VisualScriptLanguage::get_extension() const {
  1801. return "vs";
  1802. }
  1803. Error VisualScriptLanguage::execute_file(const String &p_path) {
  1804. return OK;
  1805. }
  1806. void VisualScriptLanguage::finish() {
  1807. }
  1808. /* EDITOR FUNCTIONS */
  1809. void VisualScriptLanguage::get_reserved_words(List<String> *p_words) const {
  1810. }
  1811. bool VisualScriptLanguage::is_control_flow_keyword(String p_keyword) const {
  1812. return false;
  1813. }
  1814. void VisualScriptLanguage::get_comment_delimiters(List<String> *p_delimiters) const {
  1815. }
  1816. void VisualScriptLanguage::get_string_delimiters(List<String> *p_delimiters) const {
  1817. }
  1818. Ref<Script> VisualScriptLanguage::get_template(const String &p_class_name, const String &p_base_class_name) const {
  1819. Ref<VisualScript> script;
  1820. script.instantiate();
  1821. script->set_instance_base_type(p_base_class_name);
  1822. return script;
  1823. }
  1824. bool VisualScriptLanguage::is_using_templates() {
  1825. return true;
  1826. }
  1827. void VisualScriptLanguage::make_template(const String &p_class_name, const String &p_base_class_name, Ref<Script> &p_script) {
  1828. Ref<VisualScript> script = p_script;
  1829. script->set_instance_base_type(p_base_class_name);
  1830. }
  1831. 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 {
  1832. return false;
  1833. }
  1834. Script *VisualScriptLanguage::create_script() const {
  1835. return memnew(VisualScript);
  1836. }
  1837. bool VisualScriptLanguage::has_named_classes() const {
  1838. return false;
  1839. }
  1840. bool VisualScriptLanguage::supports_builtin_mode() const {
  1841. return true;
  1842. }
  1843. int VisualScriptLanguage::find_function(const String &p_function, const String &p_code) const {
  1844. return -1;
  1845. }
  1846. String VisualScriptLanguage::make_function(const String &p_class, const String &p_name, const PackedStringArray &p_args) const {
  1847. return String();
  1848. }
  1849. void VisualScriptLanguage::auto_indent_code(String &p_code, int p_from_line, int p_to_line) const {
  1850. }
  1851. void VisualScriptLanguage::add_global_constant(const StringName &p_variable, const Variant &p_value) {
  1852. }
  1853. /* DEBUGGER FUNCTIONS */
  1854. bool VisualScriptLanguage::debug_break_parse(const String &p_file, int p_node, const String &p_error) {
  1855. // Break because of parse error.
  1856. if (EngineDebugger::is_active() && Thread::get_caller_id() == Thread::get_main_id()) {
  1857. _debug_parse_err_node = p_node;
  1858. _debug_parse_err_file = p_file;
  1859. _debug_error = p_error;
  1860. EngineDebugger::get_script_debugger()->debug(this, false, true);
  1861. return true;
  1862. } else {
  1863. return false;
  1864. }
  1865. }
  1866. bool VisualScriptLanguage::debug_break(const String &p_error, bool p_allow_continue) {
  1867. if (EngineDebugger::is_active() && Thread::get_caller_id() == Thread::get_main_id()) {
  1868. _debug_parse_err_node = -1;
  1869. _debug_parse_err_file = "";
  1870. _debug_error = p_error;
  1871. EngineDebugger::get_script_debugger()->debug(this, p_allow_continue, true);
  1872. return true;
  1873. } else {
  1874. return false;
  1875. }
  1876. }
  1877. String VisualScriptLanguage::debug_get_error() const {
  1878. return _debug_error;
  1879. }
  1880. int VisualScriptLanguage::debug_get_stack_level_count() const {
  1881. if (_debug_parse_err_node >= 0) {
  1882. return 1;
  1883. }
  1884. return _debug_call_stack_pos;
  1885. }
  1886. int VisualScriptLanguage::debug_get_stack_level_line(int p_level) const {
  1887. if (_debug_parse_err_node >= 0) {
  1888. return _debug_parse_err_node;
  1889. }
  1890. ERR_FAIL_INDEX_V(p_level, _debug_call_stack_pos, -1);
  1891. int l = _debug_call_stack_pos - p_level - 1;
  1892. return *(_call_stack[l].current_id);
  1893. }
  1894. String VisualScriptLanguage::debug_get_stack_level_function(int p_level) const {
  1895. if (_debug_parse_err_node >= 0) {
  1896. return "";
  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].function;
  1901. }
  1902. String VisualScriptLanguage::debug_get_stack_level_source(int p_level) const {
  1903. if (_debug_parse_err_node >= 0) {
  1904. return _debug_parse_err_file;
  1905. }
  1906. ERR_FAIL_INDEX_V(p_level, _debug_call_stack_pos, "");
  1907. int l = _debug_call_stack_pos - p_level - 1;
  1908. return _call_stack[l].instance->get_script_ptr()->get_path();
  1909. }
  1910. 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) {
  1911. if (_debug_parse_err_node >= 0) {
  1912. return;
  1913. }
  1914. ERR_FAIL_INDEX(p_level, _debug_call_stack_pos);
  1915. int l = _debug_call_stack_pos - p_level - 1;
  1916. const StringName *f = _call_stack[l].function;
  1917. ERR_FAIL_COND(!_call_stack[l].instance->functions.has(*f));
  1918. //VisualScriptInstance::Function *func = &_call_stack[l].instance->functions[*f];
  1919. VisualScriptNodeInstance *node = _call_stack[l].instance->instances[*_call_stack[l].current_id];
  1920. ERR_FAIL_COND(!node);
  1921. p_locals->push_back("node_name");
  1922. p_values->push_back(node->get_base_node()->get_text());
  1923. for (int i = 0; i < node->input_port_count; i++) {
  1924. String name = node->get_base_node()->get_input_value_port_info(i).name;
  1925. if (name == String()) {
  1926. name = "in_" + itos(i);
  1927. }
  1928. p_locals->push_back("input/" + name);
  1929. //value is trickier
  1930. int in_from = node->input_ports[i];
  1931. int in_value = in_from & VisualScriptNodeInstance::INPUT_MASK;
  1932. if (in_from & VisualScriptNodeInstance::INPUT_DEFAULT_VALUE_BIT) {
  1933. p_values->push_back(_call_stack[l].instance->default_values[in_value]);
  1934. } else {
  1935. p_values->push_back(_call_stack[l].stack[in_value]);
  1936. }
  1937. }
  1938. for (int i = 0; i < node->output_port_count; i++) {
  1939. String name = node->get_base_node()->get_output_value_port_info(i).name;
  1940. if (name == String()) {
  1941. name = "out_" + itos(i);
  1942. }
  1943. p_locals->push_back("output/" + name);
  1944. //value is trickier
  1945. int in_from = node->output_ports[i];
  1946. p_values->push_back(_call_stack[l].stack[in_from]);
  1947. }
  1948. for (int i = 0; i < node->get_working_memory_size(); i++) {
  1949. p_locals->push_back("working_mem/mem_" + itos(i));
  1950. p_values->push_back((*_call_stack[l].work_mem)[i]);
  1951. }
  1952. /*
  1953. ERR_FAIL_INDEX(p_level,_debug_call_stack_pos);
  1954. VisualFunction *f = _call_stack[l].function;
  1955. List<Pair<StringName,int> > locals;
  1956. f->debug_get_stack_member_state(*_call_stack[l].line,&locals);
  1957. for( List<Pair<StringName,int> >::Element *E = locals.front();E;E=E->next() ) {
  1958. p_locals->push_back(E->get().first);
  1959. p_values->push_back(_call_stack[l].stack[E->get().second]);
  1960. }
  1961. */
  1962. }
  1963. 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) {
  1964. if (_debug_parse_err_node >= 0) {
  1965. return;
  1966. }
  1967. ERR_FAIL_INDEX(p_level, _debug_call_stack_pos);
  1968. int l = _debug_call_stack_pos - p_level - 1;
  1969. Ref<VisualScript> vs = _call_stack[l].instance->get_script();
  1970. if (vs.is_null()) {
  1971. return;
  1972. }
  1973. List<StringName> vars;
  1974. vs->get_variable_list(&vars);
  1975. for (const StringName &E : vars) {
  1976. Variant v;
  1977. if (_call_stack[l].instance->get_variable(E, &v)) {
  1978. p_members->push_back("variables/" + E);
  1979. p_values->push_back(v);
  1980. }
  1981. }
  1982. }
  1983. void VisualScriptLanguage::debug_get_globals(List<String> *p_locals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  1984. // No globals are really reachable in gdscript.
  1985. }
  1986. String VisualScriptLanguage::debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems, int p_max_depth) {
  1987. return "";
  1988. }
  1989. void VisualScriptLanguage::reload_all_scripts() {
  1990. }
  1991. void VisualScriptLanguage::reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) {
  1992. }
  1993. /* LOADER FUNCTIONS */
  1994. void VisualScriptLanguage::get_recognized_extensions(List<String> *p_extensions) const {
  1995. p_extensions->push_back("vs");
  1996. }
  1997. void VisualScriptLanguage::get_public_functions(List<MethodInfo> *p_functions) const {
  1998. }
  1999. void VisualScriptLanguage::get_public_constants(List<Pair<String, Variant>> *p_constants) const {
  2000. }
  2001. void VisualScriptLanguage::profiling_start() {
  2002. }
  2003. void VisualScriptLanguage::profiling_stop() {
  2004. }
  2005. int VisualScriptLanguage::profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) {
  2006. return 0;
  2007. }
  2008. int VisualScriptLanguage::profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) {
  2009. return 0;
  2010. }
  2011. VisualScriptLanguage *VisualScriptLanguage::singleton = nullptr;
  2012. void VisualScriptLanguage::add_register_func(const String &p_name, VisualScriptNodeRegisterFunc p_func) {
  2013. ERR_FAIL_COND(register_funcs.has(p_name));
  2014. register_funcs[p_name] = p_func;
  2015. }
  2016. void VisualScriptLanguage::remove_register_func(const String &p_name) {
  2017. ERR_FAIL_COND(!register_funcs.has(p_name));
  2018. register_funcs.erase(p_name);
  2019. }
  2020. Ref<VisualScriptNode> VisualScriptLanguage::create_node_from_name(const String &p_name) {
  2021. ERR_FAIL_COND_V(!register_funcs.has(p_name), Ref<VisualScriptNode>());
  2022. return register_funcs[p_name](p_name);
  2023. }
  2024. void VisualScriptLanguage::get_registered_node_names(List<String> *r_names) {
  2025. for (const KeyValue<String, VisualScriptNodeRegisterFunc> &E : register_funcs) {
  2026. r_names->push_back(E.key);
  2027. }
  2028. }
  2029. VisualScriptLanguage::VisualScriptLanguage() {
  2030. singleton = this;
  2031. int dmcs = GLOBAL_DEF("debug/settings/visual_script/max_call_stack", 1024);
  2032. 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
  2033. if (EngineDebugger::is_active()) {
  2034. // Debugging enabled!
  2035. _debug_max_call_stack = dmcs;
  2036. _call_stack = memnew_arr(CallLevel, _debug_max_call_stack + 1);
  2037. } else {
  2038. _debug_max_call_stack = 0;
  2039. _call_stack = nullptr;
  2040. }
  2041. }
  2042. VisualScriptLanguage::~VisualScriptLanguage() {
  2043. if (_call_stack) {
  2044. memdelete_arr(_call_stack);
  2045. }
  2046. singleton = nullptr;
  2047. }