A scripted Visual Script node.
A custom Visual Script node which can be scripted in powerful ways.
Returns the node's title.
Returns the node's category.
Returns the count of input value ports.
Returns the specified input port's hint. See the [enum @GlobalScope.PropertyHint] hints.
Returns the specified input port's hint string.
Returns the specified input port's name.
Returns the specified input port's type. See the [enum Variant.Type] values.
Returns the amount of output [b]sequence[/b] ports.
Returns the specified [b]sequence[/b] output's name.
Returns the amount of output value ports.
Returns the specified output port's hint. See the [enum @GlobalScope.PropertyHint] hints.
Returns the specified output port's hint string.
Returns the specified output port's name.
Returns the specified output port's type. See the [enum Variant.Type] values.
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).
Returns the size of the custom node's working memory. See [method _step] for more details.
Returns whether the custom node has an input [b]sequence[/b] port.
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. 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.
The start mode used the first time when [method _step] is called.
The start mode used when [method _step] is called after coming back from a [constant STEP_PUSH_STACK_BIT].
The start mode used when [method _step] is called after resuming from [constant STEP_YIELD_BIT].
Hint used by [method _step] to tell that control should return to it when there is no other node left to execute.
This is used by [VisualScriptCondition] to redirect the sequence to the "Done" port after the [code]true[/code]/[code]false[/code] branch has finished execution.
Hint used by [method _step] to tell that control should return back, either hitting a previous [constant STEP_PUSH_STACK_BIT] or exiting the function.
Hint used by [method _step] to tell that control should stop and exit the function.
Hint used by [method _step] to tell that the function should be yielded.
Using this requires you to have at least one working memory slot, which is used for the [VisualScriptFunctionState].