bitburner-src/markdown/bitburner.api.md

## API Report File for "bitburner"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

// @public (undocumented)
export interface ActiveFragment {
    // (undocumented)
    avgCharge: number;
    // (undocumented)
    id: number;
    // (undocumented)
    numCharge: number;
    // (undocumented)
    rotation: number;
    // (undocumented)
    x: number;
    // (undocumented)
    y: number;
}

// @public
export interface AugmentationStats {
    agility_exp_mult?: number;
    agility_mult?: number;
    bladeburner_analysis_mult?: number;
    bladeburner_max_stamina_mult?: number;
    bladeburner_stamina_gain_mult?: number;
    bladeburner_success_chance_mult?: number;
    charisma_exp_mult?: number;
    charisma_mult?: number;
    company_rep_mult?: number;
    crime_money_mult?: number;
    crime_success_mult?: number;
    defense_exp_mult?: number;
    defense_mult?: number;
    dexterity_exp_mult?: number;
    dexterity_mult?: number;
    faction_rep_mult?: number;
    hacking_chance_mult?: number;
    hacking_exp_mult?: number;
    hacking_grow_mult?: number;
    hacking_money_mult?: number;
    hacking_mult?: number;
    hacking_speed_mult?: number;
    hacknet_node_core_cost_mult?: number;
    hacknet_node_level_cost_mult?: number;
    hacknet_node_money_mult?: number;
    hacknet_node_purchase_cost_mult?: number;
    hacknet_node_ram_cost_mult?: number;
    strength_exp_mult?: number;
    strength_mult?: number;
    work_money_mult?: number;
}

// @public
export interface AugmentPair {
    cost: number;
    name: string;
}

// @public
export interface BasicHGWOptions {
    stock?: boolean;
    threads: number;
}

// @public
export interface BitNodeMultipliers {
    AgilityLevelMultiplier: number;
    AugmentationMoneyCost: number;
    AugmentationRepCost: number;
    BladeburnerRank: number;
    BladeburnerSkillCost: number;
    CharismaLevelMultiplier: number;
    ClassGymExpGain: number;
    CodingContractMoney: number;
    CompanyWorkExpGain: number;
    CompanyWorkMoney: number;
    CorporationValuation: number;
    CrimeExpGain: number;
    CrimeMoney: number;
    DaedalusAugsRequirement: number;
    DefenseLevelMultiplier: number;
    DexterityLevelMultiplier: number;
    FactionPassiveRepGain: number;
    FactionWorkExpGain: number;
    FactionWorkRepGain: number;
    FourSigmaMarketDataApiCost: number;
    FourSigmaMarketDataCost: number;
    HackExpGain: number;
    HackingLevelMultiplier: number;
    HacknetNodeMoney: number;
    HomeComputerRamCost: number;
    InfiltrationMoney: number;
    InfiltrationRep: number;
    ManualHackMoney: number;
    PurchasedServerCost: number;
    PurchasedServerLimit: number;
    PurchasedServerMaxRam: number;
    RepToDonateToFaction: number;
    ScriptHackMoney: number;
    ServerGrowthRate: number;
    ServerMaxMoney: number;
    ServerStartingMoney: number;
    ServerStartingSecurity: number;
    ServerWeakenRate: number;
    StrengthLevelMultiplier: number;
}

// @public
export interface Bladeburner {
    getActionAutolevel(type: string, name: string): boolean;

    getActionCountRemaining(type: string, name: string): number;

    getActionCurrentLevel(type: string, name: string): number;

    getActionEstimatedSuccessChance(type: string, name: string): [number, number];

    getActionMaxLevel(type: string, name: string): number;

    getActionRepGain(type: string, name: string, level: number): number;

    getActionTime(type: string, name: string): number;

    getBlackOpNames(): string[];

    getBlackOpRank(name: string): number;

    getBonusTime(): number;

    getCity(): string;

    getCityChaos(name: string): number;

    getCityCommunities(name: string): number;

    getCityEstimatedPopulation(name: string): number;

    getContractNames(): string[];

    getCurrentAction(): BladeburnerCurAction;

    getGeneralActionNames(): string[];

    getOperationNames(): string[];

    getRank(): number;

    getSkillLevel(name: string): number;

    getSkillNames(): string[];

    getSkillPoints(): number;

    getSkillUpgradeCost(name: string): number;

    getStamina(): [number, number];

    getTeamSize(type: string, name: string): number;

    joinBladeburnerDivision(): boolean;

    joinBladeburnerFaction(): boolean;

    setActionAutolevel(type: string, name: string, autoLevel: boolean): void;

    setActionLevel(type: string, name: string, level: number): void;

    setTeamSize(type: string, name: string, size: number): number;

    startAction(type: string, name: string): boolean;

    stopBladeburnerAction(): void;

    switchCity(name: string): boolean;

    upgradeSkill(name: string): boolean;
}

// @public
export interface BladeburnerCurAction {
    name: string;
    type: string;
}

// @public (undocumented)
export interface CharacterInfo {
    bitnode: number;
    city: string;
    company: string[];
    factions: string[];
    hp: number;
    jobTitle: string[];
    maxHp: number;
    mult: CharacterMult;
    timeWorked: number;
    tor: boolean;
    workAgiExpGain: number;
    workChaExpGain: number;
    workDefExpGain: number;
    workDexExpGain: number;
    workHackExpGain: number;
    workMoneyGain: number;
    workRepGain: number;
    workStrExpGain: number;
}

// @public (undocumented)
export interface CharacterMult {
    agility: number;
    agilityExp: number;
    companyRep: number;
    crimeMoney: number;
    crimeSuccess: number;
    defense: number;
    defenseExp: number;
    dexterity: number;
    dexterityExp: number;
    factionRep: number;
    hacking: number;
    hackingExp: number;
    strength: number;
    strengthExp: number;
    workMoney: number;
}

// @public
export interface CodingAttemptOptions {
    returnReward: boolean;
}

// @public
export interface CodingContract {
    attempt(answer: string[] | number, filename: string, host?: string, opts?: CodingAttemptOptions): boolean | string;

    getContractType(filename: string, host?: string): string;

    getData(filename: string, host?: string): string;

    getDescription(filename: string, host?: string): string;

    getNumTriesRemaining(filename: string, host?: string): number;
}

// @public (undocumented)
export interface Corporation extends WarehouseAPI, OfficeAPI {
    // (undocumented)
    expandCity(divisionName: string, cityName: string): void;
    // (undocumented)
    expandIndustry(industryName: string, divisionName: string): void;
    // (undocumented)
    getCorporation(): CorporationInfo;
    // (undocumented)
    getDivision(divisionName: string): Division;
    // (undocumented)
    issueDividends(percent: number): void;
    // (undocumented)
    levelUpgrade(upgradeName: string): void;
    // (undocumented)
    unlockUpgrade(upgradeName: string): void;
}

// @public (undocumented)
export interface CorporationInfo {
    // (undocumented)
    expenses: number;
    // (undocumented)
    funds: number;
    // (undocumented)
    issuedShares: number;
    // (undocumented)
    name: string;
    // (undocumented)
    numShares: number;
    // (undocumented)
    public: boolean;
    // (undocumented)
    revenue: number;
    // (undocumented)
    sharePrice: number;
    // (undocumented)
    shareSaleCooldown: number;
    // (undocumented)
    state: string;
    // (undocumented)
    totalShares: number;
}

// @public
export interface CrimeStats {
    agility_exp: number;
    agility_success_weight: number;
    charisma_exp: number;
    charisma_success_weight: number;
    defense_exp: number;
    defense_success_weight: number;
    dexterity_exp: number;
    dexterity_success_weight: number;
    difficulty: number;
    hacking_exp: number;
    hacking_success_weight: number;
    intelligence_exp: number;
    karma: number;
    kills: number;
    money: number;
    name: number;
    strength_exp: number;
    strength_success_weight: number;
    time: number;
    type: string;
}

// @public (undocumented)
export interface Division {
    // (undocumented)
    awareness: number;
    // (undocumented)
    cities: string[];
    // (undocumented)
    lastCycleExpenses: number;
    // (undocumented)
    lastCycleRevenue: number;
    // (undocumented)
    name: string;
    // (undocumented)
    popularity: number;
    // (undocumented)
    prodMult: number;
    // (undocumented)
    research: number;
    // (undocumented)
    thisCycleExpenses: number;
    // (undocumented)
    thisCycleRevenue: number;
    // (undocumented)
    type: string;
    // (undocumented)
    upgrades: number[];
}

// @public (undocumented)
export interface Employee {
    // (undocumented)
    cha: number;
    // (undocumented)
    cre: number;
    // (undocumented)
    eff: number;
    // (undocumented)
    ene: number;
    // (undocumented)
    exp: number;
    // (undocumented)
    hap: number;
    // (undocumented)
    int: number;
    // (undocumented)
    loc: string;
    // (undocumented)
    mor: number;
    // (undocumented)
    name: string;
    // (undocumented)
    pos: string;
    // (undocumented)
    sal: number;
}

// @public (undocumented)
export interface EmployeeJobs {
    // (undocumented)
    "Research & Development": number;
    // (undocumented)
    Business: number;
    // (undocumented)
    Engineer: number;
    // (undocumented)
    Management: number;
    // (undocumented)
    Operations: number;
    // (undocumented)
    Training: number;
    // (undocumented)
    Unassigned: number;
}

// @public
export interface EquipmentStats {
    agi?: number;
    cha?: number;
    def?: number;
    dex?: number;
    hack?: number;
    str?: number;
}

// @public (undocumented)
export interface Formulas {
    // (undocumented)
    hacking: HackingFormulas;
    // (undocumented)
    hacknetNodes: HacknetNodesFormulas;
    // (undocumented)
    hacknetServers: HacknetServersFormulas;
    // (undocumented)
    skills: SkillsFormulas;
}

// @public (undocumented)
export interface Fragment {
    // (undocumented)
    id: number;
    // (undocumented)
    limit: number;
    // (undocumented)
    power: number;
    // (undocumented)
    shape: boolean[][];
    // (undocumented)
    type: number;
}

// @public
export interface Gang {
    ascendMember(memberName: string): GangMemberAscension | undefined;

    canRecruitMember(): boolean;

    createGang(faction: string): boolean;

    getBonusTime(): number;

    getChanceToWinClash(gangName: string): number;

    getEquipmentCost(equipName: string): number;

    getEquipmentNames(): string[];

    getEquipmentStats(equipName: string): EquipmentStats;

    getEquipmentType(equipName: string): string;

    getGangInformation(): GangGenInfo;

    getMemberInformation(name: string): GangMemberInfo;

    getMemberNames(): string[];

    getOtherGangInformation(): GangOtherInfo;

    getTaskNames(): string[];

    getTaskStats(name: string): GangTaskStats;

    inGang(): boolean;

    purchaseEquipment(memberName: string, equipName: string): boolean;

    recruitMember(name: string): boolean;

    setMemberTask(memberName: string, taskName: string): boolean;

    setTerritoryWarfare(engage: boolean): void;
}

// @public
export interface GangGenInfo {
    faction: string;
    isHacking: boolean;
    moneyGainRate: number;
    power: number;
    respect: number;
    respectGainRate: number;
    territory: number;
    territoryClashChance: number;
    territoryWarfareEngaged: boolean;
    wantedLevel: number;
    wantedLevelGainRate: number;
}

// @public (undocumented)
export interface GangMemberAscension {
    agi: number;
    cha: number;
    def: number;
    dex: number;
    hack: number;
    respect: number;
    str: number;
}

// @public (undocumented)
export interface GangMemberInfo {
    // (undocumented)
    agi: number;
    // (undocumented)
    agi_asc_mult: number;
    // (undocumented)
    agi_asc_points: number;
    // (undocumented)
    agi_exp: number;
    // (undocumented)
    agi_mult: number;
    // (undocumented)
    augmentations: string[];
    // (undocumented)
    cha: number;
    // (undocumented)
    cha_asc_mult: number;
    // (undocumented)
    cha_asc_points: number;
    // (undocumented)
    cha_exp: number;
    // (undocumented)
    cha_mult: number;
    // (undocumented)
    def: number;
    // (undocumented)
    def_asc_mult: number;
    // (undocumented)
    def_asc_points: number;
    // (undocumented)
    def_exp: number;
    // (undocumented)
    def_mult: number;
    // (undocumented)
    dex: number;
    // (undocumented)
    dex_asc_mult: number;
    // (undocumented)
    dex_asc_points: number;
    // (undocumented)
    dex_exp: number;
    // (undocumented)
    dex_mult: number;
    // (undocumented)
    earnedRespect: number;
    // (undocumented)
    hack: number;
    // (undocumented)
    hack_asc_mult: number;
    // (undocumented)
    hack_asc_points: number;
    // (undocumented)
    hack_exp: number;
    // (undocumented)
    hack_mult: number;
    // (undocumented)
    name: string;
    // (undocumented)
    str: number;
    // (undocumented)
    str_asc_mult: number;
    // (undocumented)
    str_asc_points: number;
    // (undocumented)
    str_exp: number;
    // (undocumented)
    str_mult: number;
    // (undocumented)
    task: string;
    // (undocumented)
    upgrades: string[];
}

// @public (undocumented)
export interface GangOtherInfo {
    // (undocumented)
    "Slum Snakes": GangOtherInfoObject;
    // (undocumented)
    "Speakers for the Dead": GangOtherInfoObject;
    // (undocumented)
    "The Black Hand": GangOtherInfoObject;
    // (undocumented)
    "The Dark Army": GangOtherInfoObject;
    // (undocumented)
    "The Syndicate": GangOtherInfoObject;
    // (undocumented)
    NiteSec: GangOtherInfoObject;
    // (undocumented)
    Tetrads: GangOtherInfoObject;
}

// @public (undocumented)
export interface GangOtherInfoObject {
    power: number;
    territory: number;
}

// @public
export interface GangTaskStats {
    agiWeight: number;
    baseMoney: number;
    baseRespect: number;
    baseWanted: number;
    chaWeight: number;
    defWeight: number;
    desc: string;
    dexWeight: number;
    difficulty: number;
    hackWeight: number;
    isCombat: boolean;
    isHacking: boolean;
    name: string;
    strWeight: number;
    territory: GangTerritory;
}

// @public (undocumented)
export interface GangTerritory {
    money: number;
    respect: number;
    wanted: number;
}

// @public (undocumented)
export interface HackingFormulas {
    // (undocumented)
    growPercent(server: number, threads: number, player: number, cores?: number): number;
    // (undocumented)
    growTime(server: number, player: number): number;
    // (undocumented)
    hackChance(server: number, player: number): number;
    // (undocumented)
    hackExp(server: number, player: number): number;
    // (undocumented)
    hackPercent(server: number, player: number): number;
    // (undocumented)
    hackTime(server: number, player: number): number;
    // (undocumented)
    weakenTime(server: number, player: number): number;
}

// @public
export interface HackingMultipliers {
    chance: number;
    growth: number;
    money: number;
    speed: number;
}

// @public
export interface Hacknet {
    getCacheUpgradeCost(index: number, n: number): number;

    getCoreUpgradeCost(index: number, n: number): number;

    getHashUpgradeLevel(upgName: string): number;

    getLevelUpgradeCost(index: number, n: number): number;

    getNodeStats(index: number): NodeStats;

    getPurchaseNodeCost(): number;

    getRamUpgradeCost(index: number, n: number): number;

    getStudyMult(): number;

    getTrainingMult(): number;

    hashCapacity(): number;

    hashCost(upgName: string): number;

    maxNumNodes(): number;

    numHashes(): number;

    numNodes(): number;

    purchaseNode(): number;

    spendHashes(upgName: string, upgTarget?: string): boolean;

    upgradeCache(index: number, n: number): boolean;

    upgradeCore(index: number, n: number): boolean;

    upgradeLevel(index: number, n: number): boolean;

    upgradeRam(index: number, n: number): boolean;
}

// @public
export interface HacknetMultipliers {
    coreCost: number;
    levelCost: number;
    production: number;
    purchaseCost: number;
    ramCost: number;
}

// @public (undocumented)
export interface HacknetNodesFormulas {
    // (undocumented)
    constants(): number;
    // (undocumented)
    coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number;
    // (undocumented)
    hacknetNodeCost(n: number, mult: number): number;
    // (undocumented)
    levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number;
    // (undocumented)
    moneyGainRate(level: number, ram: number, cores: number, mult?: number): number;
    // (undocumented)
    ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number;
}

// @public (undocumented)
export interface HacknetServersFormulas {
    // (undocumented)
    cacheUpgradeCost(startingCache: number, extraCache?: number): number;
    // (undocumented)
    constants(): any;
    // (undocumented)
    coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number;
    // (undocumented)
    hacknetServerCost(n: number, mult: number): number;
    // (undocumented)
    hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult?: number): number;
    // (undocumented)
    hashUpgradeCost(upgName: number, level: number): number;
    // (undocumented)
    levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number;
    // (undocumented)
    ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number;
}

// @public (undocumented)
export interface Material {
    // (undocumented)
    name: string;
    // (undocumented)
    qlt: number;
    // (undocumented)
    qty: number;
}

// @public
export interface NodeStats {
    cache: number;
    cores: number;
    hashCapacity: number;
    level: number;
    name: string;
    production: number;
    ram: number;
    ramUsed: number;
    timeOnline: number;
    totalProduction: number;
}

// @public
export interface NS extends Singularity {
    alert(msg: any): void;
    readonly args: (string | number)[];
    asleep(millis: number): Promise<void>;
    atExit(f: () => void): void;
    readonly bladeburner: Bladeburner;
    brutessh(host: string): void;
    clear(handle: string): void;
    clearLog(): void;
    clearPort(handle: number): void;
    readonly codingcontract: CodingContract;
    readonly corporation: Corporation;
    deleteServer(host: string): boolean;
    disableLog(fn: string): void;
    enableLog(fn: string): void;
    exec(script: string, host: string, numThreads?: number, ...args: string[]): number;
    exit(): void;
    fileExists(filename: string, host?: string): boolean;
    flags(schema: [string, string | number | boolean | string[]][]): any;
    readonly formulas: Formulas;
    ftpcrack(host: string): void;
    readonly gang: Gang;
    getBitNodeMultipliers(): BitNodeMultipliers;
    getFavorToDonate(): number;
    getGrowTime(host: string): number;
    getHackingLevel(): number;
    getHackingMultipliers(): HackingMultipliers;
    getHacknetMultipliers(): HacknetMultipliers;
    getHackTime(host: string): number;
    getHostname(): string;
    getOwnedSourceFiles(): SourceFileLvl[];
    getPlayer(): Player;
    getPortHandle(port: number): any[];
    getPurchasedServerCost(ram: number): number;
    getPurchasedServerLimit(): number;
    getPurchasedServerMaxRam(): number;
    getPurchasedServers(hostnameMode?: boolean): string[];
    getRunningScript(filename: string | number, hostname: string, ...args: (string | number)[]): RunningScript;
    getScriptExpGain(script: string, host: string, ...args: string[]): number;
    getScriptIncome(script: string, host: string, ...args: string[]): number | [number, number];
    getScriptLogs(fn?: string, host?: string, ...args: any[]): string[];
    getScriptName(): string;
    getScriptRam(script: string, host?: string): number;
    getServer(host?: string): Server;
    // @deprecated (undocumented)
    getServerBaseSecurityLevel(host: string): number;
    getServerGrowth(host: string): number;
    getServerMaxMoney(host: string): number;
    getServerMaxRam(host: string): number;
    getServerMinSecurityLevel(host: string): number;
    getServerMoneyAvailable(host: string): number;
    getServerNumPortsRequired(host: string): number;
    // @deprecated (undocumented)
    getServerRam(host: string): [number, number];
    getServerRequiredHackingLevel(host: string): number;
    getServerSecurityLevel(host: string): number;
    getServerUsedRam(host: string): number;
    getTimeSinceLastAug(): number;
    getWeakenTime(host: string): number;
    grow(host: string, opts?: BasicHGWOptions): Promise<number>;
    growthAnalyze(host: string, growthAmount: number, cores?: number): number;
    growthAnalyzeSecurity(threads: number): number;
    hack(host: string, opts?: BasicHGWOptions): Promise<number>;
    hackAnalyze(host: string): number;
    hackAnalyzeChance(host: string): number;
    hackAnalyzeSecurity(threads: number): number;
    hackAnalyzeThreads(host: string, hackAmount: number): number;
    readonly hacknet: Hacknet;
    hasRootAccess(host: string): boolean;
    httpworm(host: string): void;
    isLogEnabled(fn: string): boolean;
    isRunning(script: string, host: string, ...args: string[]): boolean;
    kill(script: string | number, host: string, ...args: string[]): boolean;
    killall(host: string): boolean;
    ls(host: string, grep?: string): string[];
    nFormat(n: number, format: string): number;
    nuke(host: string): void;
    peek(port: number): any;
    print(msg: any): void;
    prompt(txt: string): Promise<boolean>;
    ps(host?: string): ProcessInfo[];
    purchaseServer(hostname: string, ram: number): string;
    read(handle: string): any;
    readPort(port: number): any;
    relaysmtp(host: string): void;
    rm(name: string, host?: string): boolean;
    run(script: string, numThreads?: number, ...args: string[]): number;
    scan(host: string, hostnames?: boolean): string[];
    scp(files: string | string[], source: string, destination: string): Promise<boolean>;
    scriptKill(script: string, host: string): boolean;
    scriptRunning(script: string, host: string): boolean;
    serverExists(host: string): boolean;
    sleep(millis: number): Promise<void>;
    readonly sleeve: Sleeve;
    spawn(script: string, numThreads?: number, ...args: string[]): void;
    sprintf(format: string, ...args: string[]): string;
    sqlinject(host: string): void;
    readonly stanek: Stanek;
    readonly stock: TIX;
    tail(fn?: string, host?: string, ...args: any[]): void;
    tFormat(milliseconds: number, milliPrecision?: boolean): string;
    toast(msg: any, variant?: string): void;
    tprint(msg: any): void;
    tprintf(format: string, ...values: any[]): void;
    tryWritePort(port: number, data: string[] | number): Promise<boolean>;
    vsprintf(format: string, args: string[]): string;
    weaken(host: string, opts?: BasicHGWOptions): Promise<number>;
    weakenAnalyze(threads: number, cores?: number): number;
    wget(url: string, target: string, host?: string): Promise<boolean>;
    write(handle: string, data?: string[] | number, mode?: "w" | "a"): Promise<void>;
    writePort(port: number, data: string | number): Promise<any>;
}

// @public (undocumented)
export interface Office {
    // (undocumented)
    employeeProd: EmployeeJobs;
    // (undocumented)
    employees: string[];
    // (undocumented)
    loc: string;
    // (undocumented)
    maxEne: number;
    // (undocumented)
    maxHap: number;
    // (undocumented)
    maxMor: number;
    // (undocumented)
    minEne: number;
    // (undocumented)
    minHap: number;
    // (undocumented)
    size: number;
}

// @public (undocumented)
export interface OfficeAPI {
    // (undocumented)
    assignJob(divisionName: string, cityName: string, employeeName: string, job: string): Promise<void>;
    // (undocumented)
    buyCoffee(divisionName: string, cityName: string): Promise<void>;
    // (undocumented)
    employees(divisionName: string, cityName: string): string[];
    // (undocumented)
    getEmployee(divisionName: string, cityName: string, employeeName: string): Employee;
    // (undocumented)
    getOffice(divisionName: string, cityName: string): Office;
    // (undocumented)
    hireAdVert(divisionName: string): void;
    // (undocumented)
    hireEmployee(divisionName: string, cityName: string): Employee;
    // (undocumented)
    research(divisionName: string, researchName: string): void;
    // (undocumented)
    throwParty(divisionName: string, cityName: string, costPerEmployee: number): Promise<number>;
    // (undocumented)
    upgradeOfficeSize(divisionName: string, cityName: string, size: number): void;
}

// @public (undocumented)
export interface Player {
    // (undocumented)
    agility: number;
    // (undocumented)
    agility_exp: number;
    // (undocumented)
    agility_exp_mult: number;
    // (undocumented)
    agility_mult: number;
    // (undocumented)
    bitNodeN: number;
    // (undocumented)
    bladeburner_analysis_mult: number;
    // (undocumented)
    bladeburner_max_stamina_mult: number;
    // (undocumented)
    bladeburner_stamina_gain_mult: number;
    // (undocumented)
    bladeburner_success_chance_mult: number;
    // (undocumented)
    charisma: number;
    // (undocumented)
    charisma_exp: number;
    // (undocumented)
    charisma_exp_mult: number;
    // (undocumented)
    charisma_mult: number;
    // (undocumented)
    city: string;
    // (undocumented)
    className: string;
    // (undocumented)
    company_rep_mult: number;
    // (undocumented)
    companyName: string;
    // (undocumented)
    createProgramName: string;
    // (undocumented)
    createProgramReqLvl: number;
    // (undocumented)
    crime_money_mult: number;
    // (undocumented)
    crime_success_mult: number;
    // (undocumented)
    crimeType: string;
    // (undocumented)
    currentWorkFactionDescription: string;
    // (undocumented)
    currentWorkFactionName: string;
    // (undocumented)
    defense: number;
    // (undocumented)
    defense_exp: number;
    // (undocumented)
    defense_exp_mult: number;
    // (undocumented)
    defense_mult: number;
    // (undocumented)
    dexterity: number;
    // (undocumented)
    dexterity_exp: number;
    // (undocumented)
    dexterity_exp_mult: number;
    // (undocumented)
    dexterity_mult: number;
    // (undocumented)
    faction_rep_mult: number;
    // (undocumented)
    factions: string[];
    // (undocumented)
    hacking: number;
    // (undocumented)
    hacking_chance_mult: number;
    // (undocumented)
    hacking_exp: number;
    // (undocumented)
    hacking_exp_mult: number;
    // (undocumented)
    hacking_grow_mult: number;
    // (undocumented)
    hacking_money_mult: number;
    // (undocumented)
    hacking_mult: number;
    // (undocumented)
    hacking_speed_mult: number;
    // (undocumented)
    hacknet_node_core_cost_mult: number;
    // (undocumented)
    hacknet_node_level_cost_mult: number;
    // (undocumented)
    hacknet_node_money_mult: number;
    // (undocumented)
    hacknet_node_purchase_cost_mult: number;
    // (undocumented)
    hacknet_node_ram_cost_mult: number;
    // (undocumented)
    has4SData: boolean;
    // (undocumented)
    has4SDataTixApi: boolean;
    // (undocumented)
    hasTixApiAccess: boolean;
    // (undocumented)
    hasWseAccount: boolean;
    // (undocumented)
    hp: number;
    // (undocumented)
    intelligence: number;
    // (undocumented)
    isWorking: boolean;
    // (undocumented)
    jobs: any;
    // (undocumented)
    location: string;
    // (undocumented)
    max_hp: number;
    // (undocumented)
    money: number;
    // (undocumented)
    numPeopleKilled: number;
    // (undocumented)
    playtimeSinceLastAug: number;
    // (undocumented)
    playtimeSinceLastBitnode: number;
    // (undocumented)
    strength: number;
    // (undocumented)
    strength_exp: number;
    // (undocumented)
    strength_exp_mult: number;
    // (undocumented)
    strength_mult: number;
    // (undocumented)
    tor: boolean;
    // (undocumented)
    totalPlaytime: number;
    // (undocumented)
    work_money_mult: number;
    // (undocumented)
    workAgiExpGained: number;
    // (undocumented)
    workAgiExpGainRate: number;
    // (undocumented)
    workChaExpGained: number;
    // (undocumented)
    workChaExpGainRate: number;
    // (undocumented)
    workDefExpGained: number;
    // (undocumented)
    workDefExpGainRate: number;
    // (undocumented)
    workDexExpGained: number;
    // (undocumented)
    workDexExpGainRate: number;
    // (undocumented)
    workHackExpGained: number;
    // (undocumented)
    workHackExpGainRate: number;
    // (undocumented)
    workMoneyGained: number;
    // (undocumented)
    workMoneyGainRate: number;
    // (undocumented)
    workMoneyLossRate: number;
    // (undocumented)
    workRepGained: number;
    // (undocumented)
    workRepGainRate: number;
    // (undocumented)
    workStrExpGained: number;
    // (undocumented)
    workStrExpGainRate: number;
    // (undocumented)
    workType: string;
}

// @public
export interface PlayerSkills {
    agility: number;
    charisma: number;
    defense: number;
    dexterity: number;
    hacking: number;
    intelligence: number;
    strength: number;
}

// @public
export interface ProcessInfo {
    args: string[];
    filename: string;
    threads: number;
}

// @public (undocumented)
export interface Product {
    // (undocumented)
    cmp: number;
    // (undocumented)
    dmd: number;
    // (undocumented)
    name: string;
    // (undocumented)
    pCost: number;
    // (undocumented)
    sCost: string | number;
}

// @public (undocumented)
export interface RunningScript {
    // (undocumented)
    args: string[];
    // (undocumented)
    filename: string;
    // (undocumented)
    logs: string[];
    // (undocumented)
    offlineExpGained: number;
    // (undocumented)
    offlineMoneyMade: number;
    // (undocumented)
    offlineRunningTime: number;
    // (undocumented)
    onlineExpGained: number;
    // (undocumented)
    onlineMoneyMade: number;
    // (undocumented)
    onlineRunningTime: number;
    // (undocumented)
    pid: number;
    // (undocumented)
    ramUsage: number;
    // (undocumented)
    server: string;
    // (undocumented)
    threads: number;
}

// @public
export interface Server {
    backdoorInstalled: boolean;

    baseDifficulty: number;

    cpuCores: number;

    ftpPortOpen: boolean;

    hackDifficulty: number;

    hasAdminRights: boolean;

    hostname: string;

    httpPortOpen: boolean;

    ip: string;

    isConnectedTo: boolean;

    maxRam: number;

    minDifficulty: number;

    moneyAvailable: number;

    moneyMax: number;

    numOpenPortsRequired: number;

    openPortCount: number;

    organizationName: string;

    purchasedByPlayer: boolean;

    ramUsed: number;

    requiredHackingSkill: number;

    serverGrowth: number;

    smtpPortOpen: boolean;

    sqlPortOpen: boolean;

    sshPortOpen: boolean;
}

// @public
export interface Singularity {
    applyToCompany(companyName: string, field: string): boolean;

    checkFactionInvitations(): string[];

    commitCrime(crime: string): number;

    connect(hostname: string): boolean;

    createProgram(program: string): boolean;

    donateToFaction(faction: string, amount: number): boolean;

    // @deprecated
    getAugmentationCost(augName: string): [number, number];

    getAugmentationPrereq(augName: string): string[];

    getAugmentationPrice(augName: string): number;

    getAugmentationRepReq(augName: string): number;

    getAugmentationsFromFaction(faction: string): string[];

    getAugmentationStats(name: string): AugmentationStats;

    // @deprecated
    getCharacterInformation(): CharacterInfo;

    getCompanyFavor(companyName: string): number;

    getCompanyFavorGain(companyName: string): number;

    getCompanyRep(companyName: string): number;

    getCrimeChance(crime: string): number;

    getCrimeStats(crime: string): CrimeStats;

    getCurrentServer(): string;

    getFactionFavor(faction: string): number;

    getFactionFavorGain(faction: string): number;

    getFactionRep(faction: string): number;

    getOwnedAugmentations(purchased?: boolean): string[];

    // @deprecated
    getStats(): PlayerSkills;

    getUpgradeHomeCoresCost(): number;

    getUpgradeHomeRamCost(): number;

    goToLocation(locationName: string): boolean;

    gymWorkout(gymName: string, stat: string): boolean;

    hospitalize(): number;

    installAugmentations(cbScript?: string): void;

    installBackdoor(): Promise<void>;

    isBusy(): boolean;

    joinFaction(faction: string): boolean;

    manualHack(): Promise<number>;

    purchaseAugmentation(faction: string, augmentation: string): boolean;

    purchaseProgram(programName: string): boolean;

    purchaseTor(): boolean;

    softReset(cbScript: string): void;

    stopAction(): boolean;

    travelToCity(city: string): boolean;

    universityCourse(universityName: string, courseName: string): boolean;

    upgradeHomeCores(): boolean;

    upgradeHomeRam(): boolean;

    workForCompany(companyName?: string): boolean;

    workForFaction(faction: string, workType: string): boolean;
}

// @public (undocumented)
export interface SkillsFormulas {
    // (undocumented)
    calculateExp(skill: number, mult?: number): number;
    // (undocumented)
    calculateSkill(exp: number, mult?: number): number;
}

// @public
export interface Sleeve {
    getInformation(sleeveNumber: number): SleeveInformation;

    getNumSleeves(): number;

    getSleeveAugmentations(sleeveNumber: number): string[];

    getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[];

    getSleeveStats(sleeveNumber: number): SleeveSkills;

    getTask(sleeveNumber: number): SleeveTask;

    purchaseSleeveAug(sleeveNumber: number, augName: string): boolean;

    setToCommitCrime(sleeveNumber: number, name: string): boolean;

    setToCompanyWork(sleeveNumber: number, companyName: string): boolean;

    setToFactionWork(sleeveNumber: number, factionName: string, factionWorkType: string): boolean;

    setToGymWorkout(sleeveNumber: number, gymName: string, stat: string): boolean;

    setToShockRecovery(sleeveNumber: number): boolean;

    setToSynchronize(sleeveNumber: number): boolean;

    setToUniversityCourse(sleeveNumber: number, university: string, className: string): boolean;

    travel(sleeveNumber: number, cityName: string): boolean;
}

// @public
export interface SleeveInformation {
    city: string;
    earningsForPlayer: SleeveWorkGains;
    earningsForSleeves: SleeveWorkGains;
    earningsForTask: SleeveWorkGains;
    hp: number;
    jobs: string[];
    jobTitle: string[];
    maxHp: number;
    mult: CharacterMult;
    timeWorked: number;
    tor: boolean;
    workRepGain: number;
}

// @public
export interface SleeveSkills {
    agility: number;
    charisma: number;
    defense: number;
    dexterity: number;
    hacking: number;
    shock: number;
    strength: number;
    sync: number;
}

// @public
export interface SleeveTask {
    crime: string;
    factionWorkType: string;
    gymStatType: string;
    location: string;
    task: string;
}

// @public (undocumented)
export interface SleeveWorkGains {
    workAgiExpGain: number;
    workChaExpGain: number;
    workDefExpGain: number;
    workDexExpGain: number;
    workHackExpGain: number;
    workMoneyGain: number;
    workStrExpGain: number;
}

// @public (undocumented)
export interface SourceFileLvl {
    lvl: number;
    n: number;
}

// @public
export interface Stanek {
    activeFragments(): ActiveFragment[];
    canPlace(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
    charge(rootX: number, rootY: number): Promise<void>;
    clear(): void;
    fragmentDefinitions(): Fragment[];
    get(rootX: number, rootY: number): ActiveFragment | undefined;
    height(): number;
    place(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
    remove(rootX: number, rootY: number): boolean;
    width(): number;
}

// @public
export interface StockOrder {
    [key: string]: StockOrderObject[];
}

// @public
export interface StockOrderObject {
    position: string;
    price: number;
    shares: number;
    type: string;
}

// @public
export interface TIX {
    buy(sym: string, shares: number): number;

    cancelOrder(sym: string, shares: number, price: number, type: string, pos: string): void;

    getAskPrice(sym: string): number;

    getBidPrice(sym: string): number;

    getForecast(sym: string): number;

    getMaxShares(sym: string): number;

    getOrders(): StockOrder;

    getPosition(sym: string): [number, number, number, number];

    getPrice(sym: string): number;

    getPurchaseCost(sym: string, shares: number, posType: string): number;

    getSaleGain(sym: string, shares: number, posType: string): number;

    getSymbols(): string[];

    getVolatility(sym: string): number;

    placeOrder(sym: string, shares: number, price: number, type: string, pos: string): boolean;

    purchase4SMarketData(): boolean;

    purchase4SMarketDataTixApi(): boolean;

    sell(sym: string, shares: number): number;

    sellShort(sym: string, shares: number): number;

    short(sym: string, shares: number): number;
}

// @public (undocumented)
export interface Warehouse {
    // (undocumented)
    level: number;
    // (undocumented)
    loc: string;
    // (undocumented)
    size: number;
    // (undocumented)
    sizeUsed: number;
}

// @public (undocumented)
export interface WarehouseAPI {
    // (undocumented)
    buyMaterial(divisionName: string, cityName: string, materialName: string, amt: number): void;
    // (undocumented)
    cancelExportMaterial(
    sourceDivision: string,
    sourceCity: string,
    targetDivision: string,
    targetCity: string,
    materialName: string,
    amt: number,
    ): void;
    // (undocumented)
    discontinueProduct(divisionName: string, productName: string): void;
    // (undocumented)
    exportMaterial(
    sourceDivision: string,
    sourceCity: string,
    targetDivision: string,
    targetCity: string,
    materialName: string,
    amt: number,
    ): void;
    // (undocumented)
    getMaterial(divisionName: string, cityName: string, materialName: string): Material;
    // (undocumented)
    getProduct(divisionName: string, productName: string): Product;
    // (undocumented)
    getWarehouse(divisionName: string, cityName: string): Warehouse;
    // (undocumented)
    makeProduct(
    divisionName: string,
    cityName: string,
    productName: string,
    designInvest: number,
    marketingInvest: number,
    ): void;
    // (undocumented)
    purchaseWarehouse(divisionName: string, cityName: string): void;
    // (undocumented)
    sellMaterial(divisionName: string, cityName: string, materialName: string, amt: number, price: number): void;
    // (undocumented)
    sellProduct(
    divisionName: string,
    cityName: string,
    productName: string,
    amt: number,
    price: number,
    all: boolean,
    ): void;
    // (undocumented)
    setMaterialMarketTA1(divisionName: string, cityName: string, materialName: string, on: boolean): void;
    // (undocumented)
    setMaterialMarketTA2(divisionName: string, cityName: string, materialName: string, on: boolean): void;
    // (undocumented)
    setProductMarketTA1(divisionName: string, productName: string, on: boolean): void;
    // (undocumented)
    setProductMarketTA2(divisionName: string, productName: string, on: boolean): void;
    // (undocumented)
    setSmartSupply(divisionName: string, cityName: string, enabled: boolean): void;
    // (undocumented)
    upgradeWarehouse(divisionName: string, cityName: string): void;
}

// (No @packageDocumentation comment for this package)

```