interface EntityInspection

Members

addressreadonly

address: string | null

altitudereadonly

altitude: number | null

altitudeTextreadonly

altitudeText: string | null

canonicalreadonly

canonical: { offset: readonly [number, number, number]; sector: readonly [number, number, number]; text: string }

coastingreadonly

coasting: boolean

On rails: propagated from an epoch rather than integrated (ADR-0025).

flightAssistreadonly

flightAssist: boolean

framereadonly

frame: string

frameChainreadonly

frameChain: readonly string[]

headingreadonly

heading: { x: number; y: number; z: number }

The nose, in the frame's axes like local. A ship that arrives looking at a body in its own frame has this along -local.

idreadonly

id: EntityId

kindreadonly

kind: string

landedreadonly

landed: boolean

localreadonly

local: { x: number; y: number; z: number }

localSpeedreadonly

localSpeed: number

Speed within its own frame — ground speed when landed, orbital when orbiting.

localSpeedTextreadonly

localSpeedText: string

namereadonly

name: string

orbitreadonly

orbit: OrbitInspection | null

The conic about the frame's body, or null with nothing to be on one about.

partitionreadonly

partition: string

phasereadonly

phase: Degrees | null

The sun–body–eye angle at the body whose frame this is, degrees: zero is the full face, 180 the silhouette. Null outside a b: frame.

speedreadonly

speed: number

Speed in universe axes — what an outside observer measures.

speedTextreadonly

speedText: string

surfaceSpeedreadonly

surfaceSpeed: number | null

Speed against the ground and the air under the ship, m/s — the body's spin taken out of the frame speed. Null with no body to measure against.

throttlereadonly

throttle: number

The main drive's throttle, 0..1.

thrustingreadonly

thrusting: boolean

Whether any thruster valve is open this tick, the assist's included.

velocityreadonly

velocity: { x: number; y: number; z: number }

verticalSpeedreadonly

verticalSpeed: number | null

Rate of climb, m/s, positive away from the body. Null in deep space.