FlightState

Signature

export interface FlightState {
  /** The flight mode it flew. */
  mode: "rate" | "angle" | "velocity"
  /** Whether its motors are on. */
  armed: boolean
  /** Total thrust, newtons. */
  thrust: number
  /** Tilt from level, radians. */
  tilt: number
  /** Heading, radians: 0 facing -Z, positive turned left. */
  heading: number
  /** Speed through the air, m/s (the wind included). */
  airspeed: number
  /** Speed over the ground, m/s. */
  groundSpeed: number
  /** Vertical speed, m/s, up positive. */
  climbRate: number
  /** Battery left, 0..1. */
  charge: number
  /** The battery ran out and the motors stopped. */
  empty: boolean
  /** It holds a point (velocity mode, sticks centred). */
  holdingPosition: boolean
  /** It holds an altitude (lift centred). */
  holdingAltitude: boolean
  /** The rotors could not give everything asked this tick. */
  saturated: boolean
  /** On the ground with its motors idling; a climb takes it off. */
  landed: boolean
  /** Each rotor's speed as a share of full, 0..1. */
  rotorSpeeds: number[]
}

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

Members

Example

The tested fixture fixtures/host/door.ts.

import type { Behavior } from "@argus/api"
// docs/API.md, "Joints": a door on a hinge that swings open while the player is near and closes
// behind them. Typechecked by packages/api's tests.
export default {
  update(ctx) {
    const player = ctx.world.find("player")
    const near = player !== null && ctx.entity.distanceTo(player) < 2
    ctx.joint?.setMotor(near ? Math.PI / 2 : 0, { mode: "position", maxForce: 200 })
  },
} satisfies Behavior