threejs-worldgen
    Preparing search index...

    Interface BodyOptions

    One body of a star system. Plain JSON.

    interface BodyOptions {
        albedo: number;
        atmosphere: BodyAtmosphere | null;
        axialTilt: number;
        colors: [string, string, string];
        gm: number;
        kind: BodyKind;
        name: string;
        orbit: OrbitalElements | null;
        parent: string | null;
        radius: number;
        rings: RingOptions | null;
        rotationAtEpoch: number;
        siderealDay: number;
        surface: SurfaceStyle;
        temperature: number;
        tidallyLocked: boolean;
    }

    Hierarchy (View Summary)

    Index
    albedo atmosphere axialTilt colors gm kind name orbit parent radius rings rotationAtEpoch siderealDay surface temperature tidallyLocked
    albedo: number

    Bond albedo, 0..1 (moons: how bright the lit disc is).

    atmosphere: BodyAtmosphere | null

    Optional atmosphere glow in the solar-system view.

    axialTilt: number

    Obliquity: tilt of the spin axis from the orbit's reference plane, degrees.

    colors: [string, string, string]

    Three surface colours for the procedural style (#rrggbb).

    gm: number

    Gravitational parameter GM, m³/s² (the mass that children orbit).

    kind: BodyKind

    Star, planet or moon.

    name: string

    Unique name. The defaults are 'sun', 'home' and 'moon'.

    orbit: OrbitalElements | null

    Orbit around parent; null for the central star.

    parent: string | null

    Name of the body it orbits; null for the central star.

    radius: number

    Mean radius, metres.

    rings: RingOptions | null

    Optional rings.

    rotationAtEpoch: number

    Spin angle at the J2000 epoch, degrees.

    siderealDay: number

    Rotation period relative to the stars, seconds. Negative spins retrograde, 0 doesn't spin.

    surface: SurfaceStyle

    Procedural surface style for the solar-system view.

    temperature: number

    Black-body temperature, kelvin (stars: sets the light colour).

    tidallyLocked: boolean

    Always shows the same face to its parent (spin follows the orbit).

    Settings
    Member Visibility

    On This Page
    Properties