@kayahr/ed-journal
    Preparing search index...

    Interface ScanPlanet

    Scan of a planet or moon. Can be recognized by the existence of a PlanetClass property.

    interface ScanPlanet {
        AscendingNode?: number;
        Atmosphere?: string;
        AtmosphereComposition?: { Name: string; Percent: number }[];
        AtmosphereType?: string;
        AxialTilt?: number;
        BodyID?: ID;
        BodyName: string;
        Composition?: { Ice: number; Metal: number; Rock: number };
        DistanceFromArrivalLS: number;
        Eccentricity?: number;
        event: "Scan";
        Landable?: boolean;
        MassEM: number;
        Materials?: { Name: string; Percent: number }[];
        MeanAnomaly?: number;
        OrbitalInclination?: number;
        OrbitalPeriod?: number;
        Parents?: (
            | Record<"Planet", number> & Partial<
                Record<
                    | "Station"
                    | "Star"
                    | "PlanetaryRing"
                    | "AsteroidCluster"
                    | "Null"
                    | "StellarRing"
                    | "Ring",
                    never,
                >,
            >
            | Record<"Station", number> & Partial<
                Record<
                    | "Planet"
                    | "Star"
                    | "PlanetaryRing"
                    | "AsteroidCluster"
                    | "Null"
                    | "StellarRing"
                    | "Ring",
                    never,
                >,
            >
            | Record<"Star", number> & Partial<
                Record<
                    | "Planet"
                    | "Station"
                    | "PlanetaryRing"
                    | "AsteroidCluster"
                    | "Null"
                    | "StellarRing"
                    | "Ring",
                    never,
                >,
            >
            | Record<"PlanetaryRing", number> & Partial<
                Record<
                    | "Planet"
                    | "Station"
                    | "Star"
                    | "AsteroidCluster"
                    | "Null"
                    | "StellarRing"
                    | "Ring",
                    never,
                >,
            >
            | Record<"AsteroidCluster", number> & Partial<
                Record<
                    | "Planet"
                    | "Station"
                    | "Star"
                    | "PlanetaryRing"
                    | "Null"
                    | "StellarRing"
                    | "Ring",
                    never,
                >,
            >
            | Record<"Null", number> & Partial<
                Record<
                    | "Planet"
                    | "Station"
                    | "Star"
                    | "PlanetaryRing"
                    | "AsteroidCluster"
                    | "StellarRing"
                    | "Ring",
                    never,
                >,
            >
            | Record<"StellarRing", number> & Partial<
                Record<
                    | "Planet"
                    | "Station"
                    | "Star"
                    | "PlanetaryRing"
                    | "AsteroidCluster"
                    | "Null"
                    | "Ring",
                    never,
                >,
            >
            | Record<"Ring", number> & Partial<
                Record<
                    | "Planet"
                    | "Station"
                    | "Star"
                    | "PlanetaryRing"
                    | "AsteroidCluster"
                    | "Null"
                    | "StellarRing",
                    never,
                >,
            >
        )[];
        Periapsis?: number;
        PlanetClass: PlanetClass;
        Radius: number;
        ReserveLevel?: ReserveLevel;
        Rings?: Ring[];
        RotationPeriod: number;
        ScanType?: ScanType;
        SemiMajorAxis?: number;
        StarSystem?: string;
        StarType?: undefined;
        SurfaceGravity: number;
        SurfacePressure?: number;
        SurfaceTemperature?: number;
        SystemAddress?: ID;
        TerraformState?: string;
        TidalLock?: boolean;
        timestamp: string;
        Volcanism?: string;
        WasDiscovered?: boolean;
        WasMapped?: boolean;
    }

    Hierarchy

    • ScanBody
      • ScanPlanet
    Index

    Properties

    AscendingNode?: number

    Ascending node in degrees. Not set in older journal versions.

    Atmosphere?: string

    The atmosphere. Not set in basic scans. Empty if no atmosphere.

    AtmosphereComposition?: { Name: string; Percent: number }[]

    The atmosphere composition. Not set in basic scans or no atmosphere is present.

    Type Declaration

    • Name: string

      Element name (Like Hydrogen, Helium, ...)

    • Percent: number

      The quantity in percent.

    AtmosphereType?: string

    The atmosphere type. Not set in basic scans or no atmosphere is present.

    AxialTilt?: number

    Axial tilt (in degrees) if rotating. Not set in basic scans.

    BodyID?: ID

    The ID of the planet. Not set in older journals.

    BodyName: string

    The planet name.

    Composition?: { Ice: number; Metal: number; Rock: number }

    The composition of the planet/moon. Not set in basic scans or when planet/moon is not solid.

    Type Declaration

    • Ice: number

      Quantity of ice in percent.

    • Metal: number

      Quantity of metal in percent.

    • Rock: number

      Quantity of rock in percent.

    DistanceFromArrivalLS: number

    The distance of the planet to the arrival star in light seconds.

    Eccentricity?: number

    Orbital eccentricity. Not set in older journal versions.

    event: "Scan"

    The type of event.

    Landable?: boolean

    True if ships can land on the planet/moon. Not set in basic scans.

    MassEM: number

    Earth masses.

    Materials?: { Name: string; Percent: number }[]

    List of raw materials which can be gathered on the planet/moon. Not set if none.

    Type Declaration

    • Name: string

      The material name like "tungsten".

    • Percent: number

      The quantity in percent.

    MeanAnomaly?: number

    Mean anomaly in degrees. Not set in older journal versions.

    OrbitalInclination?: number

    Orbital inclination in degrees. Not set in older journal versions.

    OrbitalPeriod?: number

    Orbital period in seconds. Not set in older journal versions.

    Parents?: (
        | Record<"Planet", number> & Partial<
            Record<
                | "Station"
                | "Star"
                | "PlanetaryRing"
                | "AsteroidCluster"
                | "Null"
                | "StellarRing"
                | "Ring",
                never,
            >,
        >
        | Record<"Station", number> & Partial<
            Record<
                | "Planet"
                | "Star"
                | "PlanetaryRing"
                | "AsteroidCluster"
                | "Null"
                | "StellarRing"
                | "Ring",
                never,
            >,
        >
        | Record<"Star", number> & Partial<
            Record<
                | "Planet"
                | "Station"
                | "PlanetaryRing"
                | "AsteroidCluster"
                | "Null"
                | "StellarRing"
                | "Ring",
                never,
            >,
        >
        | Record<"PlanetaryRing", number> & Partial<
            Record<
                | "Planet"
                | "Station"
                | "Star"
                | "AsteroidCluster"
                | "Null"
                | "StellarRing"
                | "Ring",
                never,
            >,
        >
        | Record<"AsteroidCluster", number> & Partial<
            Record<
                | "Planet"
                | "Station"
                | "Star"
                | "PlanetaryRing"
                | "Null"
                | "StellarRing"
                | "Ring",
                never,
            >,
        >
        | Record<"Null", number> & Partial<
            Record<
                | "Planet"
                | "Station"
                | "Star"
                | "PlanetaryRing"
                | "AsteroidCluster"
                | "StellarRing"
                | "Ring",
                never,
            >,
        >
        | Record<"StellarRing", number> & Partial<
            Record<
                | "Planet"
                | "Station"
                | "Star"
                | "PlanetaryRing"
                | "AsteroidCluster"
                | "Null"
                | "Ring",
                never,
            >,
        >
        | Record<"Ring", number> & Partial<
            Record<
                | "Planet"
                | "Station"
                | "Star"
                | "PlanetaryRing"
                | "AsteroidCluster"
                | "Null"
                | "StellarRing",
                never,
            >,
        >
    )[]

    Array of BodyType:BodyID pairs describing the body hierarchy from direct parent to root.

    Periapsis?: number

    Argument of periapsis in degrees. Not set in older journal versions.

    PlanetClass: PlanetClass

    The planet class.

    Radius: number

    The radius in meters.

    ReserveLevel?: ReserveLevel

    The resource reserve level.

    Rings?: Ring[]

    The rings around the body. Not set in basic scans or when there are no rings.

    RotationPeriod: number

    Rotation period in seconds.

    ScanType?: ScanType

    The scan type. Missing in older journals. Maybe it is safe to assume a missing scan type is an auto scan.

    SemiMajorAxis?: number

    The semi major axis in meters. Not set in basic scans.

    StarSystem?: string

    Star system name. May not be set in older journals and must be taken from previous events (like FSDJump which always set a system name.

    StarType?: undefined
    SurfaceGravity: number

    The surface gravity measured in m/s².

    SurfacePressure?: number

    The surface pressure in kPa. Not set in basic scans.

    SurfaceTemperature?: number

    The surface temperature in Kelvin. Missing in basic scans.

    SystemAddress?: ID

    The system ID. Not set in older journals.

    TerraformState?: string

    The Terraform state. Not set in basic scans.

    TidalLock?: boolean

    True if planet/moon is tidally locked. Not set in basic scans.

    timestamp: string

    The time in GMT, ISO 8601.

    Volcanism?: string

    The volcanism like for example 'minor nitrogen magma volcanism'. Empty string if none. Not set in basic scans.

    WasDiscovered?: boolean

    Set to true if planet has been discovered by someone already.

    WasMapped?: boolean

    Set to true if planet has been mapped by someone already.