virtualx-engine/modules/visual_script/doc_classes/VisualScriptEditor.xml
George Marques 0284727e7b
Create API to add and remove VisualScript custom nodes
This makes a VisualScriptEditor singleton, which gives plugins the
ability to register their own custom nodes. Those will be available for
insertion in the Visual Script editor, under the "Custom Nodes"
category.
2017-11-15 17:13:13 -02:00

46 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptEditor" inherits="Object" category="Core" version="3.0.alpha.custom_build">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="add_custom_node">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="category" type="String">
</argument>
<argument index="2" name="script" type="Script">
</argument>
<description>
Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the [code]category[/code] as the parameter.
</description>
</method>
<method name="remove_custom_node">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="category" type="String">
</argument>
<description>
Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed.
</description>
</method>
</methods>
<signals>
<signal name="custom_nodes_updated">
<description>
Emitted when a custom Visual Script node is added or removed.
</description>
</signal>
</signals>
<constants>
</constants>
</class>