Taos API Reference
    Preparing search index...

    Class TriggerVolume

    A box sensor volume: fires onEnter/onExit as bodies overlap it and tracks how many currently do (isOccupied). Assign the callbacks from a script/circuit. Static (stays at its authored transform).

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    id: string = ...

    Stable identity for this component, unique within a session. Auto-generated for runtime-created components; the editor overwrites it with a persistent id when projecting a saved document so references survive save / load / undo.

    gameObject: GameObject

    The owning GameObject; assigned by addComponent before onAttach runs.

    halfExtents: Vec3 = ...

    Box half-extents of the sensor region.

    layer: number = CollisionLayer.Trigger
    mask: number = CollisionLayer.All
    onEnter: (() => void) | null = null

    Called when a body begins overlapping.

    onExit: (() => void) | null = null

    Called when a body stops overlapping.

    Accessors

    • get time(): Time

      The simulation clock of the scene this component belongs to. Read inside update (or any time after the GameObject is added to a scene) for absolute time, frame count, FPS, and timeScale-aware delta — e.g. this.time.elapsed, this.time.delta, this.time.frameCount.

      this.time.delta equals the dt argument passed to update, so components can ignore that argument entirely and pull everything from here.

      Returns Time

      if the owning GameObject is not currently part of a scene.

    Methods

    • Called every frame by the GameObject's update traversal.

      Parameters

      • _dt: number

        Frame delta time in seconds.

      Returns void

    • Called every frame by the GameObject's render traversal, after update and any input/controller mutations to the transform. Override to refresh per-frame state that render passes consume (e.g. Camera recomputes its cached view/projection matrices here).

      Parameters

      • _ctx: RenderContext

        Active render context (provides canvas width/height etc.).

      Returns void