VisualScriptCustomNode

    Category: Core

    A scripted Visual Script node.

    Methods

    enum StartMode:

    • START_MODE_BEGIN_SEQUENCE = 0 — The start mode used the first time when is called.
    • START_MODE_CONTINUE_SEQUENCE = 1 — The start mode used when _step is called after coming back from a STEP_PUSH_STACK_BIT.

    Constants

    • STEP_PUSH_STACK_BIT = 16777216 — Hint used by 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 /false branch has finished execution.

    • STEP_GO_BACK_BIT = 33554432 — Hint used by to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function.
    • STEP_NO_ADVANCE_BIT = 67108864
    • STEP_EXIT_FUNCTION_BIT = 134217728 — Hint used by _step to tell that control should stop and exit the function.
    • STEP_YIELD_BIT = 268435456 — Hint used by 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.

    A custom Visual Script node which can be scripted in powerful ways.

    Method Descriptions

    • _get_caption ( ) virtual

    Return the node’s title.

    • String _get_category ( ) virtual
    • _get_input_value_port_count ( ) virtual

    Return the count of input value ports.

    Return the specified input port’s name.

    • int _get_input_value_port_type ( idx ) virtual

    Return the specified input port’s type. See the TYPE_* enum in @GlobalScope.

    • _get_output_sequence_port_count ( ) virtual

    Return the amount of output sequence ports.

    • String _get_output_sequence_port_text ( idx ) virtual

    Return the specified sequence output’s name.

    • int _get_output_value_port_count ( ) virtual

    Return the amount of output value ports.

    • _get_output_value_port_name ( int idx ) virtual

    Return the specified output’s name.

    • _get_output_value_port_type ( int idx ) virtual
    • _get_text ( ) virtual

    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).

    • int _get_working_memory_size ( ) virtual

    Return the size of the custom node’s working memory. See for more details.

    Return whether the custom node has an input sequence port.

    Execute the custom node’s logic, returning the index of the output sequence port to use or a when there is an error.

    The array contains the values of the input ports.

    outputs is an array whose indices should be set to the respective outputs.

    The is usually START_MODE_BEGIN_SEQUENCE, unless you have used the STEP_* constants.

    When returning, you can mask the returned value with one of the STEP_* constants.