class_visualscripteditor.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the VisualScriptEditor.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_VisualScriptEditor:
  6. VisualScriptEditor
  7. ==================
  8. **Inherits:** :ref:`Object<class_Object>`
  9. Methods
  10. -------
  11. +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  12. | void | :ref:`add_custom_node<class_VisualScriptEditor_method_add_custom_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` category, :ref:`Script<class_Script>` script **)** |
  13. +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`remove_custom_node<class_VisualScriptEditor_method_remove_custom_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` category **)** |
  15. +------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  16. Signals
  17. -------
  18. .. _class_VisualScriptEditor_signal_custom_nodes_updated:
  19. - **custom_nodes_updated** **(** **)**
  20. Emitted when a custom Visual Script node is added or removed.
  21. Method Descriptions
  22. -------------------
  23. .. _class_VisualScriptEditor_method_add_custom_node:
  24. - void **add_custom_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` category, :ref:`Script<class_Script>` script **)**
  25. Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the ``category`` as the parameter.
  26. ----
  27. .. _class_VisualScriptEditor_method_remove_custom_node:
  28. - void **remove_custom_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` category **)**
  29. Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed.
  30. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  31. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  32. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`