godot/modules/visual_script/doc_classes/VisualScriptNode.xml
2020-01-31 17:15:41 -08:00

57 lines
1.6 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptNode" inherits="Resource" version="4.0">
<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">
</return>
<argument index="0" name="port_idx" type="int">
</argument>
<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">
</return>
<description>
Returns the [VisualScript] instance the node is bound to.
</description>
</method>
<method name="ports_changed_notify">
<return type="void">
</return>
<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">
</return>
<argument index="0" name="port_idx" type="int">
</argument>
<argument index="1" name="value" type="Variant">
</argument>
<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>