WindHandle

Since 0.7

The scene's wind (meta.environment.air.wind), read-only, at ctx.time.now: the air the dry probes of buoyancy bodies are dragged against.

Plain text

A replay reads the same numbers.

Signature

export interface WindHandle {
  /**
   * The air's velocity at world (x, y, z), `[x, y, z]` m/s: zero in still air or in a scene with no
   * `meta.environment.air`. Throws a `RangeError` (`fluid.sample-invalid`) for a coordinate that is
   * not a finite number.
   */
  sample(x: number, y: number, z: number): Vec3
}

Import: import type { WindHandle } from "@argus/api"

Members

Member	Signature	Description
`sample`	`sample(x: number, y: number, z: number): Vec3`	The air's velocity at world (x, y, z), `[x, y, z]` m/s: zero in still air or in a scene with no `meta.environment.air`. Throws a `RangeError` (`fluid.sample-invalid`) for a coordinate that is not a finite number.