godot-docs/classes/class_visualscriptcustomnode.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the VisualScriptCustomNode.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_VisualScriptCustomNode:

VisualScriptCustomNode
======================

**Inherits:** :ref:`VisualScriptNode<class_VisualScriptNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

A scripted Visual Script node.

Methods
-------

+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`   | :ref:`_get_caption<class_VisualScriptCustomNode_method__get_caption>` **(** **)** virtual                                                                                                                                |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`   | :ref:`_get_category<class_VisualScriptCustomNode_method__get_category>` **(** **)** virtual                                                                                                                              |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`_get_input_value_port_count<class_VisualScriptCustomNode_method__get_input_value_port_count>` **(** **)** virtual                                                                                                  |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`   | :ref:`_get_input_value_port_name<class_VisualScriptCustomNode_method__get_input_value_port_name>` **(** :ref:`int<class_int>` idx **)** virtual                                                                          |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`_get_input_value_port_type<class_VisualScriptCustomNode_method__get_input_value_port_type>` **(** :ref:`int<class_int>` idx **)** virtual                                                                          |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`_get_output_sequence_port_count<class_VisualScriptCustomNode_method__get_output_sequence_port_count>` **(** **)** virtual                                                                                          |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`   | :ref:`_get_output_sequence_port_text<class_VisualScriptCustomNode_method__get_output_sequence_port_text>` **(** :ref:`int<class_int>` idx **)** virtual                                                                  |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`_get_output_value_port_count<class_VisualScriptCustomNode_method__get_output_value_port_count>` **(** **)** virtual                                                                                                |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`   | :ref:`_get_output_value_port_name<class_VisualScriptCustomNode_method__get_output_value_port_name>` **(** :ref:`int<class_int>` idx **)** virtual                                                                        |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`_get_output_value_port_type<class_VisualScriptCustomNode_method__get_output_value_port_type>` **(** :ref:`int<class_int>` idx **)** virtual                                                                        |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`   | :ref:`_get_text<class_VisualScriptCustomNode_method__get_text>` **(** **)** virtual                                                                                                                                      |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`         | :ref:`_get_working_memory_size<class_VisualScriptCustomNode_method__get_working_memory_size>` **(** **)** virtual                                                                                                        |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`       | :ref:`_has_input_sequence_port<class_VisualScriptCustomNode_method__has_input_sequence_port>` **(** **)** virtual                                                                                                        |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`_step<class_VisualScriptCustomNode_method__step>` **(** :ref:`Array<class_Array>` inputs, :ref:`Array<class_Array>` outputs, :ref:`int<class_int>` start_mode, :ref:`Array<class_Array>` working_mem **)** virtual |
+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_VisualScriptCustomNode_StartMode:

.. _class_VisualScriptCustomNode_constant_START_MODE_BEGIN_SEQUENCE:

.. _class_VisualScriptCustomNode_constant_START_MODE_CONTINUE_SEQUENCE:

.. _class_VisualScriptCustomNode_constant_START_MODE_RESUME_YIELD:

enum **StartMode**:

- **START_MODE_BEGIN_SEQUENCE** = **0** --- The start mode used the first time when :ref:`_step<class_VisualScriptCustomNode_method__step>` is called.

- **START_MODE_CONTINUE_SEQUENCE** = **1** --- The start mode used when :ref:`_step<class_VisualScriptCustomNode_method__step>` is called after coming back from a STEP_PUSH_STACK_BIT.

- **START_MODE_RESUME_YIELD** = **2** --- The start mode used when :ref:`_step<class_VisualScriptCustomNode_method__step>` is called after resuming from STEP_YIELD_BIT.

Constants
---------

.. _class_VisualScriptCustomNode_constant_STEP_PUSH_STACK_BIT:

.. _class_VisualScriptCustomNode_constant_STEP_GO_BACK_BIT:

.. _class_VisualScriptCustomNode_constant_STEP_NO_ADVANCE_BIT:

.. _class_VisualScriptCustomNode_constant_STEP_EXIT_FUNCTION_BIT:

.. _class_VisualScriptCustomNode_constant_STEP_YIELD_BIT:

- **STEP_PUSH_STACK_BIT** = **16777216** --- Hint used by :ref:`_step<class_VisualScriptCustomNode_method__step>` to tell that control should return to it when there is no other node left to execute.

This is used by :ref:`VisualScriptCondition<class_VisualScriptCondition>` to redirect the sequence to the "Done" port after the true/false branch has finished execution.

- **STEP_GO_BACK_BIT** = **33554432** --- Hint used by :ref:`_step<class_VisualScriptCustomNode_method__step>` 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 :ref:`_step<class_VisualScriptCustomNode_method__step>` to tell that control should stop and exit the function.

- **STEP_YIELD_BIT** = **268435456** --- Hint used by :ref:`_step<class_VisualScriptCustomNode_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 :ref:`VisualScriptFunctionState<class_VisualScriptFunctionState>`.

Description
-----------

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

Method Descriptions
-------------------

.. _class_VisualScriptCustomNode_method__get_caption:

- :ref:`String<class_String>` **_get_caption** **(** **)** virtual

Return the node's title.

.. _class_VisualScriptCustomNode_method__get_category:

- :ref:`String<class_String>` **_get_category** **(** **)** virtual

Return the node's category.

.. _class_VisualScriptCustomNode_method__get_input_value_port_count:

- :ref:`int<class_int>` **_get_input_value_port_count** **(** **)** virtual

Return the count of input value ports.

.. _class_VisualScriptCustomNode_method__get_input_value_port_name:

- :ref:`String<class_String>` **_get_input_value_port_name** **(** :ref:`int<class_int>` idx **)** virtual

Return the specified input port's name.

.. _class_VisualScriptCustomNode_method__get_input_value_port_type:

- :ref:`int<class_int>` **_get_input_value_port_type** **(** :ref:`int<class_int>` idx **)** virtual

Return the specified input port's type. See the TYPE\_\* enum in :ref:`@GlobalScope<class_@GlobalScope>`.

.. _class_VisualScriptCustomNode_method__get_output_sequence_port_count:

- :ref:`int<class_int>` **_get_output_sequence_port_count** **(** **)** virtual

Return the amount of output **sequence** ports.

.. _class_VisualScriptCustomNode_method__get_output_sequence_port_text:

- :ref:`String<class_String>` **_get_output_sequence_port_text** **(** :ref:`int<class_int>` idx **)** virtual

Return the specified **sequence** output's name.

.. _class_VisualScriptCustomNode_method__get_output_value_port_count:

- :ref:`int<class_int>` **_get_output_value_port_count** **(** **)** virtual

Return the amount of output value ports.

.. _class_VisualScriptCustomNode_method__get_output_value_port_name:

- :ref:`String<class_String>` **_get_output_value_port_name** **(** :ref:`int<class_int>` idx **)** virtual

Return the specified output's name.

.. _class_VisualScriptCustomNode_method__get_output_value_port_type:

- :ref:`int<class_int>` **_get_output_value_port_type** **(** :ref:`int<class_int>` idx **)** virtual

Return the specified output's type. See the TYPE\_\* enum in :ref:`@GlobalScope<class_@GlobalScope>`.

.. _class_VisualScriptCustomNode_method__get_text:

- :ref:`String<class_String>` **_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).

.. _class_VisualScriptCustomNode_method__get_working_memory_size:

- :ref:`int<class_int>` **_get_working_memory_size** **(** **)** virtual

Return the size of the custom node's working memory. See :ref:`_step<class_VisualScriptCustomNode_method__step>` for more details.

.. _class_VisualScriptCustomNode_method__has_input_sequence_port:

- :ref:`bool<class_bool>` **_has_input_sequence_port** **(** **)** virtual

Return whether the custom node has an input **sequence** port.

.. _class_VisualScriptCustomNode_method__step:

- :ref:`Variant<class_Variant>` **_step** **(** :ref:`Array<class_Array>` inputs, :ref:`Array<class_Array>` outputs, :ref:`int<class_int>` start_mode, :ref:`Array<class_Array>` working_mem **)** virtual

Execute the custom node's logic, returning the index of the output sequence port to use or a :ref:`String<class_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 ``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.