visual_script.cpp 82 KB

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