VisualScript

Inherits: Script < Resource < Reference < Object

一个在可视化脚本编程环境中实现的脚本。

描述

在 Visual Script 编程环境中实现的脚本。该脚本扩展了所有实例化它的对象的功能。

Object.set_script 扩展现有对象，如果该对象的类与脚本的基类之一匹配。

您最有可能通过 Visual Script 编辑器或在为其编写插件时使用此类。

教程

• ../getting_started/scripting/visual_script/index

方法

信号

• node_ports_changed ( String function, int id )

当节点端口更改时触发。

方法说明

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

为用add_custom_signal添加的自定义信号添加一个参数。

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

连接两个数据端口。from_node的from_port的值将被输入to_node的to_port。

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

断开之前用data_connect连接的两个数据端口。

• int get_function_node_id ( String name ) const

返回函数入口点节点的ID。

• Vector2 get_function_scroll ( String name ) const

返回给定函数的屏幕中心的位置。

• VisualScriptNode get_node ( String func, int id ) const

返回一个节点，指定它的id和它的函数。

• 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

返回是否存在带有给定 ID 的节点。

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

连接两个序列端口。执行将从from_node的from_output输入to_node。

与data_connect不同，没有to_port，因为目标节点只能有一个序列端口。

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

断开之前用sequence_connect连接的两个序列端口。

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

设置变量的信息，使用与 get_variable_info 相同的格式。