f5836b40d4
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.
(cherry picked from commit 7adf4cc9b5)
49 lines
1.5 KiB
XML
49 lines
1.5 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="VisualScriptNode" inherits="Resource" version="3.4">
|
|
<brief_description>
|
|
A node which is part of a [VisualScript].
|
|
</brief_description>
|
|
<description>
|
|
A node which is part of a [VisualScript]. Not to be confused with [Node], which is a part of a [SceneTree].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_default_input_value" qualifiers="const">
|
|
<return type="Variant" />
|
|
<argument index="0" name="port_idx" type="int" />
|
|
<description>
|
|
Returns the default value of a given port. The default value is used when nothing is connected to the port.
|
|
</description>
|
|
</method>
|
|
<method name="get_visual_script" qualifiers="const">
|
|
<return type="VisualScript" />
|
|
<description>
|
|
Returns the [VisualScript] instance the node is bound to.
|
|
</description>
|
|
</method>
|
|
<method name="ports_changed_notify">
|
|
<return type="void" />
|
|
<description>
|
|
Notify that the node's ports have changed. Usually used in conjunction with [VisualScriptCustomNode] .
|
|
</description>
|
|
</method>
|
|
<method name="set_default_input_value">
|
|
<return type="void" />
|
|
<argument index="0" name="port_idx" type="int" />
|
|
<argument index="1" name="value" type="Variant" />
|
|
<description>
|
|
Change the default value of a given port.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<signals>
|
|
<signal name="ports_changed">
|
|
<description>
|
|
Emitted when the available input/output ports are changed.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
<constants>
|
|
</constants>
|
|
</class>
|