Struct VisualScriptCustomNode
A scripted Visual Script node.
struct VisualScriptCustomNode
;
A custom Visual Script node which can be scripted in powerful ways.
Methods
| Name | Description |
|---|---|
_getCaption
|
Return the node's title. |
_getCategory
|
Return the node's category. |
_getInputValuePortCount
|
Return the count of input value ports. |
_getInputValuePortName
|
Return the specified input port's name. |
_getInputValuePortType
|
Return the specified input port's type. See the Variant values.
|
_getOutputSequencePortCount
|
Return the amount of output sequence ports. |
_getOutputSequencePortText
|
Return the specified sequence output's name. |
_getOutputValuePortCount
|
Return the amount of output value ports. |
_getOutputValuePortName
|
Return the specified output's name. |
_getOutputValuePortType
|
Return the specified output's type. See the Variant values.
|
_getText
|
Return the custom node's text, which is shown right next to the input sequence port (if there is none, on the place that is usually taken by it). |
_getWorkingMemorySize
|
Return the size of the custom node's working memory. See step for more details.
|
_hasInputSequencePort
|
Return whether the custom node has an input sequence port. |
_scriptChanged
|
|
_step
|
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 inputs array contains the values of the input ports.
outputs is an array whose indices should be set to the respective outputs.
The start_mode is usually constant START_MODE_BEGIN_SEQUENCE, unless you have used the STEP_* constants.
working_mem is an array which can be used to persist information between runs of the custom node.
When returning, you can mask the returned value with one of the STEP_* constants.
|
Enums
| Name | Description |
|---|---|
Constants
|
|
StartMode
|