class_visualscriptcustomnodes.rst 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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/VisualScriptCustomNodes.xml.
  6. .. _class_VisualScriptCustomNodes:
  7. VisualScriptCustomNodes
  8. =======================
  9. **Inherits:** :ref:`Object<class_Object>`
  10. Manages custom nodes for the Visual Script editor.
  11. Description
  12. -----------
  13. This singleton can be used to manage (i.e., add or remove) custom nodes for the Visual Script editor.
  14. Methods
  15. -------
  16. +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`add_custom_node<class_VisualScriptCustomNodes_method_add_custom_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` category, :ref:`Script<class_Script>` script **)** |
  18. +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`remove_custom_node<class_VisualScriptCustomNodes_method_remove_custom_node>` **(** :ref:`String<class_String>` name, :ref:`String<class_String>` category **)** |
  20. +------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. Signals
  22. -------
  23. .. _class_VisualScriptCustomNodes_signal_custom_nodes_updated:
  24. - **custom_nodes_updated** **(** **)**
  25. Emitted when a custom Visual Script node is added or removed.
  26. Method Descriptions
  27. -------------------
  28. .. _class_VisualScriptCustomNodes_method_add_custom_node:
  29. - void **add_custom_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` category, :ref:`Script<class_Script>` script **)**
  30. Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the ``category`` as the parameter.
  31. ----
  32. .. _class_VisualScriptCustomNodes_method_remove_custom_node:
  33. - void **remove_custom_node** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` category **)**
  34. Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed.
  35. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  36. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  37. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  38. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  39. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  40. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`