SceneTimeScaleOptions

Defined in: SceneTime.ts:25

Options for SceneTime.scaleBy.

Properties

excludeUpdates?

optional excludeUpdates?: readonly Entity[]

Defined in: SceneTime.ts:51

Entities this request does not apply to. For an excluded entity the request’s channel contributes factor 1 to SceneTime.effectiveScaleForUpdates — the channel’s masked older entries do not step in. Exclusion covers component updates, the entity’s ProcessComponent, and its particle emitters. Physics is NOT excluded: the entity’s rigid body still integrates at world speed, and physics-writing components under exclusion push forces at the excluded rate into a slowed world.

---

for?

optional for?: number

Defined in: SceneTime.ts:33

Real-time duration in seconds after which the request auto-releases. Aged on raw frame time — unaffected by any time scaling — but only while the owning scene is active (a stack-paused scene holds its effects). 0 returns an already-inactive handle without adding a request. Omit for a request that lasts until release().

---

key?

optional key?: string

Defined in: SceneTime.ts:40

Channel name. Within a channel the latest active request wins (with show-through: when it ends, the previous still-active request applies again); across channels the winning factors multiply. Omit for an anonymous channel private to this call.

---

label?

optional label?: string

Defined in: SceneTime.ts:53

Display-only name for debugging. Defaults to key.