@tripo3d/engine / ScriptContext
Interface: ScriptContext
Defined in: ecs/script.ts:28
Script 同步 setup 期间获得的 Entity-local 注册与控制面。
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
engine | readonly | Engine | 拥有 Entity 的 Engine。 | ecs/script.ts:35 |
entity | readonly | Entity | 拥有该 Script record 的 Entity。 | ecs/script.ts:37 |
Methods
emitEvent()
ts
emitEvent<T>(event, ...payload): void;Defined in: ecs/script.ts:30
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
event | EngineEvent<T> | Event token。 |
...payload | [T] extends [void] ? [] : [T extends void ? undefined : T] | 非 void Event 必须提供的 payload。 |
Returns
void
isEnabled()
ts
isEnabled(): boolean;Defined in: ecs/script.ts:39
Returns
boolean
Script 自身当前的 enabled，不包含 World membership gate。
onceEvent()
ts
onceEvent<T>(event, handler): () => void;Defined in: ecs/script.ts:45
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
event | EngineEvent<T> | Event token。 |
handler | (payload) => void | 仅实际执行一次且受 Script effective/enrollment gate 约束的 handler。 |
Returns
幂等 unsubscribe。
() => void
onDestroy()
ts
onDestroy(handler): void;Defined in: ecs/script.ts:47
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => void | owner 销毁时按 LIFO 调用的同步清理回调。 |
Returns
void
onDisable()
ts
onDisable(handler): void;Defined in: ecs/script.ts:49
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => void | Script 离开 effective lane 时按注册顺序调用的同步回调。 |
Returns
void
onEnable()
ts
onEnable(handler): void;Defined in: ecs/script.ts:51
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | () => void | Script 进入 effective lane 时按注册顺序调用的同步回调。 |
Returns
void
onEvent()
ts
onEvent<T>(event, handler): () => void;Defined in: ecs/script.ts:57
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
event | EngineEvent<T> | Event token。 |
handler | (payload) => void | 仅在 Script effective/enrolled 时执行的同步 handler。 |
Returns
幂等 unsubscribe。
() => void
onLateUpdate()
ts
onLateUpdate(handler): void;Defined in: ecs/script.ts:59
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (frame) => void | Script late-update lane 的同步 frame 回调。 |
Returns
void
onResize()
ts
onResize(handler): void;Defined in: ecs/script.ts:61
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (size) => void | 每次 Engine 发布新尺寸时调用的同步回调。 |
Returns
void
onUpdate()
ts
onUpdate(handler): void;Defined in: ecs/script.ts:63
Parameters
| Parameter | Type | Description |
|---|---|---|
handler | (frame) => void | Script update lane 的同步 frame 回调。 |
Returns
void
setEnabled()
ts
setEnabled(enabled): boolean;Defined in: ecs/script.ts:65
Parameters
| Parameter | Type | Description |
|---|---|---|
enabled | boolean | 要提交的 enabled。 |
Returns
boolean
值是否实际发生变化。