diff options
Diffstat (limited to 'modules/visual_script/doc_classes/VisualScriptCustomNode.xml')
| -rw-r--r-- | modules/visual_script/doc_classes/VisualScriptCustomNode.xml | 155 |
1 files changed, 80 insertions, 75 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml index 1c23b58507..97b89fb987 100644 --- a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualScriptCustomNode" inherits="VisualScriptNode" version="4.0"> +<class name="VisualScriptCustomNode" inherits="VisualScriptNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd"> <brief_description> A scripted Visual Script node. </brief_description> @@ -9,124 +9,129 @@ <tutorials> </tutorials> <methods> - <method name="_get_caption" qualifiers="virtual"> - <return type="String"> - </return> + <method name="_get_caption" qualifiers="virtual const"> + <return type="String" /> <description> - Return the node's title. + Returns the node's title. </description> </method> - <method name="_get_category" qualifiers="virtual"> - <return type="String"> - </return> + <method name="_get_category" qualifiers="virtual const"> + <return type="String" /> <description> - Return the node's category. + Returns the node's category. </description> </method> - <method name="_get_input_value_port_count" qualifiers="virtual"> - <return type="int"> - </return> + <method name="_get_input_value_port_count" qualifiers="virtual const"> + <return type="int" /> <description> - Return the count of input value ports. + Returns the count of input value ports. </description> </method> - <method name="_get_input_value_port_name" qualifiers="virtual"> - <return type="String"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <method name="_get_input_value_port_hint" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="input_idx" type="int" /> <description> - Return the specified input port's name. + Returns the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints. </description> </method> - <method name="_get_input_value_port_type" qualifiers="virtual"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <method name="_get_input_value_port_hint_string" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="input_idx" type="int" /> <description> - Return the specified input port's type. See the [enum Variant.Type] values. + Returns the specified input port's hint string. </description> </method> - <method name="_get_output_sequence_port_count" qualifiers="virtual"> - <return type="int"> - </return> + <method name="_get_input_value_port_name" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="input_idx" type="int" /> <description> - Return the amount of output [b]sequence[/b] ports. + Returns the specified input port's name. </description> </method> - <method name="_get_output_sequence_port_text" qualifiers="virtual"> - <return type="String"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <method name="_get_input_value_port_type" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="input_idx" type="int" /> <description> - Return the specified [b]sequence[/b] output's name. + Returns the specified input port's type. See the [enum Variant.Type] values. </description> </method> - <method name="_get_output_value_port_count" qualifiers="virtual"> - <return type="int"> - </return> + <method name="_get_output_sequence_port_count" qualifiers="virtual const"> + <return type="int" /> <description> - Return the amount of output value ports. + Returns the amount of output [b]sequence[/b] ports. </description> </method> - <method name="_get_output_value_port_name" qualifiers="virtual"> - <return type="String"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <method name="_get_output_sequence_port_text" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="seq_idx" type="int" /> <description> - Return the specified output's name. + Returns the specified [b]sequence[/b] output's name. </description> </method> - <method name="_get_output_value_port_type" qualifiers="virtual"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> + <method name="_get_output_value_port_count" qualifiers="virtual const"> + <return type="int" /> <description> - Return the specified output's type. See the [enum Variant.Type] values. + Returns the amount of output value ports. </description> </method> - <method name="_get_text" qualifiers="virtual"> - <return type="String"> - </return> + <method name="_get_output_value_port_hint" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="output_idx" type="int" /> <description> - Return the custom node's text, which is shown right next to the input [b]sequence[/b] port (if there is none, on the place that is usually taken by it). + Returns the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints. </description> </method> - <method name="_get_working_memory_size" qualifiers="virtual"> - <return type="int"> - </return> + <method name="_get_output_value_port_hint_string" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="output_idx" type="int" /> <description> - Return the size of the custom node's working memory. See [method _step] for more details. + Returns the specified output port's hint string. </description> </method> - <method name="_has_input_sequence_port" qualifiers="virtual"> - <return type="bool"> - </return> + <method name="_get_output_value_port_name" qualifiers="virtual const"> + <return type="String" /> + <argument index="0" name="output_idx" type="int" /> <description> - Return whether the custom node has an input [b]sequence[/b] port. + Returns the specified output port's name. </description> </method> - <method name="_step" qualifiers="virtual"> - <return type="Variant"> - </return> - <argument index="0" name="inputs" type="Array"> - </argument> - <argument index="1" name="outputs" type="Array"> - </argument> - <argument index="2" name="start_mode" type="int"> - </argument> - <argument index="3" name="working_mem" type="Array"> - </argument> + <method name="_get_output_value_port_type" qualifiers="virtual const"> + <return type="int" /> + <argument index="0" name="output_idx" type="int" /> + <description> + Returns the specified output port's type. See the [enum Variant.Type] values. + </description> + </method> + <method name="_get_text" qualifiers="virtual const"> + <return type="String" /> + <description> + Returns the custom node's text, which is shown right next to the input [b]sequence[/b] port (if there is none, on the place that is usually taken by it). + </description> + </method> + <method name="_get_working_memory_size" qualifiers="virtual const"> + <return type="int" /> + <description> + Returns the size of the custom node's working memory. See [method _step] for more details. + </description> + </method> + <method name="_has_input_sequence_port" qualifiers="virtual const"> + <return type="bool" /> + <description> + Returns whether the custom node has an input [b]sequence[/b] port. + </description> + </method> + <method name="_step" qualifiers="virtual const"> + <return type="Variant" /> + <argument index="0" name="inputs" type="Array" /> + <argument index="1" name="outputs" type="Array" /> + <argument index="2" name="start_mode" type="int" /> + <argument index="3" name="working_mem" type="Array" /> <description> Execute the custom node's logic, returning the index of the output sequence port to use or a [String] when there is an error. The [code]inputs[/code] array contains the values of the input ports. [code]outputs[/code] is an array whose indices should be set to the respective outputs. The [code]start_mode[/code] is usually [constant START_MODE_BEGIN_SEQUENCE], unless you have used the [code]STEP_*[/code] constants. - [code]working_mem[/code] is an array which can be used to persist information between runs of the custom node. + [code]working_mem[/code] is an array which can be used to persist information between runs of the custom node. The size needs to be predefined using [method _get_working_memory_size]. When returning, you can mask the returned value with one of the [code]STEP_*[/code] constants. </description> </method> |