BusEventMap

A behavior's own emit can use any name; only these eight are raised by the engine, and only these eight have a payload the types can know in advance.

Signature

export interface BusEventMap {
  trigger: BusTriggerEvent
  collision: BusCollision
  "ui-activated": BusUiActivated
  "ui-focused": BusUiFocused
  "hold-broken": BusHoldBroken
  teleported: BusTeleported
  "character-squeezed": BusCharacterSqueezed
  "vehicle-recovered": BusVehicleRecovered
}

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

Members

Example

The tested fixture fixtures/recipes/jump-pad-and-elevator/scenes/behaviors/camera-zone.ts.

import type { Behavior } from "@argus/api"

/**
 * A trigger volume that retunes the camera while the player is inside it.
 *
 * The engine has no camera-zone concept and needs none: a volume, a `trigger` component and this.
 * Here the player's behaviour owns the camera (it re-sends its params when the view is turned), so
 * the zone tells it what to change rather than calling `ctx.camera.set` itself. In a scene where
 * nothing else writes the camera, the zone can call `ctx.camera.set(kind, params)` directly.
 */
interface Props {
  /** `ctx.camera.set` params to merge in on the way in, and on the way out. */
  inside?: Record<string, unknown>
  outside?: Record<string, unknown>
}

export default {
  onTrigger(ctx, trigger) {
    const params = trigger.entering ? ctx.props.inside : ctx.props.outside
    if (params) ctx.events.emit("camera-zone", { target: trigger.other.id, params })
  },
} satisfies Behavior<Record<string, never>, Props>