Talos docs

OrbitShotSpec

Since 0.6

What {@link orbitShot} builds a shot from.

Plain text

Signature

export interface OrbitShotSpec {
  /** The point circled, and looked at unless `target` says otherwise. */
  center: Vec3
  /** Horizontal distance from the centre, metres. */
  radius: number
  /** Eye height above the centre, metres. */
  height: number
  /** Start and end angle, degrees about +Y; 0 is on the centre's +Z side. */
  fromDeg: number
  toDeg: number
  /** Seconds. */
  duration: number
  fov?: number
  /** Look at this instead of `center`: a point or an entity id. */
  target?: Vec3 | string
  /** Keys along the arc; more is rounder. Default one per 5° (the chords sag under 0.1% of the radius), at least 2. */
  steps?: number
  name?: string
  blend?: number
}

Import: import type { OrbitShotSpec } from "@argus/gameplay"

Members

MemberSignatureDescription
centercenter: Vec3The point circled, and looked at unless target says otherwise.
radiusradius: numberHorizontal distance from the centre, metres.
heightheight: numberEye height above the centre, metres.
fromDegfromDeg: numberStart and end angle, degrees about +Y; 0 is on the centre's +Z side.
toDegtoDeg: number
durationduration: numberSeconds.
fovfov?: number
targettarget?: Vec3 | stringLook at this instead of center: a point or an entity id.
stepssteps?: numberKeys along the arc; more is rounder. Default one per 5° (the chords sag under 0.1% of the radius), at least 2.
namename?: string
blendblend?: number