class_visualscriptlists.rst 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/modules/visual_script/doc_classes/VisualScriptLists.xml.
  6. .. _class_VisualScriptLists:
  7. VisualScriptLists
  8. =================
  9. **Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`VisualScriptComposeArray<class_VisualScriptComposeArray>`
  11. A Visual Script virtual class for in-graph editable nodes.
  12. Description
  13. -----------
  14. A Visual Script virtual class that defines the shape and the default behavior of the nodes that have to be in-graph editable nodes.
  15. Methods
  16. -------
  17. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | void | :ref:`add_input_data_port<class_VisualScriptLists_method_add_input_data_port>` **(** :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type, :ref:`String<class_String>` name, :ref:`int<class_int>` index **)** |
  19. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`add_output_data_port<class_VisualScriptLists_method_add_output_data_port>` **(** :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type, :ref:`String<class_String>` name, :ref:`int<class_int>` index **)** |
  21. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`remove_input_data_port<class_VisualScriptLists_method_remove_input_data_port>` **(** :ref:`int<class_int>` index **)** |
  23. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`remove_output_data_port<class_VisualScriptLists_method_remove_output_data_port>` **(** :ref:`int<class_int>` index **)** |
  25. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | void | :ref:`set_input_data_port_name<class_VisualScriptLists_method_set_input_data_port_name>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` name **)** |
  27. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`set_input_data_port_type<class_VisualScriptLists_method_set_input_data_port_type>` **(** :ref:`int<class_int>` index, :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type **)** |
  29. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`set_output_data_port_name<class_VisualScriptLists_method_set_output_data_port_name>` **(** :ref:`int<class_int>` index, :ref:`String<class_String>` name **)** |
  31. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`set_output_data_port_type<class_VisualScriptLists_method_set_output_data_port_type>` **(** :ref:`int<class_int>` index, :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type **)** |
  33. +------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. Method Descriptions
  35. -------------------
  36. .. _class_VisualScriptLists_method_add_input_data_port:
  37. - void **add_input_data_port** **(** :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type, :ref:`String<class_String>` name, :ref:`int<class_int>` index **)**
  38. Adds an input port to the Visual Script node.
  39. ----
  40. .. _class_VisualScriptLists_method_add_output_data_port:
  41. - void **add_output_data_port** **(** :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type, :ref:`String<class_String>` name, :ref:`int<class_int>` index **)**
  42. Adds an output port to the Visual Script node.
  43. ----
  44. .. _class_VisualScriptLists_method_remove_input_data_port:
  45. - void **remove_input_data_port** **(** :ref:`int<class_int>` index **)**
  46. Removes an input port from the Visual Script node.
  47. ----
  48. .. _class_VisualScriptLists_method_remove_output_data_port:
  49. - void **remove_output_data_port** **(** :ref:`int<class_int>` index **)**
  50. Removes an output port from the Visual Script node.
  51. ----
  52. .. _class_VisualScriptLists_method_set_input_data_port_name:
  53. - void **set_input_data_port_name** **(** :ref:`int<class_int>` index, :ref:`String<class_String>` name **)**
  54. Sets the name of an input port.
  55. ----
  56. .. _class_VisualScriptLists_method_set_input_data_port_type:
  57. - void **set_input_data_port_type** **(** :ref:`int<class_int>` index, :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type **)**
  58. Sets the type of an input port.
  59. ----
  60. .. _class_VisualScriptLists_method_set_output_data_port_name:
  61. - void **set_output_data_port_name** **(** :ref:`int<class_int>` index, :ref:`String<class_String>` name **)**
  62. Sets the name of an output port.
  63. ----
  64. .. _class_VisualScriptLists_method_set_output_data_port_type:
  65. - void **set_output_data_port_type** **(** :ref:`int<class_int>` index, :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` type **)**
  66. Sets the type of an output port.
  67. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  68. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  69. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  70. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  71. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  72. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`