7897 lines
255 KiB
TypeScript
7897 lines
255 KiB
TypeScript
/** All netscript definitions */
|
||
|
||
/** @public */
|
||
interface HP {
|
||
current: number;
|
||
max: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface Skills {
|
||
hacking: number;
|
||
strength: number;
|
||
defense: number;
|
||
dexterity: number;
|
||
agility: number;
|
||
charisma: number;
|
||
intelligence: number;
|
||
}
|
||
|
||
// TODO: provide same treatment to CodingContractData as for SleeveTask (actual types)
|
||
/**
|
||
* Coding contract data will differ depending on coding contract.
|
||
* @public
|
||
*/
|
||
type CodingContractData = any;
|
||
|
||
/** @public */
|
||
type PortData = string | number;
|
||
|
||
/** @public */
|
||
type ScriptArg = string | number | boolean;
|
||
|
||
/** @public */
|
||
type FilenameOrPID = number | string;
|
||
|
||
/** @public */
|
||
interface Person {
|
||
hp: HP;
|
||
skills: Skills;
|
||
exp: Skills;
|
||
mults: Multipliers;
|
||
city: CityName;
|
||
}
|
||
|
||
/** @public */
|
||
interface Player extends Person {
|
||
money: number;
|
||
numPeopleKilled: number;
|
||
entropy: number;
|
||
jobs: Partial<Record<CompanyName, JobName>>;
|
||
factions: string[];
|
||
totalPlaytime: number;
|
||
location: string;
|
||
}
|
||
|
||
/** @public */
|
||
interface SleevePerson extends Person {
|
||
/** Number 0-100 Experience earned and shared is multiplied with shock% before sync% */
|
||
shock: number;
|
||
/** Number 1-100 Experience earned by this sleeve and shared with the player is multiplied with sync% after shock% */
|
||
sync: number;
|
||
/** Number 1-100 initial Value of sync on BN start */
|
||
memory: number;
|
||
/** Number of 200ms cycles which are stored as bonus time */
|
||
storedCycles: number;
|
||
}
|
||
|
||
/** Various info about resets
|
||
* @public */
|
||
interface ResetInfo {
|
||
/** Numeric timestamp (from Date.now()) of last augmentation reset */
|
||
lastAugReset: number;
|
||
/** Numeric timestamp (from Date.now()) of last bitnode reset */
|
||
lastNodeReset: number;
|
||
/** The current bitnode */
|
||
currentNode: number;
|
||
/** A map of owned augmentations to their levels. Keyed by the augmentation name. Map values are the augmentation level (e.g. for NeuroFlux governor). */
|
||
ownedAugs: Map<string, number>;
|
||
/** A map of owned SF to their levels. Keyed by the SF number. Map values are the SF level. */
|
||
ownedSF: Map<number, number>;
|
||
}
|
||
|
||
/** @public */
|
||
interface MoneySource {
|
||
bladeburner: number;
|
||
casino: number;
|
||
class: number;
|
||
codingcontract: number;
|
||
corporation: number;
|
||
crime: number;
|
||
gang: number;
|
||
hacking: number;
|
||
hacknet: number;
|
||
hacknet_expenses: number;
|
||
hospitalization: number;
|
||
infiltration: number;
|
||
sleeves: number;
|
||
stock: number;
|
||
total: number;
|
||
work: number;
|
||
servers: number;
|
||
other: number;
|
||
augmentations: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface MoneySources {
|
||
sinceInstall: MoneySource;
|
||
sinceStart: MoneySource;
|
||
}
|
||
|
||
/** @public */
|
||
interface Multipliers {
|
||
/** Multiplier to hacking skill */
|
||
hacking: number;
|
||
/** Multiplier to strength skill */
|
||
strength: number;
|
||
/** Multiplier to defense skill */
|
||
defense: number;
|
||
/** Multiplier to dexterity skill */
|
||
dexterity: number;
|
||
/** Multiplier to agility skill */
|
||
agility: number;
|
||
/** Multiplier to charisma skill */
|
||
charisma: number;
|
||
/** Multiplier to hacking experience gain rate */
|
||
hacking_exp: number;
|
||
/** Multiplier to strength experience gain rate */
|
||
strength_exp: number;
|
||
/** Multiplier to defense experience gain rate */
|
||
defense_exp: number;
|
||
/** Multiplier to dexterity experience gain rate */
|
||
dexterity_exp: number;
|
||
/** Multiplier to agility experience gain rate */
|
||
agility_exp: number;
|
||
/** Multiplier to charisma experience gain rate */
|
||
charisma_exp: number;
|
||
/** Multiplier to chance of successfully performing a hack */
|
||
hacking_chance: number;
|
||
/** Multiplier to hacking speed */
|
||
hacking_speed: number;
|
||
/** Multiplier to amount of money the player gains from hacking */
|
||
hacking_money: number;
|
||
/** Multiplier to amount of money injected into servers using grow */
|
||
hacking_grow: number;
|
||
/** Multiplier to amount of reputation gained when working */
|
||
company_rep: number;
|
||
/** Multiplier to amount of reputation gained when working */
|
||
faction_rep: number;
|
||
/** Multiplier to amount of money gained from crimes */
|
||
crime_money: number;
|
||
/** Multiplier to crime success rate */
|
||
crime_success: number;
|
||
/** Multiplier to amount of money gained from working */
|
||
work_money: number;
|
||
/** Multiplier to amount of money produced by Hacknet Nodes */
|
||
hacknet_node_money: number;
|
||
/** Multiplier to cost of purchasing a Hacknet Node */
|
||
hacknet_node_purchase_cost: number;
|
||
/** Multiplier to cost of ram for a Hacknet Node */
|
||
hacknet_node_ram_cost: number;
|
||
/** Multiplier to cost of core for a Hacknet Node */
|
||
hacknet_node_core_cost: number;
|
||
/** Multiplier to cost of leveling up a Hacknet Node */
|
||
hacknet_node_level_cost: number;
|
||
/** Multiplier to Bladeburner max stamina */
|
||
bladeburner_max_stamina: number;
|
||
/** Multiplier to Bladeburner stamina gain rate */
|
||
bladeburner_stamina_gain: number;
|
||
/** Multiplier to effectiveness in Bladeburner Field Analysis */
|
||
bladeburner_analysis: number;
|
||
/** Multiplier to success chance in Bladeburner contracts/operations */
|
||
bladeburner_success_chance: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface TailProperties {
|
||
/** X-coordinate of the log window */
|
||
x: number;
|
||
/** Y-coordinate of the log window */
|
||
y: number;
|
||
/** Width of the log window content area */
|
||
width: number;
|
||
/** Height of the log window content area */
|
||
height: number;
|
||
}
|
||
|
||
/**
|
||
* @public
|
||
* A stand-in for the real React.ReactNode.
|
||
* A {@link ReactElement} is rendered dynamically with React.
|
||
* number and string are displayed directly.
|
||
* boolean, null, and undefined are ignored and not rendered.
|
||
* An array of ReactNodes will display all members of that array sequentially.
|
||
*
|
||
* Use React.createElement to make the ReactElement type, see {@link https://react.dev/reference/react/createElement#creating-an-element-without-jsx | creating an element without jsx} from the official React documentation.
|
||
*/
|
||
type ReactNode = ReactElement | string | number | null | undefined | boolean | ReactNode[];
|
||
|
||
/**
|
||
* @public
|
||
* A stand-in for the real React.ReactElement.
|
||
* Use React.createElement to make these.
|
||
* See {@link https://react.dev/reference/react/createElement#creating-an-element-without-jsx | creating an element without jsx} from the official React documentation.
|
||
*/
|
||
interface ReactElement {
|
||
type: string | ((props: any) => ReactElement | null) | (new (props: any) => object);
|
||
props: any;
|
||
key: string | number | null;
|
||
}
|
||
|
||
/** @public */
|
||
interface RunningScript {
|
||
/** Arguments the script was called with */
|
||
args: (string | number | boolean)[];
|
||
/** Filename of the script */
|
||
filename: string;
|
||
/**
|
||
* Script logs as an array. The newest log entries are at the bottom.
|
||
* Timestamps, if enabled, are placed inside `[brackets]` at the start of each line.
|
||
**/
|
||
logs: string[];
|
||
/** Total amount of hacking experience earned from this script when offline */
|
||
offlineExpGained: number;
|
||
/** Total amount of money made by this script when offline */
|
||
offlineMoneyMade: number;
|
||
/** Number of seconds that the script has been running offline */
|
||
offlineRunningTime: number;
|
||
/** Total amount of hacking experience earned from this script when online */
|
||
onlineExpGained: number;
|
||
/** Total amount of money made by this script when online */
|
||
onlineMoneyMade: number;
|
||
/** Number of seconds that this script has been running online */
|
||
onlineRunningTime: number;
|
||
/** Process ID. Must be an integer */
|
||
pid: number;
|
||
/** How much RAM this script uses for ONE thread */
|
||
ramUsage: number;
|
||
/** Hostname of the server on which this script runs */
|
||
server: string;
|
||
/** Properties of the tail window, or null if it is not shown */
|
||
tailProperties: TailProperties | null;
|
||
/**
|
||
* The title, as shown in the script's log box. Defaults to the name + args,
|
||
* but can be changed by the user. If it is set to a React element (only by
|
||
* the user), that will not be persisted, and will be restored to default on
|
||
* load.
|
||
*/
|
||
title: string | ReactElement;
|
||
/** Number of threads that this script runs with */
|
||
threads: number;
|
||
/** Whether this RunningScript is excluded from saves */
|
||
temporary: boolean;
|
||
}
|
||
|
||
/** @public */
|
||
interface RunOptions {
|
||
/** Number of threads that the script will run with, defaults to 1 */
|
||
threads?: number;
|
||
/** Whether this script is excluded from saves, defaults to false */
|
||
temporary?: boolean;
|
||
/**
|
||
* The RAM allocation to launch each thread of the script with.
|
||
*
|
||
* Lowering this will <i>not</i> automatically let you get away with using less RAM:
|
||
* the dynamic RAM check enforces that all {@link NS} functions actually called incur their cost.
|
||
* However, if you know that certain functions that are statically present (and thus included
|
||
* in the static RAM cost) will never be called in a particular circumstance, you can use
|
||
* this to avoid paying for them.
|
||
*
|
||
* You can also use this to <i>increase</i> the RAM if the static RAM checker has missed functions
|
||
* that you need to call.
|
||
*
|
||
* Must be greater-or-equal to the base RAM cost. Defaults to the statically calculated cost.
|
||
*/
|
||
ramOverride?: number;
|
||
/**
|
||
* Should we fail to run if another instance is running with the exact same arguments?
|
||
* This used to be the default behavior, now defaults to false.
|
||
*/
|
||
preventDuplicates?: boolean;
|
||
}
|
||
|
||
/** @public */
|
||
interface RecentScript extends RunningScript {
|
||
/** Timestamp of when the script was killed */
|
||
timeOfDeath: Date;
|
||
}
|
||
|
||
/**
|
||
* Data representing the internal values of a crime.
|
||
* @public
|
||
*/
|
||
interface CrimeStats {
|
||
/** Number representing the difficulty of the crime. Used for success chance calculations */
|
||
difficulty: number;
|
||
/** Amount of karma lost for successfully committing this crime */
|
||
karma: number;
|
||
/** How many people die as a result of this crime */
|
||
kills: number;
|
||
/** How much money is given */
|
||
money: number;
|
||
/** Milliseconds it takes to attempt the crime */
|
||
time: number;
|
||
/** Description of the crime activity */
|
||
type: string;
|
||
/** hacking level impact on success change of the crime */
|
||
hacking_success_weight: number;
|
||
/** strength level impact on success change of the crime */
|
||
strength_success_weight: number;
|
||
/** defense level impact on success change of the crime */
|
||
defense_success_weight: number;
|
||
/** dexterity level impact on success change of the crime */
|
||
dexterity_success_weight: number;
|
||
/** agility level impact on success change of the crime */
|
||
agility_success_weight: number;
|
||
/** charisma level impact on success change of the crime */
|
||
charisma_success_weight: number;
|
||
/** hacking exp gained from crime */
|
||
hacking_exp: number;
|
||
/** strength exp gained from crime */
|
||
strength_exp: number;
|
||
/** defense exp gained from crime */
|
||
defense_exp: number;
|
||
/** dexterity exp gained from crime */
|
||
dexterity_exp: number;
|
||
/** agility exp gained from crime */
|
||
agility_exp: number;
|
||
/** charisma exp gained from crime */
|
||
charisma_exp: number;
|
||
/** intelligence exp gained from crime */
|
||
intelligence_exp: number;
|
||
}
|
||
|
||
/**
|
||
* Options to affect the behavior of {@link NS.hack | hack}, {@link NS.grow | grow}, and {@link NS.weaken | weaken}.
|
||
* @public
|
||
*/
|
||
interface BasicHGWOptions {
|
||
/** Number of threads to use for this function.
|
||
* Must be less than or equal to the number of threads the script is running with. */
|
||
threads?: number;
|
||
/** Set to true this action will affect the stock market. */
|
||
stock?: boolean;
|
||
/** Number of additional milliseconds that will be spent waiting between the start of the function and when it
|
||
* completes. */
|
||
additionalMsec?: number;
|
||
}
|
||
|
||
/**
|
||
* Return value of {@link Sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs}
|
||
* @public
|
||
*/
|
||
interface AugmentPair {
|
||
/** augmentation name */
|
||
name: string;
|
||
/** augmentation cost */
|
||
cost: number;
|
||
}
|
||
|
||
/** @public */
|
||
declare enum PositionType {
|
||
Long = "L",
|
||
Short = "S",
|
||
}
|
||
|
||
/** @public */
|
||
declare enum OrderType {
|
||
LimitBuy = "Limit Buy Order",
|
||
LimitSell = "Limit Sell Order",
|
||
StopBuy = "Stop Buy Order",
|
||
StopSell = "Stop Sell Order",
|
||
}
|
||
|
||
/**
|
||
* Value in map of {@link StockOrder}
|
||
* @public
|
||
*/
|
||
interface StockOrderObject {
|
||
/** Number of shares */
|
||
shares: number;
|
||
/** Price per share */
|
||
price: number;
|
||
/** Order type */
|
||
type: OrderType;
|
||
/** Order position */
|
||
position: PositionType;
|
||
}
|
||
|
||
/**
|
||
* Return value of {@link TIX.getOrders | getOrders}
|
||
*
|
||
* Keys are stock symbols, properties are arrays of {@link StockOrderObject}
|
||
* @public
|
||
*/
|
||
interface StockOrder {
|
||
[key: string]: StockOrderObject[];
|
||
}
|
||
|
||
/** Constants used for the stockmarket game mechanic.
|
||
* @public */
|
||
interface StockMarketConstants {
|
||
/** Normal time in ms between stock market updates */
|
||
msPerStockUpdate: number;
|
||
/** Minimum time in ms between stock market updates if there is stored offline/bonus time */
|
||
msPerStockUpdateMin: number;
|
||
/** An internal constant used while determining when to flip a stock's forecast */
|
||
TicksPerCycle: number;
|
||
/** Cost of the WSE account */
|
||
WSEAccountCost: number;
|
||
/** Cost of the TIX API */
|
||
TIXAPICost: number;
|
||
/** Cost of the 4S Market Data */
|
||
MarketData4SCost: number;
|
||
/** Cost of the 4S Market Data TIX API integration */
|
||
MarketDataTixApi4SCost: number;
|
||
/** Commission fee for transactions */
|
||
StockMarketCommission: number;
|
||
}
|
||
|
||
/**
|
||
* A single process on a server.
|
||
* @public
|
||
*/
|
||
interface ProcessInfo {
|
||
/** Script name. */
|
||
filename: string;
|
||
/** Number of threads script is running with */
|
||
threads: number;
|
||
/** Script's arguments */
|
||
args: (string | number | boolean)[];
|
||
/** Process ID */
|
||
pid: number;
|
||
/** Whether this process is excluded from saves */
|
||
temporary: boolean;
|
||
}
|
||
|
||
/**
|
||
* Hack related multipliers.
|
||
* @public
|
||
*/
|
||
interface HackingMultipliers {
|
||
/** Player's hacking chance multiplier. */
|
||
chance: number;
|
||
/** Player's hacking speed multiplier. */
|
||
speed: number;
|
||
/** Player's hacking money stolen multiplier. */
|
||
money: number;
|
||
/** Player's hacking growth multiplier */
|
||
growth: number;
|
||
}
|
||
|
||
/**
|
||
* Hacknet related multipliers.
|
||
* @public
|
||
*/
|
||
interface HacknetMultipliers {
|
||
/** Player's hacknet production multiplier */
|
||
production: number;
|
||
/** Player's hacknet purchase cost multiplier */
|
||
purchaseCost: number;
|
||
/** Player's hacknet ram cost multiplier */
|
||
ramCost: number;
|
||
/** Player's hacknet core cost multiplier */
|
||
coreCost: number;
|
||
/** Player's hacknet level cost multiplier */
|
||
levelCost: number;
|
||
}
|
||
|
||
/**
|
||
* Hacknet node related constants
|
||
* @public
|
||
*/
|
||
interface HacknetNodeConstants {
|
||
/** Amount of money gained per level */
|
||
MoneyGainPerLevel: number;
|
||
/** Base cost for a new node */
|
||
BaseCost: number;
|
||
/** Base cost per level */
|
||
LevelBaseCost: number;
|
||
/** Base cost to increase RAM */
|
||
RamBaseCost: number;
|
||
/** Base cost to increase cores */
|
||
CoreBaseCost: number;
|
||
/** Multiplier to purchase new node */
|
||
PurchaseNextMult: number;
|
||
/** Multiplier to increase node level */
|
||
UpgradeLevelMult: number;
|
||
/** Multiplier to increase RAM */
|
||
UpgradeRamMult: number;
|
||
/** Multiplier to increase cores */
|
||
UpgradeCoreMult: number;
|
||
/** Max node level */
|
||
MaxLevel: number;
|
||
/** Max amount of RAM in GB */
|
||
MaxRam: number;
|
||
/** Max number of cores */
|
||
MaxCores: number;
|
||
}
|
||
|
||
/**
|
||
* Hacknet server related constants
|
||
* @public
|
||
*/
|
||
interface HacknetServerConstants {
|
||
/** Number of hashes calculated per level */
|
||
HashesPerLevel: number;
|
||
/** Base cost for a new server */
|
||
BaseCost: number;
|
||
/** Base cost to increase RAM */
|
||
RamBaseCost: number;
|
||
/** Base cost to increase cores */
|
||
CoreBaseCost: number;
|
||
/** Base cost to upgrade cache */
|
||
CacheBaseCost: number;
|
||
/** Multiplier to purchase a new server */
|
||
PurchaseMult: number;
|
||
/** Multiplier to increase server level */
|
||
UpgradeLevelMult: number;
|
||
/** Multiplier to increase RAM */
|
||
UpgradeRamMult: number;
|
||
/** Multiplier to increase cores */
|
||
UpgradeCoreMult: number;
|
||
/** Multiplier to upgrade cache */
|
||
UpgradeCacheMult: number;
|
||
/** Max number of servers */
|
||
MaxServers: number;
|
||
/** Max level for a server */
|
||
MaxLevel: number;
|
||
/** Max amount of RAM in GB */
|
||
MaxRam: number;
|
||
/** Max number of cores */
|
||
MaxCores: number;
|
||
/** Max cache size */
|
||
MaxCache: number;
|
||
}
|
||
|
||
/**
|
||
* A server. Not all servers have all of these properties - optional properties are missing on certain servers.
|
||
* @public
|
||
*/
|
||
export interface Server {
|
||
/** Hostname. Must be unique */
|
||
hostname: string;
|
||
/** IP Address. Must be unique */
|
||
ip: string;
|
||
|
||
/** Whether or not the SSH Port is open */
|
||
sshPortOpen: boolean;
|
||
/** Whether or not the FTP port is open */
|
||
ftpPortOpen: boolean;
|
||
/** Whether or not the SMTP Port is open */
|
||
smtpPortOpen: boolean;
|
||
/** Whether or not the HTTP Port is open */
|
||
httpPortOpen: boolean;
|
||
/** Whether or not the SQL Port is open */
|
||
sqlPortOpen: boolean;
|
||
|
||
/** Flag indicating whether player has admin/root access to this server */
|
||
hasAdminRights: boolean;
|
||
|
||
/** How many CPU cores this server has. Affects magnitude of grow and weaken ran from this server. */
|
||
cpuCores: number;
|
||
|
||
/** Flag indicating whether player is currently connected to this server */
|
||
isConnectedTo: boolean;
|
||
|
||
/** RAM (GB) used. i.e. unavailable RAM */
|
||
ramUsed: number;
|
||
/** RAM (GB) available on this server */
|
||
maxRam: number;
|
||
|
||
/** Name of company/faction/etc. that this server belongs to, not applicable to all Servers */
|
||
organizationName: string;
|
||
|
||
/** Flag indicating whether this is a purchased server */
|
||
purchasedByPlayer: boolean;
|
||
|
||
/** Flag indicating whether this server has a backdoor installed by a player */
|
||
backdoorInstalled?: boolean;
|
||
|
||
/** Server's initial server security level at creation. */
|
||
baseDifficulty?: number;
|
||
|
||
/** Server Security Level */
|
||
hackDifficulty?: number;
|
||
|
||
/** Minimum server security level that this server can be weakened to */
|
||
minDifficulty?: number;
|
||
|
||
/** How much money currently resides on the server and can be hacked */
|
||
moneyAvailable?: number;
|
||
|
||
/** Maximum amount of money that this server can hold */
|
||
moneyMax?: number;
|
||
|
||
/** Number of open ports required in order to gain admin/root access */
|
||
numOpenPortsRequired?: number;
|
||
|
||
/** How many ports are currently opened on the server */
|
||
openPortCount?: number;
|
||
|
||
/** Hacking level required to hack this server */
|
||
requiredHackingSkill?: number;
|
||
|
||
/** Growth effectiveness statistic. Higher values produce more growth with ns.grow() */
|
||
serverGrowth?: number;
|
||
}
|
||
|
||
/**
|
||
* All multipliers affecting the difficulty of the current challenge.
|
||
* @public
|
||
*/
|
||
interface BitNodeMultipliers {
|
||
/** Influences how quickly the player's agility level (not exp) scales */
|
||
AgilityLevelMultiplier: number;
|
||
/** Influences the base cost to purchase an augmentation. */
|
||
AugmentationMoneyCost: number;
|
||
/** Influences the base rep the player must have with a faction to purchase an augmentation. */
|
||
AugmentationRepCost: number;
|
||
/** Influences how quickly the player can gain rank within Bladeburner. */
|
||
BladeburnerRank: number;
|
||
/** Influences the cost of skill levels from Bladeburner. */
|
||
BladeburnerSkillCost: number;
|
||
/** Influences how quickly the player's charisma level (not exp) scales */
|
||
CharismaLevelMultiplier: number;
|
||
/** Influences the experience gained for each ability when a player completes a class. */
|
||
ClassGymExpGain: number;
|
||
/** Influences the amount of money gained from completing Coding Contracts */
|
||
CodingContractMoney: number;
|
||
/** Influences the experience gained for each ability when the player completes working their job. */
|
||
CompanyWorkExpGain: number;
|
||
/** Influences how much money the player earns when completing working their job. */
|
||
CompanyWorkMoney: number;
|
||
/** Influences the money gain from dividends of corporations created by the player. */
|
||
CorporationSoftcap: number;
|
||
/** Influences the valuation of corporations created by the player. */
|
||
CorporationValuation: number;
|
||
/** Influences the base experience gained for each ability when the player commits a crime. */
|
||
CrimeExpGain: number;
|
||
/** Influences the base money gained when the player commits a crime. */
|
||
CrimeMoney: number;
|
||
/** Influences how many Augmentations you need in order to get invited to the Daedalus faction */
|
||
DaedalusAugsRequirement: number;
|
||
/** Influences how quickly the player's defense level (not exp) scales */
|
||
DefenseLevelMultiplier: number;
|
||
/** Influences how quickly the player's dexterity level (not exp) scales */
|
||
DexterityLevelMultiplier: number;
|
||
/** Influences how much rep the player gains in each faction simply by being a member. */
|
||
FactionPassiveRepGain: number;
|
||
/** Influences the experience gained for each ability when the player completes work for a Faction. */
|
||
FactionWorkExpGain: number;
|
||
/** Influences how much rep the player gains when performing work for a faction. */
|
||
FactionWorkRepGain: number;
|
||
/** Influences how much it costs to unlock the stock market's 4S Market Data API */
|
||
FourSigmaMarketDataApiCost: number;
|
||
/** Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) */
|
||
FourSigmaMarketDataCost: number;
|
||
/** Influences the respect gain and money gain of your gang. */
|
||
GangSoftcap: number;
|
||
/** Influences the experienced gained when hacking a server. */
|
||
HackExpGain: number;
|
||
/** Influences how quickly the player's hacking level (not experience) scales */
|
||
HackingLevelMultiplier: number;
|
||
/** Influences how much money is produced by Hacknet Nodes
|
||
* and the hash rate of Hacknet Servers (unlocked in BitNode-9) */
|
||
HacknetNodeMoney: number;
|
||
/** Influences how much money it costs to upgrade your home computer's RAM */
|
||
HomeComputerRamCost: number;
|
||
/** Influences how much money is gained when the player infiltrates a company. */
|
||
InfiltrationMoney: number;
|
||
/** Influences how much rep the player can gain from factions when selling stolen documents and secrets */
|
||
InfiltrationRep: number;
|
||
/** Influences how much money can be stolen from a server when the player
|
||
* performs a hack against it through the Terminal. */
|
||
ManualHackMoney: number;
|
||
/** Influence how much it costs to purchase a server */
|
||
PurchasedServerCost: number;
|
||
/** Influences the maximum number of purchased servers you can have */
|
||
PurchasedServerLimit: number;
|
||
/** Influences the maximum allowed RAM for a purchased server */
|
||
PurchasedServerMaxRam: number;
|
||
/** Influences cost of any purchased server at or above 128GB */
|
||
PurchasedServerSoftcap: number;
|
||
/** Influences the minimum favor the player must have with a faction before they can donate to gain rep. */
|
||
RepToDonateToFaction: number;
|
||
/** Influences how much the money on a server can be reduced when a script performs a hack against it. */
|
||
ScriptHackMoney: number;
|
||
/** Influences how much of the money stolen by a scripted hack will be added to the player's money. */
|
||
ScriptHackMoneyGain: number;
|
||
/** Influences the growth percentage per cycle against a server. */
|
||
ServerGrowthRate: number;
|
||
/** Influences the maximum money that a server can grow to. */
|
||
ServerMaxMoney: number;
|
||
/** Influences the initial money that a server starts with. */
|
||
ServerStartingMoney: number;
|
||
/** Influences the initial security level (hackDifficulty) of a server. */
|
||
ServerStartingSecurity: number;
|
||
/** Influences the weaken amount per invocation against a server. */
|
||
ServerWeakenRate: number;
|
||
/** Influences how quickly the player's strength level (not exp) scales */
|
||
StrengthLevelMultiplier: number;
|
||
/** Influences the power of the gift */
|
||
StaneksGiftPowerMultiplier: number;
|
||
/** Influences the size of the gift */
|
||
StaneksGiftExtraSize: number;
|
||
/** Influences the hacking skill required to backdoor the world daemon. */
|
||
WorldDaemonDifficulty: number;
|
||
}
|
||
|
||
/**
|
||
* Object representing all the values related to a hacknet node.
|
||
* @public
|
||
*/
|
||
interface NodeStats {
|
||
/** Node's name */
|
||
name: string;
|
||
/** Node's level */
|
||
level: number;
|
||
/** Node's RAM (GB) */
|
||
ram: number;
|
||
/** Node's used RAM (GB) */
|
||
ramUsed?: number;
|
||
/** Node's number of cores */
|
||
cores: number;
|
||
/** Cache level. Only applicable for Hacknet Servers */
|
||
cache?: number;
|
||
/** Hash Capacity provided by this Node. Only applicable for Hacknet Servers */
|
||
hashCapacity?: number;
|
||
/** Node's production per second */
|
||
production: number;
|
||
/** Number of seconds since Node has been purchased */
|
||
timeOnline: number;
|
||
/** Total number of money Node has produced */
|
||
totalProduction: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface SourceFileLvl {
|
||
/** The number of the source file */
|
||
n: number;
|
||
/** The level of the source file */
|
||
lvl: number;
|
||
}
|
||
|
||
/**
|
||
* Bladeburner current action.
|
||
* @public
|
||
*/
|
||
interface BladeburnerCurAction {
|
||
/** Type of Action */
|
||
type: string;
|
||
/** Name of Action */
|
||
name: string;
|
||
}
|
||
|
||
/**
|
||
* Gang general info.
|
||
* @public
|
||
*/
|
||
interface GangGenInfo {
|
||
/** Name of faction that the gang belongs to ("Slum Snakes", etc.) */
|
||
faction: string;
|
||
/** Indicating whether or not it's a hacking gang */
|
||
isHacking: boolean;
|
||
/** Money earned per game cycle */
|
||
moneyGainRate: number;
|
||
/** Gang's power for territory warfare */
|
||
power: number;
|
||
/** Gang's respect */
|
||
respect: number;
|
||
/** Respect earned per game cycle */
|
||
respectGainRate: number;
|
||
/** Amount of territory held */
|
||
territory: number;
|
||
/** Clash chance */
|
||
territoryClashChance: number;
|
||
/** Gang's wanted level */
|
||
wantedLevel: number;
|
||
/** Wanted level gained/lost per game cycle (negative for losses) */
|
||
wantedLevelGainRate: number;
|
||
/** Indicating if territory warfare is enabled */
|
||
territoryWarfareEngaged: boolean;
|
||
/** Number indicating the current wanted penalty */
|
||
wantedPenalty: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface GangOtherInfoObject {
|
||
/** Gang power */
|
||
power: number;
|
||
/** Gang territory, in decimal form */
|
||
territory: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface GangOtherInfo {
|
||
[key: string]: GangOtherInfoObject;
|
||
}
|
||
|
||
/**
|
||
* Object representing data representing a gang member task.
|
||
* @public
|
||
*/
|
||
interface GangTaskStats {
|
||
/** Task name */
|
||
name: string;
|
||
/** Task Description */
|
||
desc: string;
|
||
/** Is a task of a hacking gang */
|
||
isHacking: boolean;
|
||
/** Is a task of a combat gang */
|
||
isCombat: boolean;
|
||
/** Base respect earned */
|
||
baseRespect: number;
|
||
/** Base wanted earned */
|
||
baseWanted: number;
|
||
/** Base money earned */
|
||
baseMoney: number;
|
||
/** Hacking skill impact on task scaling */
|
||
hackWeight: number;
|
||
/** Strength skill impact on task scaling */
|
||
strWeight: number;
|
||
/** Defense skill impact on task scaling */
|
||
defWeight: number;
|
||
/** Dexterity skill impact on task scaling */
|
||
dexWeight: number;
|
||
/** Agility skill impact on task scaling */
|
||
agiWeight: number;
|
||
/** Charisma skill impact on task scaling */
|
||
chaWeight: number;
|
||
/** Number representing the difficulty of the task */
|
||
difficulty: number;
|
||
/** Territory impact on task scaling */
|
||
territory: GangTerritory;
|
||
}
|
||
|
||
/**
|
||
* Object representing data representing a gang member equipment.
|
||
* @public
|
||
*/
|
||
interface EquipmentStats {
|
||
/** Strength multiplier */
|
||
str?: number;
|
||
/** Defense multiplier */
|
||
def?: number;
|
||
/** Dexterity multiplier */
|
||
dex?: number;
|
||
/** Agility multiplier */
|
||
agi?: number;
|
||
/** Charisma multiplier */
|
||
cha?: number;
|
||
/** Hacking multiplier */
|
||
hack?: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface GangTerritory {
|
||
/** Money gain impact on task scaling */
|
||
money: number;
|
||
/** Respect gain impact on task scaling */
|
||
respect: number;
|
||
/** Wanted gain impact on task scaling */
|
||
wanted: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface GangMemberInfo {
|
||
/** Name of the gang member */
|
||
name: string;
|
||
/** Currently assigned task */
|
||
task: string;
|
||
earnedRespect: number;
|
||
|
||
/** Hack skill level */
|
||
hack: number;
|
||
/** Strength skill level */
|
||
str: number;
|
||
/** Defense skill level */
|
||
def: number;
|
||
/** Dexterity skill level */
|
||
dex: number;
|
||
/** Agility skill level */
|
||
agi: number;
|
||
/** Charisma skill level */
|
||
cha: number;
|
||
|
||
/** Current hack experience */
|
||
hack_exp: number;
|
||
/** Current strength experience */
|
||
str_exp: number;
|
||
/** Current defense experience */
|
||
def_exp: number;
|
||
/** Current dexterity experience */
|
||
dex_exp: number;
|
||
/** Current agility experience */
|
||
agi_exp: number;
|
||
/** Current charisma experience */
|
||
cha_exp: number;
|
||
|
||
/** Hack multiplier from equipment */
|
||
hack_mult: number;
|
||
/** Strength multiplier from equipment */
|
||
str_mult: number;
|
||
/** Defense multiplier from equipment */
|
||
def_mult: number;
|
||
/** Dexterity multiplier from equipment */
|
||
dex_mult: number;
|
||
/** Agility multiplier from equipment */
|
||
agi_mult: number;
|
||
/** Charisma multiplier from equipment */
|
||
cha_mult: number;
|
||
|
||
/** Hack multiplier from ascensions */
|
||
hack_asc_mult: number;
|
||
/** Strength multiplier from ascensions */
|
||
str_asc_mult: number;
|
||
/** Defense multiplier from ascensions */
|
||
def_asc_mult: number;
|
||
/** Dexterity multiplier from ascensions */
|
||
dex_asc_mult: number;
|
||
/** Agility multiplier from ascensions */
|
||
agi_asc_mult: number;
|
||
/** Charisma multiplier from ascensions */
|
||
cha_asc_mult: number;
|
||
|
||
/** Total earned hack experience */
|
||
hack_asc_points: number;
|
||
/** Total earned strength experience */
|
||
str_asc_points: number;
|
||
/** Total earned defense experience */
|
||
def_asc_points: number;
|
||
/** Total earned dexterity experience */
|
||
dex_asc_points: number;
|
||
/** Total earned agility experience */
|
||
agi_asc_points: number;
|
||
/** Total earned charisma experience */
|
||
cha_asc_points: number;
|
||
|
||
upgrades: string[];
|
||
augmentations: string[];
|
||
|
||
respectGain: number;
|
||
wantedLevelGain: number;
|
||
moneyGain: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface GangMemberAscension {
|
||
/** Amount of respect lost from ascending */
|
||
respect: number;
|
||
/** Factor by which the hacking ascension multiplier was increased (newMult / oldMult) */
|
||
hack: number;
|
||
/** Factor by which the strength ascension multiplier was increased (newMult / oldMult) */
|
||
str: number;
|
||
/** Factor by which the defense ascension multiplier was increased (newMult / oldMult) */
|
||
def: number;
|
||
/** Factor by which the dexterity ascension multiplier was increased (newMult / oldMult) */
|
||
dex: number;
|
||
/** Factor by which the agility ascension multiplier was increased (newMult / oldMult) */
|
||
agi: number;
|
||
/** Factor by which the charisma ascension multiplier was increased (newMult / oldMult) */
|
||
cha: number;
|
||
}
|
||
|
||
/** @public */
|
||
type SleeveBladeburnerTask = {
|
||
type: "BLADEBURNER";
|
||
actionType: "General" | "Contracts";
|
||
actionName: string;
|
||
cyclesWorked: number;
|
||
cyclesNeeded: number;
|
||
};
|
||
|
||
/** @public */
|
||
type SleeveClassTask = {
|
||
type: "CLASS";
|
||
classType: UniversityClassType | GymType | `${UniversityClassType}` | `${GymType}`;
|
||
location: LocationName | `${LocationName}`;
|
||
};
|
||
|
||
/** @public */
|
||
type SleeveCompanyTask = { type: "COMPANY"; companyName: CompanyName };
|
||
|
||
/** @public */
|
||
type SleeveCrimeTask = {
|
||
type: "CRIME";
|
||
crimeType: CrimeType | `${CrimeType}`;
|
||
cyclesWorked: number;
|
||
cyclesNeeded: number;
|
||
};
|
||
|
||
/** @public */
|
||
type SleeveFactionTask = {
|
||
type: "FACTION";
|
||
factionWorkType: FactionWorkType | `${FactionWorkType}`;
|
||
factionName: string;
|
||
};
|
||
|
||
/** @public */
|
||
type SleeveInfiltrateTask = { type: "INFILTRATE"; cyclesWorked: number; cyclesNeeded: number };
|
||
|
||
/** @public */
|
||
type SleeveRecoveryTask = { type: "RECOVERY" };
|
||
|
||
/** @public */
|
||
type SleeveSupportTask = { type: "SUPPORT" };
|
||
|
||
/** @public */
|
||
type SleeveSynchroTask = { type: "SYNCHRO" };
|
||
|
||
/** Object representing a sleeve current task.
|
||
* @public */
|
||
export type SleeveTask =
|
||
| SleeveBladeburnerTask
|
||
| SleeveClassTask
|
||
| SleeveCompanyTask
|
||
| SleeveCrimeTask
|
||
| SleeveFactionTask
|
||
| SleeveInfiltrateTask
|
||
| SleeveRecoveryTask
|
||
| SleeveSupportTask
|
||
| SleeveSynchroTask;
|
||
|
||
/** Object representing a port. A port is a serialized queue.
|
||
* @public */
|
||
export interface NetscriptPort {
|
||
/** Write data to a port.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @returns The data popped off the queue if it was full. */
|
||
write(value: string | number): PortData | null;
|
||
|
||
/**
|
||
* Attempt to write data to the port.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @returns True if the data was added to the port, false if the port was full
|
||
*/
|
||
tryWrite(value: string | number): boolean;
|
||
|
||
/**
|
||
* Sleeps until the port is written to.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*/
|
||
nextWrite(): Promise<void>;
|
||
|
||
/**
|
||
* Shift an element out of the port.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function will remove the first element from the port and return it.
|
||
* If the port is empty, then the string “NULL PORT DATA” will be returned.
|
||
* @returns the data read.
|
||
*/
|
||
read(): PortData;
|
||
|
||
/**
|
||
* Retrieve the first element from the port without removing it.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is used to peek at the data from a port. It returns the
|
||
* first element in the specified port without removing that element. If
|
||
* the port is empty, the string “NULL PORT DATA” will be returned.
|
||
* @returns the data read
|
||
*/
|
||
peek(): PortData;
|
||
|
||
/**
|
||
* Check if the port is full.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @returns true if the port is full, otherwise false
|
||
*/
|
||
full(): boolean;
|
||
|
||
/**
|
||
* Check if the port is empty.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @returns true if the port is empty, otherwise false
|
||
*/
|
||
empty(): boolean;
|
||
|
||
/**
|
||
* Empties all data from the port.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*/
|
||
clear(): void;
|
||
}
|
||
|
||
/**
|
||
* Stock market API
|
||
* @public
|
||
*/
|
||
export interface TIX {
|
||
/** Get game constants for the stock market mechanic.
|
||
* @remarks RAM cost: 0 GB */
|
||
getConstants(): StockMarketConstants;
|
||
/**
|
||
* Returns true if the player has access to a WSE Account
|
||
* @remarks RAM cost: 0.05 GB
|
||
*/
|
||
hasWSEAccount(): boolean;
|
||
/**
|
||
* Returns true if the player has access to the TIX API
|
||
* @remarks RAM cost: 0.05 GB
|
||
*/
|
||
hasTIXAPIAccess(): boolean;
|
||
/**
|
||
* Returns true if the player has access to the 4S Data
|
||
* @remarks RAM cost: 0.05 GB
|
||
*/
|
||
has4SData(): boolean;
|
||
/**
|
||
* Returns true if the player has access to the 4SData TIX API
|
||
* @remarks RAM cost: 0.05 GB
|
||
*/
|
||
has4SDataTIXAPI(): boolean;
|
||
/**
|
||
* Returns an array of the symbols of the tradable stocks
|
||
*
|
||
* @remarks RAM cost: 2 GB
|
||
* @returns Array of the symbols of the tradable stocks.
|
||
*/
|
||
getSymbols(): string[];
|
||
|
||
/**
|
||
* Returns the price of a stock.
|
||
*
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* The stock’s price is the average of its bid and ask prices. This function requires
|
||
* that you have the following:
|
||
*
|
||
* 1. WSE Account
|
||
*
|
||
* 1. TIX API Access
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const fourSigmaStockPrice = ns.stock.getPrice("FSIG");
|
||
*
|
||
* // Choose the first stock symbol from the array of stock symbols. Get the price
|
||
* // of the corresponding stock.
|
||
* const sym = ns.stock.getSymbols()[0];
|
||
* ns.tprint("Stock symbol: " + sym);
|
||
* ns.tprint("Stock price: " + ns.stock.getPrice(sym));
|
||
* ```
|
||
* @param sym - Stock symbol.
|
||
* @returns The price of a stock.
|
||
*/
|
||
getPrice(sym: string): number;
|
||
|
||
/**
|
||
* Returns the organization associated with a stock symbol.
|
||
*
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* The organization associated with the corresponding stock symbol. This function
|
||
* requires that you have the following:
|
||
*
|
||
* 1. WSE Account
|
||
*
|
||
* 1. TIX API Access
|
||
*
|
||
* @example
|
||
* ```js
|
||
* ns.stock.getOrganization("FSIG");
|
||
*
|
||
* // Choose the first stock symbol from the array of stock symbols. Get the
|
||
* // organization associated with the corresponding stock symbol.
|
||
* const sym = ns.stock.getSymbols()[0];
|
||
* ns.tprint("Stock symbol: " + sym);
|
||
* ns.tprint("Stock organization: " + ns.stock.getOrganization(sym));
|
||
* ```
|
||
* @param sym - Stock symbol.
|
||
* @returns The organization assicated with the stock symbol.
|
||
*/
|
||
getOrganization(sym: string): string;
|
||
|
||
/**
|
||
* Returns the ask price of that stock.
|
||
* @remarks RAM cost: 2 GB
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @returns The ask price of a stock.
|
||
*/
|
||
getAskPrice(sym: string): number;
|
||
|
||
/**
|
||
* Returns the bid price of that stock.
|
||
* @remarks RAM cost: 2 GB
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @returns The bid price of a stock.
|
||
*/
|
||
getBidPrice(sym: string): number;
|
||
|
||
/**
|
||
* Returns the player’s position in a stock.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
* Returns an array of four elements that represents the player’s position in a stock.
|
||
*
|
||
* The first element in the returned array is the number of shares the player owns of
|
||
* the stock in the Long position. The second element in the array is the average price
|
||
* of the player’s shares in the Long position.
|
||
*
|
||
* The third element in the array is the number of shares the player owns of the stock
|
||
* in the Short position. The fourth element in the array is the average price of the
|
||
* player’s Short position.
|
||
*
|
||
* All elements in the returned array are numeric.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const [sharesLong, avgLongPrice, sharesShort, avgShortPrice] = ns.stock.getPosition("ECP");
|
||
* ```
|
||
* @param sym - Stock symbol.
|
||
* @returns Array of four elements that represents the player’s position in a stock.
|
||
*/
|
||
getPosition(sym: string): [number, number, number, number];
|
||
|
||
/**
|
||
* Returns the maximum number of shares of a stock.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
* This is the maximum amount of the stock that can be purchased
|
||
* in both the Long and Short positions combined.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @returns Maximum number of shares that the stock has.
|
||
*/
|
||
getMaxShares(sym: string): number;
|
||
|
||
/**
|
||
* Calculates cost of buying stocks.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
* Calculates and returns how much it would cost to buy a given number of shares of a stock.
|
||
* This takes into account spread, large transactions influencing the price of the stock and commission fees.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @param shares - Number of shares to purchase.
|
||
* @param posType - Specifies whether the order is a “Long” or “Short” position.
|
||
* @returns Cost to buy a given number of shares of a stock.
|
||
*/
|
||
getPurchaseCost(sym: string, shares: number, posType: string): number;
|
||
|
||
/**
|
||
* Calculate profit of selling stocks.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
* Calculates and returns how much you would gain from selling a given number of shares of a stock.
|
||
* This takes into account spread, large transactions influencing the price of the stock and commission fees.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @param shares - Number of shares to sell.
|
||
* @param posType - Specifies whether the order is a “Long” or “Short” position.
|
||
* @returns Gain from selling a given number of shares of a stock.
|
||
*/
|
||
getSaleGain(sym: string, shares: number, posType: string): number;
|
||
|
||
/**
|
||
* Buy stocks.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB
|
||
* Attempts to purchase shares of a stock using a Market Order.
|
||
*
|
||
* If the player does not have enough money to purchase the specified number of shares,
|
||
* then no shares will be purchased. Remember that every transaction on the stock exchange
|
||
* costs a certain commission fee.
|
||
*
|
||
* If this function successfully purchases the shares, it will return the stock price at which
|
||
* each share was purchased. Otherwise, it will return 0.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @param shares - Number of shares to purchased. Must be positive. Will be rounded to nearest integer.
|
||
* @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased.
|
||
*/
|
||
buyStock(sym: string, shares: number): number;
|
||
|
||
/**
|
||
* Sell stocks.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB
|
||
* Attempts to sell shares of a stock using a Market Order.
|
||
*
|
||
* If the specified number of shares in the function exceeds the amount that the player
|
||
* actually owns, then this function will sell all owned shares. Remember that every
|
||
* transaction on the stock exchange costs a certain commission fee.
|
||
*
|
||
* The net profit made from selling stocks with this function is reflected in the script’s
|
||
* statistics. This net profit is calculated as:
|
||
*
|
||
* shares * (sell_price - average_price_of_purchased_shares)
|
||
*
|
||
* If the sale is successful, this function will return the stock price at
|
||
* which each share was sold. Otherwise, it will return 0.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer.
|
||
* @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold.
|
||
*/
|
||
sellStock(sym: string, shares: number): number;
|
||
|
||
/**
|
||
* Short stocks.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB
|
||
* Attempts to purchase a short position of a stock using a Market Order.
|
||
*
|
||
* The ability to short a stock is **not** immediately available to the player and
|
||
* must be unlocked later on in the game.
|
||
*
|
||
* If the player does not have enough money to purchase the specified number of shares,
|
||
* then no shares will be purchased. Remember that every transaction on the stock exchange
|
||
* costs a certain commission fee.
|
||
*
|
||
* If the purchase is successful, this function will return the stock price at which each
|
||
* share was purchased. Otherwise, it will return 0.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @param shares - Number of shares to short. Must be positive. Will be rounded to nearest integer.
|
||
* @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased.
|
||
*/
|
||
buyShort(sym: string, shares: number): number;
|
||
|
||
/**
|
||
* Sell short stock.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB
|
||
* Attempts to sell a short position of a stock using a Market Order.
|
||
*
|
||
* The ability to short a stock is **not** immediately available to the player and
|
||
* must be unlocked later on in the game.
|
||
*
|
||
* If the specified number of shares exceeds the amount that the player actually owns,
|
||
* then this function will sell all owned shares. Remember that every transaction on
|
||
* the stock exchange costs a certain commission fee.
|
||
*
|
||
* If the sale is successful, this function will return the stock price at which each
|
||
* share was sold. Otherwise it will return 0.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer.
|
||
* @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold.
|
||
*/
|
||
sellShort(sym: string, shares: number): number;
|
||
|
||
/**
|
||
* Place order for stocks.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB
|
||
* Places an order on the stock market. This function only works for Limit and Stop Orders.
|
||
*
|
||
* The ability to place limit and stop orders is **not** immediately available to the player and
|
||
* must be unlocked later on in the game.
|
||
*
|
||
* Returns true if the order is successfully placed, and false otherwise.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @param shares - Number of shares for order. Must be positive. Will be rounded to nearest integer.
|
||
* @param price - Execution price for the order.
|
||
* @param type - Type of order.
|
||
* @param pos - Specifies whether the order is a “Long” or “Short” position.
|
||
* @returns True if the order is successfully placed, and false otherwise.
|
||
*/
|
||
placeOrder(sym: string, shares: number, price: number, type: string, pos: string): boolean;
|
||
|
||
/**
|
||
* Cancel order for stocks.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB
|
||
* Cancels an outstanding Limit or Stop order on the stock market.
|
||
*
|
||
* The ability to use limit and stop orders is **not** immediately available to the player and
|
||
* must be unlocked later on in the game.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @param shares - Number of shares for order. Must be positive. Will be rounded to nearest integer.
|
||
* @param price - Execution price for the order.
|
||
* @param type - Type of order.
|
||
* @param pos - Specifies whether the order is a “Long” or “Short” position.
|
||
*/
|
||
cancelOrder(sym: string, shares: number, price: number, type: string, pos: string): void;
|
||
|
||
/**
|
||
* Returns your order book for the stock market.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB
|
||
* This is an object containing information for all the Limit and Stop Orders you have in the stock market.
|
||
* For each symbol you have a position in, the returned object will have a key with that symbol's name.
|
||
* The object's properties are each an array of {@link StockOrderObject}
|
||
* The object has the following structure:
|
||
*
|
||
* ```ts
|
||
* {
|
||
* string1: [ // Array of orders for this stock
|
||
* {
|
||
* shares: Order quantity
|
||
* price: Order price
|
||
* type: Order type
|
||
* position: Either "L" or "S" for Long or Short position
|
||
* },
|
||
* {
|
||
* ...
|
||
* },
|
||
* ...
|
||
* ],
|
||
* string2: [ // Array of orders for this stock
|
||
* ...
|
||
* ],
|
||
* ...
|
||
* }
|
||
* ```
|
||
* The “Order type” property can have one of the following four values: "Limit Buy Order", "Limit Sell Order",
|
||
* "Stop Buy Order", "Stop Sell Order".
|
||
* Note that the order book will only contain information for stocks that you actually have orders in.
|
||
*
|
||
* @example
|
||
* ```ts
|
||
* "If you do not have orders in Nova Medical (NVMD), then the returned object will not have a “NVMD” property."
|
||
* {
|
||
* ECP: [
|
||
* {
|
||
* shares: 5,
|
||
* price: 100,000
|
||
* type: "Stop Buy Order",
|
||
* position: "S",
|
||
* },
|
||
* {
|
||
* shares: 25,
|
||
* price: 125,000
|
||
* type: "Limit Sell Order",
|
||
* position: "L",
|
||
* },
|
||
* ],
|
||
* SYSC: [
|
||
* {
|
||
* shares: 100,
|
||
* price: 10,000
|
||
* type: "Limit Buy Order",
|
||
* position: "L",
|
||
* },
|
||
* ],
|
||
* }
|
||
* ```
|
||
* @returns Object containing information for all the Limit and Stop Orders you have in the stock market.
|
||
*/
|
||
getOrders(): StockOrder;
|
||
|
||
/**
|
||
* Returns the volatility of the specified stock.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB
|
||
* Volatility represents the maximum percentage by which a stock’s price can change every tick.
|
||
* The volatility is returned as a decimal value, NOT a percentage
|
||
* (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).
|
||
*
|
||
* In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @returns Volatility of the specified stock.
|
||
*/
|
||
getVolatility(sym: string): number;
|
||
|
||
/**
|
||
* Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next
|
||
* tick.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB
|
||
* The probability is returned as a decimal value, NOT a percentage
|
||
* (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).
|
||
*
|
||
* In other words, if this function returned 0.30 for a stock, then this means that the stock’s price has a
|
||
* 30% chance of increasing and a 70% chance of decreasing during the next tick.
|
||
*
|
||
* In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.
|
||
*
|
||
* @param sym - Stock symbol.
|
||
* @returns Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick.
|
||
*/
|
||
getForecast(sym: string): number;
|
||
|
||
/**
|
||
* Purchase 4S Market Data Access.
|
||
* @remarks RAM cost: 2.5 GB
|
||
* @returns True if you successfully purchased it or if you already have access, false otherwise.
|
||
*/
|
||
purchase4SMarketData(): boolean;
|
||
|
||
/**
|
||
* Purchase 4S Market Data TIX API Access.
|
||
* @remarks RAM cost: 2.5 GB
|
||
* @returns True if you successfully purchased it or if you already have access, false otherwise.
|
||
*/
|
||
purchase4SMarketDataTixApi(): boolean;
|
||
|
||
/**
|
||
* Purchase WSE Account.
|
||
* @remarks RAM cost: 2.5 GB
|
||
* @returns True if you successfully purchased it or if you already have access, false otherwise.
|
||
*/
|
||
purchaseWseAccount(): boolean;
|
||
|
||
/**
|
||
* Purchase TIX API Access
|
||
* @remarks RAM cost: 2.5 GB
|
||
* @returns True if you successfully purchased it or if you already have access, false otherwise.
|
||
*/
|
||
purchaseTixApi(): boolean;
|
||
}
|
||
|
||
/**
|
||
* Singularity API
|
||
* @remarks
|
||
* This API requires Source-File 4 to use. The RAM cost of all these functions is multiplied by 16/4/1 based on
|
||
* Source-File 4 levels.
|
||
* @public
|
||
*/
|
||
export interface Singularity {
|
||
/**
|
||
* Backup game save.
|
||
* @remarks
|
||
* RAM cost: 1 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will automatically opens the backup save prompt and claim the free faction favour if available.
|
||
*
|
||
*/
|
||
exportGame(): void;
|
||
|
||
/**
|
||
* Returns Backup save bonus availability.
|
||
* @remarks
|
||
* RAM cost: 0.5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will check if there is a bonus for backing up your save.
|
||
*
|
||
*/
|
||
exportGameBonus(): boolean;
|
||
|
||
/**
|
||
* Take university class.
|
||
*
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will automatically set you to start taking a course at a university.
|
||
* If you are already in the middle of some “working” action (such as working at a
|
||
* company, for a faction, or on a program), then running this function will automatically
|
||
* cancel that action and give you your earnings.
|
||
*
|
||
* The cost and experience gains for all of these universities and classes are the same as
|
||
* if you were to manually visit and take these classes.
|
||
*
|
||
* @param universityName - Name of university. You must be in the correct city for whatever university you specify.
|
||
* @param courseName - Name of course.
|
||
* @param focus - Acquire player focus on this class. Optional. Defaults to true.
|
||
* @returns True if action is successfully started, false otherwise.
|
||
*/
|
||
universityCourse(universityName: string, courseName: string, focus?: boolean): boolean;
|
||
|
||
/**
|
||
* Workout at the gym.
|
||
*
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
|
||
* This function will automatically set you to start working out at a gym to train
|
||
* a particular stat. If you are already in the middle of some “working” action
|
||
* (such as working at a company, for a faction, or on a program), then running
|
||
* this function will automatically cancel that action and give you your earnings.
|
||
*
|
||
* The cost and experience gains for all of these gyms are the same as if you were
|
||
* to manually visit these gyms and train
|
||
*
|
||
* @param gymName - Name of gym. You must be in the correct city for whatever gym you specify.
|
||
* @param stat - The stat you want to train.
|
||
* @param focus - Acquire player focus on this gym workout. Optional. Defaults to true.
|
||
* @returns True if actions is successfully started, false otherwise.
|
||
*/
|
||
gymWorkout(gymName: string, stat: string, focus?: boolean): boolean;
|
||
|
||
/**
|
||
* Travel to another city.
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function allows the player to travel to any city. The cost for using this
|
||
* function is the same as the cost for traveling through the Travel Agency.
|
||
*
|
||
* @param city - City to travel to.
|
||
* @returns True if action is successful, false otherwise.
|
||
*/
|
||
travelToCity(city: CityName | `${CityName}`): boolean;
|
||
|
||
/**
|
||
* Purchase the TOR router.
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function allows you to automatically purchase a TOR router. The cost for
|
||
* purchasing a TOR router using this function is the same as if you were to
|
||
* manually purchase one.
|
||
*
|
||
* @returns True if actions is successful or you already own TOR router, false otherwise.
|
||
*/
|
||
purchaseTor(): boolean;
|
||
|
||
/**
|
||
* Purchase a program from the dark web.
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function allows you to automatically purchase programs. You MUST have a
|
||
* TOR router in order to use this function. The cost of purchasing programs
|
||
* using this function is the same as if you were purchasing them through the Dark
|
||
* Web using the Terminal buy command.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const programName = "BruteSSH.exe"
|
||
* const success = ns.purchaseProgram(programName);
|
||
* if (!success) ns.tprint("ERROR: Failed to purchase ${programName}")
|
||
* ```
|
||
* @param programName - Name of program to purchase.
|
||
* @returns True if the specified program is purchased, and false otherwise.
|
||
*/
|
||
purchaseProgram(programName: string): boolean;
|
||
|
||
/**
|
||
* Check if the player is busy.
|
||
* @remarks
|
||
* RAM cost: 0.5 GB * 16/4/1
|
||
*
|
||
*
|
||
* Returns a boolean indicating whether or not the player is currently performing an
|
||
* ‘action’. These actions include working for a company/faction, studying at a university,
|
||
* working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission.
|
||
*
|
||
* @returns True if the player is currently performing an ‘action’, false otherwise.
|
||
*/
|
||
isBusy(): boolean;
|
||
|
||
/**
|
||
* Stop the current action.
|
||
* @remarks
|
||
* RAM cost: 1 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function is used to end whatever ‘action’ the player is currently performing.
|
||
* The player will receive whatever money/experience/etc. he has earned from that action.
|
||
*
|
||
* The actions that can be stopped with this function are:
|
||
*
|
||
* * Studying at a university
|
||
* * Working out at a gym
|
||
* * Working for a company/faction
|
||
* * Creating a program
|
||
* * Committing a crime
|
||
*
|
||
* This function will return true if the player’s action was ended.
|
||
* It will return false if the player was not performing an action when this function was called.
|
||
*
|
||
* @returns True if the player’s action was ended, false if the player was not performing an action.
|
||
*/
|
||
stopAction(): boolean;
|
||
|
||
/**
|
||
* Upgrade home computer RAM.
|
||
* @remarks
|
||
* RAM cost: 3 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will upgrade amount of RAM on the player’s home computer. The cost is
|
||
* the same as if you were to do it manually.
|
||
*
|
||
* This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise.
|
||
*
|
||
* @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise.
|
||
*/
|
||
upgradeHomeRam(): boolean;
|
||
|
||
/**
|
||
* Upgrade home computer cores.
|
||
* @remarks
|
||
* RAM cost: 3 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will upgrade amount of cores on the player’s home computer. The cost is
|
||
* the same as if you were to do it manually.
|
||
*
|
||
* This function will return true if the player’s home computer cores is successfully upgraded, and false otherwise.
|
||
*
|
||
* @returns True if the player’s home computer cores is successfully upgraded, and false otherwise.
|
||
*/
|
||
upgradeHomeCores(): boolean;
|
||
|
||
/**
|
||
* Get the price of upgrading home RAM.
|
||
* @remarks
|
||
* RAM cost: 1.5 GB * 16/4/1
|
||
*
|
||
*
|
||
* Returns the cost of upgrading the player’s home computer RAM.
|
||
*
|
||
* @returns Cost of upgrading the player’s home computer RAM.
|
||
*/
|
||
getUpgradeHomeRamCost(): number;
|
||
|
||
/**
|
||
* Get the price of upgrading home cores.
|
||
* @remarks
|
||
* RAM cost: 1.5 GB * 16/4/1
|
||
*
|
||
*
|
||
* Returns the cost of upgrading the player’s home computer cores.
|
||
*
|
||
* @returns Cost of upgrading the player’s home computer cores.
|
||
*/
|
||
getUpgradeHomeCoresCost(): number;
|
||
|
||
/**
|
||
* Get Requirements for Company Position.
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will return an object that contains the requirements for
|
||
* a specific position at a specific country.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const companyName = "ECorp";
|
||
* const position = "Chief Executive Officer";
|
||
*
|
||
* let requirements = ns.singularity.getCompanyPositionInfo(companyName, position);
|
||
* ```
|
||
* @param companyName - Name of company to get the requirements for. Must be an exact match.
|
||
* @param positionName - Name of position to get the requirements for. Must be an exact match.
|
||
* @returns CompanyPositionInfo object.
|
||
*/
|
||
getCompanyPositionInfo(
|
||
companyName: CompanyName | `${CompanyName}`,
|
||
positionName: JobName | `${JobName}`,
|
||
): CompanyPositionInfo;
|
||
|
||
/**
|
||
* Get List of Company Positions.
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will return a list of positions at a specific company.
|
||
*
|
||
* This function will return the position list if the company name is valid.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const companyName = "Noodle Bar";
|
||
* const jobList = ns.singularity.getCompanyPositions(companyName);
|
||
* ```
|
||
* @param companyName - Name of company to get the position list for. Must be an exact match.
|
||
* @returns The position list if the company name is valid.
|
||
*/
|
||
getCompanyPositions(companyName: CompanyName | `${CompanyName}`): JobName[];
|
||
|
||
/**
|
||
* Work for a company.
|
||
* @remarks
|
||
* RAM cost: 3 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will set you to start working at your current job at a specified company at which you are employed.
|
||
* If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or
|
||
* creating a program), then running this function will cancel that action.
|
||
*
|
||
* This function will return true if the player starts working, and false otherwise.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const companyName = "Noodle Bar";
|
||
* const success = ns.singularity.workForCompany(companyName);
|
||
* if (!success) ns.tprint(`ERROR: Failed to start work at ${companyName}.`);
|
||
* ```
|
||
* @param companyName - Name of company to work for. Must be an exact match. Optional. If not specified, this
|
||
* argument defaults to the last job that you worked.
|
||
* @param focus - Acquire player focus on this work operation. Optional. Defaults to true.
|
||
* @returns True if the player starts working, and false otherwise.
|
||
*/
|
||
workForCompany(companyName: CompanyName, focus?: boolean): boolean;
|
||
|
||
/**
|
||
* Quit jobs by company.
|
||
* @remarks
|
||
* RAM cost: 3 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will finish work with the company provided and quit any jobs.
|
||
*
|
||
* @param companyName - Name of the company.
|
||
*/
|
||
quitJob(companyName?: CompanyName | `${CompanyName}`): void;
|
||
|
||
/**
|
||
* Apply for a job at a company.
|
||
* @remarks
|
||
* RAM cost: 3 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will automatically try to apply to the specified company
|
||
* for a position in the specified field. This function can also be used to
|
||
* apply for promotions by specifying the company and field you are already
|
||
* employed at.
|
||
*
|
||
* This function will return true if you successfully get a job/promotion,
|
||
* and false otherwise. Note that if you are trying to use this function to
|
||
* apply for a promotion and you don’t get one, it will return false.
|
||
*
|
||
* @param companyName - Name of company to apply to.
|
||
* @param field - Field to which you want to apply.
|
||
* @returns True if the player successfully get a job/promotion, and false otherwise.
|
||
*/
|
||
applyToCompany(companyName: CompanyName | `${CompanyName}`, field: string): boolean;
|
||
|
||
/**
|
||
* Get company reputation.
|
||
* @remarks
|
||
* RAM cost: 1 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will return the amount of reputation you have at the specified company.
|
||
* If the company passed in as an argument is invalid, -1 will be returned.
|
||
*
|
||
* @param companyName - Name of the company.
|
||
* @returns Amount of reputation you have at the specified company.
|
||
*/
|
||
getCompanyRep(companyName: CompanyName | `${CompanyName}`): number;
|
||
|
||
/**
|
||
* Get company favor.
|
||
* @remarks
|
||
* RAM cost: 1 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will return the amount of favor you have at the specified company.
|
||
* If the company passed in as an argument is invalid, -1 will be returned.
|
||
*
|
||
* @param companyName - Name of the company.
|
||
* @returns Amount of favor you have at the specified company.
|
||
*/
|
||
getCompanyFavor(companyName: CompanyName | `${CompanyName}`): number;
|
||
|
||
/**
|
||
* Get company favor gain.
|
||
* @remarks
|
||
* RAM cost: 0.75 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will return the amount of favor you will gain for the specified
|
||
* company when you reset by installing Augmentations.
|
||
*
|
||
* @param companyName - Name of the company.
|
||
* @returns Amount of favor you gain at the specified company when you reset by installing Augmentations.
|
||
*/
|
||
getCompanyFavorGain(companyName: CompanyName | `${CompanyName}`): number;
|
||
|
||
/**
|
||
* List all current faction invitations.
|
||
* @remarks
|
||
* RAM cost: 3 GB * 16/4/1
|
||
*
|
||
*
|
||
* Performs an immediate check for which factions you qualify for invites from, then returns an array with the name
|
||
* of all Factions you have outstanding invitations from.
|
||
*
|
||
* @returns Array with the name of all Factions you currently have outstanding invitations from.
|
||
*/
|
||
checkFactionInvitations(): string[];
|
||
|
||
/**
|
||
* Join a faction.
|
||
* @remarks
|
||
* RAM cost: 3 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will automatically accept an invitation from a faction and join it.
|
||
*
|
||
* @param faction - Name of faction to join.
|
||
* @returns True if player joined the faction, and false otherwise.
|
||
*/
|
||
joinFaction(faction: string): boolean;
|
||
|
||
/**
|
||
* Work for a faction.
|
||
* @remarks
|
||
* RAM cost: 3 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will set you to start working for the specified faction. You must be a member of the faction and
|
||
* that faction must have the specified work type, or else this function will fail. If you are already in the
|
||
* middle of some “working” action (such as working for a company, training at a gym, or creating a program), then
|
||
* running this function will cancel that action.
|
||
*
|
||
* This function will return true if you successfully start working for the specified faction, and false otherwise.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const factionName = "CyberSec";
|
||
* const workType = "hacking";
|
||
*
|
||
* let success = ns.singularity.workForFaction(factionName, workType);
|
||
* if (!success) ns.tprint(`ERROR: Failed to start work for ${factionName} with work type ${workType}.`)
|
||
* ```
|
||
* @param faction - Name of faction to work for.
|
||
* @param workType - Type of work to perform for the faction.
|
||
* @param focus - Acquire player focus on this work operation. Optional. Defaults to true.
|
||
* @returns True if the player starts working, and false otherwise.
|
||
*/
|
||
workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}`, focus?: boolean): boolean;
|
||
|
||
/**
|
||
* Get faction reputation.
|
||
* @remarks
|
||
* RAM cost: 1 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function returns the amount of reputation you have for the specified faction.
|
||
*
|
||
* @param faction - Name of faction to work for.
|
||
* @returns Amount of reputation you have for the specified faction.
|
||
*/
|
||
getFactionRep(faction: string): number;
|
||
|
||
/**
|
||
* Get faction favor.
|
||
* @remarks
|
||
* RAM cost: 1 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function returns the amount of favor you have for the specified faction.
|
||
*
|
||
* @param faction - Name of faction.
|
||
* @returns Amount of favor you have for the specified faction.
|
||
*/
|
||
getFactionFavor(faction: string): number;
|
||
|
||
/**
|
||
* Get faction favor gain.
|
||
* @remarks
|
||
* RAM cost: 0.75 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function returns the amount of favor you will gain for the specified
|
||
* faction when you reset by installing Augmentations.
|
||
*
|
||
* @param faction - Name of faction.
|
||
* @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations.
|
||
*/
|
||
getFactionFavorGain(faction: string): number;
|
||
|
||
/**
|
||
* Donate to a faction.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* Attempts to donate money to the specified faction in exchange for reputation.
|
||
* Returns true if you successfully donate the money, and false otherwise.
|
||
*
|
||
* @param faction - Name of faction to donate to.
|
||
* @param amount - Amount of money to donate.
|
||
* @returns True if the money was donated, and false otherwise.
|
||
*/
|
||
donateToFaction(faction: string, amount: number): boolean;
|
||
|
||
/**
|
||
* Create a program.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will automatically set you to start working on creating the
|
||
* specified program. If you are already in the middle of some “working” action
|
||
* (such as working for a company, training at a gym, or taking a course), then
|
||
* running this function will automatically cancel that action and give you your
|
||
* earnings.
|
||
*
|
||
* This function returns true if you successfully start working on the specified program, and false otherwise.
|
||
*
|
||
* Note that creating a program using this function has the same hacking level requirements as it normally would.
|
||
* These level requirements are:
|
||
* * BruteSSH.exe: 50
|
||
* * FTPCrack.exe: 100
|
||
* * relaySMTP.exe: 250
|
||
* * HTTPWorm.exe: 500
|
||
* * SQLInject.exe: 750
|
||
* * DeepscanV1.exe: 75
|
||
* * DeepscanV2.exe: 400
|
||
* * ServerProfiler.exe: 75
|
||
* * AutoLink.exe: 25
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const programName = "BruteSSH.exe";
|
||
* const success = ns.createProgram(programName);
|
||
* if (!success) ns.tprint("ERROR: Failed to start working on ${programName}")
|
||
* ```
|
||
* @param program - Name of program to create.
|
||
* @param focus - Acquire player focus on this program creation. Optional. Defaults to true.
|
||
* @returns True if you successfully start working on the specified program, and false otherwise.
|
||
*/
|
||
createProgram(program: string, focus?: boolean): boolean;
|
||
|
||
/**
|
||
* Commit a crime.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function is used to automatically attempt to commit crimes.
|
||
* If you are already in the middle of some ‘working’ action (such
|
||
* as working for a company or training at a gym), then running this
|
||
* function will automatically cancel that action and give you your
|
||
* earnings.
|
||
*
|
||
* This function returns the number of milliseconds it takes to attempt the
|
||
* specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime,
|
||
* so running `commitCrime('Rob Store')` will return 60,000).
|
||
*
|
||
* @param crime - Name of crime to attempt.
|
||
* @param focus - Acquire player focus on this crime. Optional. Defaults to true.
|
||
* @returns The number of milliseconds it takes to attempt the specified crime.
|
||
*/
|
||
commitCrime(crime: CrimeType | `${CrimeType}`, focus?: boolean): number;
|
||
|
||
/**
|
||
* Get chance to successfully commit a crime.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function returns your chance of success at committing the specified crime.
|
||
*
|
||
* @param crime - Name of crime.
|
||
* @returns Chance of success at committing the specified crime.
|
||
*/
|
||
getCrimeChance(crime: CrimeType | `${CrimeType}`): number;
|
||
|
||
/**
|
||
* Get stats related to a crime.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* Returns the stats of the crime.
|
||
*
|
||
* @param crime - Name of crime.
|
||
* @returns The stats of the crime.
|
||
*/
|
||
getCrimeStats(crime: CrimeType | `${CrimeType}`): CrimeStats;
|
||
|
||
/**
|
||
* Get a list of owned augmentation.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function returns an array containing the names (as strings) of all Augmentations you have.
|
||
*
|
||
* @param purchased - Specifies whether the returned array should include Augmentations you have purchased but not
|
||
* yet installed. By default, this argument is false which means that the return value will NOT have the purchased
|
||
* Augmentations.
|
||
* @returns Array containing the names (as strings) of all Augmentations you have.
|
||
*/
|
||
getOwnedAugmentations(purchased?: boolean): string[];
|
||
|
||
/**
|
||
* Get a list of acquired Source-Files.
|
||
* @remarks
|
||
* RAM cost: 5 GB
|
||
*
|
||
*
|
||
* Returns an array of source files
|
||
*
|
||
* @returns Array containing an object with number and level of the source file.
|
||
*/
|
||
getOwnedSourceFiles(): SourceFileLvl[];
|
||
|
||
/**
|
||
* Get a list of faction(s) that have a specific Augmentation.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* Returns an array containing the names (as strings) of all factions
|
||
* that offer the specified Augmentation.
|
||
* If no factions offer the Augmentation, a blank array is returned.
|
||
*
|
||
* @param augName - Name of Augmentation.
|
||
* @returns Array containing the names of all factions.
|
||
*/
|
||
getAugmentationFactions(augName: string): string[];
|
||
|
||
/**
|
||
* Get a list of augmentation available from a faction.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* Returns an array containing the names (as strings) of all Augmentations
|
||
* that are available from the specified faction.
|
||
*
|
||
* @param faction - Name of faction.
|
||
* @returns Array containing the names of all Augmentations.
|
||
*/
|
||
getAugmentationsFromFaction(faction: string): string[];
|
||
|
||
/**
|
||
* Get the pre-requisite of an augmentation.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation.
|
||
* If there are no prerequisites, a blank array is returned.
|
||
*
|
||
* @param augName - Name of Augmentation.
|
||
* @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation.
|
||
*/
|
||
getAugmentationPrereq(augName: string): string[];
|
||
|
||
/**
|
||
* Get price of an augmentation.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB * 16/4/1
|
||
*
|
||
*
|
||
* @param augName - Name of Augmentation.
|
||
* @returns Price of the augmentation.
|
||
*/
|
||
getAugmentationPrice(augName: string): number;
|
||
|
||
/**
|
||
* Get base price of an augmentation.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB * 16/4/1
|
||
*
|
||
*
|
||
* @param augName - Name of Augmentation.
|
||
* @returns Base price of the augmentation, before price multiplier.
|
||
*/
|
||
getAugmentationBasePrice(augName: string): number;
|
||
|
||
/**
|
||
* Get reputation requirement of an augmentation.
|
||
* @remarks
|
||
* RAM cost: 2.5 GB * 16/4/1
|
||
*
|
||
*
|
||
* @param augName - Name of Augmentation.
|
||
* @returns Reputation requirement of the augmentation.
|
||
*/
|
||
getAugmentationRepReq(augName: string): number;
|
||
|
||
/**
|
||
* Purchase an augmentation
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will try to purchase the specified Augmentation through the given Faction.
|
||
*
|
||
* This function will return true if the Augmentation is successfully purchased, and false otherwise.
|
||
*
|
||
* @param faction - Name of faction to purchase Augmentation from.
|
||
* @param augmentation - Name of Augmentation to purchase.
|
||
* @returns True if the Augmentation is successfully purchased, and false otherwise.
|
||
*/
|
||
purchaseAugmentation(faction: string, augmentation: string): boolean;
|
||
|
||
/**
|
||
* Get the stats of an augmentation.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function returns augmentation stats.
|
||
*
|
||
* @param name - Name of Augmentation. CASE-SENSITIVE.
|
||
* @returns Augmentation stats.
|
||
*/
|
||
getAugmentationStats(name: string): Multipliers;
|
||
|
||
/**
|
||
* Install your purchased augmentations.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will automatically install your Augmentations, resetting the game as usual. If you do not own uninstalled Augmentations then the game will not reset.
|
||
*
|
||
* @param cbScript - This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer.
|
||
*/
|
||
installAugmentations(cbScript?: string): void;
|
||
|
||
/**
|
||
* Hospitalize the player.
|
||
* @remarks
|
||
* RAM cost: 0.25 GB * 16/4/1
|
||
*/
|
||
hospitalize(): void;
|
||
|
||
/**
|
||
* Soft reset the game.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function will perform a reset even if you don’t have any augmentation installed.
|
||
*
|
||
* @param cbScript - This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer.
|
||
*/
|
||
softReset(cbScript: string): void;
|
||
|
||
/**
|
||
* Go to a location.
|
||
* @remarks
|
||
* RAM cost: 5 GB * 16/4/1
|
||
*
|
||
*
|
||
* Move the player to a specific location.
|
||
*
|
||
* @param locationName - Name of the location.
|
||
* @returns True if the player was moved there, false otherwise.
|
||
*/
|
||
goToLocation(locationName: string): boolean;
|
||
|
||
/**
|
||
* Get the current server.
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
*
|
||
* @returns Name of the current server.
|
||
*/
|
||
getCurrentServer(): string;
|
||
|
||
/**
|
||
* Connect to a server.
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
*
|
||
* Run the connect HOSTNAME command in the terminal. Can only connect to neighbors.
|
||
*
|
||
* @returns True if the connect command was successful, false otherwise.
|
||
*/
|
||
connect(hostname: string): boolean;
|
||
|
||
/**
|
||
* Run the hack command in the terminal.
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
*
|
||
* @returns Amount of money stolen by manual hacking.
|
||
*/
|
||
manualHack(): Promise<number>;
|
||
|
||
/**
|
||
* Run the backdoor command in the terminal.
|
||
* @remarks
|
||
* RAM cost: 2 GB * 16/4/1
|
||
*
|
||
*
|
||
* @returns Promise waiting for the installation to finish.
|
||
*/
|
||
installBackdoor(): Promise<void>;
|
||
|
||
/**
|
||
* Check if the player is focused.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB * 16/4/1
|
||
*
|
||
*
|
||
* @returns True if the player is focused.
|
||
*/
|
||
isFocused(): boolean;
|
||
|
||
/**
|
||
* Set the players focus.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB * 16/4/1
|
||
*
|
||
* @returns True if the focus was changed.
|
||
*/
|
||
setFocus(focus: boolean): boolean;
|
||
|
||
/**
|
||
* Get a list of programs offered on the dark web.
|
||
* @remarks
|
||
* RAM cost: 1 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function allows the player to get a list of programs available for purchase
|
||
* on the dark web. Players MUST have purchased Tor to get the list of programs
|
||
* available. If Tor has not been purchased yet, this function will return an
|
||
* empty list.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const programs = ns.getDarkwebPrograms();
|
||
* ns.tprint(`Available programs are: ${programs.split(", ")}`);
|
||
* ```
|
||
* @returns - a list of programs available for purchase on the dark web, or [] if Tor has not
|
||
* been purchased
|
||
*/
|
||
getDarkwebPrograms(): string[];
|
||
|
||
/**
|
||
* Check the price of an exploit on the dark web
|
||
* @remarks
|
||
* RAM cost: 0.5 GB * 16/4/1
|
||
*
|
||
*
|
||
* This function allows you to check the price of a darkweb exploit/program.
|
||
* You MUST have a TOR router in order to use this function. The price returned
|
||
* by this function is the same price you would see with buy -l from the terminal.
|
||
* Returns the cost of the program if it has not been purchased yet, 0 if it
|
||
* has already been purchased, or -1 if Tor has not been purchased (and thus
|
||
* the program/exploit is not available for purchase).
|
||
*
|
||
* If the program does not exist, an error is thrown.
|
||
*
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const programName = "BruteSSH.exe";
|
||
* const cost = ns.getDarkwebProgramCost(programName);
|
||
* if (cost > 0) ns.tprint(`${programName} costs ${ns.formatMoney(cost)}`);
|
||
* ```
|
||
* @param programName - Name of program to check the price of
|
||
* @returns Price of the specified darkweb program
|
||
* (if not yet purchased), 0 if it has already been purchased, or -1 if Tor has not been
|
||
* purchased. Throws an error if the specified program/exploit does not exist
|
||
*/
|
||
getDarkwebProgramCost(programName: string): number;
|
||
|
||
/**
|
||
* b1t_flum3 into a different BN.
|
||
* @remarks
|
||
* RAM cost: 16 GB * 16/4/1
|
||
*
|
||
* @param nextBN - BN number to jump to
|
||
* @param callbackScript - Name of the script to launch in the next BN.
|
||
*/
|
||
b1tflum3(nextBN: number, callbackScript?: string): void;
|
||
|
||
/**
|
||
* Destroy the w0r1d_d43m0n and move on to the next BN.
|
||
* @remarks
|
||
* RAM cost: 32 GB * 16/4/1
|
||
*
|
||
* You must have the special augment installed and the required hacking level
|
||
* OR
|
||
* Completed the final black op.
|
||
*
|
||
* @param nextBN - BN number to jump to
|
||
* @param callbackScript - Name of the script to launch in the next BN.
|
||
*/
|
||
destroyW0r1dD43m0n(nextBN: number, callbackScript?: string): void;
|
||
|
||
/**
|
||
* Get the current work the player is doing.
|
||
* @remarks
|
||
* RAM cost: 0.5 GB * 16/4/1
|
||
*
|
||
* @returns - An object representing the current work. Fields depend on the kind of work.
|
||
*/
|
||
getCurrentWork(): any | null;
|
||
}
|
||
|
||
/**
|
||
* Company position requirements and salary.
|
||
* @public
|
||
* @returns - An object representing the requirements and salary for a company/position combination.
|
||
*/
|
||
export interface CompanyPositionInfo {
|
||
name: JobName;
|
||
nextPosition: JobName | null;
|
||
salary: number;
|
||
requiredReputation: number;
|
||
requiredSkills: Skills;
|
||
}
|
||
|
||
/**
|
||
* Hacknet API
|
||
* @remarks
|
||
* Not all these functions are immediately available.
|
||
* @public
|
||
*/
|
||
export interface Hacknet {
|
||
/**
|
||
* Get the number of hacknet nodes you own.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Returns the number of Hacknet Nodes you own.
|
||
*
|
||
* @returns Number of hacknet nodes.
|
||
*/
|
||
numNodes(): number;
|
||
|
||
/**
|
||
* Get the maximum number of hacknet nodes.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @returns Maximum number of hacknet nodes.
|
||
*/
|
||
maxNumNodes(): number;
|
||
|
||
/**
|
||
* Purchase a new hacknet node.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Purchases a new Hacknet Node. Returns a number with the index of the
|
||
* Hacknet Node. This index is equivalent to the number at the end of
|
||
* the Hacknet Node’s name (e.g The Hacknet Node named `hacknet-node-4`
|
||
* will have an index of 4).
|
||
*
|
||
* If the player cannot afford to purchase a new Hacknet Node then the function will return -1.
|
||
*
|
||
* @returns The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1.
|
||
*/
|
||
purchaseNode(): number;
|
||
|
||
/**
|
||
* Get the price of the next hacknet node.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Returns the cost of purchasing a new Hacknet Node.
|
||
*
|
||
* @returns Cost of purchasing a new Hacknet Node.
|
||
*/
|
||
getPurchaseNodeCost(): number;
|
||
|
||
/**
|
||
* Get the stats of a hacknet node.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Returns an object containing a variety of stats about the specified Hacknet Node.
|
||
*
|
||
* Note that for Hacknet Nodes, production refers to the amount of money the node generates.
|
||
* For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the
|
||
* amount of hashes the node generates.
|
||
*
|
||
* @param index - Index/Identifier of Hacknet Node
|
||
* @returns Object containing a variety of stats about the specified Hacknet Node.
|
||
*/
|
||
getNodeStats(index: number): NodeStats;
|
||
|
||
/**
|
||
* Upgrade the level of a hacknet node.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Tries to upgrade the level of the specified Hacknet Node by n.
|
||
*
|
||
* Returns true if the Hacknet Node’s level is successfully upgraded by n
|
||
* or if it is upgraded by some positive amount and the Node reaches its max level.
|
||
*
|
||
* Returns false otherwise.
|
||
*
|
||
* @param index - Index/Identifier of Hacknet Node.
|
||
* @param n - Number of levels to purchase. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified.
|
||
* @returns True if the Hacknet Node’s level is successfully upgraded, false otherwise.
|
||
*/
|
||
upgradeLevel(index: number, n?: number): boolean;
|
||
|
||
/**
|
||
* Upgrade the RAM of a hacknet node.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Tries to upgrade the specified Hacknet Node’s RAM n times.
|
||
* Note that each upgrade doubles the Node’s RAM.
|
||
* So this is equivalent to multiplying the Node’s RAM by 2 n.
|
||
*
|
||
* Returns true if the Hacknet Node’s RAM is successfully upgraded n times
|
||
* or if it is upgraded some positive number of times and the Node reaches its max RAM.
|
||
*
|
||
* Returns false otherwise.
|
||
*
|
||
* @param index - Index/Identifier of Hacknet Node.
|
||
* @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified.
|
||
* @returns True if the Hacknet Node’s RAM is successfully upgraded, false otherwise.
|
||
*/
|
||
upgradeRam(index: number, n?: number): boolean;
|
||
|
||
/**
|
||
* Upgrade the core of a hacknet node.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Tries to purchase n cores for the specified Hacknet Node.
|
||
*
|
||
* Returns true if it successfully purchases n cores for the Hacknet Node
|
||
* or if it purchases some positive amount and the Node reaches its max number of cores.
|
||
*
|
||
* Returns false otherwise.
|
||
*
|
||
* @param index - Index/Identifier of Hacknet Node.
|
||
* @param n - Number of cores to purchase. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified.
|
||
* @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise.
|
||
*/
|
||
upgradeCore(index: number, n?: number): boolean;
|
||
|
||
/**
|
||
* Upgrade the cache of a hacknet node.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).
|
||
*
|
||
* Tries to upgrade the specified Hacknet Server’s cache n times.
|
||
*
|
||
* Returns true if it successfully upgrades the Server’s cache n times,
|
||
* or if it purchases some positive amount and the Server reaches its max cache level.
|
||
*
|
||
* Returns false otherwise.
|
||
*
|
||
* @param index - Index/Identifier of Hacknet Node.
|
||
* @param n - Number of cache levels to purchase. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified.
|
||
* @returns True if the Hacknet Node’s cache level is successfully upgraded, false otherwise.
|
||
*/
|
||
upgradeCache(index: number, n?: number): boolean;
|
||
|
||
/**
|
||
* Calculate the cost of upgrading hacknet node levels.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Returns the cost of upgrading the specified Hacknet Node by n levels.
|
||
*
|
||
* If an invalid value for n is provided, then this function returns 0.
|
||
* If the specified Hacknet Node is already at max level, then Infinity is returned.
|
||
*
|
||
* @param index - Index/Identifier of Hacknet Node.
|
||
* @param n - Number of levels to upgrade. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified.
|
||
* @returns Cost of upgrading the specified Hacknet Node.
|
||
*/
|
||
getLevelUpgradeCost(index: number, n?: number): number;
|
||
|
||
/**
|
||
* Calculate the cost of upgrading hacknet node RAM.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Returns the cost of upgrading the RAM of the specified Hacknet Node n times.
|
||
*
|
||
* If an invalid value for n is provided, then this function returns 0.
|
||
* If the specified Hacknet Node already has max RAM, then Infinity is returned.
|
||
*
|
||
* @param index - Index/Identifier of Hacknet Node.
|
||
* @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified.
|
||
* @returns Cost of upgrading the specified Hacknet Node's RAM.
|
||
*/
|
||
getRamUpgradeCost(index: number, n?: number): number;
|
||
|
||
/**
|
||
* Calculate the cost of upgrading hacknet node cores.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Returns the cost of upgrading the number of cores of the specified Hacknet Node by n.
|
||
*
|
||
* If an invalid value for n is provided, then this function returns 0.
|
||
* If the specified Hacknet Node is already at max level, then Infinity is returned.
|
||
*
|
||
* @param index - Index/Identifier of Hacknet Node.
|
||
* @param n - Number of times to upgrade cores. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified.
|
||
* @returns Cost of upgrading the specified Hacknet Node's number of cores.
|
||
*/
|
||
getCoreUpgradeCost(index: number, n?: number): number;
|
||
|
||
/**
|
||
* Calculate the cost of upgrading hacknet node cache.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).
|
||
*
|
||
* Returns the cost of upgrading the cache level of the specified Hacknet Server by n.
|
||
*
|
||
* If an invalid value for n is provided, then this function returns 0.
|
||
* If the specified Hacknet Node is already at max level, then Infinity is returned.
|
||
*
|
||
* @param index - Index/Identifier of Hacknet Node.
|
||
* @param n - Number of times to upgrade cache. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified.
|
||
* @returns Cost of upgrading the specified Hacknet Node's cache.
|
||
*/
|
||
getCacheUpgradeCost(index: number, n?: number): number;
|
||
|
||
/**
|
||
* Get the total number of hashes stored.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).
|
||
*
|
||
* Returns the number of hashes you have.
|
||
*
|
||
* @returns Number of hashes you have.
|
||
*/
|
||
numHashes(): number;
|
||
|
||
/**
|
||
* Get the maximum number of hashes you can store.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).
|
||
*
|
||
* Returns the number of hashes you can store.
|
||
*
|
||
* @returns Number of hashes you can store.
|
||
*/
|
||
hashCapacity(): number;
|
||
|
||
/**
|
||
* Get the cost of a hash upgrade.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).
|
||
*
|
||
* Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const upgradeName = "Sell for Corporation Funds";
|
||
* if (ns.hacknet.numHashes() > ns.hacknet.hashCost(upgradeName)) {
|
||
* ns.hacknet.spendHashes(upgradeName);
|
||
* }
|
||
* ```
|
||
* @param upgName - Name of the upgrade of Hacknet Node.
|
||
* @param count - Number of upgrades to buy at once. Defaults to 1 if not specified.
|
||
* @returns Number of hashes required for the specified upgrade.
|
||
*/
|
||
hashCost(upgName: string, count?: number): number;
|
||
|
||
/**
|
||
* Purchase a hash upgrade.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).
|
||
*
|
||
* Spend the hashes generated by your Hacknet Servers on an upgrade.
|
||
* Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise.
|
||
*
|
||
* The name of the upgrade must be an exact match.
|
||
* The `upgTarget` argument is used for upgrades such as `Reduce Minimum Security`, which applies to a specific server.
|
||
* In this case, the `upgTarget` argument must be the hostname of the server.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* // For upgrades where no target is required
|
||
* ns.hacknet.spendHashes("Sell for Corporation Funds");
|
||
* // For upgrades requiring a target
|
||
* ns.hacknet.spendHashes("Increase Maximum Money", "foodnstuff");
|
||
* ```
|
||
* @param upgName - Name of the upgrade of Hacknet Node.
|
||
* @param upgTarget - Object to which upgrade applies. Required for certain upgrades.
|
||
* @param count - Number of upgrades to buy at once. Defaults to 1 if not specified.
|
||
* For compatibility reasons, upgTarget must be specified, even if it is not used, in order to specify count.
|
||
* @returns True if the upgrade is successfully purchased, and false otherwise.
|
||
*/
|
||
spendHashes(upgName: string, upgTarget?: string, count?: number): boolean;
|
||
|
||
/**
|
||
* Get the list of hash upgrades
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).
|
||
*
|
||
* Returns the list of all available hash upgrades that can be used in the spendHashes function.
|
||
* @example
|
||
* ```js
|
||
* const upgrades = ns.hacknet.getHashUpgrades(); // ["Sell for Money","Sell for Corporation Funds",...]
|
||
* ```
|
||
* @returns An array containing the available upgrades
|
||
*/
|
||
getHashUpgrades(): string[];
|
||
|
||
/**
|
||
* Get the level of a hash upgrade.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).
|
||
*
|
||
* @returns Level of the upgrade.
|
||
*/
|
||
getHashUpgradeLevel(upgName: string): number;
|
||
|
||
/**
|
||
* Get the multiplier to study.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).
|
||
*
|
||
* @returns Multiplier.
|
||
*/
|
||
getStudyMult(): number;
|
||
|
||
/**
|
||
* Get the multiplier to training.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).
|
||
*
|
||
* @returns Multiplier.
|
||
*/
|
||
getTrainingMult(): number;
|
||
}
|
||
|
||
/**
|
||
* Bladeburner API
|
||
* @remarks
|
||
* You have to be employed in the Bladeburner division and be in BitNode-7
|
||
* or have Source-File 7 in order to use this API.
|
||
* @public
|
||
*/
|
||
export interface Bladeburner {
|
||
/**
|
||
* List all contracts.
|
||
* @remarks
|
||
* RAM cost: 0.4 GB
|
||
*
|
||
* Returns an array of strings containing the names of all Bladeburner contracts.
|
||
*
|
||
* @returns Array of strings containing the names of all Bladeburner contracts.
|
||
*/
|
||
getContractNames(): string[];
|
||
|
||
/**
|
||
* List all operations.
|
||
* @remarks
|
||
* RAM cost: 0.4 GB
|
||
*
|
||
* Returns an array of strings containing the names of all Bladeburner operations.
|
||
*
|
||
* @returns Array of strings containing the names of all Bladeburner operations.
|
||
*/
|
||
getOperationNames(): string[];
|
||
|
||
/**
|
||
* List all black ops.
|
||
* @remarks
|
||
* RAM cost: 0.4 GB
|
||
*
|
||
* Returns an array of strings containing the names of all Bladeburner Black Ops.
|
||
*
|
||
* @returns Array of strings containing the names of all Bladeburner Black Ops.
|
||
*/
|
||
getBlackOpNames(): string[];
|
||
|
||
/**
|
||
* List all general actions.
|
||
* @remarks
|
||
* RAM cost: 0.4 GB
|
||
*
|
||
* Returns an array of strings containing the names of all general Bladeburner actions.
|
||
*
|
||
* @returns Array of strings containing the names of all general Bladeburner actions.
|
||
*/
|
||
getGeneralActionNames(): string[];
|
||
|
||
/**
|
||
* List all skills.
|
||
* @remarks
|
||
* RAM cost: 0.4 GB
|
||
*
|
||
* Returns an array of strings containing the names of all general Bladeburner skills.
|
||
*
|
||
* @returns Array of strings containing the names of all general Bladeburner skills.
|
||
*/
|
||
getSkillNames(): string[];
|
||
|
||
/**
|
||
* Start an action.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Attempts to start the specified Bladeburner action.
|
||
* Returns true if the action was started successfully, and false otherwise.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match
|
||
* @returns True if the action was started successfully, and false otherwise.
|
||
*/
|
||
startAction(type: string, name: string): boolean;
|
||
|
||
/**
|
||
* Stop current action.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Stops the current Bladeburner action.
|
||
*
|
||
*/
|
||
stopBladeburnerAction(): void;
|
||
|
||
/**
|
||
* Get current action.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Returns an object that represents the player’s current Bladeburner action.
|
||
* If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”.
|
||
*
|
||
* @returns Object that represents the player’s current Bladeburner action.
|
||
*/
|
||
getCurrentAction(): BladeburnerCurAction;
|
||
|
||
/**
|
||
* Get the time to complete an action.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the number of milliseconds it takes to complete the specified action
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @returns Number of milliseconds it takes to complete the specified action.
|
||
*/
|
||
getActionTime(type: string, name: string): number;
|
||
|
||
/**
|
||
* Get the time elapsed on current action.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the number of milliseconds already spent on the current action.
|
||
*
|
||
* @returns Number of milliseconds already spent on the current action.
|
||
*/
|
||
getActionCurrentTime(): number;
|
||
|
||
/**
|
||
* Get estimate success chance of an action.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the estimated success chance for the specified action.
|
||
* This chance is returned as a decimal value, NOT a percentage
|
||
* (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80).
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @returns Estimated success chance for the specified action.
|
||
*/
|
||
getActionEstimatedSuccessChance(type: string, name: string): [number, number];
|
||
|
||
/**
|
||
* Get the reputation gain of an action.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the average Bladeburner reputation gain for successfully
|
||
* completing the specified action.
|
||
* Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @param level - Optional action level at which to calculate the gain
|
||
* @returns Average Bladeburner reputation gain for successfully completing the specified action.
|
||
*/
|
||
getActionRepGain(type: string, name: string, level: number): number;
|
||
|
||
/**
|
||
* Get action count remaining.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the remaining count of the specified action.
|
||
*
|
||
* Note that this is meant to be used for Contracts and Operations.
|
||
* This function will return ‘Infinity’ for actions such as Training and Field Analysis.
|
||
* This function will return 1 for BlackOps not yet completed regardless of whether
|
||
* the player has the required rank to attempt the mission or not.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @returns Remaining count of the specified action.
|
||
*/
|
||
getActionCountRemaining(type: string, name: string): number;
|
||
|
||
/**
|
||
* Get the maximum level of an action.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the maximum level for this action.
|
||
*
|
||
* Returns -1 if an invalid action is specified.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @returns Maximum level of the specified action.
|
||
*/
|
||
getActionMaxLevel(type: string, name: string): number;
|
||
|
||
/**
|
||
* Get the current level of an action.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the current level of this action.
|
||
*
|
||
* Returns -1 if an invalid action is specified.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @returns Current level of the specified action.
|
||
*/
|
||
getActionCurrentLevel(type: string, name: string): number;
|
||
|
||
/**
|
||
* Get whether an action is set to autolevel.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a boolean indicating whether or not this action is currently set to autolevel.
|
||
*
|
||
* Returns false if an invalid action is specified.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @returns True if the action is set to autolevel, and false otherwise.
|
||
*/
|
||
getActionAutolevel(type: string, name: string): boolean;
|
||
|
||
/**
|
||
* Get action successes.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a number with how many successes you have with action.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @returns a number with how many successes you have with action.
|
||
*/
|
||
getActionSuccesses(type: string, name: string): number;
|
||
|
||
/**
|
||
* Set an action autolevel.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Enable/disable autoleveling for the specified action.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @param autoLevel - Whether or not to autolevel this action
|
||
*/
|
||
setActionAutolevel(type: string, name: string, autoLevel: boolean): void;
|
||
|
||
/**
|
||
* Set the level of an action.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Set the level for the specified action.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @param level - Level to set this action to.
|
||
*/
|
||
setActionLevel(type: string, name: string, level: number): void;
|
||
|
||
/**
|
||
* Get player bladeburner rank.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the player’s Bladeburner Rank.
|
||
*
|
||
* @returns Player’s Bladeburner Rank.
|
||
*/
|
||
getRank(): number;
|
||
|
||
/**
|
||
* Get black op required rank.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Returns the rank required to complete this BlackOp.
|
||
*
|
||
* Returns -1 if an invalid action is specified.
|
||
*
|
||
* @param name - Name of BlackOp. Must be an exact match.
|
||
* @returns Rank required to complete this BlackOp.
|
||
*/
|
||
getBlackOpRank(name: string): number;
|
||
|
||
/**
|
||
* Get bladeburner skill points.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the number of Bladeburner skill points you have.
|
||
*
|
||
* @returns Number of Bladeburner skill points you have.
|
||
*/
|
||
getSkillPoints(): number;
|
||
|
||
/**
|
||
* Get skill level.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* This function returns your level in the specified skill.
|
||
*
|
||
* The function returns -1 if an invalid skill name is passed in.
|
||
*
|
||
* @param skillName - Name of skill. Case-sensitive and must be an exact match
|
||
* @returns Level in the specified skill.
|
||
*/
|
||
getSkillLevel(name: string): number;
|
||
|
||
/**
|
||
* Get cost to upgrade skill.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* This function returns the number of skill points needed to upgrade the specified skill the specified number of times.
|
||
*
|
||
* The function returns -1 if an invalid skill name is passed in.
|
||
*
|
||
* @param skillName - Name of skill. Case-sensitive and must be an exact match
|
||
* @param count - Number of times to upgrade the skill. Defaults to 1 if not specified.
|
||
* @returns Number of skill points needed to upgrade the specified skill.
|
||
*/
|
||
getSkillUpgradeCost(name: string, count?: number): number;
|
||
|
||
/**
|
||
* Upgrade skill.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Attempts to upgrade the specified Bladeburner skill the specified number of times.
|
||
*
|
||
* Returns true if the skill is successfully upgraded, and false otherwise.
|
||
*
|
||
* @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match
|
||
* @param count - Number of times to upgrade the skill. Defaults to 1 if not specified.
|
||
* @returns true if the skill is successfully upgraded, and false otherwise.
|
||
*/
|
||
upgradeSkill(name: string, count?: number): boolean;
|
||
|
||
/**
|
||
* Get team size.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the number of Bladeburner team members you have assigned to the specified action.
|
||
*
|
||
* Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @returns Number of Bladeburner team members that were assigned to the specified action.
|
||
*/
|
||
getTeamSize(type: string, name: string): number;
|
||
|
||
/**
|
||
* Set team size.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Set the team size for the specified Bladeburner action.
|
||
*
|
||
* Returns the team size that was set, or -1 if the function failed.
|
||
*
|
||
* @param type - Type of action.
|
||
* @param name - Name of action. Must be an exact match.
|
||
* @param size - Number of team members to set. Will be converted using Math.round().
|
||
* @returns Number of Bladeburner team members you assigned to the specified action.
|
||
*/
|
||
setTeamSize(type: string, name: string, size: number): number;
|
||
|
||
/**
|
||
* Get estimated population in city.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the estimated number of Synthoids in the specified city,
|
||
* or -1 if an invalid city was specified.
|
||
*
|
||
* @param city - Name of city. Case-sensitive
|
||
* @returns Estimated number of Synthoids in the specified city.
|
||
*/
|
||
getCityEstimatedPopulation(city: CityName | `${CityName}`): number;
|
||
|
||
/**
|
||
* Get number of communities in a city.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the estimated number of Synthoid communities in the specified city,
|
||
* or -1 if an invalid city was specified.
|
||
*
|
||
* @param city - Name of city. Case-sensitive
|
||
* @returns Number of Synthoids communities in the specified city.
|
||
*/
|
||
getCityCommunities(city: CityName | `${CityName}`): number;
|
||
|
||
/**
|
||
* Get chaos of a city.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the chaos in the specified city,
|
||
* or -1 if an invalid city was specified.
|
||
*
|
||
* @param city - Name of city. Case-sensitive
|
||
* @returns Chaos in the specified city.
|
||
*/
|
||
getCityChaos(city: CityName | `${CityName}`): number;
|
||
|
||
/**
|
||
* Get current city.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the city that the player is currently in (for Bladeburner).
|
||
*
|
||
* @returns City that the player is currently in (for Bladeburner).
|
||
*/
|
||
getCity(): CityName;
|
||
|
||
/**
|
||
* Travel to another city in bladeburner.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
* Attempts to switch to the specified city (for Bladeburner only).
|
||
*
|
||
* Returns true if successful, and false otherwise
|
||
*
|
||
* @param city - Name of city. Case-sensitive
|
||
* @returns true if successful, and false otherwise
|
||
*/
|
||
switchCity(city: CityName | `${CityName}`): boolean;
|
||
|
||
/**
|
||
* Get bladeburner stamina.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
* Returns an array with two elements:
|
||
* * [Current stamina, Max stamina]
|
||
* @example
|
||
* ```js
|
||
* function getStaminaPercentage() {
|
||
* const [current, max] = ns.bladeburner.getStamina();
|
||
* return current / max;
|
||
* }
|
||
* ```
|
||
* @returns Array containing current stamina and max stamina.
|
||
*/
|
||
getStamina(): [number, number];
|
||
|
||
/**
|
||
* Join the bladeburner faction.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
* Attempts to join the Bladeburner faction.
|
||
*
|
||
* Returns true if you successfully join the Bladeburner faction, or if you are already a member.
|
||
*
|
||
* Returns false otherwise.
|
||
*
|
||
* @returns True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise.
|
||
*/
|
||
joinBladeburnerFaction(): boolean;
|
||
|
||
/**
|
||
* Join the bladeburner division.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Attempts to join the Bladeburner division.
|
||
*
|
||
* Returns true if you successfully join the Bladeburner division, or if you are already a member.
|
||
*
|
||
* Returns false otherwise.
|
||
*
|
||
* @returns True if you successfully join the Bladeburner division, or if you are already a member, false otherwise.
|
||
*/
|
||
joinBladeburnerDivision(): boolean;
|
||
|
||
/**
|
||
* Get bladeburner bonus time.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Returns the amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic.
|
||
*
|
||
* “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
|
||
*
|
||
* “Bonus time” makes the game progress faster, up to 5x the normal speed.
|
||
* For example, if an action takes 30 seconds to complete but you’ve accumulated over
|
||
* 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete.
|
||
*
|
||
* @returns Amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic.
|
||
*/
|
||
getBonusTime(): number;
|
||
|
||
/** Returns whether player is a member of bladeburner division. Does not require API access.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* @returns whether player is a member of bladeburner division. */
|
||
inBladeburner(): boolean;
|
||
}
|
||
|
||
/**
|
||
* Coding Contract API
|
||
* @public
|
||
*/
|
||
export interface CodingContract {
|
||
/**
|
||
* Attempts a coding contract, returning a reward string on success or empty string on failure.
|
||
* @remarks
|
||
* RAM cost: 10 GB
|
||
*
|
||
* Attempts to solve the Coding Contract with the provided solution.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const reward = codingcontract.attempt(yourSolution, filename, hostname);
|
||
* if (reward) {
|
||
* ns.tprint(`Contract solved successfully! Reward: ${reward}`)
|
||
* } else ns.tprint("Failed to solve contract.")
|
||
* ```
|
||
*
|
||
* @param answer - Attempted solution for the contract.
|
||
* @param filename - Filename of the contract.
|
||
* @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not
|
||
* provided.
|
||
* @returns A reward description string on success, or an empty string on failure.
|
||
*/
|
||
attempt(answer: string | number | any[], filename: string, host?: string): string;
|
||
|
||
/**
|
||
* Get the type of a coding contract.
|
||
* @remarks
|
||
* RAM cost: 5 GB
|
||
*
|
||
* Returns a name describing the type of problem posed by the Coding Contract.
|
||
* (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.)
|
||
*
|
||
* @param filename - Filename of the contract.
|
||
* @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not provided.
|
||
* @returns Name describing the type of problem posed by the Coding Contract.
|
||
*/
|
||
getContractType(filename: string, host?: string): string;
|
||
|
||
/**
|
||
* Get the description.
|
||
* @remarks
|
||
* RAM cost: 5 GB
|
||
*
|
||
* Get the full text description for the problem posed by the Coding Contract.
|
||
*
|
||
* @param filename - Filename of the contract.
|
||
* @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not provided.
|
||
* @returns Contract’s text description.
|
||
*/
|
||
getDescription(filename: string, host?: string): string;
|
||
|
||
/**
|
||
* Get the input data.
|
||
* @remarks
|
||
* RAM cost: 5 GB
|
||
*
|
||
* Get the data associated with the specific Coding Contract.
|
||
* Note that this is not the same as the contract’s description.
|
||
* This is just the data that the contract wants you to act on in order to solve the contract.
|
||
*
|
||
* @param filename - Filename of the contract.
|
||
* @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
|
||
* @returns The specified contract’s data, data type depends on contract type.
|
||
*/
|
||
getData(filename: string, host?: string): CodingContractData;
|
||
|
||
/**
|
||
* Get the number of attempts remaining.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Get the number of tries remaining on the contract before it self-destructs.
|
||
*
|
||
* @param filename - Filename of the contract.
|
||
* @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not provided.
|
||
* @returns How many attempts are remaining for the contract.
|
||
*/
|
||
getNumTriesRemaining(filename: string, host?: string): number;
|
||
|
||
/**
|
||
* Generate a dummy contract.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Generate a dummy contract on the home computer with no reward. Used to test various algorithms.
|
||
*
|
||
* @param type - Type of contract to generate
|
||
*/
|
||
createDummyContract(type: string): void;
|
||
|
||
/**
|
||
* List all contract types.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*/
|
||
getContractTypes(): string[];
|
||
}
|
||
|
||
/**
|
||
* Gang API
|
||
* @remarks
|
||
* If you are not in BitNode-2, then you must have Source-File 2 in order to use this API.
|
||
* @public
|
||
*/
|
||
export interface Gang {
|
||
/**
|
||
* Create a gang.
|
||
* @remarks
|
||
* RAM cost: 1GB
|
||
*
|
||
* Create a gang with the specified faction.
|
||
* @returns True if the gang was created, false otherwise.
|
||
*/
|
||
createGang(faction: string): boolean;
|
||
|
||
/**
|
||
* Check if you're in a gang.
|
||
* @remarks
|
||
* RAM cost: 1GB
|
||
* @returns True if you're in a gang, false otherwise.
|
||
*/
|
||
inGang(): boolean;
|
||
|
||
/**
|
||
* List all gang members.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Get the names of all Gang members
|
||
*
|
||
* @returns Names of all Gang members.
|
||
*/
|
||
getMemberNames(): string[];
|
||
|
||
/**
|
||
* Get information about your gang.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Get general information about the gang.
|
||
*
|
||
* @returns Object containing general information about the gang.
|
||
*/
|
||
getGangInformation(): GangGenInfo;
|
||
|
||
/**
|
||
* Get information about the other gangs.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Get territory and power information about all gangs.
|
||
*
|
||
* @returns Object containing territory and power information about all gangs.
|
||
*/
|
||
getOtherGangInformation(): GangOtherInfo;
|
||
|
||
/**
|
||
* Get information about a specific gang member.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Get stat and equipment-related information about a Gang Member
|
||
*
|
||
* @param name - Name of member.
|
||
* @returns Object containing stat and equipment-related information about a Gang Member.
|
||
*/
|
||
getMemberInformation(name: string): GangMemberInfo;
|
||
|
||
/**
|
||
* Check if you can recruit a new gang member.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Returns a boolean indicating whether a member can currently be recruited.
|
||
*
|
||
* Once you have successfully created a gang by using the function
|
||
* {@link Gang.createGang | createGang}, you can immediately recruit a small
|
||
* number of members to your gang. After you have recruited the founding
|
||
* members, to recruit another member you must increase your respect. The
|
||
* more members you want to recruit, the more respect you require. If your
|
||
* gang has the maximum number of members, then this function would return
|
||
* false.
|
||
*
|
||
* @returns True if a member can currently be recruited, false otherwise.
|
||
*/
|
||
canRecruitMember(): boolean;
|
||
|
||
/**
|
||
* Recruit a new gang member.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Attempt to recruit a new gang member.
|
||
*
|
||
* Possible reasons for failure:
|
||
* * Cannot currently recruit a new member
|
||
* * There already exists a member with the specified name
|
||
*
|
||
* @param name - Name of member to recruit.
|
||
* @returns True if the member was successfully recruited, false otherwise.
|
||
*/
|
||
recruitMember(name: string): boolean;
|
||
|
||
/**
|
||
* List member task names.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Get the name of all valid tasks that Gang members can be assigned to.
|
||
*
|
||
* @returns All valid tasks that Gang members can be assigned to.
|
||
*/
|
||
getTaskNames(): string[];
|
||
|
||
/**
|
||
* Set gang member to task.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Attempts to assign the specified Gang Member to the specified task.
|
||
* If an invalid task is specified, the Gang member will be set to idle (“Unassigned”).
|
||
*
|
||
* @param memberName - Name of Gang member to assign.
|
||
* @param taskName - Task to assign.
|
||
* @returns True if the Gang Member was successfully assigned to the task, false otherwise.
|
||
*/
|
||
setMemberTask(memberName: string, taskName: string): boolean;
|
||
|
||
/**
|
||
* Get stats of a task.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next.
|
||
*
|
||
* @param name - Name of the task.
|
||
* @returns Detailed stats of a task.
|
||
*/
|
||
getTaskStats(name: string): GangTaskStats;
|
||
|
||
/**
|
||
* List equipment names.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Get the name of all possible equipment/upgrades you can purchase for your Gang Members.
|
||
* This includes Augmentations.
|
||
*
|
||
* @returns Names of all Equipments/Augmentations.
|
||
*/
|
||
getEquipmentNames(): string[];
|
||
|
||
/**
|
||
* Get cost of equipment.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Get the amount of money it takes to purchase a piece of Equipment or an Augmentation.
|
||
* If an invalid Equipment/Augmentation is specified, this function will return Infinity.
|
||
*
|
||
* @param equipName - Name of equipment.
|
||
* @returns Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments
|
||
*/
|
||
getEquipmentCost(equipName: string): number;
|
||
|
||
/**
|
||
* Get type of an equipment.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Get the specified equipment type.
|
||
*
|
||
* @param equipName - Name of equipment.
|
||
* @returns Type of the equipment.
|
||
*/
|
||
getEquipmentType(equipName: string): string;
|
||
|
||
/**
|
||
* Get stats of an equipment.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Get the specified equipment stats.
|
||
*
|
||
* @param equipName - Name of equipment.
|
||
* @returns A dictionary containing the stats of the equipment.
|
||
*/
|
||
getEquipmentStats(equipName: string): EquipmentStats;
|
||
|
||
/**
|
||
* Purchase an equipment for a gang member.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Attempt to purchase the specified Equipment/Augmentation for the specified Gang member.
|
||
*
|
||
* @param memberName - Name of Gang member to purchase the equipment for.
|
||
* @param equipName - Name of Equipment/Augmentation to purchase.
|
||
* @returns True if the equipment was successfully purchased. False otherwise
|
||
*/
|
||
purchaseEquipment(memberName: string, equipName: string): boolean;
|
||
|
||
/**
|
||
* Ascend a gang member.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Ascend the specified Gang Member.
|
||
*
|
||
* @param memberName - Name of member to ascend.
|
||
* @returns Object with info about the ascension results, or undefined if ascension did not occur.
|
||
*/
|
||
ascendMember(memberName: string): GangMemberAscension | undefined;
|
||
|
||
/**
|
||
* Get the result of an ascension without ascending.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Get a {@link GangMemberAscension} result for ascending a gang member without performing the ascension.
|
||
*
|
||
* @param memberName - Name of member.
|
||
* @returns Object with info about the ascension results, or undefined if ascension is not possible.
|
||
*/
|
||
getAscensionResult(memberName: string): GangMemberAscension | undefined;
|
||
|
||
/**
|
||
* Enable/Disable territory warfare.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Set whether or not the gang should engage in territory warfare
|
||
*
|
||
* @param engage - Whether or not to engage in territory warfare.
|
||
*/
|
||
setTerritoryWarfare(engage: boolean): void;
|
||
|
||
/**
|
||
* Get chance to win clash with other gang.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage
|
||
*
|
||
* @param gangName - Target gang
|
||
* @returns Chance you have to win a clash with the specified gang.
|
||
*/
|
||
getChanceToWinClash(gangName: string): number;
|
||
|
||
/**
|
||
* Get bonus time.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Returns the amount of accumulated “bonus time” (milliseconds) for the Gang mechanic.
|
||
*
|
||
* “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
|
||
*
|
||
* “Bonus time” makes the game progress faster, up to 25x the normal speed.
|
||
*
|
||
* @returns Bonus time for the Gang mechanic in milliseconds.
|
||
*/
|
||
getBonusTime(): number;
|
||
}
|
||
|
||
/**
|
||
* Sleeve API
|
||
* @remarks
|
||
* If you are not in BitNode-10, then you must have Source-File 10 in order to use this API.
|
||
* @public
|
||
*/
|
||
export interface Sleeve {
|
||
/**
|
||
* Get the number of sleeves you own.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return the number of duplicate sleeves the player has.
|
||
*
|
||
* @returns Number of duplicate sleeves the player has.
|
||
*/
|
||
getNumSleeves(): number;
|
||
|
||
/**
|
||
* Get information about a sleeve.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a person object for this sleeve
|
||
*
|
||
* storedCycles is the amount of Bonus Time in cycles, each translates to 200ms
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to retrieve information.
|
||
* @returns Object containing information about this sleeve.
|
||
*/
|
||
getSleeve(sleeveNumber: number): SleevePerson;
|
||
|
||
/**
|
||
* Get task of a sleeve.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return the current task that the sleeve is performing, or null if the sleeve is idle. All tasks have a "type"
|
||
* property, and other available properties depend on the type of task.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to retrieve task from.
|
||
* @returns Object containing information for the current task that the sleeve is performing.
|
||
*/
|
||
getTask(sleeveNumber: number): SleeveTask | null;
|
||
|
||
/**
|
||
* Set a sleeve to idle.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to idle.
|
||
*/
|
||
setToIdle(sleeveNumber: number): void;
|
||
|
||
/**
|
||
* Set a sleeve to shock recovery.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a boolean indicating whether or not this action was set successfully.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to start recovery.
|
||
* @returns True if this action was set successfully, false otherwise.
|
||
*/
|
||
setToShockRecovery(sleeveNumber: number): boolean;
|
||
|
||
/**
|
||
* Set a sleeve to synchronize.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a boolean indicating whether or not this action was set successfully.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to start synchronizing.
|
||
* @returns True if this action was set successfully, false otherwise.
|
||
*/
|
||
setToSynchronize(sleeveNumber: number): boolean;
|
||
|
||
/**
|
||
* Set a sleeve to commit crime.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a boolean indicating whether or not this action was set successfully (false if an invalid action is specified).
|
||
*
|
||
* @example
|
||
* ```ts
|
||
* // Assigns the first sleeve to Homicide.
|
||
* ns.sleeve.setToCommitCrime(0, "Homicide");
|
||
*
|
||
* // Assigns the second sleeve to Grand Theft Auto, using enum
|
||
* const crimes = ns.enums.CrimeType;
|
||
* ns.sleeve.setToCommitCrime(1, crimes.grandTheftAuto)
|
||
* ```
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to start committing crime. Sleeves are numbered starting from 0.
|
||
* @param name - Name of the crime.
|
||
* @returns True if this action was set successfully, false otherwise.
|
||
*/
|
||
setToCommitCrime(sleeveNumber: number, crimeType: CrimeType | `${CrimeType}`): boolean;
|
||
|
||
/**
|
||
* Set a sleeve to work for a faction.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a boolean indicating whether or not the sleeve started working for a faction.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to work for the faction.
|
||
* @param factionName - Name of the faction to work for.
|
||
* @param factionWorkType - Name of the action to perform for this faction.
|
||
* @returns True if the sleeve started working for this faction, false otherwise. Can also throw on errors.
|
||
*/
|
||
setToFactionWork(
|
||
sleeveNumber: number,
|
||
factionName: string,
|
||
factionWorkType: FactionWorkType | `${FactionWorkType}`,
|
||
): boolean | undefined;
|
||
|
||
/**
|
||
* Set a sleeve to work for a company.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a boolean indicating whether or not the sleeve started working for a company.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to work for the company.
|
||
* @param companyName - Name of the company to work for.
|
||
* @returns True if the sleeve started working for this company, false otherwise.
|
||
*/
|
||
setToCompanyWork(sleeveNumber: number, companyName: CompanyName | `${CompanyName}`): boolean;
|
||
|
||
/**
|
||
* Set a sleeve to take a class at a university.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a boolean indicating whether or not this action was set successfully.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to start taking class.
|
||
* @param university - Name of the university to attend.
|
||
* @param className - Name of the class to follow.
|
||
* @returns True if this action was set successfully, false otherwise.
|
||
*/
|
||
setToUniversityCourse(sleeveNumber: number, university: string, className: string): boolean;
|
||
|
||
/**
|
||
* Set a sleeve to workout at the gym.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a boolean indicating whether or not the sleeve started working out.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to workout at the gym.
|
||
* @param gymName - Name of the gym.
|
||
* @param stat - Name of the stat to train.
|
||
* @returns True if the sleeve started working out, false otherwise.
|
||
*/
|
||
setToGymWorkout(sleeveNumber: number, gymName: string, stat: string): boolean;
|
||
|
||
/**
|
||
* Make a sleeve travel to another city.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a boolean indicating whether or not the sleeve reached destination.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to travel.
|
||
* @param city - Name of the destination city.
|
||
* @returns True if the sleeve reached destination, false otherwise.
|
||
*/
|
||
travel(sleeveNumber: number, city: CityName | `${CityName}`): boolean;
|
||
|
||
/**
|
||
* Get augmentations installed on a sleeve.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a list of augmentation names that this sleeve has installed.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to retrieve augmentations from.
|
||
* @returns List of augmentation names that this sleeve has installed.
|
||
*/
|
||
getSleeveAugmentations(sleeveNumber: number): string[];
|
||
|
||
/**
|
||
* Get price of an augmentation.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
*
|
||
* @param augName - Name of Augmentation.
|
||
* @returns Price of the augmentation.
|
||
*/
|
||
getSleeveAugmentationPrice(augName: string): number;
|
||
|
||
/**
|
||
* Get reputation requirement of an augmentation.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
*
|
||
* @param augName - Name of Augmentation.
|
||
* @returns Reputation requirement of the augmentation.
|
||
*/
|
||
getSleeveAugmentationRepReq(augName: string): number;
|
||
|
||
/**
|
||
* List purchasable augs for a sleeve.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a list of augmentations that the player can buy for this sleeve.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to retrieve purchasable augmentations from.
|
||
* @returns List of augmentations that the player can buy for this sleeve.
|
||
*/
|
||
getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[];
|
||
|
||
/**
|
||
* Purchase an aug for a sleeve.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return true if the aug was purchased and installed on the sleeve.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to buy an aug for.
|
||
* @param augName - Name of the aug to buy. Must be an exact match.
|
||
* @returns True if the aug was purchased and installed on the sleeve, false otherwise.
|
||
*/
|
||
purchaseSleeveAug(sleeveNumber: number, augName: string): boolean;
|
||
|
||
/**
|
||
* Set a sleeve to perform Bladeburner actions.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Return a boolean indicating whether or not the sleeve started a Bladeburner action.
|
||
*
|
||
* @param sleeveNumber - Index of the sleeve to perform a Bladeburner action.
|
||
* @param action - Name of the action to be performed.
|
||
* @param contract - Name of the contract if applicable.
|
||
* @returns True if the sleeve started the given Bladeburner action, false otherwise.
|
||
*/
|
||
setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): boolean;
|
||
}
|
||
|
||
/**
|
||
* Grafting API
|
||
* @remarks
|
||
* This API requires Source-File 10 to use.
|
||
* @public
|
||
*/
|
||
export interface Grafting {
|
||
/**
|
||
* Retrieve the grafting cost of an aug.
|
||
* @remarks
|
||
* RAM cost: 3.75 GB
|
||
*
|
||
* @param augName - Name of the aug to check the price of. Must be an exact match.
|
||
* @returns The cost required to graft the named augmentation.
|
||
* @throws Will error if an invalid Augmentation name is provided.
|
||
*/
|
||
getAugmentationGraftPrice(augName: string): number;
|
||
|
||
/**
|
||
* Retrieves the time required to graft an aug.
|
||
* @remarks
|
||
* RAM cost: 3.75 GB
|
||
*
|
||
* @param augName - Name of the aug to check the grafting time of. Must be an exact match.
|
||
* @returns The time required, in millis, to graft the named augmentation.
|
||
* @throws Will error if an invalid Augmentation name is provided.
|
||
*/
|
||
getAugmentationGraftTime(augName: string): number;
|
||
|
||
/**
|
||
* Retrieves a list of Augmentations that can be grafted.
|
||
* @remarks
|
||
* RAM cost: 5 GB
|
||
*
|
||
* Note that this function returns a list of currently graftable Augmentations,
|
||
* based off of the Augmentations that you already own.
|
||
*
|
||
* @returns An array of graftable Augmentations.
|
||
*/
|
||
getGraftableAugmentations(): string[];
|
||
|
||
/**
|
||
* Begins grafting the named aug. You must be in New Tokyo to use this.
|
||
* @remarks
|
||
* RAM cost: 7.5 GB
|
||
*
|
||
* @param augName - The name of the aug to begin grafting. Must be an exact match.
|
||
* @param focus - Acquire player focus on this Augmentation grafting. Optional. Defaults to true.
|
||
* @returns True if the aug successfully began grafting, false otherwise (e.g. not enough money, or
|
||
* invalid Augmentation name provided).
|
||
* @throws Will error if called while you are not in New Tokyo.
|
||
*/
|
||
graftAugmentation(augName: string, focus?: boolean): boolean;
|
||
}
|
||
|
||
/**
|
||
* Skills formulas
|
||
* @public
|
||
*/
|
||
interface SkillsFormulas {
|
||
/**
|
||
* Calculate skill level.
|
||
* @param exp - experience for that skill
|
||
* @param skillMult - Multiplier for that skill, defaults to 1.
|
||
* @returns The calculated skill level.
|
||
*/
|
||
calculateSkill(exp: number, skillMult?: number): number;
|
||
/**
|
||
* Calculate exp for skill level.
|
||
* @param skill - target skill level
|
||
* @param skillMult - Multiplier for that skill, defaults to 1.
|
||
* @returns The calculated exp required.
|
||
*/
|
||
calculateExp(skill: number, skillMult?: number): number;
|
||
}
|
||
|
||
/** @public */
|
||
interface WorkStats {
|
||
money: number;
|
||
reputation: number;
|
||
hackExp: number;
|
||
strExp: number;
|
||
defExp: number;
|
||
dexExp: number;
|
||
agiExp: number;
|
||
chaExp: number;
|
||
intExp: number;
|
||
}
|
||
|
||
/**
|
||
* Work formulas
|
||
* @public
|
||
*/
|
||
interface WorkFormulas {
|
||
crimeSuccessChance(person: Person, crimeType: CrimeType | `${CrimeType}`): number;
|
||
/** @returns The WorkStats gained when completing one instance of the specified crime. */
|
||
crimeGains(person: Person, crimeType: CrimeType | `${CrimeType}`): WorkStats;
|
||
/** @returns The WorkStats applied every game cycle (200ms) by taking the specified gym class. */
|
||
gymGains(person: Person, gymType: GymType | `${GymType}`, locationName: string): WorkStats;
|
||
/** @returns The WorkStats applied every game cycle (200ms) by taking the specified university class. */
|
||
universityGains(
|
||
person: Person,
|
||
classType: UniversityClassType | `${UniversityClassType}`,
|
||
locationName: string,
|
||
): WorkStats;
|
||
/** @returns The WorkStats applied every game cycle (200ms) by performing the specified faction work. */
|
||
factionGains(person: Person, workType: FactionWorkType | `${FactionWorkType}`, favor: number): WorkStats;
|
||
/** @returns The WorkStats applied every game cycle (200ms) by performing the specified company work. */
|
||
companyGains(
|
||
person: Person,
|
||
companyName: CompanyName | `${CompanyName}`,
|
||
workType: JobName | `${JobName}`,
|
||
favor: number,
|
||
): WorkStats;
|
||
}
|
||
|
||
/**
|
||
* Reputation formulas
|
||
* @public
|
||
*/
|
||
interface ReputationFormulas {
|
||
/**
|
||
* Calculate the total required amount of faction reputation to reach a target favor.
|
||
* @param favor - target faction favor.
|
||
* @returns The calculated faction reputation required.
|
||
*/
|
||
calculateFavorToRep(favor: number): number;
|
||
/**
|
||
* Calculate the resulting faction favor of a total amount of reputation.
|
||
* (Faction favor is gained whenever you install an Augmentation.)
|
||
* @param rep - amount of reputation.
|
||
* @returns The calculated faction favor.
|
||
*/
|
||
calculateRepToFavor(rep: number): number;
|
||
|
||
/**
|
||
* Calculate how much rep would be gained.
|
||
* @param amount - Amount of money donated
|
||
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
|
||
*/
|
||
repFromDonation(amount: number, player: Person): number;
|
||
}
|
||
|
||
/**
|
||
* Hacking formulas
|
||
* @public
|
||
*/
|
||
interface HackingFormulas {
|
||
/**
|
||
* Calculate hack chance.
|
||
* (Ex: 0.25 would indicate a 25% chance of success.)
|
||
* @param server - Server info, typically from {@link NS.getServer | getServer}
|
||
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
|
||
* @returns The calculated hack chance.
|
||
*/
|
||
hackChance(server: Server, player: Person): number;
|
||
/**
|
||
* Calculate hack exp for one thread.
|
||
* @remarks
|
||
* Multiply by thread to get total exp
|
||
* @param server - Server info, typically from {@link NS.getServer | getServer}
|
||
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
|
||
* @returns The calculated hack exp.
|
||
*/
|
||
hackExp(server: Server, player: Person): number;
|
||
/**
|
||
* Calculate hack percent for one thread.
|
||
* (Ex: 0.25 would steal 25% of the server's current value.)
|
||
* @remarks
|
||
* Multiply by thread to get total percent hacked.
|
||
* @param server - Server info, typically from {@link NS.getServer | getServer}
|
||
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
|
||
* @returns The calculated hack percent.
|
||
*/
|
||
hackPercent(server: Server, player: Person): number;
|
||
/**
|
||
* Calculate the percent a server would grow to.
|
||
* Not exact due to limitations of mathematics.
|
||
* (Ex: 3.0 would would grow the server to 300% of its current value.)
|
||
* @param server - Server info, typically from {@link NS.getServer | getServer}
|
||
* @param threads - Amount of thread.
|
||
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
|
||
* @param cores - Number of cores on the computer that will execute grow.
|
||
* @returns The calculated grow percent.
|
||
*/
|
||
growPercent(server: Server, threads: number, player: Person, cores?: number): number;
|
||
/**
|
||
* Calculate how many threads it will take to grow server to targetMoney. Starting money is server.moneyAvailable.
|
||
* @param server - Server info, typically from {@link NS.getServer | getServer}
|
||
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
|
||
* @param targetMoney - Desired final money, capped to server's moneyMax
|
||
* @param cores - Number of cores on the computer that will execute grow.
|
||
* @returns The calculated grow threads as an integer, rounded up.
|
||
*/
|
||
growThreads(server: Server, player: Person, targetMoney: number, cores?: number): number;
|
||
/**
|
||
* Calculate hack time.
|
||
* @param server - Server info, typically from {@link NS.getServer | getServer}
|
||
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
|
||
* @returns The calculated hack time.
|
||
*/
|
||
hackTime(server: Server, player: Person): number;
|
||
/**
|
||
* Calculate grow time.
|
||
* @param server - Server info, typically from {@link NS.getServer | getServer}
|
||
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
|
||
* @returns The calculated grow time.
|
||
*/
|
||
growTime(server: Server, player: Person): number;
|
||
/**
|
||
* Calculate weaken time.
|
||
* @param server - Server info, typically from {@link NS.getServer | getServer}
|
||
* @param player - Player info, typically from {@link NS.getPlayer | getPlayer}
|
||
* @returns The calculated weaken time.
|
||
*/
|
||
weakenTime(server: Server, player: Person): number;
|
||
}
|
||
|
||
/**
|
||
* Hacknet Node formulas
|
||
* @public
|
||
*/
|
||
interface HacknetNodesFormulas {
|
||
/**
|
||
* Calculate money gain rate.
|
||
* @param level - level of the node.
|
||
* @param ram - ram of the node.
|
||
* @param cores - cores of the node.
|
||
* @param mult - player production mult (default to 1)
|
||
* @returns The calculated money gain rate.
|
||
*/
|
||
moneyGainRate(level: number, ram: number, cores: number, mult?: number): number;
|
||
/**
|
||
* Calculate cost of upgrading hacknet node level.
|
||
* @param startingLevel - starting level
|
||
* @param extraLevels - amount of level to purchase (defaults to 1)
|
||
* @param costMult - player cost reduction (default to 1)
|
||
* @returns The calculated cost.
|
||
*/
|
||
levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number;
|
||
/**
|
||
* Calculate cost of upgrading hacknet node ram.
|
||
* @param startingRam - starting ram
|
||
* @param extraLevels - amount of level of ram to purchase (defaults to 1)
|
||
* @param costMult - player cost reduction (default to 1)
|
||
* @returns The calculated cost.
|
||
*/
|
||
ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number;
|
||
/**
|
||
* Calculate cost of upgrading hacknet node cores.
|
||
* @param startingCore - starting cores
|
||
* @param extraCores - amount of cores to purchase (defaults to 1)
|
||
* @param costMult - player cost reduction (default to 1)
|
||
* @returns The calculated cost.
|
||
*/
|
||
coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number;
|
||
/**
|
||
* Calculate the cost of a hacknet node.
|
||
* @param n - number of the hacknet node
|
||
* @param mult - player cost reduction (defaults to 1)
|
||
* @returns The calculated cost.
|
||
*/
|
||
hacknetNodeCost(n: number, mult: number): number;
|
||
/**
|
||
* All constants used by the game.
|
||
* @returns An object with all hacknet node constants used by the game.
|
||
*/
|
||
constants(): HacknetNodeConstants;
|
||
}
|
||
|
||
/**
|
||
* Hacknet Server formulas
|
||
* @public
|
||
*/
|
||
interface HacknetServersFormulas {
|
||
/**
|
||
* Calculate hash gain rate.
|
||
* @param level - level of the server.
|
||
* @param ramUsed - ramUsed of the server.
|
||
* @param maxRam - maxRam of the server.
|
||
* @param cores - cores of the server.
|
||
* @param mult - player production mult (default to 1)
|
||
* @returns The calculated hash gain rate.
|
||
*/
|
||
hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult?: number): number;
|
||
/**
|
||
* Calculate cost of upgrading hacknet server level.
|
||
* @param startingLevel - starting level
|
||
* @param extraLevels - amount of level to purchase (defaults to 1)
|
||
* @param costMult - player cost reduction (default to 1)
|
||
* @returns The calculated cost.
|
||
*/
|
||
levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number;
|
||
/**
|
||
* Calculate cost of upgrading hacknet server ram.
|
||
* @param startingRam - starting ram
|
||
* @param extraLevels - amount of level of ram to purchase (defaults to 1)
|
||
* @param costMult - player cost reduction (default to 1)
|
||
* @returns The calculated cost.
|
||
*/
|
||
ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number;
|
||
/**
|
||
* Calculate cost of upgrading hacknet server cores.
|
||
* @param startingCore - starting cores
|
||
* @param extraCores - amount of cores to purchase (defaults to 1)
|
||
* @param costMult - player cost reduction (default to 1)
|
||
* @returns The calculated cost.
|
||
*/
|
||
coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number;
|
||
/**
|
||
* Calculate cost of upgrading hacknet server cache.
|
||
* @param startingCache - starting cache level
|
||
* @param extraCache - amount of levels of cache to purchase (defaults to 1)
|
||
* @returns The calculated cost.
|
||
*/
|
||
cacheUpgradeCost(startingCache: number, extraCache?: number): number;
|
||
/**
|
||
* Calculate hash cost of an upgrade.
|
||
* @param upgName - name of the upgrade
|
||
* @param level - level of the upgrade
|
||
* @returns The calculated hash cost.
|
||
*/
|
||
hashUpgradeCost(upgName: number, level: number): number;
|
||
/**
|
||
* Calculate the cost of a hacknet server.
|
||
* @param n - number of the hacknet server
|
||
* @param mult - player cost reduction (defaults to 1)
|
||
* @returns The calculated cost.
|
||
*/
|
||
hacknetServerCost(n: number, mult?: number): number;
|
||
/**
|
||
* All constants used by the game.
|
||
* @returns An object with all hacknet server constants used by the game.
|
||
*/
|
||
constants(): HacknetServerConstants;
|
||
}
|
||
|
||
/**
|
||
* Gang formulas
|
||
* @public
|
||
*/
|
||
interface GangFormulas {
|
||
/**
|
||
* Calculate the wanted penalty.
|
||
* @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}
|
||
* @returns The calculated wanted penalty.
|
||
*/
|
||
wantedPenalty(gang: GangGenInfo): number;
|
||
/**
|
||
* Calculate respect gain per tick.
|
||
* @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}
|
||
* @param member - Gang info from {@link Gang.getMemberInformation | getMemberInformation}
|
||
* @param task - Gang info from {@link Gang.getTaskStats | getTaskStats}
|
||
* @returns The calculated respect gain.
|
||
*/
|
||
respectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number;
|
||
/**
|
||
* Calculate wanted gain per tick.
|
||
* @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}
|
||
* @param member - Member info from {@link Gang.getMemberInformation | getMemberInformation}
|
||
* @param task - Task info from {@link Gang.getTaskStats | getTaskStats}
|
||
* @returns The calculated wanted gain.
|
||
*/
|
||
wantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number;
|
||
/**
|
||
* Calculate money gain per tick.
|
||
* @param gang - Gang info from {@link Gang.getGangInformation | getGangInformation}
|
||
* @param member - Member info from {@link Gang.getMemberInformation | getMemberInformation}
|
||
* @param task - Task info from {@link Gang.getTaskStats | getTaskStats}
|
||
* @returns The calculated money gain.
|
||
*/
|
||
moneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number;
|
||
|
||
/**
|
||
* Calculate ascension point gain.
|
||
* @param exp - Experience point before ascension.
|
||
* @returns The calculated ascension point gain.
|
||
*/
|
||
ascensionPointsGain(exp: number): number;
|
||
|
||
/**
|
||
* Calculate ascension mult.
|
||
* @param points - Amount of ascension points.
|
||
* @returns The calculated ascension mult.
|
||
*/
|
||
ascensionMultiplier(points: number): number;
|
||
}
|
||
|
||
/**
|
||
* Formulas API
|
||
* @remarks
|
||
* You need Formulas.exe on your home computer to use this API.
|
||
* @public
|
||
*/
|
||
export interface Formulas {
|
||
mockServer(): Server;
|
||
mockPlayer(): Player;
|
||
mockPerson(): Person;
|
||
/** Reputation formulas */
|
||
reputation: ReputationFormulas;
|
||
/** Skills formulas */
|
||
skills: SkillsFormulas;
|
||
/** Hacking formulas */
|
||
hacking: HackingFormulas;
|
||
/** Hacknet Nodes formulas */
|
||
hacknetNodes: HacknetNodesFormulas;
|
||
/** Hacknet Servers formulas */
|
||
hacknetServers: HacknetServersFormulas;
|
||
/** Gang formulas */
|
||
gang: GangFormulas;
|
||
/** Work formulas */
|
||
work: WorkFormulas;
|
||
}
|
||
|
||
/** @public */
|
||
interface Fragment {
|
||
id: number;
|
||
shape: boolean[][];
|
||
type: number;
|
||
power: number;
|
||
limit: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface ActiveFragment {
|
||
id: number;
|
||
highestCharge: number;
|
||
numCharge: number;
|
||
rotation: number;
|
||
x: number;
|
||
y: number;
|
||
}
|
||
|
||
/**
|
||
* Stanek's Gift API.
|
||
* @public
|
||
*/
|
||
interface Stanek {
|
||
/**
|
||
* Stanek's Gift width.
|
||
* @remarks
|
||
* RAM cost: 0.4 GB
|
||
* @returns The width of the gift.
|
||
*/
|
||
giftWidth(): number;
|
||
/**
|
||
* Stanek's Gift height.
|
||
* @remarks
|
||
* RAM cost: 0.4 GB
|
||
* @returns The height of the gift.
|
||
*/
|
||
giftHeight(): number;
|
||
|
||
/**
|
||
* Charge a fragment, increasing its power.
|
||
* @remarks
|
||
* RAM cost: 0.4 GB
|
||
* @param rootX - rootX Root X against which to align the top left of the fragment.
|
||
* @param rootY - rootY Root Y against which to align the top left of the fragment.
|
||
* @returns Promise that lasts until the charge action is over.
|
||
*/
|
||
chargeFragment(rootX: number, rootY: number): Promise<void>;
|
||
|
||
/**
|
||
* List possible fragments.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @returns List of possible fragments.
|
||
*/
|
||
fragmentDefinitions(): Fragment[];
|
||
|
||
/**
|
||
* List of fragments in Stanek's Gift.
|
||
* @remarks
|
||
* RAM cost: 5 GB
|
||
*
|
||
* @returns List of active fragments placed on Stanek's Gift.
|
||
*/
|
||
activeFragments(): ActiveFragment[];
|
||
|
||
/**
|
||
* Clear the board of all fragments.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*/
|
||
clearGift(): void;
|
||
|
||
/**
|
||
* Check if fragment can be placed at specified location.
|
||
* @remarks
|
||
* RAM cost: 0.5 GB
|
||
*
|
||
* @param rootX - rootX Root X against which to align the top left of the fragment.
|
||
* @param rootY - rootY Root Y against which to align the top left of the fragment.
|
||
* @param rotation - rotation A number from 0 to 3, the mount of 90 degree turn to take.
|
||
* @param fragmentId - fragmentId ID of the fragment to place.
|
||
* @returns true if the fragment can be placed at that position. false otherwise.
|
||
*/
|
||
canPlaceFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
|
||
/**
|
||
* Place fragment on Stanek's Gift.
|
||
* @remarks
|
||
* RAM cost: 5 GB
|
||
*
|
||
* @param rootX - X against which to align the top left of the fragment.
|
||
* @param rootY - Y against which to align the top left of the fragment.
|
||
* @param rotation - A number from 0 to 3, the mount of 90 degree turn to take.
|
||
* @param fragmentId - ID of the fragment to place.
|
||
* @returns true if the fragment can be placed at that position. false otherwise.
|
||
*/
|
||
placeFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
|
||
/**
|
||
* Get placed fragment at location.
|
||
* @remarks
|
||
* RAM cost: 5 GB
|
||
*
|
||
* @param rootX - X against which to align the top left of the fragment.
|
||
* @param rootY - Y against which to align the top left of the fragment.
|
||
* @returns The fragment at [rootX, rootY], if any.
|
||
*/
|
||
getFragment(rootX: number, rootY: number): ActiveFragment | undefined;
|
||
|
||
/**
|
||
* Remove fragment at location.
|
||
* @remarks
|
||
* RAM cost: 0.15 GB
|
||
*
|
||
* @param rootX - X against which to align the top left of the fragment.
|
||
* @param rootY - Y against which to align the top left of the fragment.
|
||
* @returns The fragment at [rootX, rootY], if any.
|
||
*/
|
||
removeFragment(rootX: number, rootY: number): boolean;
|
||
|
||
/**
|
||
* Accept Stanek's Gift by joining the Church of the Machine God
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* @returns true if the player is a member of the church and has the gift installed,
|
||
* false otherwise.
|
||
*/
|
||
acceptGift(): boolean;
|
||
}
|
||
|
||
/** @public */
|
||
interface InfiltrationReward {
|
||
tradeRep: number;
|
||
sellCash: number;
|
||
SoARep: number;
|
||
}
|
||
|
||
/** @public */
|
||
interface ILocation {
|
||
city: CityName;
|
||
name: LocationName;
|
||
}
|
||
|
||
/** @public */
|
||
interface InfiltrationLocation {
|
||
location: ILocation;
|
||
reward: InfiltrationReward;
|
||
difficulty: number;
|
||
}
|
||
|
||
/**
|
||
* Infiltration API.
|
||
* @public
|
||
*/
|
||
interface Infiltration {
|
||
/**
|
||
* Get all locations that can be infiltrated.
|
||
* @remarks
|
||
* RAM cost: 5 GB
|
||
*
|
||
* @returns all locations that can be infiltrated.
|
||
*/
|
||
getPossibleLocations(): ILocation[];
|
||
/**
|
||
* Get all infiltrations with difficulty, location and rewards.
|
||
* @remarks
|
||
* RAM cost: 15 GB
|
||
*
|
||
* @returns Infiltration data for given location.
|
||
*/
|
||
getInfiltration(location: string): InfiltrationLocation;
|
||
}
|
||
|
||
/**
|
||
* User Interface API.
|
||
* @public
|
||
*/
|
||
interface UserInterface {
|
||
/**
|
||
* Get the current window size
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @returns An array of 2 value containing the window width and height.
|
||
*/
|
||
windowSize(): [number, number];
|
||
|
||
/**
|
||
* Get the current theme
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @returns An object containing the theme's colors
|
||
*/
|
||
getTheme(): UserInterfaceTheme;
|
||
|
||
/**
|
||
* Sets the current theme
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
* @example
|
||
* Usage example (NS2)
|
||
* ```ts
|
||
* const theme = ns.ui.getTheme();
|
||
* theme.primary = '#ff5500';
|
||
* ns.ui.setTheme(theme);
|
||
* ```
|
||
*/
|
||
setTheme(newTheme: UserInterfaceTheme): void;
|
||
|
||
/**
|
||
* Resets the player's theme to the default values
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*/
|
||
resetTheme(): void;
|
||
|
||
/**
|
||
* Get the current styles
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @returns An object containing the player's styles
|
||
*/
|
||
getStyles(): IStyleSettings;
|
||
|
||
/**
|
||
* Sets the current styles
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
* @example
|
||
* Usage example (NS2)
|
||
* ```ts
|
||
* const styles = ns.ui.getStyles();
|
||
* styles.fontFamily = 'Comic Sans Ms';
|
||
* ns.ui.setStyles(styles);
|
||
* ```
|
||
*/
|
||
setStyles(newStyles: IStyleSettings): void;
|
||
|
||
/**
|
||
* Resets the player's styles to the default values
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*/
|
||
resetStyles(): void;
|
||
|
||
/**
|
||
* Gets the current game information (version, commit, ...)
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*/
|
||
getGameInfo(): GameInfo;
|
||
|
||
/**
|
||
* Clear the Terminal window, as if the player ran `clear` in the terminal
|
||
* @remarks
|
||
* RAM cost: 0.2 GB
|
||
*/
|
||
clearTerminal(): void;
|
||
}
|
||
|
||
/**
|
||
* Collection of all functions passed to scripts
|
||
* @public
|
||
* @remarks
|
||
* <b>Basic usage example:</b>
|
||
* ```js
|
||
* export async function main(ns) {
|
||
* // Basic ns functions can be accessed on the ns object
|
||
* ns.getHostname();
|
||
* // Some related functions are gathered under a sub-property of the ns object
|
||
* ns.stock.getPrice();
|
||
* // Most functions that return a promise need to be awaited.
|
||
* await ns.hack('n00dles');
|
||
* }
|
||
* ```
|
||
*/
|
||
export interface NS {
|
||
/**
|
||
* Namespace for hacknet functions. Some of this API contains spoilers.
|
||
* @remarks RAM cost: 4 GB.
|
||
*/
|
||
readonly hacknet: Hacknet;
|
||
|
||
/**
|
||
* Namespace for bladeburner functions. Contains spoilers.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly bladeburner: Bladeburner;
|
||
|
||
/**
|
||
* Namespace for codingcontract functions.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly codingcontract: CodingContract;
|
||
|
||
/**
|
||
* Namespace for gang functions. Contains spoilers.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly gang: Gang;
|
||
|
||
/**
|
||
* Namespace for sleeve functions. Contains spoilers.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly sleeve: Sleeve;
|
||
|
||
/**
|
||
* Namespace for stock functions.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly stock: TIX;
|
||
|
||
/**
|
||
* Namespace for formulas functions.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly formulas: Formulas;
|
||
|
||
/**
|
||
* Namespace for stanek functions. Contains spoilers.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly stanek: Stanek;
|
||
|
||
/**
|
||
* Namespace for infiltration functions.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly infiltration: Infiltration;
|
||
|
||
/**
|
||
* Namespace for corporation functions. Contains spoilers.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly corporation: Corporation;
|
||
|
||
/**
|
||
* Namespace for user interface functions.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly ui: UserInterface;
|
||
|
||
/**
|
||
* Namespace for singularity functions. Contains spoilers.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly singularity: Singularity;
|
||
|
||
/**
|
||
* Namespace for grafting functions. Contains spoilers.
|
||
* @remarks RAM cost: 0 GB
|
||
*/
|
||
readonly grafting: Grafting;
|
||
|
||
/**
|
||
* Arguments passed into the script.
|
||
*
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Arguments passed into a script can be accessed as a normal array by using the `[]` operator
|
||
* (`args[0]`, `args[1]`, etc...).
|
||
* Arguments can be string, number, or boolean.
|
||
* Use `args.length` to get the number of arguments that were passed into a script.
|
||
*
|
||
* @example
|
||
* `run example.js 7 text true`
|
||
*
|
||
* ```js
|
||
* // example.js
|
||
* export async function main(ns) {
|
||
* ns.tprint(ns.args.length) // 3
|
||
* ns.tprint(ns.args[0]); // 7 (number)
|
||
* ns.tprint(ns.args[1]); // "text" (string)
|
||
* ns.tprint(ns.args[2]); // true (boolean)
|
||
* ns.tprint(ns.args[3]); // undefined, because only 3 arguments were provided
|
||
* }
|
||
* ```
|
||
*/
|
||
readonly args: (string | number | boolean)[];
|
||
|
||
/** The current script's PID */
|
||
readonly pid: number;
|
||
|
||
/**
|
||
* Steal a server's money.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* Function that is used to try and hack servers to steal money and gain hacking experience.
|
||
* The runtime for this command depends on your hacking level and the target server’s
|
||
* security level when this function is called. In order to hack a server you must first gain root access to that server
|
||
* and also have the required hacking level.
|
||
*
|
||
* A script can hack a server from anywhere. It does not need to be running on the same
|
||
* server to hack that server. For example, you can create a script that hacks the `foodnstuff`
|
||
* server and run that script on any server in the game.
|
||
*
|
||
* A successful `hack()` on a server will raise that server’s security level by 0.002.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* let earnedMoney = await ns.hack("foodnstuff");
|
||
* ```
|
||
* @param host - Hostname of the target server to hack.
|
||
* @param opts - Optional parameters for configuring function behavior.
|
||
* @returns A promise that resolves to the amount of money stolen (which is zero if the hack is unsuccessful).
|
||
*/
|
||
hack(host: string, opts?: BasicHGWOptions): Promise<number>;
|
||
|
||
/**
|
||
* Spoof money in a server's bank account, increasing the amount available.
|
||
* @remarks
|
||
* RAM cost: 0.15 GB
|
||
*
|
||
* Use your hacking skills to increase the amount of money available on a server.
|
||
*
|
||
* Once the grow is complete, $1 is added to the server's available money for every script thread. This additive
|
||
* growth allows for rescuing a server even after it is emptied.
|
||
*
|
||
* After this addition, the thread count is also used to determine a multiplier, which the server's money is then
|
||
* multiplied by.
|
||
*
|
||
* The multiplier scales exponentially with thread count, and its base depends on the server's security
|
||
* level and in inherent "growth" statistic that varies between different servers.
|
||
*
|
||
* {@link NS.getServerGrowth | getServerGrowth} can be used to check the inherent growth statistic of a server.
|
||
*
|
||
* {@link NS.growthAnalyze | growthAnalyze} can be used to determine the number of threads needed for a specified
|
||
* multiplicative portion of server growth.
|
||
*
|
||
* To determine the effect of a single grow, obtain access to the Formulas API and use
|
||
* {@link HackingFormulas.growPercent | formulas.hacking.growPercent}, or invert {@link NS.growthAnalyze | growthAnalyze}.
|
||
*
|
||
* Like {@link NS.hack | hack}, `grow` can be called on any hackable server, regardless of where the script is
|
||
* running. Hackable servers are any servers not owned by the player.
|
||
*
|
||
* The grow() command requires root access to the target server, but there is no required hacking
|
||
* level to run the command. It also raises the security level of the target server based on the number of threads.
|
||
* The security increase can be determined using {@link NS.growthAnalyzeSecurity | growthAnalyzeSecurity}.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* let currentMoney = ns.getServerMoneyAvailable("n00dles");
|
||
* currentMoney *= await ns.grow("foodnstuff");
|
||
* ```
|
||
* @param host - Hostname of the target server to grow.
|
||
* @param opts - Optional parameters for configuring function behavior.
|
||
* @returns The total effective multiplier that was applied to the server's money (after both additive and multiplicative growth).
|
||
*/
|
||
grow(host: string, opts?: BasicHGWOptions): Promise<number>;
|
||
|
||
/**
|
||
* Reduce a server's security level.
|
||
* @remarks
|
||
* RAM cost: 0.15 GB
|
||
*
|
||
* Use your hacking skills to attack a server’s security, lowering the server’s security level.
|
||
* The runtime for this function depends on your hacking level and the target server’s security
|
||
* level when this function is called. This function lowers the security level of the target server by 0.05.
|
||
*
|
||
* Like {@link NS.hack | hack} and {@link NS.grow| grow}, `weaken` can be called on any server, regardless of
|
||
* where the script is running. This function requires root access to the target server, but
|
||
* there is no required hacking level to run the function.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* let currentSecurity = ns.getServerSecurityLevel("foodnstuff");
|
||
* currentSecurity -= await ns.weaken("foodnstuff");
|
||
* ```
|
||
* @param host - Hostname of the target server to weaken.
|
||
* @param opts - Optional parameters for configuring function behavior.
|
||
* @returns A promise that resolves to the value by which security was reduced.
|
||
*/
|
||
weaken(host: string, opts?: BasicHGWOptions): Promise<number>;
|
||
|
||
/**
|
||
* Predict the effect of weaken.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Returns the security decrease that would occur if a weaken with this many threads happened.
|
||
*
|
||
* @param threads - Amount of threads that will be used.
|
||
* @param cores - Optional. The number of cores of the server that would run weaken.
|
||
* @returns The security decrease.
|
||
*/
|
||
weakenAnalyze(threads: number, cores?: number): number;
|
||
|
||
/**
|
||
* Calculate the decimal number of threads needed to hack a specified amount of money from a target host.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* This function returns the decimal number of script threads you need when running the hack command
|
||
* to steal the specified amount of money from the target server.
|
||
* If hackAmount is less than zero or greater than the amount of money available on the server,
|
||
* then this function returns -1.
|
||
*
|
||
*
|
||
* @example
|
||
* ```ts
|
||
* // Calculate threadcount of a single hack that would take $100k from n00dles
|
||
* const hackThreads = hackAnalyzeThreads("n00dles", 1e5);
|
||
*
|
||
* // Launching a script requires an integer thread count. The below would take less than the targeted $100k.
|
||
* ns.run("noodleHack.js", Math.floor(hackThreads))
|
||
*
|
||
* ```
|
||
* @param host - Hostname of the target server to analyze.
|
||
* @param hackAmount - Amount of money you want to hack from the server.
|
||
* @returns The number of threads needed to hack the server for hackAmount money.
|
||
*/
|
||
hackAnalyzeThreads(host: string, hackAmount: number): number;
|
||
|
||
/**
|
||
* Get the part of money stolen with a single thread.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Returns the part of the specified server’s money you will steal with a single thread hack.
|
||
*
|
||
* Like other basic hacking analysis functions, this calculation uses the current status of the player and server.
|
||
* To calculate using hypothetical server or player status, obtain access to the Formulas API and use {@link HackingFormulas.hackPercent | formulas.hacking.hackPercent}.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* //For example, assume the following returns 0.01:
|
||
* const hackAmount = ns.hackAnalyze("foodnstuff");
|
||
* //This means that if hack the foodnstuff server using a single thread, then you will steal 1%, or 0.01 of its total money. If you hack using N threads, then you will steal N*0.01 times its total money.
|
||
* ```
|
||
* @param host - Hostname of the target server.
|
||
* @returns The part of money you will steal from the target server with a single thread hack.
|
||
*/
|
||
hackAnalyze(host: string): number;
|
||
|
||
/**
|
||
* Get the security increase for a number of threads.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Returns the security increase that would occur if a hack with this many threads happened.
|
||
*
|
||
* @param threads - Amount of threads that will be used.
|
||
* @param hostname - Hostname of the target server. The number of threads is limited to the number needed to hack the server's maximum amount of money.
|
||
* @returns The security increase.
|
||
*/
|
||
hackAnalyzeSecurity(threads: number, hostname?: string): number;
|
||
|
||
/**
|
||
* Get the chance of successfully hacking a server.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Returns the chance you have of successfully hacking the specified server.
|
||
*
|
||
* This returned value is in decimal form, not percentage.
|
||
*
|
||
* Like other basic hacking analysis functions, this calculation uses the current status of the player and server.
|
||
* To calculate using hypothetical server or player status, obtain access to the Formulas API and use {@link HackingFormulas.hackChance | formulas.hacking.hackChance}.
|
||
*
|
||
* @param host - Hostname of the target server.
|
||
* @returns The chance you have of successfully hacking the target server.
|
||
*/
|
||
hackAnalyzeChance(host: string): number;
|
||
|
||
/**
|
||
* Calculate the number of grow threads needed for a given multiplicative growth factor.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* This function returns the total decimal number of {@link NS.grow | grow} threads needed in order to multiply the
|
||
* money available on the specified server by a given multiplier, if all threads are executed at the server's current
|
||
* security level, regardless of how many threads are assigned to each call.
|
||
*
|
||
* Note that there is also an additive factor that is applied before the multiplier. Each {@link NS.grow | grow} call
|
||
* will add $1 to the host's money for each thread before applying the multiplier for its thread count. This means
|
||
* that at extremely low starting money, fewer threads would be needed to apply the same effective multiplier than
|
||
* what is calculated by growthAnalyze.
|
||
*
|
||
* Like other basic hacking analysis functions, this calculation uses the current status of the player and server.
|
||
* To calculate using hypothetical server or player status, obtain access to the Formulas API and use {@link HackingFormulas.growThreads | formulas.hacking.growThreads}.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* // calculate number of grow threads to apply 2x growth multiplier on n00dles (does not include the additive growth).
|
||
* const growThreads = ns.growthAnalyze("n00dles", 2);
|
||
*
|
||
* // When using the thread count to launch a script, it needs to be converted to an integer.
|
||
* ns.run("noodleGrow.js", Math.ceil(growThreads));
|
||
* ```
|
||
* @param host - Hostname of the target server.
|
||
* @param multiplier - Multiplier that will be applied to a server's money after applying additive growth. Decimal form.
|
||
* @param cores - Number of cores on the host running the grow function. Optional, defaults to 1.
|
||
* @returns Decimal number of grow threads needed for the specified multiplicative growth factor (does not include additive growth).
|
||
*/
|
||
growthAnalyze(host: string, multiplier: number, cores?: number): number;
|
||
|
||
/**
|
||
* Calculate the security increase for a number of grow threads.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Returns the security increase that would occur if a grow with this many threads happened.
|
||
*
|
||
* @param threads - Amount of threads that will be used.
|
||
* @param hostname - Optional. Hostname of the target server. If provided, security increase is limited by the number of threads needed to reach maximum money.
|
||
* @param cores - Optional. The number of cores of the server that would run grow.
|
||
* @returns The security increase.
|
||
*/
|
||
growthAnalyzeSecurity(threads: number, hostname?: string, cores?: number): number;
|
||
|
||
/**
|
||
* Suspends the script for n milliseconds.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @param millis - Number of milliseconds to sleep.
|
||
* @example
|
||
* ```js
|
||
* // This will count from 1 to 10 in your terminal, with one number every 5 seconds
|
||
* for (var i = 1; i <= 10; i++) {
|
||
* ns.tprint(i);
|
||
* await ns.sleep(5000);
|
||
* }
|
||
* ```
|
||
* @returns A promise that resolves to true when the sleep is completed.
|
||
*/
|
||
sleep(millis: number): Promise<true>;
|
||
|
||
/**
|
||
* Suspends the script for n milliseconds. Doesn't block with concurrent calls.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @param millis - Number of milliseconds to sleep.
|
||
* @returns A promise that resolves to true when the sleep is completed.
|
||
*/
|
||
asleep(millis: number): Promise<true>;
|
||
|
||
/**
|
||
* Prints one or more values or variables to the script’s logs.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* If the argument is a string, you can color code your message by prefixing your
|
||
* string with one of these strings:
|
||
*
|
||
* - `"ERROR"`: The whole string will be printed in red. Use this prefix to indicate
|
||
* that an error has occurred.
|
||
*
|
||
* - `"SUCCESS"`: The whole string will be printed in green, similar to the default
|
||
* theme of the Terminal. Use this prefix to indicate that something is correct.
|
||
*
|
||
* - `"WARN"`: The whole string will be printed in yellow. Use this prefix to
|
||
* indicate that you or a user of your script should be careful of something.
|
||
*
|
||
* - `"INFO"`: The whole string will be printed in purplish blue. Use this prefix to
|
||
* remind yourself or a user of your script of something. Think of this prefix as
|
||
* indicating an FYI (for your information).
|
||
*
|
||
* For custom coloring, use ANSI escape sequences. The examples below use the Unicode
|
||
* escape code `\u001b`. The color coding also works if `\u001b` is replaced with
|
||
* the hexadecimal escape code `\x1b`. The Bash escape code `\e` is not supported.
|
||
* The octal escape code `\033` is not allowed because the game runs JavaScript in
|
||
* strict mode.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* // Default color coding.
|
||
* ns.print("ERROR means something's wrong.");
|
||
* ns.print("SUCCESS means everything's OK.");
|
||
* ns.print("WARN Tread with caution!");
|
||
* ns.print("WARNING, warning, danger, danger!");
|
||
* ns.print("WARNing! Here be dragons.");
|
||
* ns.print("INFO for your I's only (FYI).");
|
||
* ns.print("INFOrmation overload!");
|
||
* // Custom color coding.
|
||
* const cyan = "\u001b[36m";
|
||
* const green = "\u001b[32m";
|
||
* const red = "\u001b[31m";
|
||
* const reset = "\u001b[0m";
|
||
* ns.print(`${red}Ugh! What a mess.${reset}`);
|
||
* ns.print(`${green}Well done!${reset}`);
|
||
* ns.print(`${cyan}ERROR Should this be in red?${reset}`);
|
||
* ns.tail();
|
||
* ```
|
||
*
|
||
* @param args - Value(s) to be printed.
|
||
*/
|
||
print(...args: any[]): void;
|
||
|
||
/** Prints a ReactNode to the script logs.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* See {@link ReactNode} type for the acceptable values.
|
||
*
|
||
* @param node - The react node to be printed. */
|
||
printRaw(node: ReactNode): void;
|
||
|
||
/**
|
||
* Prints a formatted string to the script’s logs.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* - See {@link NS.print | print} for how to add color to your printed strings.
|
||
*
|
||
* - For more detail, see: https://github.com/alexei/sprintf.js
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const name = "Bit";
|
||
* const age = 4;
|
||
* ns.printf("My name is %s.", name);
|
||
* ns.printf("I'm %d seconds old.", age);
|
||
* ns.printf("My age in binary is %b.", age);
|
||
* ns.printf("My age in scientific notation is %e.", age);
|
||
* ns.printf("In %d seconds, I'll be %s.", 6, "Byte");
|
||
* ns.printf("Am I a nibble? %t", (4 == age));
|
||
* ns.tail();
|
||
* ```
|
||
*
|
||
* @param format - Format of the message.
|
||
* @param args - Value(s) to be printed.
|
||
*/
|
||
printf(format: string, ...args: any[]): void;
|
||
|
||
/**
|
||
* Prints one or more values or variables to the Terminal.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* See {@link NS.print | print} for how to add color to your printed strings.
|
||
*
|
||
* @param args - Value(s) to be printed.
|
||
*/
|
||
tprint(...args: any[]): void;
|
||
|
||
/** Prints a ReactNode to the terminal.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* See {@link ReactNode} type for the acceptable values.
|
||
*
|
||
* @param node - The react node to be printed. */
|
||
tprintRaw(node: ReactNode): void;
|
||
|
||
/**
|
||
* Prints a raw value or a variable to the Terminal.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* - See {@link NS.print | print} for how to add color to your printed strings.
|
||
*
|
||
* - See {@link NS.printf | printf} for examples on formatted strings.
|
||
*
|
||
* - For more detail, see: https://github.com/alexei/sprintf.js
|
||
*
|
||
* @param format - Format of the message.
|
||
* @param values - Value(s) to be printed.
|
||
*/
|
||
tprintf(format: string, ...values: any[]): void;
|
||
|
||
/**
|
||
* Clears the script’s logs.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*/
|
||
clearLog(): void;
|
||
|
||
/**
|
||
* Disables logging for the given function.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Logging can be disabled for all functions by passing `ALL` as the argument.
|
||
*
|
||
* @param fn - Name of function for which to disable logging.
|
||
*/
|
||
disableLog(fn: string): void;
|
||
|
||
/**
|
||
* Enable logging for a certain function.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Re-enables logging for the given function. If `ALL` is passed into this
|
||
* function as an argument, then it will revert the effects of disableLog(`ALL`).
|
||
*
|
||
* @param fn - Name of function for which to enable logging.
|
||
*/
|
||
enableLog(fn: string): void;
|
||
|
||
/**
|
||
* Checks the status of the logging for the given function.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @param fn - Name of function to check.
|
||
* @returns Returns a boolean indicating whether or not logging is enabled for that function (or `ALL`).
|
||
*/
|
||
isLogEnabled(fn: string): boolean;
|
||
|
||
/**
|
||
* Get all the logs of a script.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Returns a script’s logs. The logs are returned as an array, where each line is an element in the array.
|
||
* The most recently logged line is at the end of the array.
|
||
* Note that there is a maximum number of lines that a script stores in its logs. This is configurable in the game’s options.
|
||
* If the function is called with no arguments, it will return the current script’s logs.
|
||
*
|
||
* Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script.
|
||
* Remember that scripts are uniquely identified by both their names and arguments.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* //Get logs from foo.js on the current server that was run with no args
|
||
* ns.getScriptLogs("foo.js");
|
||
*
|
||
* //Open logs from foo.js on the foodnstuff server that was run with no args
|
||
* ns.getScriptLogs("foo.js", "foodnstuff");
|
||
*
|
||
* //Open logs from foo.js on the foodnstuff server that was run with the arguments [1, "test"]
|
||
* ns.getScriptLogs("foo.js", "foodnstuff", 1, "test");
|
||
* ```
|
||
* @param fn - Optional. Filename of script to get logs from.
|
||
* @param host - Optional. Hostname of the server that the script is on.
|
||
* @param args - Arguments to identify which scripts to get logs for.
|
||
* @returns Returns a string array, where each line is an element in the array. The most recently logged line is at the end of the array.
|
||
*/
|
||
getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[];
|
||
|
||
/**
|
||
* Get an array of recently killed scripts across all servers.
|
||
* @remarks
|
||
* RAM cost: 0.2 GB
|
||
*
|
||
* The most recently killed script is the first element in the array.
|
||
* Note that there is a maximum number of recently killed scripts which are tracked.
|
||
* This is configurable in the game's options as `Recently killed scripts size`.
|
||
*
|
||
* @example
|
||
* ```ts
|
||
* let recentScripts = ns.getRecentScripts();
|
||
* let mostRecent = recentScripts.shift()
|
||
* if (mostRecent)
|
||
* ns.tprint(mostRecent.logs.join('\n'))
|
||
* ```
|
||
*
|
||
* @returns Array with information about previously killed scripts.
|
||
*/
|
||
getRecentScripts(): RecentScript[];
|
||
|
||
/**
|
||
* Open the tail window of a script.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Opens a script’s logs. This is functionally the same as the tail Terminal command.
|
||
*
|
||
* If the function is called with no arguments, it will open the current script’s logs.
|
||
*
|
||
* Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script.
|
||
* Remember that scripts are uniquely identified by both their names and arguments.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* //Open logs from foo.js on the current server that was run with no args
|
||
* ns.tail("foo.js");
|
||
*
|
||
* //Get logs from foo.js on the foodnstuff server that was run with no args
|
||
* ns.tail("foo.js", "foodnstuff");
|
||
*
|
||
* //Get logs from foo.js on the foodnstuff server that was run with the arguments [1, "test"]
|
||
* ns.tail("foo.js", "foodnstuff", 1, "test");
|
||
* ```
|
||
* @param fn - Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed.
|
||
* @param host - Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional.
|
||
* @param args - Arguments for the script being tailed.
|
||
*/
|
||
tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): void;
|
||
|
||
/**
|
||
* Move a tail window.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Moves a tail window. Coordinates are in screenspace pixels (top left is 0,0).
|
||
*
|
||
* @param x - x coordinate.
|
||
* @param y - y coordinate.
|
||
* @param pid - Optional. PID of the script having its tail moved. If omitted, the current script is used.
|
||
*/
|
||
moveTail(x: number, y: number, pid?: number): void;
|
||
|
||
/**
|
||
* Resize a tail window.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Resize a tail window. Size are in pixel.
|
||
*
|
||
* @param width - Width of the window.
|
||
* @param height - Height of the window.
|
||
* @param pid - Optional. PID of the script having its tail resized. If omitted, the current script is used.
|
||
*/
|
||
resizeTail(width: number, height: number, pid?: number): void;
|
||
|
||
/**
|
||
* Close the tail window of a script.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Closes a script’s logs. This is functionally the same as pressing the "Close" button on the tail window.
|
||
*
|
||
* If the function is called with no arguments, it will close the current script’s logs.
|
||
*
|
||
* Otherwise, the pid argument can be used to close the logs from another script.
|
||
*
|
||
* @param pid - Optional. PID of the script having its tail closed. If omitted, the current script is used.
|
||
*/
|
||
closeTail(pid?: number): void;
|
||
|
||
/**
|
||
* Set the title of the tail window of a script.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This sets the title to the given string, and also forces an update of the
|
||
* tail window's contents.
|
||
*
|
||
* The title is saved across restarts, but only if it is a simple string.
|
||
*
|
||
* If the pid is unspecified, it will modify the current script’s logs.
|
||
*
|
||
* Otherwise, the pid argument can be used to change the logs from another script.
|
||
*
|
||
* It is possible to pass any React Node instead of a string.
|
||
* See {@link ReactElement} and {@link ReactNode} types for additional info.
|
||
*
|
||
* @param pid - Optional. PID of the script having its tail closed. If omitted, the current script is used.
|
||
*/
|
||
setTitle(title: string | ReactNode, pid?: number): void;
|
||
|
||
/**
|
||
* Get the list of servers connected to a server.
|
||
* @remarks
|
||
* RAM cost: 0.2 GB
|
||
*
|
||
* Returns an array containing the hostnames of all servers that are one
|
||
* node way from the specified target server. The hostnames in the returned
|
||
* array are strings.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* // All servers that are one hop from the current server.
|
||
* ns.tprint("Neighbors of current server.");
|
||
* let neighbor = ns.scan();
|
||
* for (let i = 0; i < neighbor.length; i++) {
|
||
* ns.tprint(neighbor[i]);
|
||
* }
|
||
* // All neighbors of n00dles.
|
||
* const target = "n00dles";
|
||
* neighbor = ns.scan(target);
|
||
* ns.tprintf("Neighbors of %s.", target);
|
||
* for (let i = 0; i < neighbor.length; i++) {
|
||
* ns.tprint(neighbor[i]);
|
||
* }
|
||
* ```
|
||
*
|
||
* @param host - Optional. Hostname of the server to scan, default to current server.
|
||
* @returns Returns an array of hostnames.
|
||
*/
|
||
scan(host?: string): string[];
|
||
|
||
/** Returns whether the player has access to the darkweb.
|
||
* @remarks
|
||
* RAM cost: 0.05GB
|
||
*
|
||
* @example
|
||
* ```js
|
||
* if (ns.hasTorRouter()) ns.tprint("TOR router detected.");
|
||
* ```
|
||
*
|
||
* @returns Whether player has access to the dark web. */
|
||
hasTorRouter(): boolean;
|
||
|
||
/**
|
||
* Runs NUKE.exe on a server.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* Running NUKE.exe on a target server gives you root access which means you can execute scripts on said server. NUKE.exe must exist on your home computer.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* ns.nuke("foodnstuff");
|
||
* ```
|
||
* @param host - Hostname of the target server.
|
||
*/
|
||
nuke(host: string): void;
|
||
|
||
/**
|
||
* Runs BruteSSH.exe on a server.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* ns.brutessh("foodnstuff");
|
||
* ```
|
||
* @param host - Hostname of the target server.
|
||
*/
|
||
brutessh(host: string): void;
|
||
|
||
/**
|
||
* Runs FTPCrack.exe on a server.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* Runs the FTPCrack.exe program on the target server. FTPCrack.exe must exist on your home computer.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* ns.ftpcrack("foodnstuff");
|
||
* ```
|
||
* @param host - Hostname of the target server.
|
||
*/
|
||
ftpcrack(host: string): void;
|
||
|
||
/**
|
||
* Runs relaySMTP.exe on a server.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* Runs the relaySMTP.exe program on the target server. relaySMTP.exe must exist on your home computer.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* ns.relaysmtp("foodnstuff");
|
||
* ```
|
||
* @param host - Hostname of the target server.
|
||
*/
|
||
relaysmtp(host: string): void;
|
||
|
||
/**
|
||
* Runs HTTPWorm.exe on a server.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* ns.httpworm("foodnstuff");
|
||
* ```
|
||
* @param host - Hostname of the target server.
|
||
*/
|
||
httpworm(host: string): void;
|
||
|
||
/**
|
||
* Runs SQLInject.exe on a server.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* Runs the SQLInject.exe program on the target server. SQLInject.exe must exist on your home computer.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* ns.sqlinject("foodnstuff");
|
||
* ```
|
||
* @remarks RAM cost: 0.05 GB
|
||
* @param host - Hostname of the target server.
|
||
*/
|
||
sqlinject(host: string): void;
|
||
|
||
/**
|
||
* Start another script on the current server.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Run a script as a separate process. This function can only be used to run scripts located on the
|
||
* current server (the server running the script that calls this function). Requires a significant
|
||
* amount of RAM to run this command.
|
||
*
|
||
* The second argument is either a thread count, or a {@link RunOptions} object that can also
|
||
* specify the number of threads (among other things).
|
||
*
|
||
* If the script was successfully started, then this functions returns the PID of that script.
|
||
* Otherwise, it returns 0.
|
||
*
|
||
* PID stands for Process ID. The PID is a unique identifier for each script.
|
||
* The PID will always be a positive integer.
|
||
*
|
||
* Running this function with 0 or fewer threads will cause a runtime error.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* //The simplest way to use the run command is to call it with just the script name. The following example will run ‘foo.js’ single-threaded with no arguments:
|
||
* ns.run("foo.js");
|
||
*
|
||
* //The following example will run ‘foo.js’ but with 5 threads instead of single-threaded:
|
||
* ns.run("foo.js", {threads: 5});
|
||
*
|
||
* //This next example will run ‘foo.js’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument:
|
||
* ns.run("foo.js", 1, 'foodnstuff');
|
||
* ```
|
||
* @param script - Filename of script to run.
|
||
* @param threadOrOptions - Either an integer number of threads for new script, or a {@link RunOptions} object. Threads defaults to 1.
|
||
* @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument threadOrOptions must be filled in with a value.
|
||
* @returns Returns the PID of a successfully started script, and 0 otherwise.
|
||
*/
|
||
run(script: string, threadOrOptions?: number | RunOptions, ...args: (string | number | boolean)[]): number;
|
||
|
||
/**
|
||
* Start another script on any server.
|
||
* @remarks
|
||
* RAM cost: 1.3 GB
|
||
*
|
||
* Run a script as a separate process on a specified server. This is similar to the function {@link NS.run | run}
|
||
* except that it can be used to run a script that already exists on any server, instead of just the current server.
|
||
*
|
||
* If the script was successfully started, then this function returns the PID of that script.
|
||
* Otherwise, it returns 0.
|
||
*
|
||
* PID stands for Process ID. The PID is a unique identifier for each script.
|
||
* The PID will always be a positive integer.
|
||
*
|
||
* Running this function with 0 or fewer threads will cause a runtime error.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* // The simplest way to use the exec command is to call it with just the script name
|
||
* // and the target server. The following example will try to run generic-hack.js
|
||
* // on the foodnstuff server.
|
||
* ns.exec("generic-hack.js", "foodnstuff");
|
||
*
|
||
* // The following example will try to run the script generic-hack.js on the
|
||
* // joesguns server with 10 threads.
|
||
* ns.exec("generic-hack.js", "joesguns", {threads: 10});
|
||
*
|
||
* // This last example will try to run the script foo.js on the foodnstuff server
|
||
* // with 5 threads. It will also pass the number 1 and the string “test” in as
|
||
* // arguments to the script.
|
||
* ns.exec("foo.js", "foodnstuff", 5, 1, "test");
|
||
* ```
|
||
* @param script - Filename of script to execute. This file must already exist on the target server.
|
||
* @param hostname - Hostname of the `target server` on which to execute the script.
|
||
* @param threadOrOptions - Either an integer number of threads for new script, or a {@link RunOptions} object. Threads defaults to 1.
|
||
* @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument threadOrOptions must be filled in with a value.
|
||
* @returns Returns the PID of a successfully started script, and 0 otherwise.
|
||
*/
|
||
exec(
|
||
script: string,
|
||
hostname: string,
|
||
threadOrOptions?: number | RunOptions,
|
||
...args: (string | number | boolean)[]
|
||
): number;
|
||
|
||
/**
|
||
* Terminate current script and start another in 10 seconds.
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
*
|
||
* Terminates the current script, and then after a delay of about 10 seconds it will execute the
|
||
* newly-specified script. The purpose of this function is to execute a new script without being
|
||
* constrained by the RAM usage of the current one. This function can only be used to run scripts
|
||
* on the local server.
|
||
*
|
||
* Because this function immediately terminates the script, it does not have a return value.
|
||
*
|
||
* Running this function with 0 or fewer threads will cause a runtime error.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* //The following example will execute the script ‘foo.js’ with 10 threads and the arguments ‘foodnstuff’ and 90:
|
||
* ns.spawn('foo.js', 10, 'foodnstuff', 90);
|
||
* ```
|
||
* @param script - Filename of script to execute.
|
||
* @param threadOrOptions - Either an integer number of threads for new script, or a {@link RunOptions} object. Threads defaults to 1.
|
||
* @param args - Additional arguments to pass into the new script that is being run.
|
||
*/
|
||
spawn(script: string, threadOrOptions?: number | RunOptions, ...args: (string | number | boolean)[]): void;
|
||
|
||
/**
|
||
* Terminate the script with the provided PID.
|
||
* @remarks
|
||
* RAM cost: 0.5 GB
|
||
*
|
||
* Kills the script with the provided PID.
|
||
* To instead kill a script using its filename, hostname, and args, see {@link NS.(kill:2) | the other ns.kill entry}.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* // kills the script with PID 20:
|
||
* ns.kill(20);
|
||
* ```
|
||
*
|
||
* @param pid - The PID of the script to kill.
|
||
* @returns True if the script is successfully killed, and false otherwise.
|
||
*/
|
||
kill(pid: number): boolean;
|
||
|
||
/**
|
||
* Terminate the script(s) with the provided filename, hostname, and script arguments.
|
||
* @remarks
|
||
* RAM cost: 0.5 GB
|
||
*
|
||
* Kills the script(s) with the provided filename, running on the specified host with the specified args.
|
||
* To instead kill a script using its PID, see {@link NS.(kill:1) | the other ns.kill entry}.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* // kill the script "foo.js" on the same server the current script is running from, with no arguments
|
||
* ns.kill("foo.js");
|
||
*
|
||
* // kill the script "foo.js" on the "n00dles" server with no arguments.
|
||
* ns.kill("foo.js", "n00dles");
|
||
*
|
||
* // kill the script foo.js on the current server that was ran with the arguments [1, “foodnstuff”, false]:
|
||
* ns.kill("foo.js", ns.getHostname(), 1, "foodnstuff", false);
|
||
* ```
|
||
* @param filename - Filename of the script to kill.
|
||
* @param hostname - Hostname where the script to kill is running. Defaults to the current server.
|
||
* @param args - Arguments of the script to kill.
|
||
* @returns True if the scripts were successfully killed, and false otherwise.
|
||
*/
|
||
kill(filename: string, hostname?: string, ...args: ScriptArg[]): boolean;
|
||
|
||
/**
|
||
* Terminate all scripts on a server.
|
||
* @remarks
|
||
* RAM cost: 0.5 GB
|
||
*
|
||
* Kills all running scripts on the specified server. This function returns true
|
||
* if any scripts were killed, and false otherwise. In other words, it will return
|
||
* true if there are any scripts running on the target server.
|
||
* If no host is defined, it will kill all scripts, where the script is running.
|
||
*
|
||
* @param host - IP or hostname of the server on which to kill all scripts.
|
||
* @param safetyguard - Skips the script that calls this function
|
||
* @returns True if any scripts were killed, and false otherwise.
|
||
*/
|
||
killall(host?: string, safetyguard?: boolean): boolean;
|
||
|
||
/**
|
||
* Terminates the current script immediately.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*/
|
||
exit(): never;
|
||
|
||
/**
|
||
* Copy file between servers.
|
||
* @remarks
|
||
* RAM cost: 0.6 GB
|
||
*
|
||
* Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string
|
||
* specifying a single file to copy, or an array of strings specifying multiple files to copy.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* //Copies foo.lit from the helios server to the home computer:
|
||
* ns.scp("foo.lit", "home", "helios" );
|
||
*
|
||
* //Tries to copy three files from rothman-uni to home computer:
|
||
* const files = ["foo1.lit", "foo2.txt", "foo3.js"];
|
||
* ns.scp(files, "home", "rothman-uni");
|
||
* ```
|
||
* @example
|
||
* ```js
|
||
* const server = ns.args[0];
|
||
* const files = ["hack.js", "weaken.js", "grow.js"];
|
||
* ns.scp(files, server, "home");
|
||
* ```
|
||
* @param files - Filename or an array of filenames of script/literature files to copy. Note that if a file is located in a subdirectory, the filename must include the leading `/`.
|
||
* @param destination - Hostname of the destination server, which is the server to which the file will be copied.
|
||
* @param source - Hostname of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server.
|
||
* @returns True if the file is successfully copied over and false otherwise. If the files argument is an array then this function will return false if any of the operations failed.
|
||
*/
|
||
scp(files: string | string[], destination: string, source?: string): boolean;
|
||
|
||
/**
|
||
* List files on a server.
|
||
* @remarks
|
||
* RAM cost: 0.2 GB
|
||
*
|
||
* Returns an array with the filenames of all files on the specified server
|
||
* (as strings). The returned array is sorted in alphabetic order.
|
||
*
|
||
* @param host - Hostname of the target server.
|
||
* @param substring - A substring to search for in the filename.
|
||
* @returns Array with the filenames of all files on the specified server.
|
||
*/
|
||
ls(host: string, substring?: string): string[];
|
||
|
||
/**
|
||
* List running scripts on a server.
|
||
* @remarks
|
||
* RAM cost: 0.2 GB
|
||
*
|
||
* Returns an array with general information about all scripts running on the specified target server.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const ps = ns.ps("home");
|
||
* for (let script of ps) {
|
||
* ns.tprint(`${script.filename} ${script.threads}`);
|
||
* ns.tprint(script.args);
|
||
* }
|
||
* ```
|
||
* @param host - Host address of the target server. If not specified, it will be the current server’s IP by default.
|
||
* @returns Array with general information about all scripts running on the specified target server.
|
||
*/
|
||
ps(host?: string): ProcessInfo[];
|
||
|
||
/**
|
||
* Check if you have root access on a server.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* Returns a boolean indicating whether or not the player has root access to the specified target server.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* if (!ns.hasRootAccess("foodnstuff")) {
|
||
* ns.nuke("foodnstuff");
|
||
* }
|
||
* ```
|
||
* @param host - Hostname of the target server.
|
||
* @returns True if player has root access to the specified target server, and false otherwise.
|
||
*/
|
||
hasRootAccess(host: string): boolean;
|
||
|
||
/**
|
||
* Returns a string with the hostname of the server that the script is running on.
|
||
*
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
* @returns Hostname of the server that the script runs on.
|
||
*/
|
||
getHostname(): string;
|
||
|
||
/**
|
||
* Returns the player’s current hacking level.
|
||
*
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
* @returns Player’s current hacking level
|
||
*/
|
||
getHackingLevel(): number;
|
||
|
||
/**
|
||
* Get hacking related multipliers.
|
||
* @remarks
|
||
* RAM cost: 0.25 GB
|
||
*
|
||
* Returns an object containing the Player’s hacking related multipliers.
|
||
* These multipliers are returned in fractional forms, not percentages
|
||
* (e.g. 1.5 instead of 150%).
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const mults = ns.getHackingMultipliers();
|
||
* print(`chance: ${mults.chance}`);
|
||
* print(`growthL ${mults.growth}`);
|
||
* ```
|
||
* @returns Object containing the Player’s hacking related multipliers.
|
||
*/
|
||
getHackingMultipliers(): HackingMultipliers;
|
||
|
||
/**
|
||
* Get hacknet related multipliers.
|
||
* @remarks
|
||
* RAM cost: 0.25 GB
|
||
*
|
||
* Returns an object containing the Player’s hacknet related multipliers.
|
||
* These multipliers are returned in fractional forms, not percentages
|
||
* (e.g. 1.5 instead of 150%).
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const mults = ns.getHacknetMultipliers();
|
||
* ns.tprint(`production: ${mults.production}`);
|
||
* ns.tprint(`purchaseCost: ${mults.purchaseCost}`);
|
||
* ```
|
||
* @returns Object containing the Player’s hacknet related multipliers.
|
||
*/
|
||
getHacknetMultipliers(): HacknetMultipliers;
|
||
|
||
/**
|
||
* Returns a server object for the given server. Defaults to the running script's server if host is not specified.
|
||
*
|
||
* @remarks
|
||
* RAM cost: 2 GB
|
||
* @param host - Optional. Hostname for the requested server object.
|
||
* @returns The requested server object.
|
||
*/
|
||
getServer(host?: string): Server;
|
||
|
||
/**
|
||
* Get money available on a server.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* Returns the amount of money available on a server.
|
||
* Running this function on the home computer will return the player’s money.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* ns.getServerMoneyAvailable("foodnstuff");
|
||
* ns.getServerMoneyAvailable("home"); // Returns player's money
|
||
* ```
|
||
* @param host - Hostname of target server.
|
||
* @returns Amount of money available on the server.
|
||
*/
|
||
getServerMoneyAvailable(host: string): number;
|
||
|
||
/**
|
||
* Get the maximum money available on a server.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* Returns the maximum amount of money that can be available on a server.
|
||
*
|
||
* @param host - Hostname of target server.
|
||
* @returns Maximum amount of money available on the server.
|
||
*/
|
||
getServerMaxMoney(host: string): number;
|
||
|
||
/**
|
||
* Get a server growth parameter.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* Returns the server’s intrinsic “growth parameter”. This growth
|
||
* parameter is a number typically between 0 and 100 that represents
|
||
* how quickly the server’s money grows. This parameter affects the
|
||
* percentage by which the server’s money is increased when using the
|
||
* grow function. A higher growth parameter will result in a
|
||
* higher percentage increase from grow.
|
||
*
|
||
* @param host - Hostname of target server.
|
||
* @returns Parameter that affects the percentage by which the server’s money is increased when using the grow function.
|
||
*/
|
||
getServerGrowth(host: string): number;
|
||
|
||
/**
|
||
* Get server security level.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* Returns the security level of the target server. A server’s security
|
||
* level is denoted by a number, typically between 1 and 100
|
||
* (but it can go above 100).
|
||
*
|
||
* @param host - Hostname of target server.
|
||
* @returns Security level of the target server.
|
||
*/
|
||
getServerSecurityLevel(host: string): number;
|
||
|
||
/**
|
||
* Returns the minimum security level of the target server.
|
||
*
|
||
* @remarks RAM cost: 0.1 GB
|
||
* @param host - Hostname of target server.
|
||
* @returns Minimum security level of the target server.
|
||
*/
|
||
getServerMinSecurityLevel(host: string): number;
|
||
|
||
/**
|
||
* Get the base security level of a server.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
* Returns the base security level of the target server.
|
||
* For the server's actual security level, use {@link NS.getServerSecurityLevel | ns.getServerSecurityLevel}.
|
||
*
|
||
* @param host - Host of target server.
|
||
* @returns Base security level of the target server.
|
||
*/
|
||
getServerBaseSecurityLevel(host: string): number;
|
||
|
||
/**
|
||
* Get the maximum amount of RAM on a server.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* @param host - Hostname of the target server.
|
||
* @returns The maximum amount of RAM (GB) a server can have.
|
||
*/
|
||
getServerMaxRam(host: string): number;
|
||
/**
|
||
* Get the used RAM on a server.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* @param host - Hostname of the target server.
|
||
* @returns The amount of used RAM (GB) on the specified server.
|
||
*/
|
||
getServerUsedRam(host: string): number;
|
||
|
||
/**
|
||
* Returns the required hacking level of the target server.
|
||
*
|
||
* @remarks RAM cost: 0.1 GB
|
||
* @param host - Hostname of target server.
|
||
* @returns The required hacking level of the target server.
|
||
*/
|
||
getServerRequiredHackingLevel(host: string): number;
|
||
|
||
/**
|
||
* Returns the number of open ports required to successfully run NUKE.exe on the specified server.
|
||
*
|
||
* @remarks RAM cost: 0.1 GB
|
||
* @param host - Hostname of target server.
|
||
* @returns The number of open ports required to successfully run NUKE.exe on the specified server.
|
||
*/
|
||
getServerNumPortsRequired(host: string): number;
|
||
|
||
/**
|
||
* Returns a boolean denoting whether or not the specified server exists.
|
||
*
|
||
* @remarks RAM cost: 0.1 GB
|
||
* @param host - Hostname of target server.
|
||
* @returns True if the specified server exists, and false otherwise.
|
||
*/
|
||
serverExists(host: string): boolean;
|
||
|
||
/**
|
||
* Check if a file exists.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* Returns a boolean indicating whether the specified file exists on the target server.
|
||
* The filename for programs is case insensitive, other file types are case sensitive.
|
||
* For example, fileExists(“brutessh.exe”) will work fine, even though the actual program
|
||
* is named 'BruteSSH.exe'.
|
||
*
|
||
* * @example
|
||
* ```js
|
||
* // The function call will return true if the script named foo.js exists on the foodnstuff server, and false otherwise.
|
||
* ns.fileExists("foo.js", "foodnstuff");
|
||
*
|
||
* // The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise.
|
||
* ns.fileExists("ftpcrack.exe");
|
||
* ```
|
||
* @param filename - Filename of file to check.
|
||
* @param host - Host of target server. Optional, defaults to the server the script is running on.
|
||
* @returns True if specified file exists, and false otherwise.
|
||
*/
|
||
fileExists(filename: string, host?: string): boolean;
|
||
|
||
/**
|
||
* Check if a script is running.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* Returns a boolean indicating whether the specified script is running on the target server.
|
||
* If you use a PID instead of a filename, the hostname and args parameters are unnecessary.
|
||
* Remember that a script is semi-uniquely identified by both its name and its arguments.
|
||
* (You can run multiple copies of scripts with the same arguments, but for the purposes of
|
||
* functions like this that check based on filename, the filename plus arguments forms the key.)
|
||
*
|
||
* @example
|
||
* ```js
|
||
* //The function call will return true if there is a script named foo.js with no arguments running on the foodnstuff server, and false otherwise:
|
||
* ns.isRunning("foo.js", "foodnstuff");
|
||
*
|
||
* //The function call will return true if there is a script named foo.js with no arguments running on the current server, and false otherwise:
|
||
* ns.isRunning("foo.js", ns.getHostname());
|
||
*
|
||
* //The function call will return true if there is a script named foo.js running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise:
|
||
* ns.isRunning("foo.js", "joesguns", 1, 5, "test");
|
||
* ```
|
||
* @param script - Filename or PID of script to check. This is case-sensitive.
|
||
* @param host - Hostname of target server.
|
||
* @param args - Arguments to specify/identify which scripts to search for.
|
||
* @returns True if the specified script is running on the target server, and false otherwise.
|
||
*/
|
||
isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): boolean;
|
||
|
||
/**
|
||
* Get general info about a running script.
|
||
* @remarks
|
||
* RAM cost: 0.3 GB
|
||
*
|
||
* Running with no args returns current script.
|
||
* If you use a PID as the first parameter, the hostname and args parameters are unnecessary.
|
||
*
|
||
* @param filename - Optional. Filename or PID of the script.
|
||
* @param hostname - Optional. Name of host server the script is running on.
|
||
* @param args - Arguments to identify the script
|
||
* @returns The info about the running script if found, and null otherwise.
|
||
*/
|
||
getRunningScript(
|
||
filename?: FilenameOrPID,
|
||
hostname?: string,
|
||
...args: (string | number | boolean)[]
|
||
): RunningScript | null;
|
||
|
||
/**
|
||
* Get cost of purchasing a server.
|
||
* @remarks
|
||
* RAM cost: 0.25 GB
|
||
*
|
||
* Returns the cost to purchase a server with the specified amount of ram.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const ram = 2 ** 20;
|
||
* const cost = ns.getPurchasedServerCost(ram);
|
||
* ns.tprint(`A purchased server with ${ns.formatRam(ram)} costs ${ns.formatMoney(cost)}`);
|
||
* ```
|
||
* @param ram - Amount of RAM of a potential purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).
|
||
* @returns The cost to purchase a server with the specified amount of ram.
|
||
*/
|
||
getPurchasedServerCost(ram: number): number;
|
||
|
||
/**
|
||
* Purchase a server.
|
||
* @remarks
|
||
* 2.25 GB
|
||
*
|
||
* Purchase a server with the specified hostname and amount of RAM.
|
||
*
|
||
* The hostname argument can be any data type, but it will be converted to a string
|
||
* and have whitespace removed. Anything that resolves to an empty string will cause
|
||
* the function to fail. If there is already a server with the specified hostname,
|
||
* then the function will automatically append a number at the end of the hostname
|
||
* argument value until it finds a unique hostname. For example, if the script calls
|
||
* `purchaseServer(“foo”, 4)` but a server named “foo” already exists, then it will
|
||
* automatically change the hostname to `foo-0`. If there is already a server with the
|
||
* hostname `foo-0`, then it will change the hostname to `foo-1`, and so on.
|
||
*
|
||
* Note that there is a maximum limit to the amount of servers you can purchase.
|
||
*
|
||
* Returns the hostname of the newly purchased server as a string. If the function
|
||
* fails to purchase a server, then it will return an empty string. The function will
|
||
* fail if the arguments passed in are invalid, if the player does not have enough
|
||
* money to purchase the specified server, or if the player has exceeded the maximum
|
||
* amount of servers.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* // Attempt to purchase 5 servers with 64GB of ram each
|
||
* const ram = 64;
|
||
* const prefix = "pserv-";
|
||
* for (i = 0; i < 5; ++i) {
|
||
* ns.purchaseServer(prefix + i, ram);
|
||
* }
|
||
* ```
|
||
* @param hostname - Hostname of the purchased server.
|
||
* @param ram - Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).
|
||
* @returns The hostname of the newly purchased server.
|
||
*/
|
||
purchaseServer(hostname: string, ram: number): string;
|
||
|
||
/**
|
||
* Get cost of upgrading a purchased server to the given ram.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* @param hostname - Hostname of the server to upgrade.
|
||
* @param ram - Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).
|
||
* @returns The price to upgrade.
|
||
*/
|
||
getPurchasedServerUpgradeCost(hostname: string, ram: number): number;
|
||
|
||
/**
|
||
* Upgrade a purchased server's RAM.
|
||
* @remarks
|
||
* RAM cost: 0.25 GB
|
||
*
|
||
* @param hostname - Hostname of the server to upgrade.
|
||
* @param ram - Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).
|
||
* @returns True if the upgrade succeeded, and false otherwise.
|
||
*/
|
||
upgradePurchasedServer(hostname: string, ram: number): boolean;
|
||
|
||
/**
|
||
* Rename a purchased server.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @param hostname - Current server hostname.
|
||
* @param newName - New server hostname.
|
||
* @returns True if successful, and false otherwise.
|
||
*/
|
||
renamePurchasedServer(hostname: string, newName: string): boolean;
|
||
|
||
/**
|
||
* Delete a purchased server.
|
||
* @remarks
|
||
* 2.25 GB
|
||
*
|
||
* Deletes one of your purchased servers, which is specified by its hostname.
|
||
*
|
||
* The hostname argument can be any data type, but it will be converted to a string.
|
||
* Whitespace is automatically removed from the string. This function will not delete a
|
||
* server that still has scripts running on it.
|
||
*
|
||
* @param host - Hostname of the server to delete.
|
||
* @returns True if successful, and false otherwise.
|
||
*/
|
||
deleteServer(host: string): boolean;
|
||
|
||
/**
|
||
* Returns an array with the hostnames of all of the servers you have purchased.
|
||
*
|
||
* @remarks 2.25 GB
|
||
* @returns Returns an array with the hostnames of all of the servers you have purchased.
|
||
*/
|
||
getPurchasedServers(): string[];
|
||
|
||
/**
|
||
* Returns the maximum number of servers you can purchase.
|
||
*
|
||
* @remarks RAM cost: 0.05 GB
|
||
* @returns Returns the maximum number of servers you can purchase.
|
||
*/
|
||
getPurchasedServerLimit(): number;
|
||
|
||
/**
|
||
* Returns the maximum RAM that a purchased server can have.
|
||
*
|
||
* @remarks RAM cost: 0.05 GB
|
||
* @returns Returns the maximum RAM (in GB) that a purchased server can have.
|
||
*/
|
||
getPurchasedServerMaxRam(): number;
|
||
|
||
/**
|
||
* Write data to a file.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function can be used to write data to a text file (.txt) or a script (.js or .script).
|
||
*
|
||
* This function will write data to that file. If the specified file does not exist,
|
||
* then it will be created. The third argument mode defines how the data will be written to
|
||
* the file. If mode is set to “w”, then the data is written in “write” mode which means
|
||
* that it will overwrite all existing data on the file. If mode is set to any other value
|
||
* then the data will be written in “append” mode which means that the data will be added at the
|
||
* end of the file.
|
||
*
|
||
* @param filename - Name of the file to be written to.
|
||
* @param data - Data to write.
|
||
* @param mode - Defines the write mode.
|
||
*/
|
||
write(filename: string, data?: string, mode?: "w" | "a"): void;
|
||
|
||
/**
|
||
* Attempt to write to a port.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Attempts to write data to the specified Netscript port.
|
||
* If the port is full, the data will not be written.
|
||
* Otherwise, the data will be written normally.
|
||
*
|
||
* @param portNumber - Port or text file that will be written to.
|
||
* @param data - Data to write.
|
||
* @returns True if the data is successfully written to the port, and false otherwise.
|
||
*/
|
||
tryWritePort(portNumber: number, data: string | number): boolean;
|
||
|
||
/**
|
||
* Read content of a file.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is used to read data from a text file (.txt) or script (.js or .script).
|
||
*
|
||
* This function will return the data in the specified file.
|
||
* If the file does not exist, an empty string will be returned.
|
||
*
|
||
* @param filename - Name of the file to be read.
|
||
* @returns Data in the specified text file.
|
||
*/
|
||
read(filename: string): string;
|
||
|
||
/**
|
||
* Get a copy of the data from a port without popping it.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* This function is used to peek at the data from a port. It returns the
|
||
* first element in the specified port without removing that element. If
|
||
* the port is empty, the string “NULL PORT DATA” will be returned.
|
||
*
|
||
* @param portNumber - Port to peek. Must be an integer between 1 and 20.
|
||
* @returns Data in the specified port.
|
||
*/
|
||
peek(portNumber: number): PortData;
|
||
|
||
/**
|
||
* Clear data from a file.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Delete all data from that text file.
|
||
*
|
||
* @param handle - Text file to clear.
|
||
*/
|
||
clear(handle: string): void;
|
||
|
||
/**
|
||
* Clear data from a port.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Delete all data from the underlying queue.
|
||
*
|
||
* @param handle - Port to clear.
|
||
*/
|
||
clearPort(handle: number): void;
|
||
|
||
/**
|
||
* Write data to a port.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Write data to the given Netscript port.
|
||
* @returns The data popped off the queue if it was full, or null if it was not full.
|
||
*/
|
||
writePort(portNumber: number, data: string | number): PortData | null;
|
||
/**
|
||
* Read data from a port.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Read data from that port. A port is a serialized queue.
|
||
* This function will remove the first element from that queue and return it.
|
||
* If the queue is empty, then the string “NULL PORT DATA” will be returned.
|
||
* @returns The data read.
|
||
*/
|
||
readPort(portNumber: number): PortData;
|
||
|
||
/**
|
||
* Get all data on a port.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Get a handle to a Netscript Port.
|
||
*
|
||
* WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0.
|
||
*
|
||
* @param portNumber - Port number. Must be an integer between 1 and 20.
|
||
*/
|
||
getPortHandle(portNumber: number): NetscriptPort;
|
||
|
||
/**
|
||
* Delete a file.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Removes the specified file from the current server. This function works for every file
|
||
* type except message (.msg) files.
|
||
*
|
||
* @param name - Filename of file to remove. Must include the extension.
|
||
* @param host - Hostname of the server on which to delete the file. Optional. Defaults to current server.
|
||
* @returns True if it successfully deletes the file, and false otherwise.
|
||
*/
|
||
rm(name: string, host?: string): boolean;
|
||
|
||
/**
|
||
* Check if any script with a filename is running.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Returns a boolean indicating whether any instance of the specified script is running
|
||
* on the target server, regardless of its arguments.
|
||
*
|
||
* This is different than the {@link NS.isRunning | isRunning} function because it does not try to
|
||
* identify a specific instance of a running script by its arguments.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* //The function call will return true if there is any script named foo.js running on the foodnstuff server, and false otherwise:
|
||
* ns.scriptRunning("foo.js", "foodnstuff");
|
||
*
|
||
* //The function call will return true if there is any script named “foo.js” running on the current server, and false otherwise:
|
||
* ns.scriptRunning("foo.js", ns.getHostname());
|
||
* ```
|
||
* @param script - Filename of script to check. This is case-sensitive.
|
||
* @param host - Hostname of target server.
|
||
* @returns True if the specified script is running, and false otherwise.
|
||
*/
|
||
scriptRunning(script: string, host: string): boolean;
|
||
|
||
/**
|
||
* Kill all scripts with a filename.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* Kills all scripts with the specified filename on the target server specified by hostname,
|
||
* regardless of arguments.
|
||
*
|
||
* @param script - Filename of script to kill. This is case-sensitive.
|
||
* @param host - Hostname of target server.
|
||
* @returns True if one or more scripts were successfully killed, and false if none were.
|
||
*/
|
||
scriptKill(script: string, host: string): boolean;
|
||
|
||
/**
|
||
* Returns the current script name.
|
||
*
|
||
* @remarks RAM cost: 0 GB
|
||
* @returns Current script name.
|
||
*/
|
||
getScriptName(): string;
|
||
|
||
/**
|
||
* Get the ram cost of a script.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* Returns the amount of RAM required to run the specified script on the target server.
|
||
* Returns 0 if the script does not exist.
|
||
*
|
||
* @param script - Filename of script. This is case-sensitive.
|
||
* @param host - Hostname of target server the script is located on. This is optional. If it is not specified then the function will use the current server as the target server.
|
||
* @returns Amount of RAM (in GB) required to run the specified script on the target server, and 0 if the script does not exist.
|
||
*/
|
||
getScriptRam(script: string, host?: string): number;
|
||
|
||
/**
|
||
* Get the execution time of a hack() call.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* When `hack` completes an amount of money is stolen depending on the player's skills.
|
||
* Returns the amount of time in milliseconds it takes to execute the {@link NS.hack | hack} Netscript function on the target server.
|
||
* The required time is increased by the security level of the target server and decreased by the player's hacking level.
|
||
*
|
||
* @param host - Hostname of target server.
|
||
* @returns Returns the amount of time in milliseconds it takes to execute the {@link NS.hack | hack} Netscript function.
|
||
*/
|
||
getHackTime(host: string): number;
|
||
|
||
/**
|
||
* Get the execution time of a grow() call.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server.
|
||
* The required time is increased by the security level of the target server and decreased by the player's hacking level.
|
||
*
|
||
* @param host - Hostname of target server.
|
||
* @returns Returns the amount of time in milliseconds it takes to execute the grow Netscript function.
|
||
*/
|
||
getGrowTime(host: string): number;
|
||
|
||
/**
|
||
* Get the execution time of a weaken() call.
|
||
* @remarks
|
||
* RAM cost: 0.05 GB
|
||
*
|
||
* Returns the amount of time in milliseconds it takes to execute the {@link NS.weaken | weaken} Netscript function on the target server.
|
||
* The required time is increased by the security level of the target server and decreased by the player's hacking level.
|
||
*
|
||
* @param host - Hostname of target server.
|
||
* @returns Returns the amount of time in milliseconds it takes to execute the {@link NS.weaken | weaken} Netscript function.
|
||
*/
|
||
getWeakenTime(host: string): number;
|
||
|
||
/**
|
||
* Get the income of all scripts.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* @returns An array of two values.
|
||
* The first value is the total income (dollar / second) of all of your active scripts
|
||
* (scripts that are currently running on any server).
|
||
* The second value is the total income (dollar / second) that you’ve earned from scripts
|
||
* since you last installed Augmentations.
|
||
*/
|
||
getTotalScriptIncome(): [number, number];
|
||
|
||
/**
|
||
* Get the income of a script.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* Returns the amount of income the specified script generates while online
|
||
* (when the game is open, does not apply for offline income). Remember that
|
||
* a script is uniquely identified by both its name and its arguments. So for
|
||
* example if you ran a script with the arguments “foodnstuff” and “5” then
|
||
* in order to use this function to get that script’s income you must specify
|
||
* those same arguments in the same order in this function call.
|
||
*
|
||
* @param script - Filename of script.
|
||
* @param host - Server on which script is running.
|
||
* @param args - Arguments that the script is running with.
|
||
* @returns Amount of income the specified script generates while online.
|
||
*/
|
||
getScriptIncome(script: string, host: string, ...args: (string | number | boolean)[]): number;
|
||
|
||
/**
|
||
* Get the exp gain of all scripts.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* @returns Total experience gain rate of all of your active scripts.
|
||
*/
|
||
getTotalScriptExpGain(): number;
|
||
|
||
/**
|
||
* Get the exp gain of a script.
|
||
* @remarks
|
||
* RAM cost: 0.1 GB
|
||
*
|
||
* Returns the amount of hacking experience the specified script generates while online
|
||
* (when the game is open, does not apply for offline experience gains). Remember that a
|
||
* script is uniquely identified by both its name and its arguments.
|
||
*
|
||
* This function can also return the total experience gain rate of all of your active
|
||
* scripts by running the function with no arguments.
|
||
*
|
||
* @param script - Filename of script.
|
||
* @param host - Server on which script is running.
|
||
* @param args - Arguments that the script is running with.
|
||
* @returns Amount of hacking experience the specified script generates while online.
|
||
*/
|
||
getScriptExpGain(script: string, host: string, ...args: (string | number | boolean)[]): number;
|
||
|
||
/**
|
||
* Returns the amount of time in milliseconds that have passed since you last installed Augmentations.
|
||
*
|
||
* @remarks RAM cost: 0.05 GB
|
||
* @returns Time in milliseconds that have passed since you last installed Augmentations.
|
||
*/
|
||
getTimeSinceLastAug(): number;
|
||
|
||
/**
|
||
* Format a string.
|
||
*
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* see: https://github.com/alexei/sprintf.js
|
||
* @param format - String to format.
|
||
* @param args - Formatting arguments.
|
||
* @returns Formatted text.
|
||
*/
|
||
sprintf(format: string, ...args: any[]): string;
|
||
|
||
/**
|
||
* Format a string with an array of arguments.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* see: https://github.com/alexei/sprintf.js
|
||
* @param format - String to format.
|
||
* @param args - Formatting arguments.
|
||
* @returns Formatted text.
|
||
*/
|
||
vsprintf(format: string, args: any[]): string;
|
||
|
||
/**
|
||
* Format a number.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Converts a number into a numeric string with the specified format options.
|
||
* This is the same function that the game itself uses to display numbers. The format also depends on the Numeric
|
||
* Display settings (all options on the "Numeric Display" options page)
|
||
* To format ram or percentages, see {@link NS.formatRam | formatRam} and {@link NS.formatPercent | formatPercent}
|
||
*
|
||
* @param n - Number to format.
|
||
* @param fractionalDigits - Number of digits to show in the fractional part of the decimal number. Optional, defaults to 3.
|
||
* @param suffixStart - How high a number must be before a suffix will be added. Optional, defaults to 1000.
|
||
* @param isInteger - Whether the number represents an integer. Integers do not display fractional digits until a suffix is present. Optional, defaults to false.
|
||
* @returns Formatted number.
|
||
*/
|
||
formatNumber(n: number, fractionalDigits?: number, suffixStart?: number, isInteger?: boolean): string;
|
||
|
||
/**
|
||
* Format a number as an amount of ram.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Converts a number into a ram string with the specified number of fractional digits.
|
||
* This is the same function that the game itself uses to display ram. The format also depends on the Numeric Display
|
||
* settings (all options on the "Numeric Display" options page)
|
||
* To format plain numbers or percentages, see {@link NS.formatNumber | formatNumber} and {@link NS.formatPercent | formatPercent}
|
||
*
|
||
* @param n - Number to format as an amount of ram, in base units of GB (or GiB if that Numeric Display option is set).
|
||
* @param fractionalDigits - Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2.
|
||
* @returns Formatted ram amount.
|
||
*/
|
||
formatRam(n: number, fractionalDigits?: number): string;
|
||
|
||
/**
|
||
* Format a number as a percentage.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Converts a number into a percentage string with the specified number of fractional digits.
|
||
* This is the same function that the game itself uses to display percentages. The format also depends on the Numeric
|
||
* Display settings (all options on the "Numeric Display" options page)
|
||
* To format plain numbers or ram, see {@link NS.formatNumber | formatNumber} and {@link NS.formatRam | formatRam}
|
||
*
|
||
* @param n - Number to format as a percentage.
|
||
* @param fractionalDigits - Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2.
|
||
* @param suffixStart - When to switch the percentage to a multiplier. Default is 1e6 or x1.00m.
|
||
* @returns Formatted percentage.
|
||
*/
|
||
formatPercent(n: number, fractionalDigits?: number, multStart?: number): string;
|
||
|
||
/**
|
||
* Format a number using the numeral library. This function is deprecated and will be removed in 2.4.
|
||
* @deprecated Use ns.formatNumber, formatRam, or formatPercent instead. Will be removed in 2.4.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Converts a number into a string with the specified format options.
|
||
* See http://numeraljs.com/#format for documentation on format strings supported.
|
||
*
|
||
* This function is deprecated and will be removed in 2.3.
|
||
*
|
||
* @param n - Number to format.
|
||
* @param format - Formatting options. See http://numeraljs.com/#format for valid formats.
|
||
* @returns Formatted number.
|
||
*/
|
||
nFormat(n: number, format: string): string;
|
||
|
||
/**
|
||
* Format time to a readable string.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @param milliseconds - Number of millisecond to format.
|
||
* @param milliPrecision - Format time with subsecond precision. Defaults to false.
|
||
* @returns The formatted time.
|
||
*/
|
||
tFormat(milliseconds: number, milliPrecision?: boolean): string;
|
||
|
||
/**
|
||
* Prompt the player with an input modal.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Prompts the player with a dialog box. Here is an explanation of the various options.
|
||
*
|
||
* - `options.type` is not provided to the function. If `options.type` is left out and
|
||
* only a string is passed to the function, then the default behavior is to create a
|
||
* boolean dialog box.
|
||
*
|
||
* - `options.type` has value `undefined` or `"boolean"`. A boolean dialog box is
|
||
* created. The player is shown "Yes" and "No" prompts, which return true and false
|
||
* respectively. The script's execution is halted until the player presses either the
|
||
* "Yes" or "No" button.
|
||
*
|
||
* - `options.type` has value `"text"`. The player is given a text field to enter
|
||
* free-form text. The script's execution is halted until the player enters some text
|
||
* and/or presses the "Confirm" button.
|
||
*
|
||
* - `options.type` has value `"select"`. The player is shown a drop-down field.
|
||
* Choosing type `"select"` will require an array to be passed via the
|
||
* `options.choices` property. The array can be an array of strings, an array of
|
||
* numbers (not BigInt numbers), or a mixture of both numbers and strings. Any other
|
||
* types of array elements will result in an error or an undefined/unexpected
|
||
* behavior. The `options.choices` property will be ignored if `options.type` has a
|
||
* value other than `"select"`. The script's execution is halted until the player
|
||
* chooses one of the provided options and presses the "Confirm" button.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* // A Yes/No question. The default is to create a boolean dialog box.
|
||
* const queryA = "Do you enjoy Bitburner?";
|
||
* const resultA = await ns.prompt(queryA);
|
||
* ns.tprint(`${queryA} ${resultA}`);
|
||
*
|
||
* // Another Yes/No question. Can also create a boolean dialog box by explicitly
|
||
* // passing the option {"type": "boolean"}.
|
||
* const queryB = "Is programming fun?";
|
||
* const resultB = await ns.prompt(queryB, { type: "boolean" });
|
||
* ns.tprint(`${queryB} ${resultB}`);
|
||
*
|
||
* // Free-form text box.
|
||
* const resultC = await ns.prompt("Please enter your name.", { type: "text" });
|
||
* ns.tprint(`Hello, ${resultC}.`);
|
||
*
|
||
* // A drop-down list.
|
||
* const resultD = await ns.prompt("Please select your favorite fruit.", {
|
||
* type: "select",
|
||
* choices: ["Apple", "Banana", "Orange", "Pear", "Strawberry"]
|
||
* });
|
||
* ns.tprint(`Your favorite fruit is ${resultD.toLowerCase()}.`);
|
||
* ```
|
||
*
|
||
* @param txt - Text to appear in the prompt dialog box.
|
||
* @param options - Options to modify the prompt the player is shown.
|
||
* @returns True if the player clicks “Yes”; false if the player clicks “No”; or the value entered by the player.
|
||
*/
|
||
prompt(
|
||
txt: string,
|
||
options?: { type?: "boolean" | "text" | "select"; choices?: string[] },
|
||
): Promise<boolean | string>;
|
||
|
||
/**
|
||
* Open up a message box.
|
||
* @param msg - Message to alert.
|
||
*/
|
||
alert(msg: string): void;
|
||
|
||
/**
|
||
* Queue a toast (bottom-right notification).
|
||
* @param msg - Message in the toast.
|
||
* @param variant - Type of toast. Must be one of success, info, warning, error. Defaults to success.
|
||
* @param duration - Duration of toast in ms. Can also be `null` to create a persistent toast. Defaults to 2000.
|
||
*/
|
||
toast(msg: string, variant?: ToastVariant | `${ToastVariant}`, duration?: number | null): void;
|
||
|
||
/**
|
||
* Download a file from the internet.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Retrieves data from a URL and downloads it to a file on the specified server.
|
||
* The data can only be downloaded to a script (.js or .script) or a text file (.txt).
|
||
* If the file already exists, it will be overwritten by this command.
|
||
* Note that it will not be possible to download data from many websites because they
|
||
* do not allow cross-origin resource sharing (CORS).
|
||
*
|
||
* IMPORTANT: This is an asynchronous function that returns a Promise.
|
||
* The Promise’s resolved value will be a boolean indicating whether or not the data was
|
||
* successfully retrieved from the URL. Because the function is async and returns a Promise,
|
||
* it is recommended you use wget in NetscriptJS (Netscript 2.0).
|
||
*
|
||
* In NetscriptJS, you must preface any call to wget with the await keyword (like you would {@link NS.hack | hack} or {@link NS.sleep | sleep}).
|
||
* wget will still work in Netscript 1.0, but the function's execution will not be synchronous
|
||
* (i.e. it may not execute when you expect/want it to).
|
||
* Furthermore, since Promises are not supported in ES5,
|
||
* you will not be able to process the returned value of wget in Netscript 1.0.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* await ns.wget("https://raw.githubusercontent.com/bitburner-official/bitburner-src/master/README.md", "game_readme.txt");
|
||
* ```
|
||
* @param url - URL to pull data from.
|
||
* @param target - Filename to write data to. Must be script or text file.
|
||
* @param host - Optional hostname/ip of server for target file.
|
||
* @returns True if the data was successfully retrieved from the URL, false otherwise.
|
||
*/
|
||
wget(url: string, target: string, host?: string): Promise<boolean>;
|
||
|
||
/**
|
||
* Returns the amount of Faction favor required to be able to donate to a faction.
|
||
*
|
||
* @remarks RAM cost: 0.1 GB
|
||
* @returns Amount of Faction favor required to be able to donate to a faction.
|
||
*/
|
||
getFavorToDonate(): number;
|
||
|
||
/**
|
||
* Get the current Bitnode multipliers.
|
||
* @remarks
|
||
* RAM cost: 4 GB
|
||
*
|
||
* Returns an object containing the current (or supplied) BitNode multipliers.
|
||
* This function requires you to be in Bitnode 5 or have Source-File 5 in order to run.
|
||
* The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%).
|
||
* The multipliers represent the difference between the current BitNode and
|
||
* the original BitNode (BitNode-1).
|
||
*
|
||
* For example, if the CrimeMoney multiplier has a value of 0.1, then that means
|
||
* that committing crimes in the current BitNode will only give 10% of the money
|
||
* you would have received in BitNode-1.
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const mults = ns.getBitNodeMultipliers();
|
||
* ns.tprint(`ServerMaxMoney: ${mults.ServerMaxMoney}`);
|
||
* ns.tprint(`HackExpGain: ${mults.HackExpGain}`);
|
||
* ```
|
||
* @returns Object containing the current BitNode multipliers.
|
||
*/
|
||
getBitNodeMultipliers(n?: number, lvl?: number): BitNodeMultipliers;
|
||
|
||
/**
|
||
* Get information about the player.
|
||
* @remarks
|
||
* RAM cost: 0.5 GB
|
||
*
|
||
* Returns an object with information on the current player.
|
||
*
|
||
* @returns Player info
|
||
*/
|
||
getPlayer(): Player;
|
||
|
||
/**
|
||
* Get information about the sources of income for this run.
|
||
* @remarks
|
||
* RAM cost: 1.0 GB
|
||
*
|
||
* Returns an object with information on the income sources for this run
|
||
*
|
||
* @returns Money sources
|
||
*/
|
||
getMoneySources(): MoneySources;
|
||
|
||
/**
|
||
* Add callback function when the script dies
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* NS2 exclusive
|
||
*
|
||
* Add callback to be executed when the script dies.
|
||
*/
|
||
atExit(f: () => void): void;
|
||
|
||
/**
|
||
* Move a file on the target server.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Move the source file to the specified destination on the target server.
|
||
*
|
||
* This command only works for scripts and text files (.txt). It cannot, however, be used
|
||
* to convert from script to text file, or vice versa.
|
||
*
|
||
* This function can also be used to rename files.
|
||
*
|
||
* @param host - Hostname of target server.
|
||
* @param source - Filename of the source file.
|
||
* @param destination - Filename of the destination file.
|
||
*/
|
||
mv(host: string, source: string, destination: string): void;
|
||
|
||
/** Get information about resets.
|
||
* @remarks
|
||
* RAM cost: 1 GB
|
||
*
|
||
* @example
|
||
* ```js
|
||
* const resetInfo = ns.getResetInfo();
|
||
* const lastAugReset = resetInfo.lastAugReset;
|
||
* ns.tprint(`The last augmentation reset was: ${new Date(lastAugReset)}`);
|
||
* ns.tprint(`It has been ${Date.now() - lastAugReset}ms since the last augmentation reset.`);
|
||
* ```
|
||
* */
|
||
getResetInfo(): ResetInfo;
|
||
|
||
/**
|
||
* Get the ram cost of a netscript function.
|
||
*
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* @param name - The fully-qualified function name, without the leading `ns`. Example inputs: `hack`, `tprint`, `stock.getPosition`.
|
||
*/
|
||
getFunctionRamCost(name: string): number;
|
||
|
||
/**
|
||
* Parse command line flags.
|
||
* @remarks
|
||
* RAM cost: 0 GB
|
||
*
|
||
* Allows Unix-like flag parsing.
|
||
* @example
|
||
* ```js
|
||
* export async function main(ns) {
|
||
* const data = ns.flags([
|
||
* ['delay', 0], // a default number means this flag is a number
|
||
* ['server', 'foodnstuff'], // a default string means this flag is a string
|
||
* ['exclude', []], // a default array means this flag is a default array of string
|
||
* ['help', false], // a default boolean means this flag is a boolean
|
||
* ]);
|
||
* ns.tprint(data);
|
||
* }
|
||
*
|
||
* // [home ~/]> run example.js
|
||
* // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false}
|
||
* // [home ~/]> run example.js --delay 3000
|
||
* // {"_":[],"server":"foodnstuff","exclude":[],"help":false,"delay":3000}
|
||
* // [home ~/]> run example.js --delay 3000 --server harakiri-sushi
|
||
* // {"_":[],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"}
|
||
* // [home ~/]> run example.js --delay 3000 --server harakiri-sushi hello world
|
||
* // {"_":["hello","world"],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"}
|
||
* // [home ~/]> run example.js --delay 3000 --server harakiri-sushi hello world --exclude a --exclude b
|
||
* // {"_":["hello","world"],"help":false,"delay":3000,"server":"harakiri-sushi","exclude":["a","b"]}
|
||
* // [home ~/]> run example.script --help
|
||
* // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true}
|
||
* ```
|
||
*/
|
||
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] };
|
||
|
||
/**
|
||
* Share the server's ram with your factions.
|
||
* @remarks
|
||
* RAM cost: 2.4 GB
|
||
*
|
||
* Increases rep/second for all faction work while share is running. Each cycle of ns.share() is 10 seconds.
|
||
* Scales with thread count, but at a sharply decreasing rate.
|
||
*/
|
||
share(): Promise<void>;
|
||
|
||
/**
|
||
* Share Power has a multiplicative effect on rep/second while doing work for a faction.
|
||
* Share Power increases incrementally for every thread of share running on your server network, but at a sharply decreasing rate.
|
||
* @remarks
|
||
* RAM cost: 0.2 GB
|
||
*/
|
||
getSharePower(): number;
|
||
|
||
enums: NSEnums;
|
||
}
|
||
|
||
// BASE ENUMS
|
||
/** @public */
|
||
declare enum ToastVariant {
|
||
SUCCESS = "success",
|
||
WARNING = "warning",
|
||
ERROR = "error",
|
||
INFO = "info",
|
||
}
|
||
|
||
/** @public */
|
||
declare enum CrimeType {
|
||
shoplift = "Shoplift",
|
||
robStore = "Rob Store",
|
||
mug = "Mug",
|
||
larceny = "Larceny",
|
||
dealDrugs = "Deal Drugs",
|
||
bondForgery = "Bond Forgery",
|
||
traffickArms = "Traffick Arms",
|
||
homicide = "Homicide",
|
||
grandTheftAuto = "Grand Theft Auto",
|
||
kidnap = "Kidnap",
|
||
assassination = "Assassination",
|
||
heist = "Heist",
|
||
}
|
||
|
||
/** @public */
|
||
declare enum FactionWorkType {
|
||
hacking = "hacking",
|
||
field = "field",
|
||
security = "security",
|
||
}
|
||
|
||
/** @public */
|
||
declare enum UniversityClassType {
|
||
computerScience = "Computer Science",
|
||
dataStructures = "Data Structures",
|
||
networks = "Networks",
|
||
algorithms = "Algorithms",
|
||
management = "Management",
|
||
leadership = "Leadership",
|
||
}
|
||
|
||
/** @public */
|
||
declare enum GymType {
|
||
strength = "str",
|
||
defense = "def",
|
||
dexterity = "dex",
|
||
agility = "agi",
|
||
}
|
||
|
||
/** @public */
|
||
declare enum JobName {
|
||
software0 = "Software Engineering Intern",
|
||
software1 = "Junior Software Engineer",
|
||
software2 = "Senior Software Engineer",
|
||
software3 = "Lead Software Developer",
|
||
software4 = "Head of Software",
|
||
software5 = "Head of Engineering",
|
||
software6 = "Vice President of Technology",
|
||
software7 = "Chief Technology Officer",
|
||
IT0 = "IT Intern",
|
||
IT1 = "IT Analyst",
|
||
IT2 = "IT Manager",
|
||
IT3 = "Systems Administrator",
|
||
securityEng = "Security Engineer",
|
||
networkEng0 = "Network Engineer",
|
||
networkEng1 = "Network Administrator",
|
||
business0 = "Business Intern",
|
||
business1 = "Business Analyst",
|
||
business2 = "Business Manager",
|
||
business3 = "Operations Manager",
|
||
business4 = "Chief Financial Officer",
|
||
business5 = "Chief Executive Officer",
|
||
security0 = "Security Guard",
|
||
security1 = "Security Officer",
|
||
security2 = "Security Supervisor",
|
||
security3 = "Head of Security",
|
||
agent0 = "Field Agent",
|
||
agent1 = "Secret Agent",
|
||
agent2 = "Special Operative",
|
||
waiter = "Waiter",
|
||
employee = "Employee",
|
||
softwareConsult0 = "Software Consultant",
|
||
softwareConsult1 = "Senior Software Consultant",
|
||
businessConsult0 = "Business Consultant",
|
||
businessConsult1 = "Senior Business Consultant",
|
||
waiterPT = "Part-time Waiter",
|
||
employeePT = "Part-time Employee",
|
||
}
|
||
|
||
// CORP ENUMS - Changed to types
|
||
/** @public */
|
||
type CorpEmployeePosition =
|
||
| "Operations"
|
||
| "Engineer"
|
||
| "Business"
|
||
| "Management"
|
||
| "Research & Development"
|
||
| "Intern"
|
||
| "Unassigned";
|
||
|
||
/** @public */
|
||
type CorpIndustryName =
|
||
| "Spring Water"
|
||
| "Water Utilities"
|
||
| "Agriculture"
|
||
| "Fishing"
|
||
| "Mining"
|
||
| "Refinery"
|
||
| "Restaurant"
|
||
| "Tobacco"
|
||
| "Chemical"
|
||
| "Pharmaceutical"
|
||
| "Computer Hardware"
|
||
| "Robotics"
|
||
| "Software"
|
||
| "Healthcare"
|
||
| "Real Estate";
|
||
|
||
/** @public */
|
||
type CorpSmartSupplyOption = "leftovers" | "imports" | "none";
|
||
|
||
/** Names of all cities
|
||
* @public */
|
||
declare enum CityName {
|
||
Aevum = "Aevum",
|
||
Chongqing = "Chongqing",
|
||
Sector12 = "Sector-12",
|
||
NewTokyo = "New Tokyo",
|
||
Ishima = "Ishima",
|
||
Volhaven = "Volhaven",
|
||
}
|
||
|
||
/** Names of all locations
|
||
* @public */
|
||
declare enum LocationName {
|
||
AevumAeroCorp = "AeroCorp",
|
||
AevumBachmanAndAssociates = "Bachman & Associates",
|
||
AevumClarkeIncorporated = "Clarke Incorporated",
|
||
AevumCrushFitnessGym = "Crush Fitness Gym",
|
||
AevumECorp = "ECorp",
|
||
AevumFulcrumTechnologies = "Fulcrum Technologies",
|
||
AevumGalacticCybersystems = "Galactic Cybersystems",
|
||
AevumNetLinkTechnologies = "NetLink Technologies",
|
||
AevumPolice = "Aevum Police Headquarters",
|
||
AevumRhoConstruction = "Rho Construction",
|
||
AevumSnapFitnessGym = "Snap Fitness Gym",
|
||
AevumSummitUniversity = "Summit University",
|
||
AevumWatchdogSecurity = "Watchdog Security",
|
||
AevumCasino = "Iker Molina Casino",
|
||
|
||
ChongqingKuaiGongInternational = "KuaiGong International",
|
||
ChongqingSolarisSpaceSystems = "Solaris Space Systems",
|
||
ChongqingChurchOfTheMachineGod = "Church of the Machine God",
|
||
|
||
Sector12AlphaEnterprises = "Alpha Enterprises",
|
||
Sector12BladeIndustries = "Blade Industries",
|
||
Sector12CIA = "Central Intelligence Agency",
|
||
Sector12CarmichaelSecurity = "Carmichael Security",
|
||
Sector12CityHall = "Sector-12 City Hall",
|
||
Sector12DeltaOne = "DeltaOne",
|
||
Sector12FoodNStuff = "FoodNStuff",
|
||
Sector12FourSigma = "Four Sigma",
|
||
Sector12IcarusMicrosystems = "Icarus Microsystems",
|
||
Sector12IronGym = "Iron Gym",
|
||
Sector12JoesGuns = "Joe's Guns",
|
||
Sector12MegaCorp = "MegaCorp",
|
||
Sector12NSA = "National Security Agency",
|
||
Sector12PowerhouseGym = "Powerhouse Gym",
|
||
Sector12RothmanUniversity = "Rothman University",
|
||
Sector12UniversalEnergy = "Universal Energy",
|
||
|
||
NewTokyoDefComm = "DefComm",
|
||
NewTokyoGlobalPharmaceuticals = "Global Pharmaceuticals",
|
||
NewTokyoNoodleBar = "Noodle Bar",
|
||
NewTokyoVitaLife = "VitaLife",
|
||
NewTokyoArcade = "Arcade",
|
||
|
||
IshimaNovaMedical = "Nova Medical",
|
||
IshimaOmegaSoftware = "Omega Software",
|
||
IshimaStormTechnologies = "Storm Technologies",
|
||
IshimaGlitch = "0x6C1",
|
||
|
||
VolhavenCompuTek = "CompuTek",
|
||
VolhavenHeliosLabs = "Helios Labs",
|
||
VolhavenLexoCorp = "LexoCorp",
|
||
VolhavenMilleniumFitnessGym = "Millenium Fitness Gym",
|
||
VolhavenNWO = "NWO",
|
||
VolhavenOmniTekIncorporated = "OmniTek Incorporated",
|
||
VolhavenOmniaCybersystems = "Omnia Cybersystems",
|
||
VolhavenSysCoreSecurities = "SysCore Securities",
|
||
VolhavenZBInstituteOfTechnology = "ZB Institute of Technology",
|
||
|
||
Hospital = "Hospital",
|
||
Slums = "The Slums",
|
||
TravelAgency = "Travel Agency",
|
||
WorldStockExchange = "World Stock Exchange",
|
||
|
||
Void = "The Void",
|
||
}
|
||
|
||
/** Names of all companies
|
||
* @public */
|
||
declare enum CompanyName {
|
||
ECorp = "ECorp",
|
||
MegaCorp = "MegaCorp",
|
||
BachmanAndAssociates = "Bachman & Associates",
|
||
BladeIndustries = "Blade Industries",
|
||
NWO = "NWO",
|
||
ClarkeIncorporated = "Clarke Incorporated",
|
||
OmniTekIncorporated = "OmniTek Incorporated",
|
||
FourSigma = "Four Sigma",
|
||
KuaiGongInternational = "KuaiGong International",
|
||
FulcrumTechnologies = "Fulcrum Technologies",
|
||
StormTechnologies = "Storm Technologies",
|
||
DefComm = "DefComm",
|
||
HeliosLabs = "Helios Labs",
|
||
VitaLife = "VitaLife",
|
||
IcarusMicrosystems = "Icarus Microsystems",
|
||
UniversalEnergy = "Universal Energy",
|
||
GalacticCybersystems = "Galactic Cybersystems",
|
||
AeroCorp = "AeroCorp",
|
||
OmniaCybersystems = "Omnia Cybersystems",
|
||
SolarisSpaceSystems = "Solaris Space Systems",
|
||
DeltaOne = "DeltaOne",
|
||
GlobalPharmaceuticals = "Global Pharmaceuticals",
|
||
NovaMedical = "Nova Medical",
|
||
CIA = "Central Intelligence Agency",
|
||
NSA = "National Security Agency",
|
||
WatchdogSecurity = "Watchdog Security",
|
||
LexoCorp = "LexoCorp",
|
||
RhoConstruction = "Rho Construction",
|
||
AlphaEnterprises = "Alpha Enterprises",
|
||
Police = "Aevum Police Headquarters",
|
||
SysCoreSecurities = "SysCore Securities",
|
||
CompuTek = "CompuTek",
|
||
NetLinkTechnologies = "NetLink Technologies",
|
||
CarmichaelSecurity = "Carmichael Security",
|
||
FoodNStuff = "FoodNStuff",
|
||
JoesGuns = "Joe's Guns",
|
||
OmegaSoftware = "Omega Software",
|
||
NoodleBar = "Noodle Bar",
|
||
}
|
||
|
||
/** @public */
|
||
export type NSEnums = {
|
||
CityName: typeof CityName;
|
||
CrimeType: typeof CrimeType;
|
||
FactionWorkType: typeof FactionWorkType;
|
||
GymType: typeof GymType;
|
||
JobName: typeof JobName;
|
||
LocationName: typeof LocationName;
|
||
ToastVariant: typeof ToastVariant;
|
||
UniversityClassType: typeof UniversityClassType;
|
||
CompanyName: typeof CompanyName;
|
||
};
|
||
|
||
/**
|
||
* Corporation Office API
|
||
* @remarks
|
||
* requires the Office API upgrade from your corporation.
|
||
* @public
|
||
*/
|
||
|
||
export interface OfficeAPI {
|
||
/**
|
||
* Hire an employee.
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param employeePosition - Position to place into. Defaults to "Unassigned".
|
||
* @returns True if an employee was hired, false otherwise
|
||
*/
|
||
hireEmployee(divisionName: string, city: CityName | `${CityName}`, employeePosition?: CorpEmployeePosition): boolean;
|
||
/**
|
||
* Upgrade office size.
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param size - Amount of positions to open
|
||
*/
|
||
upgradeOfficeSize(divisionName: string, city: CityName | `${CityName}`, size: number): void;
|
||
/**
|
||
* Throw a party for your employees
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param costPerEmployee - Amount to spend per employee.
|
||
* @returns Multiplier for morale, or zero on failure
|
||
*/
|
||
throwParty(divisionName: string, city: CityName | `${CityName}`, costPerEmployee: number): number;
|
||
/**
|
||
* Buy tea for your employees
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @returns true if buying tea was successful, false otherwise
|
||
*/
|
||
buyTea(divisionName: string, city: CityName | `${CityName}`): boolean;
|
||
/**
|
||
* Hire AdVert.
|
||
* @param divisionName - Name of the division
|
||
*/
|
||
hireAdVert(divisionName: string): void;
|
||
/**
|
||
* Purchase a research
|
||
* @param divisionName - Name of the division
|
||
* @param researchName - Name of the research
|
||
*/
|
||
research(divisionName: string, researchName: string): void;
|
||
/**
|
||
* Get data about an office
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @returns Office data
|
||
*/
|
||
getOffice(divisionName: string, city: CityName | `${CityName}`): Office;
|
||
/**
|
||
* Get the cost to hire AdVert.
|
||
* @param divisionName - Name of the division.
|
||
* @returns The cost to hire AdVert.
|
||
*/
|
||
getHireAdVertCost(divisionName: string): number;
|
||
/**
|
||
* Get the number of times you have hired AdVert.
|
||
* @param divisionName - Name of the division.
|
||
* @returns Number of times you have hired AdVert.
|
||
*/
|
||
getHireAdVertCount(divisionName: string): number;
|
||
/**
|
||
* Get the cost to unlock research
|
||
* @param divisionName - Name of the division
|
||
* @param researchName - Name of the research
|
||
* @returns cost
|
||
*/
|
||
getResearchCost(divisionName: string, researchName: string): number;
|
||
/**
|
||
* Gets if you have unlocked a research
|
||
* @param divisionName - Name of the division
|
||
* @param researchName - Name of the research
|
||
* @returns true is unlocked, false if not
|
||
*/
|
||
hasResearched(divisionName: string, researchName: string): boolean;
|
||
/**
|
||
* Set the auto job assignment for a job
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param job - Name of the job
|
||
* @param amount - Number of employees to assign to that job
|
||
* @returns true if the employee count reached the target amount, false if not
|
||
*/
|
||
setAutoJobAssignment(divisionName: string, city: CityName | `${CityName}`, job: string, amount: number): boolean;
|
||
/**
|
||
* Cost to Upgrade office size.
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param size - Amount of positions to open
|
||
* @returns Cost of upgrading the office
|
||
*/
|
||
getOfficeSizeUpgradeCost(divisionName: string, city: CityName | `${CityName}`, asize: number): number;
|
||
}
|
||
|
||
/**
|
||
* Corporation Warehouse API
|
||
* @remarks
|
||
* Requires the Warehouse API upgrade from your corporation.
|
||
* @public
|
||
*/
|
||
export interface WarehouseAPI {
|
||
/**
|
||
* Set material sell data.
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param materialName - Name of the material
|
||
* @param amt - Amount to sell, can be "MAX"
|
||
* @param price - Price to sell, can be "MP"
|
||
*/
|
||
sellMaterial(
|
||
divisionName: string,
|
||
city: CityName | `${CityName}`,
|
||
materialName: string,
|
||
amt: string,
|
||
price: string,
|
||
): void;
|
||
/**
|
||
* Set product sell data.
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param productName - Name of the product
|
||
* @param amt - Amount to sell, can be "MAX"
|
||
* @param price - Price to sell, can be "MP"
|
||
* @param all - Sell in all city
|
||
*/
|
||
sellProduct(
|
||
divisionName: string,
|
||
city: CityName | `${CityName}`,
|
||
productName: string,
|
||
amt: string,
|
||
price: string,
|
||
all: boolean,
|
||
): void;
|
||
/**
|
||
* Discontinue a product.
|
||
* @param divisionName - Name of the division
|
||
* @param productName - Name of the product
|
||
*/
|
||
discontinueProduct(divisionName: string, productName: string): void;
|
||
/**
|
||
* Set smart supply
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param enabled - smart supply enabled
|
||
*/
|
||
setSmartSupply(divisionName: string, city: CityName | `${CityName}`, enabled: boolean): void;
|
||
/**
|
||
* Set whether smart supply uses leftovers before buying
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param materialName - Name of the material
|
||
* @param option - smart supply option, "leftovers" to use leftovers, "imports" to use only imported materials, "none" to not use materials from store
|
||
*/
|
||
setSmartSupplyOption(
|
||
divisionName: string,
|
||
city: CityName | `${CityName}`,
|
||
materialName: string,
|
||
option: CorpSmartSupplyOption,
|
||
): void;
|
||
/**
|
||
* Set material buy data
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param materialName - Name of the material
|
||
* @param amt - Amount of material to buy
|
||
*/
|
||
buyMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: string, amt: number): void;
|
||
/**
|
||
* Set material to bulk buy
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param materialName - Name of the material
|
||
* @param amt - Amount of material to buy
|
||
*/
|
||
bulkPurchase(divisionName: string, city: CityName | `${CityName}`, materialName: string, amt: number): void;
|
||
|
||
/** Get warehouse data
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @returns warehouse data */
|
||
getWarehouse(divisionName: string, city: CityName | `${CityName}`): Warehouse;
|
||
|
||
/** Get product data
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param productName - Name of the product
|
||
* @returns product data */
|
||
getProduct(divisionName: string, cityName: CityName | `${CityName}`, productName: string): Product;
|
||
/**
|
||
* Get material data
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param materialName - Name of the material
|
||
* @returns material data
|
||
*/
|
||
getMaterial(divisionName: string, city: CityName | `${CityName}`, materialName: string): Material;
|
||
/**
|
||
* Set market TA 1 for a material.
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param materialName - Name of the material
|
||
* @param on - market ta enabled
|
||
*/
|
||
setMaterialMarketTA1(divisionName: string, city: CityName | `${CityName}`, materialName: string, on: boolean): void;
|
||
/**
|
||
* Set market TA 2 for a material.
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param materialName - Name of the material
|
||
* @param on - market ta enabled
|
||
*/
|
||
setMaterialMarketTA2(divisionName: string, city: CityName | `${CityName}`, materialName: string, on: boolean): void;
|
||
|
||
/** * Set market TA 1 for a product.
|
||
* @param divisionName - Name of the division
|
||
* @param productName - Name of the product
|
||
* @param on - market ta enabled */
|
||
setProductMarketTA1(divisionName: string, productName: string, on: boolean): void;
|
||
|
||
/** Set market TA 2 for a product.
|
||
* @param divisionName - Name of the division
|
||
* @param productName - Name of the product
|
||
* @param on - market ta enabled */
|
||
setProductMarketTA2(divisionName: string, productName: string, on: boolean): void;
|
||
/**
|
||
* Set material export data
|
||
* @param sourceDivision - Source division
|
||
* @param sourceCity - Source city
|
||
* @param targetDivision - Target division
|
||
* @param targetCity - Target city
|
||
* @param materialName - Name of the material
|
||
* @param amt - Amount of material to export.
|
||
*/
|
||
exportMaterial(
|
||
sourceDivision: string,
|
||
sourceCity: CityName | `${CityName}`,
|
||
targetDivision: string,
|
||
targetCity: CityName | `${CityName}`,
|
||
materialName: string,
|
||
amt: number | string,
|
||
): void;
|
||
/**
|
||
* Cancel material export
|
||
* @param sourceDivision - Source division
|
||
* @param sourceCity - Source city
|
||
* @param targetDivision - Target division
|
||
* @param targetCity - Target city
|
||
* @param materialName - Name of the material
|
||
*/
|
||
cancelExportMaterial(
|
||
sourceDivision: string,
|
||
sourceCity: CityName | `${CityName}`,
|
||
targetDivision: string,
|
||
targetCity: CityName | `${CityName}`,
|
||
materialName: string,
|
||
): void;
|
||
/**
|
||
* Purchase warehouse for a new city
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
*/
|
||
purchaseWarehouse(divisionName: string, city: CityName | `${CityName}`): void;
|
||
/**
|
||
* Upgrade warehouse
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param amt - amount of upgrades defaults to 1
|
||
*/
|
||
upgradeWarehouse(divisionName: string, city: CityName | `${CityName}`, amt?: number): void;
|
||
/**
|
||
* Create a new product
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param productName - Name of the product
|
||
* @param designInvest - Amount to invest for the design of the product.
|
||
* @param marketingInvest - Amount to invest for the marketing of the product.
|
||
*/
|
||
makeProduct(
|
||
divisionName: string,
|
||
city: CityName | `${CityName}`,
|
||
productName: string,
|
||
designInvest: number,
|
||
marketingInvest: number,
|
||
): void;
|
||
/**
|
||
* Limit Material Production.
|
||
* @param divisionName - Name of the division.
|
||
* @param city - Name of the city.
|
||
* @param materialName - Name of the material.
|
||
* @param qty - Amount to limit to. Pass a negative value to remove the limit instead.
|
||
*/
|
||
limitMaterialProduction(
|
||
divisionName: string,
|
||
city: CityName | `${CityName}`,
|
||
materialName: string,
|
||
qty: number,
|
||
): void;
|
||
/**
|
||
* Limit Product Production.
|
||
* @param divisionName - Name of the division.
|
||
* @param city - Name of the city.
|
||
* @param productName - Name of the product.
|
||
* @param qty - Amount to limit to. Pass a negative value to remove the limit instead.
|
||
*/
|
||
limitProductProduction(divisionName: string, city: CityName | `${CityName}`, productName: string, qty: number): void;
|
||
/**
|
||
* Gets the cost to upgrade a warehouse to the next level
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city
|
||
* @param amt - amount of upgrades. Optional, defaults to 1
|
||
* @returns cost to upgrade
|
||
*/
|
||
getUpgradeWarehouseCost(divisionName: string, city: CityName | `${CityName}`, amt?: number): number;
|
||
/**
|
||
* Check if you have a warehouse in city
|
||
* @returns true if warehouse is present, false if not
|
||
*/
|
||
hasWarehouse(divisionName: string, city: CityName | `${CityName}`): boolean;
|
||
}
|
||
|
||
/**
|
||
* Corporation API
|
||
* @public
|
||
*/
|
||
export interface Corporation extends WarehouseAPI, OfficeAPI {
|
||
/** Returns whether the player has a corporation. Does not require API access.
|
||
* @returns whether the player has a corporation */
|
||
hasCorporation(): boolean;
|
||
|
||
/** Create a Corporation
|
||
* @param corporationName - Name of the corporation
|
||
* @param selfFund - If you should self fund, defaults to true, false will only work on Bitnode 3
|
||
* @returns true if created and false if not */
|
||
createCorporation(corporationName: string, selfFund: boolean): boolean;
|
||
|
||
/** Check if you have a one time unlockable upgrade
|
||
* @param upgradeName - Name of the upgrade
|
||
* @returns true if unlocked and false if not */
|
||
hasUnlock(upgradeName: string): boolean;
|
||
|
||
/** Gets the cost to unlock a one time unlockable upgrade
|
||
* @param upgradeName - Name of the upgrade
|
||
* @returns cost of the upgrade */
|
||
getUnlockCost(upgradeName: string): number;
|
||
|
||
/** Get the level of a levelable upgrade
|
||
* @param upgradeName - Name of the upgrade
|
||
* @returns the level of the upgrade */
|
||
getUpgradeLevel(upgradeName: string): number;
|
||
|
||
/** Gets the cost to unlock the next level of a levelable upgrade
|
||
* @param upgradeName - Name of the upgrade
|
||
* @returns cost of the upgrade */
|
||
getUpgradeLevelCost(upgradeName: string): number;
|
||
|
||
/** Get an offer for investment based on you companies current valuation
|
||
* @returns An offer of investment */
|
||
getInvestmentOffer(): InvestmentOffer;
|
||
|
||
/** Get corporation related constants
|
||
* @returns corporation related constants */
|
||
getConstants(): CorpConstants;
|
||
|
||
/** Get constant industry definition data for a specific industry */
|
||
getIndustryData(industryName: CorpIndustryName): CorpIndustryData;
|
||
|
||
/** Get constant data for a specific material */
|
||
getMaterialData(materialName: CorpMaterialName): CorpMaterialConstantData;
|
||
|
||
/** Accept investment based on you companies current valuation
|
||
* @remarks
|
||
* Is based on current valuation and will not honer a specific Offer
|
||
* @returns An offer of investment */
|
||
acceptInvestmentOffer(): boolean;
|
||
|
||
/** Go public
|
||
* @param numShares - number of shares you would like to issue for your IPO
|
||
* @returns true if you successfully go public, false if not */
|
||
goPublic(numShares: number): boolean;
|
||
|
||
/** Bribe a faction
|
||
* @param factionName - Faction name
|
||
* @param amountCash - Amount of money to bribe
|
||
* @returns True if successful, false if not */
|
||
bribe(factionName: string, amountCash: number): boolean;
|
||
|
||
/** Get corporation data
|
||
* @returns Corporation data */
|
||
getCorporation(): CorporationInfo;
|
||
|
||
/** Get division data
|
||
* @param divisionName - Name of the division
|
||
* @returns Division data */
|
||
getDivision(divisionName: string): Division;
|
||
|
||
/** Expand to a new industry
|
||
* @param industryType - Name of the industry
|
||
* @param divisionName - Name of the division */
|
||
expandIndustry(industryType: CorpIndustryName, divisionName: string): void;
|
||
|
||
/** Expand to a new city
|
||
* @param divisionName - Name of the division
|
||
* @param city - Name of the city */
|
||
expandCity(divisionName: string, city: CityName | `${CityName}`): void;
|
||
|
||
/** Unlock an upgrade
|
||
* @param upgradeName - Name of the upgrade */
|
||
purchaseUnlock(upgradeName: string): void;
|
||
|
||
/** Level an upgrade.
|
||
* @param upgradeName - Name of the upgrade */
|
||
levelUpgrade(upgradeName: string): void;
|
||
|
||
/** Issue dividends
|
||
* @param rate - Fraction of profit to issue as dividends. */
|
||
issueDividends(rate: number): void;
|
||
|
||
/** Issue new shares
|
||
* @param amount - Number of new shares to issue, will be rounded to nearest 10m. Defaults to max amount.
|
||
* @returns Amount of funds generated for the corporation. */
|
||
issueNewShares(amount?: number): number;
|
||
|
||
/** Buyback Shares
|
||
* @param amount - Amount of shares to buy back, must be integer and larger than 0 */
|
||
buyBackShares(amount: number): void;
|
||
|
||
/** Sell Shares
|
||
* @param amount - Amount of shares to sell, must be integer between 1 and 100t */
|
||
sellShares(amount: number): void;
|
||
|
||
/** Get bonus time.
|
||
* “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
|
||
* “Bonus time” makes the game progress faster.
|
||
* @returns Bonus time for the Corporation mechanic in milliseconds. */
|
||
getBonusTime(): number;
|
||
}
|
||
|
||
/** Product rating information
|
||
* @public */
|
||
interface CorpProductData {
|
||
/** Name of the product */
|
||
name: string;
|
||
/** Verb used to describe creation of the product */
|
||
verb: string;
|
||
/** Description of product creation */
|
||
desc: string;
|
||
/** Weighting factors for product */
|
||
ratingWeights: {
|
||
aesthetics?: number;
|
||
durability?: number;
|
||
features?: number;
|
||
quality?: number;
|
||
performance?: number;
|
||
reliability?: number;
|
||
};
|
||
}
|
||
|
||
/** Data for an individual industry
|
||
* @public */
|
||
interface CorpIndustryData {
|
||
startingCost: number;
|
||
description: string;
|
||
product?: CorpProductData;
|
||
recommendStarting: boolean;
|
||
requiredMaterials: Partial<Record<CorpMaterialName, number>>;
|
||
/** Real estate factor */
|
||
realEstateFactor?: number;
|
||
/** Scientific research factor (affects quality) */
|
||
scienceFactor?: number;
|
||
/** Hardware factor */
|
||
hardwareFactor?: number;
|
||
/** Robots factor */
|
||
robotFactor?: number;
|
||
/** AI Cores factor */
|
||
aiCoreFactor?: number;
|
||
/** Advertising factor (affects sales) */
|
||
advertisingFactor?: number;
|
||
producedMaterials?: CorpMaterialName[];
|
||
}
|
||
|
||
/**
|
||
* General info about a corporation
|
||
* @public
|
||
*/
|
||
interface CorporationInfo {
|
||
/** Name of the corporation */
|
||
name: string;
|
||
/** Funds available */
|
||
funds: number;
|
||
/** Revenue per second this cycle */
|
||
revenue: number;
|
||
/** Expenses per second this cycle */
|
||
expenses: number;
|
||
/** Indicating if the company is public */
|
||
public: boolean;
|
||
/** Total number of shares issues by this corporation */
|
||
totalShares: number;
|
||
/** Amount of share owned */
|
||
numShares: number;
|
||
/** Cooldown until shares can be sold again */
|
||
shareSaleCooldown: number;
|
||
/** Amount of acquirable shares. */
|
||
issuedShares: number;
|
||
/** Price of the shares */
|
||
sharePrice: number;
|
||
/** Fraction of profits issued as dividends */
|
||
dividendRate: number;
|
||
/** Tax applied on your earnings as a shareholder */
|
||
dividendTax: number;
|
||
/** Your earnings as a shareholder per second this cycle */
|
||
dividendEarnings: number;
|
||
/** State of the corporation. Possible states are START, PURCHASE, PRODUCTION, EXPORT, SALE. */
|
||
state: string;
|
||
/** Array of all division names */
|
||
divisions: string[];
|
||
}
|
||
|
||
/**
|
||
* Corporation related constants
|
||
* @public
|
||
*/
|
||
interface CorpConstants {
|
||
/** Names of all corporation game states */
|
||
stateNames: CorpStateName[];
|
||
/** Names of all employee positions */
|
||
employeePositions: CorpEmployeePosition[];
|
||
/** Names of all industries */
|
||
industryNames: CorpIndustryName[];
|
||
/** Names of all materials */
|
||
materialNames: CorpMaterialName[];
|
||
/** Names of all one-time corporation-wide unlocks */
|
||
unlockNames: CorpUnlockName[];
|
||
/** Names of all corporation-wide upgrades */
|
||
upgradeNames: CorpUpgradeName[];
|
||
/** Names of all researches common to all industries */
|
||
researchNamesBase: CorpResearchName[];
|
||
/** Names of all researches only available to product industries */
|
||
researchNamesProductOnly: CorpResearchName[];
|
||
/** Names of all researches */
|
||
researchNames: CorpResearchName[];
|
||
initialShares: number;
|
||
/** When selling large number of shares, price is dynamically updated for every batch of this amount */
|
||
sharesPerPriceUpdate: number;
|
||
/** Cooldown for issue new shares cooldown in game cycles (1 game cycle = 200ms) */
|
||
issueNewSharesCooldown: number;
|
||
/** Cooldown for selling shares in game cycles (1 game cycle = 200ms) */
|
||
sellSharesCooldown: number;
|
||
teaCostPerEmployee: number;
|
||
gameCyclesPerMarketCycle: number;
|
||
gameCyclesPerCorpStateCycle: number;
|
||
secondsPerMarketCycle: number;
|
||
warehouseInitialCost: number;
|
||
warehouseInitialSize: number;
|
||
warehouseSizeUpgradeCostBase: number;
|
||
officeInitialCost: number;
|
||
officeInitialSize: number;
|
||
officeSizeUpgradeCostBase: number;
|
||
bribeThreshold: number;
|
||
bribeAmountPerReputation: number;
|
||
baseProductProfitMult: number;
|
||
dividendMaxRate: number;
|
||
/** Conversion factor for employee stats to initial salary */
|
||
employeeSalaryMultiplier: number;
|
||
marketCyclesPerEmployeeRaise: number;
|
||
employeeRaiseAmount: number;
|
||
/** Max products for a division without upgrades */
|
||
maxProductsBase: number;
|
||
/** The minimum decay value for morale/energy */
|
||
minEmployeeDecay: number;
|
||
smartSupplyOptions: CorpSmartSupplyOption[];
|
||
}
|
||
/** @public */
|
||
type CorpStateName = "START" | "PURCHASE" | "PRODUCTION" | "EXPORT" | "SALE";
|
||
|
||
/** @public */
|
||
type CorpMaterialName =
|
||
| "Minerals"
|
||
| "Ore"
|
||
| "Water"
|
||
| "Food"
|
||
| "Plants"
|
||
| "Metal"
|
||
| "Hardware"
|
||
| "Chemicals"
|
||
| "Drugs"
|
||
| "Robots"
|
||
| "AI Cores"
|
||
| "Real Estate";
|
||
|
||
/** @public */
|
||
type CorpUnlockName =
|
||
| "Export"
|
||
| "Smart Supply"
|
||
| "Market Research - Demand"
|
||
| "Market Data - Competition"
|
||
| "VeChain"
|
||
| "Shady Accounting"
|
||
| "Government Partnership"
|
||
| "Warehouse API"
|
||
| "Office API";
|
||
|
||
/** @public */
|
||
type CorpUpgradeName =
|
||
| "Smart Factories"
|
||
| "Smart Storage"
|
||
| "DreamSense"
|
||
| "Wilson Analytics"
|
||
| "Nuoptimal Nootropic Injector Implants"
|
||
| "Speech Processor Implants"
|
||
| "Neural Accelerators"
|
||
| "FocusWires"
|
||
| "ABC SalesBots"
|
||
| "Project Insight";
|
||
|
||
/** @public */
|
||
type CorpResearchName =
|
||
| "Hi-Tech R&D Laboratory"
|
||
| "AutoBrew"
|
||
| "AutoPartyManager"
|
||
| "Automatic Drug Administration"
|
||
| "CPH4 Injections"
|
||
| "Drones"
|
||
| "Drones - Assembly"
|
||
| "Drones - Transport"
|
||
| "Go-Juice"
|
||
| "HRBuddy-Recruitment"
|
||
| "HRBuddy-Training"
|
||
| "Market-TA.I"
|
||
| "Market-TA.II"
|
||
| "Overclock"
|
||
| "Self-Correcting Assemblers"
|
||
| "Sti.mu"
|
||
| "uPgrade: Capacity.I"
|
||
| "uPgrade: Capacity.II"
|
||
| "uPgrade: Dashboard"
|
||
| "uPgrade: Fulcrum"
|
||
| "sudo.Assist";
|
||
|
||
/**
|
||
* Corporation material information
|
||
* @public
|
||
*/
|
||
interface CorpMaterialConstantData {
|
||
/** Name of the material */
|
||
name: string;
|
||
/** Size of the material */
|
||
size: number;
|
||
demandBase: number;
|
||
/** Min and max demand */
|
||
demandRange: [min: number, max: number];
|
||
competitionBase: number;
|
||
competitionRange: [min: number, max: number];
|
||
baseCost: number;
|
||
maxVolatility: number;
|
||
baseMarkup: number;
|
||
}
|
||
|
||
/**
|
||
* Corporation industry information
|
||
* @public
|
||
*/
|
||
interface IndustryData {
|
||
/** Industry type */
|
||
type: CorpIndustryName;
|
||
/** Cost to make a new division of this industry type */
|
||
cost: number;
|
||
/** Materials required for production and their amounts */
|
||
requiredMaterials: Record<string, number>;
|
||
/** Materials produced */
|
||
producedMaterials?: string[];
|
||
/** Whether the division makes materials */
|
||
makesMaterials: boolean;
|
||
/** Whether the division makes products */
|
||
makesProducts: boolean;
|
||
/** Product type */
|
||
productType?: string;
|
||
}
|
||
|
||
/**
|
||
* Product in a warehouse
|
||
* @public
|
||
*/
|
||
interface Product {
|
||
/** Name of the product */
|
||
name: string;
|
||
/** Demand for the product, only present if "Market Research - Demand" unlocked */
|
||
demand: number | undefined;
|
||
/** Competition for the product, only present if "Market Research - Competition" unlocked */
|
||
competition: number | undefined;
|
||
/** Rating based on stats */
|
||
rating: number;
|
||
/** Effective rating in the specific city */
|
||
effectiveRating: number;
|
||
/** Product stats */
|
||
stats: {
|
||
quality: number;
|
||
performance: number;
|
||
durability: number;
|
||
reliability: number;
|
||
aesthetics: number;
|
||
features: number;
|
||
};
|
||
/** Production cost */
|
||
productionCost: number;
|
||
/** Desired sell price, can be "MP+5" */
|
||
desiredSellPrice: string | number;
|
||
/** Desired sell amount, e.g. "PROD/2" */
|
||
desiredSellAmount: string | number;
|
||
/** Amount of product stored in warehouse*/
|
||
stored: number;
|
||
/** Amount of product produced last cycle */
|
||
productionAmount: number;
|
||
/** Amount of product sold last cycle */
|
||
actualSellAmount: number;
|
||
/** A number between 0-100 representing percentage completion */
|
||
developmentProgress: number;
|
||
/** Funds that were spent on advertising the product */
|
||
advertisingInvestment: number;
|
||
/** Funds that were spent on designing the product */
|
||
designInvestment: number;
|
||
}
|
||
|
||
/**
|
||
* Material in a warehouse
|
||
* @public
|
||
*/
|
||
interface Material {
|
||
/** Name of the material */
|
||
name: CorpMaterialName;
|
||
/** Amount of material */
|
||
stored: number;
|
||
/** Quality of the material */
|
||
quality: number;
|
||
/** Demand for the material, only present if "Market Research - Demand" unlocked */
|
||
demand: number | undefined;
|
||
/** Competition for the material, only present if "Market Research - Competition" unlocked */
|
||
competition: number | undefined;
|
||
/** Amount of material produced last cycle */
|
||
productionAmount: number;
|
||
/** Amount of material sold last cycle */
|
||
actualSellAmount: number;
|
||
/** Cost to buy material */
|
||
marketPrice: number;
|
||
/** Sell cost, can be "MP+5" */
|
||
desiredSellPrice: string | number;
|
||
/** Sell amount, can be "PROD/2" */
|
||
desiredSellAmount: string | number;
|
||
/** Export orders */
|
||
exports: Export[];
|
||
}
|
||
|
||
/**
|
||
* Export order for a material
|
||
* @public
|
||
*/
|
||
interface Export {
|
||
/** Division the material is being exported to */
|
||
division: string;
|
||
/** City the material is being exported to */
|
||
city: CityName;
|
||
/** Amount of material exported */
|
||
amount: string;
|
||
}
|
||
|
||
/**
|
||
* Warehouse for a division in a city
|
||
* @public
|
||
*/
|
||
interface Warehouse {
|
||
/** Amount of size upgrade bought */
|
||
level: number;
|
||
/** City in which the warehouse is located */
|
||
city: CityName;
|
||
/** Total space in the warehouse */
|
||
size: number;
|
||
/** Used space in the warehouse */
|
||
sizeUsed: number;
|
||
/** Smart Supply status in the warehouse */
|
||
smartSupplyEnabled: boolean;
|
||
}
|
||
|
||
/**
|
||
* Office for a division in a city.
|
||
* @public
|
||
*/
|
||
export interface Office {
|
||
/** City of the office */
|
||
city: CityName;
|
||
/** Maximum number of employee */
|
||
size: number;
|
||
/** Maximum amount of energy of the employees */
|
||
maxEnergy: number;
|
||
/** Maximum morale of the employees */
|
||
maxMorale: number;
|
||
/** Amount of employees */
|
||
numEmployees: number;
|
||
/** Average energy of the employees */
|
||
avgEnergy: number;
|
||
/** Average morale of the employees */
|
||
avgMorale: number;
|
||
/** Total experience of all employees */
|
||
totalExperience: number;
|
||
/** Production of the employees */
|
||
employeeProductionByJob: Record<CorpEmployeePosition, number>;
|
||
/** Positions of the employees */
|
||
employeeJobs: Record<CorpEmployeePosition, number>;
|
||
}
|
||
|
||
/**
|
||
* Corporation division
|
||
* @public
|
||
*/
|
||
interface Division {
|
||
/** Name of the division */
|
||
name: string;
|
||
/** Type of division, like Agriculture */
|
||
type: CorpIndustryName;
|
||
/** Awareness of the division */
|
||
awareness: number;
|
||
/** Popularity of the division */
|
||
popularity: number;
|
||
/** Production multiplier */
|
||
productionMult: number;
|
||
/** Amount of research in that division */
|
||
researchPoints: number;
|
||
/** Revenue last cycle */
|
||
lastCycleRevenue: number;
|
||
/** Expenses last cycle */
|
||
lastCycleExpenses: number;
|
||
/** Revenue this cycle */
|
||
thisCycleRevenue: number;
|
||
/** Expenses this cycle */
|
||
thisCycleExpenses: number;
|
||
/** Number of times AdVert has been bought */
|
||
numAdVerts: number;
|
||
/** Cities in which this division has expanded */
|
||
cities: CityName[];
|
||
/** Names of Products developed by this division */
|
||
products: string[];
|
||
/** Whether the industry this division is in is capable of making products */
|
||
makesProducts: boolean;
|
||
/** How many products this division can support */
|
||
maxProducts: number;
|
||
}
|
||
|
||
/**
|
||
* Corporation investment offer
|
||
* @public
|
||
*/
|
||
interface InvestmentOffer {
|
||
/** Amount of funds you will get from this investment */
|
||
funds: number;
|
||
/** Amount of share you will give in exchange for this investment */
|
||
shares: number;
|
||
/** Current round of funding (max 4) */
|
||
round: number;
|
||
}
|
||
|
||
/**
|
||
* Interface Theme
|
||
* @public
|
||
*/
|
||
interface UserInterfaceTheme {
|
||
[key: string]: string | undefined;
|
||
primarylight: string;
|
||
primary: string;
|
||
primarydark: string;
|
||
successlight: string;
|
||
success: string;
|
||
successdark: string;
|
||
errorlight: string;
|
||
error: string;
|
||
errordark: string;
|
||
secondarylight: string;
|
||
secondary: string;
|
||
secondarydark: string;
|
||
warninglight: string;
|
||
warning: string;
|
||
warningdark: string;
|
||
infolight: string;
|
||
info: string;
|
||
infodark: string;
|
||
welllight: string;
|
||
well: string;
|
||
white: string;
|
||
black: string;
|
||
hp: string;
|
||
money: string;
|
||
hack: string;
|
||
combat: string;
|
||
cha: string;
|
||
int: string;
|
||
rep: string;
|
||
disabled: string;
|
||
backgroundprimary: string;
|
||
backgroundsecondary: string;
|
||
button: string;
|
||
}
|
||
|
||
/**
|
||
* Interface Styles
|
||
* @public
|
||
*/
|
||
interface IStyleSettings {
|
||
fontFamily: string;
|
||
lineHeight: number;
|
||
}
|
||
|
||
/**
|
||
* Game Information
|
||
* @public
|
||
*/
|
||
interface GameInfo {
|
||
version: string;
|
||
commit: string;
|
||
platform: string;
|
||
}
|
||
|
||
/**
|
||
* Used for autocompletion
|
||
* @public
|
||
*/
|
||
interface AutocompleteData {
|
||
servers: string[];
|
||
scripts: string[];
|
||
txts: string[];
|
||
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] };
|
||
}
|