VisualScript

Inherits: Script < Resource < Reference < Object

Un script implementado en el entorno de programación de Visual Script.

Descripción

A script implemented in the Visual Script programming environment. The script extends the functionality of all objects that instance it.

Object.set_script extends an existing object, if that object's class matches one of the script's base classes.

You are most likely to use this class via the Visual Script editor or when writing plugins for it.

Tutoriales

• ../getting_started/scripting/visual_script/index

Métodos

void	add_custom_signal ( String name )
void	add_function ( String name )
void	add_node ( String func, int id, VisualScriptNode node, Vector2 position=Vector2( 0, 0 ) )
void	add_variable ( String name, Variant default_value=null, bool export=false )
void	custom_signal_add_argument ( String name, Variant.Type type, String argname, int index=-1 )
int	custom_signal_get_argument_count ( String name ) const
String	custom_signal_get_argument_name ( String name, int argidx ) const
Variant.Type	custom_signal_get_argument_type ( String name, int argidx ) const
void	custom_signal_remove_argument ( String name, int argidx )
void	custom_signal_set_argument_name ( String name, int argidx, String argname )
void	custom_signal_set_argument_type ( String name, int argidx, Variant.Type type )
void	custom_signal_swap_argument ( String name, int argidx, int withidx )
void	data_connect ( String func, int from_node, int from_port, int to_node, int to_port )
void	data_disconnect ( String func, int from_node, int from_port, int to_node, int to_port )
int	get_function_node_id ( String name ) const
Vector2	get_function_scroll ( String name ) const
VisualScriptNode	get_node ( String func, int id ) const
Vector2	get_node_position ( String func, int id ) const
Variant	get_variable_default_value ( String name ) const
bool	get_variable_export ( String name ) const
Dictionary	get_variable_info ( String name ) const
bool	has_custom_signal ( String name ) const
bool	has_data_connection ( String func, int from_node, int from_port, int to_node, int to_port ) const
bool	has_function ( String name ) const
bool	has_node ( String func, int id ) const
bool	has_sequence_connection ( String func, int from_node, int from_output, int to_node ) const
bool	has_variable ( String name ) const
void	remove_custom_signal ( String name )
void	remove_function ( String name )
void	remove_node ( String func, int id )
void	remove_variable ( String name )
void	rename_custom_signal ( String name, String new_name )
void	rename_function ( String name, String new_name )
void	rename_variable ( String name, String new_name )
void	sequence_connect ( String func, int from_node, int from_output, int to_node )
void	sequence_disconnect ( String func, int from_node, int from_output, int to_node )
void	set_function_scroll ( String name, Vector2 ofs )
void	set_instance_base_type ( String type )
void	set_node_position ( String func, int id, Vector2 position )
void	set_variable_default_value ( String name, Variant value )
void	set_variable_export ( String name, bool enable )
void	set_variable_info ( String name, Dictionary value )

Señales

• node_ports_changed ( String function, int id )

Emitido cuando se cambian los puertos de un nodo.

Descripciones de Métodos

• void add_custom_signal ( String name )

Añade una señal personalizada con el nombre especificado al VisualScript.

---

• void add_function ( String name )

Añade una función con el nombre especificado al VisualScript.

---

• void add_node ( String func, int id, VisualScriptNode node, Vector2 position=Vector2( 0, 0 ) )

Añade un nodo a una función del VisualScript.

---

• void add_variable ( String name, Variant default_value=null, bool export=false )

Añade una variable al VisualScript, opcionalmente dándole un valor por defecto o marcándola como exportada.

---

• void custom_signal_add_argument ( String name, Variant.Type type, String argname, int index=-1 )

Añade un argumento a una señal personalizada añadida con add_custom_signal.

---

• int custom_signal_get_argument_count ( String name ) const

Consigue el conteo de los argumentos de una señal personalizada.

---

• String custom_signal_get_argument_name ( String name, int argidx ) const

Consigue el nombre del argumento de una señal personalizada.

---

• Variant.Type custom_signal_get_argument_type ( String name, int argidx ) const

Obtener el tipo de argumento de una señal personalizada.

---

• void custom_signal_remove_argument ( String name, int argidx )

Eliminar el argumento de una señal personalizada específica.

---

• void custom_signal_set_argument_name ( String name, int argidx, String argname )

Renombrar el argumento de una señal personalizada.

---

• void custom_signal_set_argument_type ( String name, int argidx, Variant.Type type )

Cambiar el tipo de argumento de una señal personalizada.

---

• void custom_signal_swap_argument ( String name, int argidx, int withidx )

Intercambie dos de los argumentos de una señal personalizada.

---

• void data_connect ( String func, int from_node, int from_port, int to_node, int to_port )

Conecta dos puertos de datos. El valor de from_node's from_port se introduciría en to_node's to_port.

---

• void data_disconnect ( String func, int from_node, int from_port, int to_node, int to_port )

Desconecte dos puertos de datos previamente conectados con data_connect.

---

• int get_function_node_id ( String name ) const

Devuelve la identificación del nodo de entrada de una función.

---

• Vector2 get_function_scroll ( String name ) const

Devuelve la posición del centro de la pantalla para una función determinada.

---

• VisualScriptNode get_node ( String func, int id ) const

Devuelve un nodo dado su id y su función.

---

• Vector2 get_node_position ( String func, int id ) const

Devuelve la posición de un nodo en píxeles.

---

• Variant get_variable_default_value ( String name ) const

Devuelve el valor por defecto (inicial) de una variable.

---

• bool get_variable_export ( String name ) const

Devuelve si una variable se exporta.

---

• Dictionary get_variable_info ( String name ) const

Devuelve la información de una determinada variable como un diccionario. La información incluye su nombre, tipo, pista y uso.

---

• bool has_custom_signal ( String name ) const

Devuelve si existe una señal con el nombre especificado.

---

• bool has_data_connection ( String func, int from_node, int from_port, int to_node, int to_port ) const

Devuelve si los puertos de datos especificados están conectados.

---

• bool has_function ( String name ) const

Devuelve si existe una función con el nombre especificado.

---

• bool has_node ( String func, int id ) const

Devuelve si existe un nodo con el id dado.

---

• bool has_sequence_connection ( String func, int from_node, int from_output, int to_node ) const

Devuelve si los puertos de secuencia especificados están conectados.

---

• bool has_variable ( String name ) const

Devuelve si una variable existe con el nombre especificado.

---

• void remove_custom_signal ( String name )

Quita una señal personalizada con el nombre dado.

---

• void remove_function ( String name )

Eliminar una función específica y sus nodos del script.

---

• void remove_node ( String func, int id )

Elimina un nodo específico.

---

• void remove_variable ( String name )

Elimina una variable con el nombre dado.

---

• void rename_custom_signal ( String name, String new_name )

Cambiar el nombre de una señal personalizada.

---

• void rename_function ( String name, String new_name )

Cambia el nombre de una función.

---

• void rename_variable ( String name, String new_name )

Cambiar el nombre de una variable.

---

• void sequence_connect ( String func, int from_node, int from_output, int to_node )

Conecta dos puertos de secuencia. La ejecución fluirá desde el from_node del from_output hacia el to_node.

A diferencia de data_connect, no hay un to_port, ya que el nodo destino sólo puede tener un puerto de secuencia.

---

• void sequence_disconnect ( String func, int from_node, int from_output, int to_node )

Desconecte dos puertos de secuencia previamente conectados con sequence_connect.

---

• void set_function_scroll ( String name, Vector2 ofs )

Coloca el centro de la pantalla para una función.

---

• void set_instance_base_type ( String type )

Establece el tipo de base del script.

---

• void set_node_position ( String func, int id, Vector2 position )

Coloca un nodo en la pantalla.

---

• void set_variable_default_value ( String name, Variant value )

Cambia el valor por defecto (inicial) de una variable.

---

• void set_variable_export ( String name, bool enable )

Cambia si una variable se exporta.

---

• void set_variable_info ( String name, Dictionary value )

Establece la información de una variable, usando el mismo formato que get_variable_info.