跳至主要内容

RunGraphOptions

描述​

RunGraphOptions 是一个复杂类型，封装了运行图时可提供的一系列选项和配置。该类型使您能够根据特定需求灵活自定义图执行过程。

定义​

type RunGraphOptions = {
  graph: string;
  inputs?: Record<string, LooseDataValue>;
  context?: Record<string, LooseDataValue>;
  remoteDebugger?: RivetDebuggerServer;
  nativeApi?: NativeApi;
  externalFunctions?: {
    [key: string]: ExternalFunction;
  };
  onUserEvent?: {
    [key: string]: (data: DataValue | undefined) => void;
  };
  abortSignal?: AbortSignal;
} & {
  [P in keyof ProcessEvents as `on${PascalCase<P>}`]?: (params: ProcessEvents[P]) => void;
} & Settings;

属性​

图表​

类型: string

graph属性代表项目中要执行的图。这应该对应您项目中定义的某个图。可以是图的ID，也可以是Rivet UI中显示的图名称。

输入​

类型: Record

指定要执行的图表的一组输入值。对象中的键必须对应图表中Graph Input节点的ID，关联的值则是要传递给图表的数值。

有关可以传递给图表的不同类型值的更多信息，请参阅LooseDataValue。

上下文​

类型: Record

指定要执行的图形的一组上下文值。对象中的键必须对应图形中上下文节点的ID，关联的值则是要传递给图形的值。上下文类似于输入，但这些值对每个图形和子图形都可用。

有关可以传递给图表的不同类型值的更多信息，请参阅LooseDataValue。

远程调试器​

类型: RivetDebuggerServer

将一个RivetDebuggerServer实例传递给图执行进程。这允许您使用Rivet调试器来调试图执行过程。

更多信息请参阅Remote Debugging页面。

nativeApi​

类型: NativeApi

nativeApi属性是一个可选的NativeApi实例。这可用于为图形执行过程提供自定义的原生API实现。

externalFunctions​

类型: Object

externalFunctions属性是一个可选对象，可用于提供可由图形调用的外部函数。对象中的每个键对应一个外部函数的名称，关联的值则是要调用的函数。

函数必须返回一个解析为DataValue或undefined的Promise。该函数返回的DataValue将作为函数调用的结果传递给图表。

有关可以从外部函数返回的不同类型值的更多信息，请参见(DataValue)[../core/DataValue]。

onUserEvent​

类型: Object

onUserEvent属性是一个可选的用户事件处理程序对象。键是事件名称，值是在事件触发时将被调用的函数。这允许您处理在图形执行过程中可能发生的自定义事件。

abortSignal​

类型: AbortSignal

abortSignal属性是一个可选的AbortSignal实例。这可用于向图形处理操作发送中止信号，允许您以编程方式停止执行过程。

事件处理器​

类型: Object

RunGraphOptions 类型的这部分表示用于图处理的事件处理程序对象。键是以 on 为前缀的 PascalCase 事件名称，值是在事件触发时将被调用的函数。这允许您处理在图执行过程中可能发生的各种事件。

设置​

(Settings)[../core/Settings] 的属性会被合并到 RunGraphOptions 类型中。Settings 上的某些属性是必需的。更多信息请参阅该页面。

另请参阅​