:github_url: hide

.. Generated automatically by doc/tools/make_rst.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>`

Un nodo de Visual Script con script.

Descripción
----------------------

Un nodo de Visual Script personalizado que puede ser programado de manera poderosa.

Métodos
--------------

+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`int<class_int>`         | :ref:`_get_input_value_port_hint<class_VisualScriptCustomNode_method__get_input_value_port_hint>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                                          |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`   | :ref:`_get_input_value_port_hint_string<class_VisualScriptCustomNode_method__get_input_value_port_hint_string>` **(** :ref:`int<class_int>` idx **)** |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:`int<class_int>`         | :ref:`_get_output_value_port_hint<class_VisualScriptCustomNode_method__get_output_value_port_hint>` **(** :ref:`int<class_int>` idx **)** |virtual|                                                                        |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`   | :ref:`_get_output_value_port_hint_string<class_VisualScriptCustomNode_method__get_output_value_port_hint_string>` **(** :ref:`int<class_int>` idx **)** |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| |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Enumeraciones
--------------------------

.. _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** --- El modo de inicio utilizado la primera vez cuando se llama a :ref:`_step<class_VisualScriptCustomNode_method__step>`.

- **START_MODE_CONTINUE_SEQUENCE** = **1** --- El modo de inicio utilizado cuando se llama a :ref:`_step<class_VisualScriptCustomNode_method__step>` después de volver de una :ref:`STEP_PUSH_STACK_BIT<class_VisualScriptCustomNode_constant_STEP_PUSH_STACK_BIT>`.

- **START_MODE_RESUME_YIELD** = **2** --- El modo de inicio utilizado cuando se llama a :ref:`_step<class_VisualScriptCustomNode_method__step>` después de reanudar desde :ref:`STEP_YIELD_BIT<class_VisualScriptCustomNode_constant_STEP_YIELD_BIT>`.

Constantes
--------------------

.. _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** --- Sugerencia usada por :ref:`_step<class_VisualScriptCustomNode_method__step>` para decir que el control debe volver a él cuando no quede ningún otro nodo por ejecutar.

Esto lo usa :ref:`VisualScriptCondition<class_VisualScriptCondition>` para redirigir la secuencia al puerto "Done" después de que la rama ``true``/``false`` haya terminado la ejecución.

- **STEP_GO_BACK_BIT** = **33554432** --- Sugerencia usada por :ref:`_step<class_VisualScriptCustomNode_method__step>` para decir que el control debe regresar, ya sea golpeando una :ref:`STEP_PUSH_STACK_BIT<class_VisualScriptCustomNode_constant_STEP_PUSH_STACK_BIT>` anterior o saliendo de la función.

- **STEP_NO_ADVANCE_BIT** = **67108864**

- **STEP_EXIT_FUNCTION_BIT** = **134217728** --- Sugerencia usada por :ref:`_step<class_VisualScriptCustomNode_method__step>` para decir que el control debe detenerse y salir de la función.

- **STEP_YIELD_BIT** = **268435456** --- Sugerencia utilizada por el :ref:`_step<class_VisualScriptCustomNode_method__step>` para decir que la función debe ser cedida.

Usar esto requiere que tengas al menos una ranura de memoria de trabajo, que se usa para el :ref:`VisualScriptFunctionState<class_VisualScriptFunctionState>`.

Descripciones de Métodos
------------------------------------------------

.. _class_VisualScriptCustomNode_method__get_caption:

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

Devuelve el título del nodo.

----

.. _class_VisualScriptCustomNode_method__get_category:

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

Devuelve la categoría del nodo.

----

.. _class_VisualScriptCustomNode_method__get_input_value_port_count:

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

Devuelve el recuento de los puertos de valor de entrada.

----

.. _class_VisualScriptCustomNode_method__get_input_value_port_hint:

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

Return the specified input port's hint. See the :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` hints.

----

.. _class_VisualScriptCustomNode_method__get_input_value_port_hint_string:

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

Return the specified input port's hint string.

----

.. _class_VisualScriptCustomNode_method__get_input_value_port_name:

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

Devuelve el nombre del puerto de entrada especificado.

----

.. _class_VisualScriptCustomNode_method__get_input_value_port_type:

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

Devuelve el tipo de puerto de entrada especificado. Vea los valores de :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>`.

----

.. _class_VisualScriptCustomNode_method__get_output_sequence_port_count:

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

Devuelve la cantidad de puertos **secuencia** de salida.

----

.. _class_VisualScriptCustomNode_method__get_output_sequence_port_text:

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

Devuelve el nombre de la salida de la **secuencia** especificada.

----

.. _class_VisualScriptCustomNode_method__get_output_value_port_count:

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

Devuelve la cantidad de puertos de valor de salida.

----

.. _class_VisualScriptCustomNode_method__get_output_value_port_hint:

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

Return the specified output port's hint. See the :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` hints.

----

.. _class_VisualScriptCustomNode_method__get_output_value_port_hint_string:

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

Return the specified output port's hint string.

----

.. _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 port'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 port's type. See the :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` values.

----

.. _class_VisualScriptCustomNode_method__get_text:

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

Devuelve el texto del nodo personalizado, que se muestra justo al lado del puerto de entrada **secuencia** (si no hay ninguno, en el lugar que suele ocupar).

----

.. _class_VisualScriptCustomNode_method__get_working_memory_size:

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

Devuelve el texto del nodo personalizado, que se muestra justo al lado del puerto de entrada **secuencia** (si no hay ninguno, en el lugar que suele ocupar).

----

.. _class_VisualScriptCustomNode_method__has_input_sequence_port:

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

Devuelve si el nodo personalizado tiene un puerto **secuencia** entrada.

----

.. _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 :ref:`START_MODE_BEGIN_SEQUENCE<class_VisualScriptCustomNode_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. The size needs to be predefined using :ref:`_get_working_memory_size<class_VisualScriptCustomNode_method__get_working_memory_size>`.

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

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`