VisualScriptCustomNode

Inherits: VisualScriptNode < Resource < Reference < Object

有脚本的可视化脚本节点。

描述

自定义的可视化脚本节点,可以用强大的方式进行脚本编写。

枚举

enum StartMode:

  • START_MODE_BEGIN_SEQUENCE = 0 --- 当_step被调用时,首次使用的启动模式。

  • START_MODE_CONTINUE_SEQUENCE = 1 --- 当从STEP_PUSH_STACK_BIT返回后调用_step时使用的启动模式。

  • START_MODE_RESUME_YIELD = 2 --- 从STEP_YIELD_BIT恢复后调用_step时使用的启动模式。

常量

  • STEP_PUSH_STACK_BIT = 16777216 --- 由_step使用的提示,告诉控件应该在没有其他节点可以执行时返回给它。

这被VisualScriptCondition用来在true/false分支执行完毕后,将序列重定向到 "Done" 端口。

  • STEP_GO_BACK_BIT = 33554432 --- 由_step使用的提示,告诉控件应该返回,要么命中之前的STEP_PUSH_STACK_BIT,要么退出函数。

  • STEP_NO_ADVANCE_BIT = 67108864

  • STEP_EXIT_FUNCTION_BIT = 134217728 --- _step用来告诉控件应该停止和退出函数的提示。

  • STEP_YIELD_BIT = 268435456 --- 由_step使用的提示,告诉函数应该被yielded。

使用这个要求你至少有一个工作存储槽,它被用于VisualScriptFunctionState

方法说明

  • String _get_caption ( ) virtual

返回节点的标题。


  • String _get_category ( ) virtual

返回节点的类别。


  • int _get_input_value_port_count ( ) virtual

返回输入值端口的数量。


  • int _get_input_value_port_hint ( int idx ) virtual

返回指定输入端口的提示。参阅 PropertyHint 提示。


  • String _get_input_value_port_hint_string ( int idx ) virtual

返回指定输入端口的提示字符串。


  • String _get_input_value_port_name ( int idx ) virtual

返回指定的输入端口的名称。


  • int _get_input_value_port_type ( int idx ) virtual

返回指定输入端口的类型。参阅Variant.Type值。


  • int _get_output_sequence_port_count ( ) virtual

返回输出sequence序列端口的数量。


  • String _get_output_sequence_port_text ( int idx ) virtual

返回指定的sequence序列输出的名称。


  • int _get_output_value_port_count ( ) virtual

返回输出值端口的数量。


  • int _get_output_value_port_hint ( int idx ) virtual

返回指定输出端口的提示。参阅PropertyHint 提示。


  • String _get_output_value_port_hint_string ( int idx ) virtual

返回指定输出端口的提示字符串。


  • String _get_output_value_port_name ( int idx ) virtual

返回指定输出端口的名称。


  • int _get_output_value_port_type ( int idx ) virtual

返回指定输出端口的类型。参阅Variant.Type值。


  • String _get_text ( ) virtual

返回自定义节点的文本,就在输入sequence序列端口旁边显示,如果没有,则在通常被它占用的位置。


  • int _get_working_memory_size ( ) virtual

返回自定义节点的运行内存的大小。更多细节参阅 _step


  • bool _has_input_sequence_port ( ) virtual

返回自定义节点是否有输入sequence序列端口。


执行自定义节点的逻辑,返回要使用的输出序列端口的索引,或者在有错误时返回一个String

inputs数组包含输入端口的值。

output是一个数组,其索引应被设置为相应的输出。

start_mode通常是START_MODE_BEGIN_SEQUENCE,除非你使用了STEP_*常量。

working_mem是一个数组,可以用来在自定义节点的运行之间持续保存信息。其大小需要用_get_working_memory_size来预定义。

当返回时,你可以用STEP_*中的一个常量来屏蔽返回值。