Skip to content

@tripo3d/engine / createScript

Function: createScript() ​

ts
function createScript<T>(
   name, 
   setup, 
options?): ScriptDefinition<T>;

Defined in: ecs/script.ts:92

创建一个冻结且 identity 唯一的 Script Definition。

Type Parameters ​

Type ParameterDescription
Tsetup 返回的业务 identity 类型。

Parameters ​

ParameterTypeDescription
namestring仅用于诊断的名称;允许同名 Definition。
setup(context) => Towner add 时严格同步执行的 setup。
options?ScriptOptions可选的初始 enabled。

Returns ​

ScriptDefinition<T>

冻结的新 Script Definition。

Throws ​

name、setup、options 或 enabled 类型错误时抛出。

基于 MIT 协议发布(内部使用)