sc4/lib/core/savegame.d.ts

A command line utility for automating SimCity 4 modding tasks & modifying savegames

import DBPF from './dbpf.js';
import type { DecodedFileTypeId, SimGridFileTypeId } from './types.js';
import type TerrainMap from './terrain-map.js';
import { type SimGrid } from './enums.js';
import type { SimGridFloat32, SimGridSint16, SimGridSint8, SimGridUint16, SimGridUint32, SimGridUint8 } from './sim-grid-file.js';
import type { EntryFromType } from './dbpf-entry.js';
import SavegameContext from './savegame-context.js';
import RegionView from './region-view.js';
type SimGrid = SimGridUint8 | SimGridSint8 | SimGridUint16 | SimGridSint16 | SimGridUint32 | SimGridFloat32;
type Result<T extends DecodedFileTypeId> = ReturnType<EntryFromType<T>['read']>;
type SavegameCreateOptions = {
    size: 'small' | 'medium' | 'large';
};
export default class Savegame extends DBPF {
    get GID(): number;
    get lots(): import("./lot.js").default[];
    get buildings(): import("./building.js").default[];
    get props(): import("./prop.js").default[];
    get propDeveloper(): import("./prop-developer.js").default;
    get propManager(): import("./prop-manager.js").default;
    get textures(): import("./lot-base-texture.js").default[];
    get flora(): import("./flora.js").default[];
    get itemIndex(): import("./item-index.js").default;
    get zoneDeveloper(): import("./zone-developer.js").default;
    get zones(): import("./zone-developer.js").default;
    get lotDeveloper(): import("./lot-developer.js").default;
    get zoneManager(): import("./zone-manager.js").default;
    get COMSerializer(): import("./com-serializer.js").default;
    get lineItems(): import("./line-item.js").default[];
    get departmentBudgets(): import("./department-budget.js").default[];
    get pipes(): import("./pipe.js").default[];
    get plumbingSimulator(): import("./plumbing-simulator.js").default;
    get network(): import("./network.js").default[];
    get tunnels(): import("./network-tunnel-occupant.js").default[];
    get bridges(): import("./network-bridge-occupant.js").default[];
    get prebuiltNetwork(): import("./prebuilt-network.js").default[];
    get networkIndex(): import("./network-index.js").NetworkIndex;
    get networkManager(): import("./network-manager.js").default;
    get terrainFlags(): import("./terrain-flags.js").default;
    get cityInfo(): import("./csc4-city.js").default;
    get date(): import("./csc4-simulator.js").default;
    get clock(): import("./csc4-24hour-clock.js").default;
    get regionView(): RegionView;
    get terrain(): TerrainMap | undefined;
    get width(): number;
    get depth(): number;
    get tileWidth(): number;
    get tileDepth(): number;
    get metricWidth(): number;
    get metricDepth(): number;
    createContext(): SavegameContext;
    getSimGrid(dataId: number, type?: SimGridFileTypeId): SimGrid | undefined;
    getByType<T extends DecodedFileTypeId>(type: T): EntryFromType<T>;
    readByType<T extends DecodedFileTypeId>(type: T): Result<T>;
    static create(opts: SavegameCreateOptions): Savegame;
}
export {};