diff options
| author | Bojidar Marinov <bojidar.marinov.bg@gmail.com> | 2017-09-28 13:07:20 +0300 |
|---|---|---|
| committer | Bojidar Marinov <bojidar.marinov.bg@gmail.com> | 2017-10-03 12:01:53 +0300 |
| commit | 10469c1962172db954d02a3912053a99e2a0dfa3 (patch) | |
| tree | e17f745f2a44e5d5d358406f72f08ea177b4ba78 /doc/classes/VisualScriptNode.xml | |
| parent | 62cb43bb8dec8f5078012b58ff06a2077078565f (diff) | |
Document some of the VisualScript classes.
Diffstat (limited to 'doc/classes/VisualScriptNode.xml')
| -rw-r--r-- | doc/classes/VisualScriptNode.xml | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/classes/VisualScriptNode.xml b/doc/classes/VisualScriptNode.xml index dbb75e69fa..74ec9bdc2e 100644 --- a/doc/classes/VisualScriptNode.xml +++ b/doc/classes/VisualScriptNode.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptNode" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> <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> @@ -15,12 +17,21 @@ <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"> @@ -31,6 +42,7 @@ <argument index="1" name="value" type="Variant"> </argument> <description> + Change the default value of a given port. </description> </method> </methods> @@ -41,6 +53,7 @@ <signals> <signal name="ports_changed"> <description> + Emitted when the available input/output ports are changed. </description> </signal> </signals> |