visual_script_nodes.h 31 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070
  1. /*************************************************************************/
  2. /* visual_script_nodes.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #ifndef VISUAL_SCRIPT_NODES_H
  31. #define VISUAL_SCRIPT_NODES_H
  32. #include "visual_script.h"
  33. class VisualScriptFunction : public VisualScriptNode {
  34. GDCLASS(VisualScriptFunction, VisualScriptNode);
  35. struct Argument {
  36. String name;
  37. Variant::Type type;
  38. PropertyHint hint;
  39. String hint_string;
  40. };
  41. Vector<Argument> arguments;
  42. bool stack_less;
  43. int stack_size;
  44. MultiplayerAPI::RPCMode rpc_mode;
  45. bool sequenced;
  46. protected:
  47. bool _set(const StringName &p_name, const Variant &p_value);
  48. bool _get(const StringName &p_name, Variant &r_ret) const;
  49. void _get_property_list(List<PropertyInfo> *p_list) const;
  50. public:
  51. virtual int get_output_sequence_port_count() const;
  52. virtual bool has_input_sequence_port() const;
  53. virtual String get_output_sequence_port_text(int p_port) const;
  54. virtual int get_input_value_port_count() const;
  55. virtual int get_output_value_port_count() const;
  56. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  57. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  58. virtual String get_caption() const;
  59. virtual String get_text() const;
  60. virtual String get_category() const { return "flow_control"; }
  61. void add_argument(Variant::Type p_type, const String &p_name, int p_index = -1, const PropertyHint p_hint = PROPERTY_HINT_NONE, const String &p_hint_string = String(""));
  62. void set_argument_type(int p_argidx, Variant::Type p_type);
  63. Variant::Type get_argument_type(int p_argidx) const;
  64. void set_argument_name(int p_argidx, const String &p_name);
  65. String get_argument_name(int p_argidx) const;
  66. void remove_argument(int p_argidx);
  67. int get_argument_count() const;
  68. void set_stack_less(bool p_enable);
  69. bool is_stack_less() const;
  70. void set_sequenced(bool p_enable);
  71. bool is_sequenced() const;
  72. void set_stack_size(int p_size);
  73. int get_stack_size() const;
  74. void set_return_type_enabled(bool p_returns);
  75. bool is_return_type_enabled() const;
  76. void set_return_type(Variant::Type p_type);
  77. Variant::Type get_return_type() const;
  78. void set_rpc_mode(MultiplayerAPI::RPCMode p_mode);
  79. MultiplayerAPI::RPCMode get_rpc_mode() const;
  80. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  81. VisualScriptFunction();
  82. };
  83. class VisualScriptLists : public VisualScriptNode {
  84. GDCLASS(VisualScriptLists, VisualScriptNode)
  85. struct Port {
  86. String name;
  87. Variant::Type type;
  88. };
  89. protected:
  90. Vector<Port> inputports;
  91. Vector<Port> outputports;
  92. enum {
  93. OUTPUT_EDITABLE = 0x0001,
  94. OUTPUT_NAME_EDITABLE = 0x0002,
  95. OUTPUT_TYPE_EDITABLE = 0x0004,
  96. INPUT_EDITABLE = 0x0008,
  97. INPUT_NAME_EDITABLE = 0x000F,
  98. INPUT_TYPE_EDITABLE = 0x0010,
  99. };
  100. int flags;
  101. bool sequenced;
  102. bool _set(const StringName &p_name, const Variant &p_value);
  103. bool _get(const StringName &p_name, Variant &r_ret) const;
  104. void _get_property_list(List<PropertyInfo> *p_list) const;
  105. static void _bind_methods();
  106. public:
  107. virtual bool is_output_port_editable() const;
  108. virtual bool is_output_port_name_editable() const;
  109. virtual bool is_output_port_type_editable() const;
  110. virtual bool is_input_port_editable() const;
  111. virtual bool is_input_port_name_editable() const;
  112. virtual bool is_input_port_type_editable() const;
  113. virtual int get_output_sequence_port_count() const;
  114. virtual bool has_input_sequence_port() const;
  115. virtual String get_output_sequence_port_text(int p_port) const;
  116. virtual int get_input_value_port_count() const;
  117. virtual int get_output_value_port_count() const;
  118. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  119. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  120. virtual String get_caption() const = 0;
  121. virtual String get_text() const = 0;
  122. virtual String get_category() const = 0;
  123. void add_input_data_port(Variant::Type p_type, const String &p_name, int p_index = -1);
  124. void set_input_data_port_type(int p_idx, Variant::Type p_type);
  125. void set_input_data_port_name(int p_idx, const String &p_name);
  126. void remove_input_data_port(int p_argidx);
  127. void add_output_data_port(Variant::Type p_type, const String &p_name, int p_index = -1);
  128. void set_output_data_port_type(int p_idx, Variant::Type p_type);
  129. void set_output_data_port_name(int p_idx, const String &p_name);
  130. void remove_output_data_port(int p_argidx);
  131. void set_sequenced(bool p_enable);
  132. bool is_sequenced() const;
  133. VisualScriptLists();
  134. };
  135. class VisualScriptComposeArray : public VisualScriptLists {
  136. GDCLASS(VisualScriptComposeArray, VisualScriptLists)
  137. public:
  138. virtual int get_output_sequence_port_count() const;
  139. virtual bool has_input_sequence_port() const;
  140. virtual String get_output_sequence_port_text(int p_port) const;
  141. virtual int get_input_value_port_count() const;
  142. virtual int get_output_value_port_count() const;
  143. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  144. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  145. virtual String get_caption() const;
  146. virtual String get_text() const;
  147. virtual String get_category() const { return "functions"; }
  148. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  149. VisualScriptComposeArray();
  150. };
  151. class VisualScriptOperator : public VisualScriptNode {
  152. GDCLASS(VisualScriptOperator, VisualScriptNode);
  153. Variant::Type typed;
  154. Variant::Operator op;
  155. protected:
  156. static void _bind_methods();
  157. public:
  158. virtual int get_output_sequence_port_count() const;
  159. virtual bool has_input_sequence_port() const;
  160. virtual String get_output_sequence_port_text(int p_port) const;
  161. virtual int get_input_value_port_count() const;
  162. virtual int get_output_value_port_count() const;
  163. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  164. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  165. virtual String get_caption() const;
  166. virtual String get_category() const { return "operators"; }
  167. void set_operator(Variant::Operator p_op);
  168. Variant::Operator get_operator() const;
  169. void set_typed(Variant::Type p_op);
  170. Variant::Type get_typed() const;
  171. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  172. VisualScriptOperator();
  173. };
  174. class VisualScriptSelect : public VisualScriptNode {
  175. GDCLASS(VisualScriptSelect, VisualScriptNode);
  176. Variant::Type typed;
  177. protected:
  178. static void _bind_methods();
  179. public:
  180. virtual int get_output_sequence_port_count() const;
  181. virtual bool has_input_sequence_port() const;
  182. virtual String get_output_sequence_port_text(int p_port) const;
  183. virtual int get_input_value_port_count() const;
  184. virtual int get_output_value_port_count() const;
  185. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  186. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  187. virtual String get_caption() const;
  188. virtual String get_text() const;
  189. virtual String get_category() const { return "operators"; }
  190. void set_typed(Variant::Type p_op);
  191. Variant::Type get_typed() const;
  192. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  193. VisualScriptSelect();
  194. };
  195. class VisualScriptVariableGet : public VisualScriptNode {
  196. GDCLASS(VisualScriptVariableGet, VisualScriptNode);
  197. StringName variable;
  198. protected:
  199. virtual void _validate_property(PropertyInfo &property) const;
  200. static void _bind_methods();
  201. public:
  202. virtual int get_output_sequence_port_count() const;
  203. virtual bool has_input_sequence_port() const;
  204. virtual String get_output_sequence_port_text(int p_port) const;
  205. virtual int get_input_value_port_count() const;
  206. virtual int get_output_value_port_count() const;
  207. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  208. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  209. virtual String get_caption() const;
  210. virtual String get_category() const { return "data"; }
  211. void set_variable(StringName p_variable);
  212. StringName get_variable() const;
  213. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  214. VisualScriptVariableGet();
  215. };
  216. class VisualScriptVariableSet : public VisualScriptNode {
  217. GDCLASS(VisualScriptVariableSet, VisualScriptNode);
  218. StringName variable;
  219. protected:
  220. virtual void _validate_property(PropertyInfo &property) const;
  221. static void _bind_methods();
  222. public:
  223. virtual int get_output_sequence_port_count() const;
  224. virtual bool has_input_sequence_port() const;
  225. virtual String get_output_sequence_port_text(int p_port) const;
  226. virtual int get_input_value_port_count() const;
  227. virtual int get_output_value_port_count() const;
  228. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  229. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  230. virtual String get_caption() const;
  231. virtual String get_category() const { return "data"; }
  232. void set_variable(StringName p_variable);
  233. StringName get_variable() const;
  234. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  235. VisualScriptVariableSet();
  236. };
  237. class VisualScriptConstant : public VisualScriptNode {
  238. GDCLASS(VisualScriptConstant, VisualScriptNode);
  239. Variant::Type type;
  240. Variant value;
  241. protected:
  242. virtual void _validate_property(PropertyInfo &property) const;
  243. static void _bind_methods();
  244. public:
  245. virtual int get_output_sequence_port_count() const;
  246. virtual bool has_input_sequence_port() const;
  247. virtual String get_output_sequence_port_text(int p_port) const;
  248. virtual int get_input_value_port_count() const;
  249. virtual int get_output_value_port_count() const;
  250. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  251. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  252. virtual String get_caption() const;
  253. virtual String get_category() const { return "constants"; }
  254. void set_constant_type(Variant::Type p_type);
  255. Variant::Type get_constant_type() const;
  256. void set_constant_value(Variant p_value);
  257. Variant get_constant_value() const;
  258. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  259. VisualScriptConstant();
  260. };
  261. class VisualScriptPreload : public VisualScriptNode {
  262. GDCLASS(VisualScriptPreload, VisualScriptNode);
  263. Ref<Resource> preload;
  264. protected:
  265. static void _bind_methods();
  266. public:
  267. virtual int get_output_sequence_port_count() const;
  268. virtual bool has_input_sequence_port() const;
  269. virtual String get_output_sequence_port_text(int p_port) const;
  270. virtual int get_input_value_port_count() const;
  271. virtual int get_output_value_port_count() const;
  272. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  273. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  274. virtual String get_caption() const;
  275. virtual String get_category() const { return "data"; }
  276. void set_preload(const Ref<Resource> &p_preload);
  277. Ref<Resource> get_preload() const;
  278. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  279. VisualScriptPreload();
  280. };
  281. class VisualScriptIndexGet : public VisualScriptNode {
  282. GDCLASS(VisualScriptIndexGet, VisualScriptNode);
  283. public:
  284. virtual int get_output_sequence_port_count() const;
  285. virtual bool has_input_sequence_port() const;
  286. virtual String get_output_sequence_port_text(int p_port) const;
  287. virtual int get_input_value_port_count() const;
  288. virtual int get_output_value_port_count() const;
  289. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  290. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  291. virtual String get_caption() const;
  292. virtual String get_category() const { return "operators"; }
  293. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  294. VisualScriptIndexGet();
  295. };
  296. class VisualScriptIndexSet : public VisualScriptNode {
  297. GDCLASS(VisualScriptIndexSet, VisualScriptNode);
  298. public:
  299. virtual int get_output_sequence_port_count() const;
  300. virtual bool has_input_sequence_port() const;
  301. virtual String get_output_sequence_port_text(int p_port) const;
  302. virtual int get_input_value_port_count() const;
  303. virtual int get_output_value_port_count() const;
  304. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  305. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  306. virtual String get_caption() const;
  307. virtual String get_category() const { return "operators"; }
  308. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  309. VisualScriptIndexSet();
  310. };
  311. class VisualScriptGlobalConstant : public VisualScriptNode {
  312. GDCLASS(VisualScriptGlobalConstant, VisualScriptNode);
  313. int index;
  314. static void _bind_methods();
  315. public:
  316. virtual int get_output_sequence_port_count() const;
  317. virtual bool has_input_sequence_port() const;
  318. virtual String get_output_sequence_port_text(int p_port) const;
  319. virtual int get_input_value_port_count() const;
  320. virtual int get_output_value_port_count() const;
  321. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  322. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  323. virtual String get_caption() const;
  324. virtual String get_category() const { return "constants"; }
  325. void set_global_constant(int p_which);
  326. int get_global_constant();
  327. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  328. VisualScriptGlobalConstant();
  329. };
  330. class VisualScriptClassConstant : public VisualScriptNode {
  331. GDCLASS(VisualScriptClassConstant, VisualScriptNode);
  332. StringName base_type;
  333. StringName name;
  334. protected:
  335. static void _bind_methods();
  336. virtual void _validate_property(PropertyInfo &property) const;
  337. public:
  338. virtual int get_output_sequence_port_count() const;
  339. virtual bool has_input_sequence_port() const;
  340. virtual String get_output_sequence_port_text(int p_port) const;
  341. virtual int get_input_value_port_count() const;
  342. virtual int get_output_value_port_count() const;
  343. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  344. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  345. virtual String get_caption() const;
  346. virtual String get_category() const { return "constants"; }
  347. void set_class_constant(const StringName &p_which);
  348. StringName get_class_constant();
  349. void set_base_type(const StringName &p_which);
  350. StringName get_base_type();
  351. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  352. VisualScriptClassConstant();
  353. };
  354. class VisualScriptBasicTypeConstant : public VisualScriptNode {
  355. GDCLASS(VisualScriptBasicTypeConstant, VisualScriptNode);
  356. Variant::Type type;
  357. StringName name;
  358. protected:
  359. static void _bind_methods();
  360. virtual void _validate_property(PropertyInfo &property) const;
  361. public:
  362. virtual int get_output_sequence_port_count() const;
  363. virtual bool has_input_sequence_port() const;
  364. virtual String get_output_sequence_port_text(int p_port) const;
  365. virtual int get_input_value_port_count() const;
  366. virtual int get_output_value_port_count() const;
  367. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  368. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  369. virtual String get_caption() const;
  370. virtual String get_text() const;
  371. virtual String get_category() const { return "constants"; }
  372. void set_basic_type_constant(const StringName &p_which);
  373. StringName get_basic_type_constant() const;
  374. void set_basic_type(Variant::Type p_which);
  375. Variant::Type get_basic_type() const;
  376. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  377. VisualScriptBasicTypeConstant();
  378. };
  379. class VisualScriptMathConstant : public VisualScriptNode {
  380. GDCLASS(VisualScriptMathConstant, VisualScriptNode);
  381. public:
  382. enum MathConstant {
  383. MATH_CONSTANT_ONE,
  384. MATH_CONSTANT_PI,
  385. MATH_CONSTANT_HALF_PI,
  386. MATH_CONSTANT_TAU,
  387. MATH_CONSTANT_E,
  388. MATH_CONSTANT_SQRT2,
  389. MATH_CONSTANT_INF,
  390. MATH_CONSTANT_NAN,
  391. MATH_CONSTANT_MAX
  392. };
  393. private:
  394. static const char *const_name[MATH_CONSTANT_MAX];
  395. static double const_value[MATH_CONSTANT_MAX];
  396. MathConstant constant;
  397. protected:
  398. static void _bind_methods();
  399. public:
  400. virtual int get_output_sequence_port_count() const;
  401. virtual bool has_input_sequence_port() const;
  402. virtual String get_output_sequence_port_text(int p_port) const;
  403. virtual int get_input_value_port_count() const;
  404. virtual int get_output_value_port_count() const;
  405. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  406. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  407. virtual String get_caption() const;
  408. virtual String get_category() const { return "constants"; }
  409. void set_math_constant(MathConstant p_which);
  410. MathConstant get_math_constant();
  411. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  412. VisualScriptMathConstant();
  413. };
  414. VARIANT_ENUM_CAST(VisualScriptMathConstant::MathConstant)
  415. class VisualScriptEngineSingleton : public VisualScriptNode {
  416. GDCLASS(VisualScriptEngineSingleton, VisualScriptNode);
  417. String singleton;
  418. protected:
  419. void _validate_property(PropertyInfo &property) const;
  420. static void _bind_methods();
  421. public:
  422. virtual int get_output_sequence_port_count() const;
  423. virtual bool has_input_sequence_port() const;
  424. virtual String get_output_sequence_port_text(int p_port) const;
  425. virtual int get_input_value_port_count() const;
  426. virtual int get_output_value_port_count() const;
  427. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  428. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  429. virtual String get_caption() const;
  430. virtual String get_category() const { return "data"; }
  431. void set_singleton(const String &p_string);
  432. String get_singleton();
  433. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  434. virtual TypeGuess guess_output_type(TypeGuess *p_inputs, int p_output) const;
  435. VisualScriptEngineSingleton();
  436. };
  437. class VisualScriptSceneNode : public VisualScriptNode {
  438. GDCLASS(VisualScriptSceneNode, VisualScriptNode);
  439. NodePath path;
  440. protected:
  441. virtual void _validate_property(PropertyInfo &property) const;
  442. static void _bind_methods();
  443. public:
  444. virtual int get_output_sequence_port_count() const;
  445. virtual bool has_input_sequence_port() const;
  446. virtual String get_output_sequence_port_text(int p_port) const;
  447. virtual int get_input_value_port_count() const;
  448. virtual int get_output_value_port_count() const;
  449. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  450. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  451. virtual String get_caption() const;
  452. virtual String get_category() const { return "data"; }
  453. void set_node_path(const NodePath &p_path);
  454. NodePath get_node_path();
  455. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  456. virtual TypeGuess guess_output_type(TypeGuess *p_inputs, int p_output) const;
  457. VisualScriptSceneNode();
  458. };
  459. class VisualScriptSceneTree : public VisualScriptNode {
  460. GDCLASS(VisualScriptSceneTree, VisualScriptNode);
  461. protected:
  462. virtual void _validate_property(PropertyInfo &property) const;
  463. static void _bind_methods();
  464. public:
  465. virtual int get_output_sequence_port_count() const;
  466. virtual bool has_input_sequence_port() const;
  467. virtual String get_output_sequence_port_text(int p_port) const;
  468. virtual int get_input_value_port_count() const;
  469. virtual int get_output_value_port_count() const;
  470. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  471. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  472. virtual String get_caption() const;
  473. virtual String get_category() const { return "data"; }
  474. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  475. virtual TypeGuess guess_output_type(TypeGuess *p_inputs, int p_output) const;
  476. VisualScriptSceneTree();
  477. };
  478. class VisualScriptResourcePath : public VisualScriptNode {
  479. GDCLASS(VisualScriptResourcePath, VisualScriptNode);
  480. String path;
  481. protected:
  482. static void _bind_methods();
  483. public:
  484. virtual int get_output_sequence_port_count() const;
  485. virtual bool has_input_sequence_port() const;
  486. virtual String get_output_sequence_port_text(int p_port) const;
  487. virtual int get_input_value_port_count() const;
  488. virtual int get_output_value_port_count() const;
  489. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  490. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  491. virtual String get_caption() const;
  492. virtual String get_category() const { return "data"; }
  493. void set_resource_path(const String &p_path);
  494. String get_resource_path();
  495. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  496. VisualScriptResourcePath();
  497. };
  498. class VisualScriptSelf : public VisualScriptNode {
  499. GDCLASS(VisualScriptSelf, VisualScriptNode);
  500. protected:
  501. static void _bind_methods();
  502. public:
  503. virtual int get_output_sequence_port_count() const;
  504. virtual bool has_input_sequence_port() const;
  505. virtual String get_output_sequence_port_text(int p_port) const;
  506. virtual int get_input_value_port_count() const;
  507. virtual int get_output_value_port_count() const;
  508. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  509. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  510. virtual String get_caption() const;
  511. virtual String get_category() const { return "data"; }
  512. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  513. virtual TypeGuess guess_output_type(TypeGuess *p_inputs, int p_output) const;
  514. VisualScriptSelf();
  515. };
  516. class VisualScriptCustomNode : public VisualScriptNode {
  517. GDCLASS(VisualScriptCustomNode, VisualScriptNode);
  518. protected:
  519. static void _bind_methods();
  520. public:
  521. enum StartMode { //replicated for step
  522. START_MODE_BEGIN_SEQUENCE,
  523. START_MODE_CONTINUE_SEQUENCE,
  524. START_MODE_RESUME_YIELD
  525. };
  526. enum { //replicated for step
  527. STEP_SHIFT = 1 << 24,
  528. STEP_MASK = STEP_SHIFT - 1,
  529. STEP_PUSH_STACK_BIT = STEP_SHIFT, //push bit to stack
  530. STEP_GO_BACK_BIT = STEP_SHIFT << 1, //go back to previous node
  531. STEP_NO_ADVANCE_BIT = STEP_SHIFT << 2, //do not advance past this node
  532. STEP_EXIT_FUNCTION_BIT = STEP_SHIFT << 3, //return from function
  533. STEP_YIELD_BIT = STEP_SHIFT << 4, //yield (will find VisualScriptFunctionState state in first working memory)
  534. };
  535. virtual int get_output_sequence_port_count() const;
  536. virtual bool has_input_sequence_port() const;
  537. virtual String get_output_sequence_port_text(int p_port) const;
  538. virtual int get_input_value_port_count() const;
  539. virtual int get_output_value_port_count() const;
  540. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  541. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  542. virtual String get_caption() const;
  543. virtual String get_text() const;
  544. virtual String get_category() const;
  545. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  546. virtual TypeGuess guess_output_type(TypeGuess *p_inputs, int p_output) const;
  547. void _script_changed();
  548. VisualScriptCustomNode();
  549. };
  550. VARIANT_ENUM_CAST(VisualScriptCustomNode::StartMode);
  551. class VisualScriptSubCall : public VisualScriptNode {
  552. GDCLASS(VisualScriptSubCall, VisualScriptNode);
  553. protected:
  554. static void _bind_methods();
  555. public:
  556. virtual int get_output_sequence_port_count() const;
  557. virtual bool has_input_sequence_port() const;
  558. virtual String get_output_sequence_port_text(int p_port) const;
  559. virtual int get_input_value_port_count() const;
  560. virtual int get_output_value_port_count() const;
  561. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  562. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  563. virtual String get_caption() const;
  564. virtual String get_text() const;
  565. virtual String get_category() const;
  566. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  567. VisualScriptSubCall();
  568. };
  569. class VisualScriptComment : public VisualScriptNode {
  570. GDCLASS(VisualScriptComment, VisualScriptNode);
  571. String title;
  572. String description;
  573. Size2 size;
  574. protected:
  575. static void _bind_methods();
  576. public:
  577. virtual int get_output_sequence_port_count() const;
  578. virtual bool has_input_sequence_port() const;
  579. virtual String get_output_sequence_port_text(int p_port) const;
  580. virtual int get_input_value_port_count() const;
  581. virtual int get_output_value_port_count() const;
  582. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  583. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  584. virtual String get_caption() const;
  585. virtual String get_text() const;
  586. virtual String get_category() const;
  587. void set_title(const String &p_title);
  588. String get_title() const;
  589. void set_description(const String &p_description);
  590. String get_description() const;
  591. void set_size(const Size2 &p_size);
  592. Size2 get_size() const;
  593. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  594. VisualScriptComment();
  595. };
  596. class VisualScriptConstructor : public VisualScriptNode {
  597. GDCLASS(VisualScriptConstructor, VisualScriptNode);
  598. Variant::Type type;
  599. MethodInfo constructor;
  600. protected:
  601. static void _bind_methods();
  602. public:
  603. virtual int get_output_sequence_port_count() const;
  604. virtual bool has_input_sequence_port() const;
  605. virtual String get_output_sequence_port_text(int p_port) const;
  606. virtual int get_input_value_port_count() const;
  607. virtual int get_output_value_port_count() const;
  608. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  609. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  610. virtual String get_caption() const;
  611. virtual String get_category() const;
  612. void set_constructor_type(Variant::Type p_type);
  613. Variant::Type get_constructor_type() const;
  614. void set_constructor(const Dictionary &p_info);
  615. Dictionary get_constructor() const;
  616. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  617. VisualScriptConstructor();
  618. };
  619. class VisualScriptLocalVar : public VisualScriptNode {
  620. GDCLASS(VisualScriptLocalVar, VisualScriptNode);
  621. StringName name;
  622. Variant::Type type;
  623. protected:
  624. static void _bind_methods();
  625. public:
  626. virtual int get_output_sequence_port_count() const;
  627. virtual bool has_input_sequence_port() const;
  628. virtual String get_output_sequence_port_text(int p_port) const;
  629. virtual int get_input_value_port_count() const;
  630. virtual int get_output_value_port_count() const;
  631. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  632. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  633. virtual String get_caption() const;
  634. virtual String get_category() const;
  635. void set_var_name(const StringName &p_name);
  636. StringName get_var_name() const;
  637. void set_var_type(Variant::Type p_type);
  638. Variant::Type get_var_type() const;
  639. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  640. VisualScriptLocalVar();
  641. };
  642. class VisualScriptLocalVarSet : public VisualScriptNode {
  643. GDCLASS(VisualScriptLocalVarSet, VisualScriptNode);
  644. StringName name;
  645. Variant::Type type;
  646. protected:
  647. static void _bind_methods();
  648. public:
  649. virtual int get_output_sequence_port_count() const;
  650. virtual bool has_input_sequence_port() const;
  651. virtual String get_output_sequence_port_text(int p_port) const;
  652. virtual int get_input_value_port_count() const;
  653. virtual int get_output_value_port_count() const;
  654. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  655. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  656. virtual String get_caption() const;
  657. virtual String get_text() const;
  658. virtual String get_category() const;
  659. void set_var_name(const StringName &p_name);
  660. StringName get_var_name() const;
  661. void set_var_type(Variant::Type p_type);
  662. Variant::Type get_var_type() const;
  663. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  664. VisualScriptLocalVarSet();
  665. };
  666. class VisualScriptInputAction : public VisualScriptNode {
  667. GDCLASS(VisualScriptInputAction, VisualScriptNode);
  668. public:
  669. enum Mode {
  670. MODE_PRESSED,
  671. MODE_RELEASED,
  672. MODE_JUST_PRESSED,
  673. MODE_JUST_RELEASED,
  674. };
  675. StringName name;
  676. Mode mode;
  677. protected:
  678. virtual void _validate_property(PropertyInfo &property) const;
  679. static void _bind_methods();
  680. public:
  681. virtual int get_output_sequence_port_count() const;
  682. virtual bool has_input_sequence_port() const;
  683. virtual String get_output_sequence_port_text(int p_port) const;
  684. virtual int get_input_value_port_count() const;
  685. virtual int get_output_value_port_count() const;
  686. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  687. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  688. virtual String get_caption() const;
  689. virtual String get_category() const;
  690. void set_action_name(const StringName &p_name);
  691. StringName get_action_name() const;
  692. void set_action_mode(Mode p_mode);
  693. Mode get_action_mode() const;
  694. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  695. VisualScriptInputAction();
  696. };
  697. VARIANT_ENUM_CAST(VisualScriptInputAction::Mode)
  698. class VisualScriptDeconstruct : public VisualScriptNode {
  699. GDCLASS(VisualScriptDeconstruct, VisualScriptNode);
  700. struct Element {
  701. StringName name;
  702. Variant::Type type;
  703. };
  704. Vector<Element> elements;
  705. void _update_elements();
  706. Variant::Type type;
  707. void _set_elem_cache(const Array &p_elements);
  708. Array _get_elem_cache() const;
  709. virtual void _validate_property(PropertyInfo &property) const;
  710. protected:
  711. static void _bind_methods();
  712. public:
  713. virtual int get_output_sequence_port_count() const;
  714. virtual bool has_input_sequence_port() const;
  715. virtual String get_output_sequence_port_text(int p_port) const;
  716. virtual int get_input_value_port_count() const;
  717. virtual int get_output_value_port_count() const;
  718. virtual PropertyInfo get_input_value_port_info(int p_idx) const;
  719. virtual PropertyInfo get_output_value_port_info(int p_idx) const;
  720. virtual String get_caption() const;
  721. virtual String get_category() const;
  722. void set_deconstruct_type(Variant::Type p_type);
  723. Variant::Type get_deconstruct_type() const;
  724. virtual VisualScriptNodeInstance *instance(VisualScriptInstance *p_instance);
  725. VisualScriptDeconstruct();
  726. };
  727. void register_visual_script_nodes();
  728. void unregister_visual_script_nodes();
  729. #endif // VISUAL_SCRIPT_NODES_H