VisualScript¶
Inherits: Script < Resource < Reference < Object
一个在可视化脚本编程环境中实现的脚本。
描述¶
在 Visual Script 编程环境中实现的脚本。该脚本扩展了所有实例化它的对象的功能。
Object.set_script 扩展现有对象,如果该对象的类与脚本的基类之一匹配。
您最有可能通过 Visual Script 编辑器或在为其编写插件时使用此类。
教程¶
../getting_started/scripting/visual_script/index
方法¶
信号¶
当节点端口更改时触发。
方法说明¶
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 custom_signal_add_argument ( String name, Variant.Type type, String argname, int index=-1 )
为用add_custom_signal添加的自定义信号添加一个参数。
获取自定义信号的参数计数。
获取自定义信号的参数名称。
Variant.Type custom_signal_get_argument_type ( String name, int argidx ) const
获取自定义信号的参数类型。
删除特定的自定义信号的参数。
重命名自定义信号的参数。
void custom_signal_set_argument_type ( String name, int argidx, Variant.Type type )
更改自定义信号的参数类型。
调换自定义信号的两个参数。
连接两个数据端口。from_node
的from_port
的值将被输入to_node
的to_port
。
断开之前用data_connect连接的两个数据端口。
返回函数入口点节点的ID。
返回给定函数的屏幕中心的位置。
VisualScriptNode get_node ( String func, int id ) const
返回一个节点,指定它的id和它的函数。
返回节点的坐标,单位是像素。
返回变量的初始默认值。
返回是否导出变量。
Dictionary get_variable_info ( String name ) const
以字典的形式返回指定变量的信息。这些信息包括它的名称、类型、提示和用法。
返回是否存在具有指定名称的信号。
bool has_data_connection ( String func, int from_node, int from_port, int to_node, int to_port ) const
返回指定的数据端口是否已连接。
返回是否存在带有指定名称的函数。
返回是否存在带有给定 ID 的节点。
返回指定的序列端口是否已连接。
返回是否存在带有指定名称的变量。
void remove_custom_signal ( String name )
删除带有给定名称的自定义信号。
void remove_function ( String name )
从脚本中删除特定函数及其节点。
删除特定节点。
void remove_variable ( String name )
删除具有给定名称的变量。
更改自定义信号的名称。
更改函数的名称。
更改变量的名称。
连接两个序列端口。执行将从from_node
的from_output
输入to_node
。
与data_connect不同,没有to_port
,因为目标节点只能有一个序列端口。
断开之前用sequence_connect连接的两个序列端口。
为功能定位屏幕中心。
void set_instance_base_type ( String type )
设置脚本的基类。
在屏幕上定位一个节点。
更改变量的初始默认值。
更改是否导出变量。
void set_variable_info ( String name, Dictionary value )
设置变量的信息,使用与 get_variable_info 相同的格式。