summaryrefslogtreecommitdiff
path: root/modules/visual_script/doc_classes
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2017-11-15 20:40:49 +0100
committerGitHub <noreply@github.com>2017-11-15 20:40:49 +0100
commit4d08e7c4204ff3fa0e17e0de7e5a08ef03968202 (patch)
tree4c108558ec25992c2c940cbbde4d3832055c45a2 /modules/visual_script/doc_classes
parent9543801d51910cdf61123f591fd91993f57782ae (diff)
parent0284727e7bc6337ebcd98e61eacf0d095d74a094 (diff)
Merge pull request #12948 from vnen/vs-custom-nodes
Create API to add and remove VisualScript custom nodes
Diffstat (limited to 'modules/visual_script/doc_classes')
-rw-r--r--modules/visual_script/doc_classes/VisualScriptEditor.xml46
1 files changed, 46 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptEditor.xml b/modules/visual_script/doc_classes/VisualScriptEditor.xml
new file mode 100644
index 0000000000..70d52b2bd7
--- /dev/null
+++ b/modules/visual_script/doc_classes/VisualScriptEditor.xml
@@ -0,0 +1,46 @@
+<?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>