asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/modules/visual_script/doc_classes/VisualScriptCustomNodes.xml

38 lines
1.4 KiB
XML
Raw Normal View History

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 16:57:24 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 14:18:53 +01:00
<class name="VisualScriptCustomNodes" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
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 16:57:24 +01:00
<brief_description>
Fix Visual Script editor
2021-08-23 18:15:50 +02:00
Manages custom nodes for the Visual Script editor.
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 16:57:24 +01:00
</brief_description>
<description>
Fix Visual Script editor
2021-08-23 18:15:50 +02:00
This singleton can be used to manage (i.e., add or remove) custom nodes for the Visual Script editor.
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 16:57:24 +01:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_custom_node">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="name" type="String" />
<argument index="1" name="category" type="String" />
<argument index="2" name="script" type="Script" />
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 16:57:24 +01:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="name" type="String" />
<argument index="1" name="category" type="String" />
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 16:57:24 +01:00
<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>
</class>
Reference in a new issue Copy permalink