PARACOSM AGENTOS | API Reference v0.9.1035
Home Simulation API Docs GitHub npm
Home Simulation API Docs GitHub npm AgentOS Discord
paracosm - v0.9.1035
    Preparing search index...

    Interface WorldMetrics

    Universal settlement metrics shared by every scenario. Fields below the population and morale core are common but optional — a non-Mars scenario might not have pressurizedVolumeM3 for example, and is free to set its own values via the index signature.

    Scenario-specific metrics (e.g., a submarine's hullPressureBars or a corporation's quarterlyRevenue) live alongside via [key: string]: number.

    interface WorldMetrics {
        foodMonthsReserve: number;
        infrastructureModules: number;
        lifeSupportCapacity: number;
        morale: number;
        population: number;
        powerKw: number;
        pressurizedVolumeM3: number;
        scienceOutput: number;
        waterLitersPerDay: number;
        [key: string]: number;
    }

    Indexable

    • [key: string]: number

      Scenario-defined metrics beyond the universal set.

    Index
    foodMonthsReserve: number

    Months of food reserve at current consumption.

    infrastructureModules: number

    Infrastructure modules / building units.

    lifeSupportCapacity: number

    Life support headroom (max sustainable population).

    morale: number

    Aggregate morale, 0..1.

    population: number

    Alive headcount.

    powerKw: number

    Generated power capacity, kW.

    pressurizedVolumeM3: number

    Sealed habitable volume, m³ — Mars/Lunar/space-specific, optional in others.

    scienceOutput: number

    Science / research output index.

    waterLitersPerDay: number

    Daily water budget, liters.