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



Member Functions
----------------

+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`    | :ref:`_get_caption<class_VisualScriptCustomNode__get_caption>`  **(** **)** virtual                                                                                                                                 |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`    | :ref:`_get_category<class_VisualScriptCustomNode__get_category>`  **(** **)** virtual                                                                                                                               |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`_get_input_value_port_count<class_VisualScriptCustomNode__get_input_value_port_count>`  **(** **)** virtual                                                                                                   |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`    | :ref:`_get_input_value_port_name<class_VisualScriptCustomNode__get_input_value_port_name>`  **(** :ref:`int<class_int>` idx  **)** virtual                                                                          |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`_get_input_value_port_type<class_VisualScriptCustomNode__get_input_value_port_type>`  **(** :ref:`int<class_int>` idx  **)** virtual                                                                          |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`_get_output_sequence_port_count<class_VisualScriptCustomNode__get_output_sequence_port_count>`  **(** **)** virtual                                                                                           |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`    | :ref:`_get_output_sequence_port_text<class_VisualScriptCustomNode__get_output_sequence_port_text>`  **(** :ref:`int<class_int>` idx  **)** virtual                                                                  |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`_get_output_value_port_count<class_VisualScriptCustomNode__get_output_value_port_count>`  **(** **)** virtual                                                                                                 |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`    | :ref:`_get_output_value_port_name<class_VisualScriptCustomNode__get_output_value_port_name>`  **(** :ref:`int<class_int>` idx  **)** virtual                                                                        |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`_get_output_value_port_type<class_VisualScriptCustomNode__get_output_value_port_type>`  **(** :ref:`int<class_int>` idx  **)** virtual                                                                        |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`    | :ref:`_get_text<class_VisualScriptCustomNode__get_text>`  **(** **)** virtual                                                                                                                                       |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`_get_working_memory_size<class_VisualScriptCustomNode__get_working_memory_size>`  **(** **)** virtual                                                                                                         |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`_has_input_sequence_port<class_VisualScriptCustomNode__has_input_sequence_port>`  **(** **)** virtual                                                                                                         |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>`  | :ref:`_step<class_VisualScriptCustomNode__step>`  **(** :ref:`Array<class_array>` inputs, :ref:`Array<class_array>` outputs, :ref:`int<class_int>` start_mode, :ref:`Array<class_array>` working_mem  **)** virtual |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Numeric Constants
-----------------

- **START_MODE_BEGIN_SEQUENCE** = **0**
- **START_MODE_CONTINUE_SEQUENCE** = **1**
- **START_MODE_RESUME_YIELD** = **2**
- **STEP_PUSH_STACK_BIT** = **16777216**
- **STEP_GO_BACK_BIT** = **33554432**
- **STEP_NO_ADVANCE_BIT** = **67108864**
- **STEP_EXIT_FUNCTION_BIT** = **134217728**
- **STEP_YIELD_BIT** = **268435456**

Member Function Description
---------------------------

.. _class_VisualScriptCustomNode__get_caption:

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

.. _class_VisualScriptCustomNode__get_category:

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

.. _class_VisualScriptCustomNode__get_input_value_port_count:

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

.. _class_VisualScriptCustomNode__get_input_value_port_name:

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

.. _class_VisualScriptCustomNode__get_input_value_port_type:

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

.. _class_VisualScriptCustomNode__get_output_sequence_port_count:

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

.. _class_VisualScriptCustomNode__get_output_sequence_port_text:

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

.. _class_VisualScriptCustomNode__get_output_value_port_count:

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

.. _class_VisualScriptCustomNode__get_output_value_port_name:

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

.. _class_VisualScriptCustomNode__get_output_value_port_type:

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

.. _class_VisualScriptCustomNode__get_text:

- :ref:`String<class_string>`  **_get_text**  **(** **)** virtual

.. _class_VisualScriptCustomNode__get_working_memory_size:

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

.. _class_VisualScriptCustomNode__has_input_sequence_port:

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

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