diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts index 483ebf0d4..2819851e0 100644 --- a/dist/bitburner.d.ts +++ b/dist/bitburner.d.ts @@ -2124,6 +2124,27 @@ export declare interface NodeStats { /** * Collection of all functions passed to scripts * @public + * @remarks + * Basic ns1 usage example: + * ```ts + * // Basic ns functions can be used directly + * methodName(); + * // Some related functions are gathered within a common namespace + * property.methodName(); + * ``` + * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html| ns1 in-game docs} + *
+ * Basic ns2 usage example: + * ```ts + * export async function main(ns) { + * // Basic ns functions can be accessed on the ns object + * await ns.methodName; + * // Some related functions are gathered under a sub-property of the ns object + * await ns.property.methodName; + * } + * ``` + * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html| ns2 in-game docs} + *
*/ export declare interface NS extends Singularity { /** @@ -2321,9 +2342,9 @@ export declare interface NS extends Singularity { * * @example * ```ts - * //For example, assume the following returns 1: + * //For example, assume the following returns 0.01: * hackAnalyze("foodnstuff"); - * //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N% of its total money. + * //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N*0.01% of its total money. * ``` * @param host - Hostname of the target server. * @returns The percentage of money you will steal from the target server with a single hack. @@ -3259,13 +3280,12 @@ export declare interface NS extends Singularity { deleteServer(host: string): boolean; /** - * Returns an array with either the hostnames or IPs of all of the servers you have purchased. + * Returns an array with the hostnames of all of the servers you have purchased. * * @remarks 2.25 GB - * @param hostnameMode - Optional. Defaults to true. Returns hostnames if true, and IPs if false. - * @returns Returns an array with either the hostnames or IPs of all of the servers you have purchased. + * @returns Returns an array with the hostnames of all of the servers you have purchased. */ - getPurchasedServers(hostnameMode?: boolean): string[]; + getPurchasedServers(): string[]; /** * Returns the maximum number of servers you can purchase. diff --git a/input/bitburner.api.json b/input/bitburner.api.json index a508c9761..fed345ce6 100644 --- a/input/bitburner.api.json +++ b/input/bitburner.api.json @@ -14221,7 +14221,7 @@ { "kind": "Interface", "canonicalReference": "bitburner!NS:interface", - "docComment": "/**\n * Collection of all functions passed to scripts\n *\n * @public\n */\n", + "docComment": "/**\n * Collection of all functions passed to scripts\n *\n * @remarks\n *\n * Basic ns1 usage example:\n * ```ts\n * // Basic ns functions can be used directly\n * methodName();\n * // Some related functions are gathered within a common namespace\n * property.methodName();\n * ```\n *\n * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html | ns1 in-game docs}
Basic ns2 usage example:\n * ```ts\n * export async function main(ns) {\n * // Basic ns functions can be accessed on the ns object\n * await ns.methodName;\n * // Some related functions are gathered under a sub-property of the ns object\n * await ns.property.methodName;\n * }\n * ```\n *\n * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html | ns2 in-game docs}
\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", @@ -15562,19 +15562,11 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#getPurchasedServers:member(1)", - "docComment": "/**\n * Returns an array with either the hostnames or IPs of all of the servers you have purchased.\n *\n * @remarks\n *\n * 2.25 GB\n *\n * @param hostnameMode - Optional. Defaults to true. Returns hostnames if true, and IPs if false.\n *\n * @returns Returns an array with either the hostnames or IPs of all of the servers you have purchased.\n */\n", + "docComment": "/**\n * Returns an array with the hostnames of all of the servers you have purchased.\n *\n * @remarks\n *\n * 2.25 GB\n *\n * @returns Returns an array with the hostnames of all of the servers you have purchased.\n */\n", "excerptTokens": [ { "kind": "Content", - "text": "getPurchasedServers(hostnameMode?: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": "): " + "text": "getPurchasedServers(): " }, { "kind": "Content", @@ -15587,20 +15579,12 @@ ], "isOptional": false, "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 + "startIndex": 1, + "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, - "parameters": [ - { - "parameterName": "hostnameMode", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], + "parameters": [], "name": "getPurchasedServers" }, { @@ -16839,7 +16823,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!NS#hackAnalyze:member(1)", - "docComment": "/**\n * Get the percent of money stolen with a single thread.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Returns the percentage of the specified server’s money you will steal with a single hack. This value is returned in percentage form, not decimal (Netscript functions typically return in decimal form, but not this one).\n *\n * @param host - Hostname of the target server.\n *\n * @returns The percentage of money you will steal from the target server with a single hack.\n *\n * @example\n * ```ts\n * //For example, assume the following returns 1:\n * hackAnalyze(\"foodnstuff\");\n * //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N% of its total money.\n * ```\n *\n */\n", + "docComment": "/**\n * Get the percent of money stolen with a single thread.\n *\n * @remarks\n *\n * RAM cost: 1 GB\n *\n * Returns the percentage of the specified server’s money you will steal with a single hack. This value is returned in percentage form, not decimal (Netscript functions typically return in decimal form, but not this one).\n *\n * @param host - Hostname of the target server.\n *\n * @returns The percentage of money you will steal from the target server with a single hack.\n *\n * @example\n * ```ts\n * //For example, assume the following returns 0.01:\n * hackAnalyze(\"foodnstuff\");\n * //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N*0.01% of its total money.\n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/markdown/bitburner.ns.getpurchasedservers.md b/markdown/bitburner.ns.getpurchasedservers.md index 757cf6f9e..3117ef93c 100644 --- a/markdown/bitburner.ns.getpurchasedservers.md +++ b/markdown/bitburner.ns.getpurchasedservers.md @@ -4,25 +4,18 @@ ## NS.getPurchasedServers() method -Returns an array with either the hostnames or IPs of all of the servers you have purchased. +Returns an array with the hostnames of all of the servers you have purchased. Signature: ```typescript -getPurchasedServers(hostnameMode?: boolean): string[]; +getPurchasedServers(): string[]; ``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| hostnameMode | boolean | Optional. Defaults to true. Returns hostnames if true, and IPs if false. | - Returns: string\[\] -Returns an array with either the hostnames or IPs of all of the servers you have purchased. +Returns an array with the hostnames of all of the servers you have purchased. ## Remarks diff --git a/markdown/bitburner.ns.getweakentime.md b/markdown/bitburner.ns.getweakentime.md index 1fe6e825d..8b0d8d911 100644 --- a/markdown/bitburner.ns.getweakentime.md +++ b/markdown/bitburner.ns.getweakentime.md @@ -22,7 +22,7 @@ getWeakenTime(host: string): number; number -Returns the amount of time in milliseconds it takes to execute the weaken Netscript function. Returns Infinity if called on a Hacknet Server. +Returns the amount of time in milliseconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. ## Remarks diff --git a/markdown/bitburner.ns.hackanalyze.md b/markdown/bitburner.ns.hackanalyze.md index 20ac97c46..74d04c5f7 100644 --- a/markdown/bitburner.ns.hackanalyze.md +++ b/markdown/bitburner.ns.hackanalyze.md @@ -34,8 +34,8 @@ Returns the percentage of the specified server’s money you will steal with a s ```ts -//For example, assume the following returns 1: +//For example, assume the following returns 0.01: hackAnalyze("foodnstuff"); -//This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N% of its total money. +//This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N*0.01% of its total money. ``` diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index 48240f8c9..a3847b1a1 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -9,125 +9,149 @@ Collection of all functions passed to scripts Signature: ```typescript -export interface NS extends Singularity +export interface NS extends Singularity ``` + Extends: [Singularity](./bitburner.singularity.md) +## Remarks + +Basic ns1 usage example: + +```ts +// Basic ns functions can be used directly +methodName(); +// Some related functions are gathered within a common namespace +property.methodName(); +``` + +[ns1 in-game docs](https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html)
Basic ns2 usage example: + +```ts +export async function main(ns) { + // Basic ns functions can be accessed on the ns object + await ns.methodName; + // Some related functions are gathered under a sub-property of the ns object + await ns.property.methodName; +} +``` + +[ns2 in-game docs](https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html)
+ ## Properties -| Property | Type | Description | -| --- | --- | --- | -| [args](./bitburner.ns.args.md) | (string \| number \| boolean)\[\] | Arguments passed into the script. | -| [bladeburner](./bitburner.ns.bladeburner.md) | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. | -| [codingcontract](./bitburner.ns.codingcontract.md) | [CodingContract](./bitburner.codingcontract.md) | Namespace for codingcontract functions. | -| [corporation](./bitburner.ns.corporation.md) | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. RAM cost: 0 GB | -| [formulas](./bitburner.ns.formulas.md) | [Formulas](./bitburner.formulas.md) | Namespace for formulas functions. | -| [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | Namespace for gang functions. | -| [hacknet](./bitburner.ns.hacknet.md) | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. | -| [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. | -| [stanek](./bitburner.ns.stanek.md) | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB | -| [stock](./bitburner.ns.stock.md) | [TIX](./bitburner.tix.md) | Namespace for stock functions. | +| Property | Type | Description | +| -------------------------------------------------- | ----------------------------------------------- | --------------------------------------------------- | +| [args](./bitburner.ns.args.md) | (string \| number \| boolean)\[\] | Arguments passed into the script. | +| [bladeburner](./bitburner.ns.bladeburner.md) | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. | +| [codingcontract](./bitburner.ns.codingcontract.md) | [CodingContract](./bitburner.codingcontract.md) | Namespace for codingcontract functions. | +| [corporation](./bitburner.ns.corporation.md) | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. RAM cost: 0 GB | +| [formulas](./bitburner.ns.formulas.md) | [Formulas](./bitburner.formulas.md) | Namespace for formulas functions. | +| [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | Namespace for gang functions. | +| [hacknet](./bitburner.ns.hacknet.md) | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. | +| [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. | +| [stanek](./bitburner.ns.stanek.md) | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB | +| [stock](./bitburner.ns.stock.md) | [TIX](./bitburner.tix.md) | Namespace for stock functions. | ## Methods -| Method | Description | -| --- | --- | -| [alert(msg)](./bitburner.ns.alert.md) | Open up a message box. | -| [asleep(millis)](./bitburner.ns.asleep.md) | Suspends the script for n milliseconds. Doesn't block with concurrent calls. | -| [atExit(f)](./bitburner.ns.atexit.md) | Add callback function when the script dies | -| [brutessh(host)](./bitburner.ns.brutessh.md) | Runs BruteSSH.exe on a server. | -| [clear(handle)](./bitburner.ns.clear.md) | Clear data from a file. | -| [clearLog()](./bitburner.ns.clearlog.md) | Clears the script’s logs. | -| [clearPort(handle)](./bitburner.ns.clearport.md) | Clear data from a port. | -| [deleteServer(host)](./bitburner.ns.deleteserver.md) | Delete a purchased server. | -| [disableLog(fn)](./bitburner.ns.disablelog.md) | Disables logging for the given function. | -| [enableLog(fn)](./bitburner.ns.enablelog.md) | Enable logging for a certain function. | -| [exec(script, host, numThreads, args)](./bitburner.ns.exec.md) | Start another script on any server. | -| [exit()](./bitburner.ns.exit.md) | Terminates the current script immediately. | -| [fileExists(filename, host)](./bitburner.ns.fileexists.md) | Check if a file exists. | -| [flags(schema)](./bitburner.ns.flags.md) | Parse command line flags. | -| [ftpcrack(host)](./bitburner.ns.ftpcrack.md) | Runs FTPCrack.exe on a server. | -| [getBitNodeMultipliers()](./bitburner.ns.getbitnodemultipliers.md) | Get the current Bitnode multipliers. | -| [getFavorToDonate()](./bitburner.ns.getfavortodonate.md) | Returns the amount of Faction favor required to be able to donate to a faction. | -| [getGrowTime(host)](./bitburner.ns.getgrowtime.md) | Get the execution time of a grow() call. | -| [getHackingLevel()](./bitburner.ns.gethackinglevel.md) | Returns the player’s current hacking level. | -| [getHackingMultipliers()](./bitburner.ns.gethackingmultipliers.md) | Get hacking related multipliers. | -| [getHacknetMultipliers()](./bitburner.ns.gethacknetmultipliers.md) | Get hacknet related multipliers. | -| [getHackTime(host)](./bitburner.ns.gethacktime.md) | Get the execution time of a hack() call. | -| [getHostname()](./bitburner.ns.gethostname.md) | Returns a string with the hostname of the server that the script is running on. | -| [getOwnedSourceFiles()](./bitburner.ns.getownedsourcefiles.md) | Get a list of acquired Source-Files. | -| [getPlayer()](./bitburner.ns.getplayer.md) | Get information about the player. | -| [getPortHandle(port)](./bitburner.ns.getporthandle.md) | Get all data on a port. | -| [getPurchasedServerCost(ram)](./bitburner.ns.getpurchasedservercost.md) | Get cost of purchasing a server. | -| [getPurchasedServerLimit()](./bitburner.ns.getpurchasedserverlimit.md) | Returns the maximum number of servers you can purchase. | -| [getPurchasedServerMaxRam()](./bitburner.ns.getpurchasedservermaxram.md) | Returns the maximum RAM that a purchased server can have. | -| [getPurchasedServers(hostnameMode)](./bitburner.ns.getpurchasedservers.md) | Returns an array with either the hostnames or IPs of all of the servers you have purchased. | -| [getRunningScript(filename, hostname, args)](./bitburner.ns.getrunningscript.md) | Get general info about a running script. | -| [getScriptExpGain(script, host, args)](./bitburner.ns.getscriptexpgain.md) | Get the exp gain of a script. | -| [getScriptIncome(script, host, args)](./bitburner.ns.getscriptincome.md) | Get the income of a script. | -| [getScriptLogs(fn, host, args)](./bitburner.ns.getscriptlogs.md) | Get all the logs of a script. | -| [getScriptName()](./bitburner.ns.getscriptname.md) | Returns the current script name. | -| [getScriptRam(script, host)](./bitburner.ns.getscriptram.md) | Get the ram cost of a script. | -| [getServer(host)](./bitburner.ns.getserver.md) | Returns a server object for the given server. Defaults to the running script's server if host is not specified. | -| [getServerBaseSecurityLevel(host)](./bitburner.ns.getserverbasesecuritylevel.md) | | -| [getServerGrowth(host)](./bitburner.ns.getservergrowth.md) | Get a server growth parameter. | -| [getServerMaxMoney(host)](./bitburner.ns.getservermaxmoney.md) | Get maximum money available on a server. | -| [getServerMaxRam(host)](./bitburner.ns.getservermaxram.md) | Get the max RAM on a server. | -| [getServerMinSecurityLevel(host)](./bitburner.ns.getserverminsecuritylevel.md) | Returns the minimum security level of the target server. | -| [getServerMoneyAvailable(host)](./bitburner.ns.getservermoneyavailable.md) | Get money available on a server. | -| [getServerNumPortsRequired(host)](./bitburner.ns.getservernumportsrequired.md) | Returns the number of open ports required to successfully run NUKE.exe on the specified server. | -| [getServerRam(host)](./bitburner.ns.getserverram.md) | | -| [getServerRequiredHackingLevel(host)](./bitburner.ns.getserverrequiredhackinglevel.md) | Returns the required hacking level of the target server. | -| [getServerSecurityLevel(host)](./bitburner.ns.getserversecuritylevel.md) | Get server security level. | -| [getServerUsedRam(host)](./bitburner.ns.getserverusedram.md) | Get the used RAM on a server. | -| [getTimeSinceLastAug()](./bitburner.ns.gettimesincelastaug.md) | Returns the amount of time in milliseconds that have passed since you last installed Augmentations. | -| [getWeakenTime(host)](./bitburner.ns.getweakentime.md) | Get the execution time of a weaken() call. | -| [grow(host, opts)](./bitburner.ns.grow.md) | Spoof money in a servers bank account, increasing the amount available. | -| [growthAnalyze(host, growthAmount, cores)](./bitburner.ns.growthanalyze.md) | Calculate the number of grow thread needed to grow a server by a certain multiplier. | -| [growthAnalyzeSecurity(threads)](./bitburner.ns.growthanalyzesecurity.md) | Calculate the security increase for a number of thread. | -| [hack(host, opts)](./bitburner.ns.hack.md) | Steal a servers money. | -| [hackAnalyze(host)](./bitburner.ns.hackanalyze.md) | Get the percent of money stolen with a single thread. | -| [hackAnalyzeChance(host)](./bitburner.ns.hackanalyzechance.md) | Get the chance of successfully hacking a server. | -| [hackAnalyzeSecurity(threads)](./bitburner.ns.hackanalyzesecurity.md) | Get the security increase for a number of thread. | -| [hackAnalyzeThreads(host, hackAmount)](./bitburner.ns.hackanalyzethreads.md) | Predict the effect of hack. | -| [hasRootAccess(host)](./bitburner.ns.hasrootaccess.md) | Check if your have root access on a server. | -| [httpworm(host)](./bitburner.ns.httpworm.md) | Runs HTTPWorm.exe on a server. | -| [isLogEnabled(fn)](./bitburner.ns.islogenabled.md) | Checks the status of the logging for the given function. | -| [isRunning(script, host, args)](./bitburner.ns.isrunning.md) | Check if a script is running. | -| [kill(script, host, args)](./bitburner.ns.kill.md) | Terminate another script. | -| [killall(host)](./bitburner.ns.killall.md) | Terminate all scripts on a server. | -| [ls(host, grep)](./bitburner.ns.ls.md) | List files on a server. | -| [nFormat(n, format)](./bitburner.ns.nformat.md) | Format a number | -| [nuke(host)](./bitburner.ns.nuke.md) | Runs NUKE.exe on a server. | -| [peek(port)](./bitburner.ns.peek.md) | Get a copy of the data from a port without popping it. | -| [print(msg)](./bitburner.ns.print.md) | Prints a value or a variable to the script’s logs. | -| [prompt(txt)](./bitburner.ns.prompt.md) | Prompt the player with a Yes/No modal. | -| [ps(host)](./bitburner.ns.ps.md) | List running scripts on a server. | -| [purchaseServer(hostname, ram)](./bitburner.ns.purchaseserver.md) | Purchase a server. | -| [read(handle)](./bitburner.ns.read.md) | Read content of a file. | -| [readPort(port)](./bitburner.ns.readport.md) | Read data from a port. | -| [relaysmtp(host)](./bitburner.ns.relaysmtp.md) | Runs relaySMTP.exe on a server. | -| [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. | -| [run(script, numThreads, args)](./bitburner.ns.run.md) | Start another script on the current server. | -| [scan(host, hostnames)](./bitburner.ns.scan.md) | Get the list servers connected to a server. | -| [scp(files, source, destination)](./bitburner.ns.scp.md) | Copy file between servers. | -| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kill all scripts with a filename. | -| [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Check if any script with a filename is running. | -| [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. | -| [sleep(millis)](./bitburner.ns.sleep.md) | Suspends the script for n milliseconds. | -| [spawn(script, numThreads, args)](./bitburner.ns.spawn.md) | Terminate current script and start another in 10s. | -| [sprintf(format, args)](./bitburner.ns.sprintf.md) | Format a string. | -| [sqlinject(host)](./bitburner.ns.sqlinject.md) | Runs SQLInject.exe on a server. | -| [tail(fn, host, args)](./bitburner.ns.tail.md) | Open the tail window of a script. | -| [tFormat(milliseconds, milliPrecision)](./bitburner.ns.tformat.md) | Format time to readable string | -| [toast(msg, variant)](./bitburner.ns.toast.md) | Queue a toast (bottom-right notification). | -| [tprint(msg)](./bitburner.ns.tprint.md) | Prints a value or a variable to the Terminal. | -| [tprintf(format, values)](./bitburner.ns.tprintf.md) | Prints a raw value or a variable to the Terminal. | -| [tryWritePort(port, data)](./bitburner.ns.trywriteport.md) | Attempt to write to a port. | -| [vsprintf(format, args)](./bitburner.ns.vsprintf.md) | Format a string with an array of arguments. | -| [weaken(host, opts)](./bitburner.ns.weaken.md) | Reduce a server security level. | -| [weakenAnalyze(threads, cores)](./bitburner.ns.weakenanalyze.md) | Predict the effect of weaken. | -| [wget(url, target, host)](./bitburner.ns.wget.md) | Download a file from the internet. | -| [write(handle, data, mode)](./bitburner.ns.write.md) | Write data to a file. | -| [writePort(port, data)](./bitburner.ns.writeport.md) | Write data to a port. | - +| Method | Description | +| -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| [alert(msg)](./bitburner.ns.alert.md) | Open up a message box. | +| [asleep(millis)](./bitburner.ns.asleep.md) | Suspends the script for n milliseconds. Doesn't block with concurrent calls. | +| [atExit(f)](./bitburner.ns.atexit.md) | Add callback function when the script dies | +| [brutessh(host)](./bitburner.ns.brutessh.md) | Runs BruteSSH.exe on a server. | +| [clear(handle)](./bitburner.ns.clear.md) | Clear data from a file. | +| [clearLog()](./bitburner.ns.clearlog.md) | Clears the script’s logs. | +| [clearPort(handle)](./bitburner.ns.clearport.md) | Clear data from a port. | +| [deleteServer(host)](./bitburner.ns.deleteserver.md) | Delete a purchased server. | +| [disableLog(fn)](./bitburner.ns.disablelog.md) | Disables logging for the given function. | +| [enableLog(fn)](./bitburner.ns.enablelog.md) | Enable logging for a certain function. | +| [exec(script, host, numThreads, args)](./bitburner.ns.exec.md) | Start another script on any server. | +| [exit()](./bitburner.ns.exit.md) | Terminates the current script immediately. | +| [fileExists(filename, host)](./bitburner.ns.fileexists.md) | Check if a file exists. | +| [flags(schema)](./bitburner.ns.flags.md) | Parse command line flags. | +| [ftpcrack(host)](./bitburner.ns.ftpcrack.md) | Runs FTPCrack.exe on a server. | +| [getBitNodeMultipliers()](./bitburner.ns.getbitnodemultipliers.md) | Get the current Bitnode multipliers. | +| [getFavorToDonate()](./bitburner.ns.getfavortodonate.md) | Returns the amount of Faction favor required to be able to donate to a faction. | +| [getGrowTime(host)](./bitburner.ns.getgrowtime.md) | Get the execution time of a grow() call. | +| [getHackingLevel()](./bitburner.ns.gethackinglevel.md) | Returns the player’s current hacking level. | +| [getHackingMultipliers()](./bitburner.ns.gethackingmultipliers.md) | Get hacking related multipliers. | +| [getHacknetMultipliers()](./bitburner.ns.gethacknetmultipliers.md) | Get hacknet related multipliers. | +| [getHackTime(host)](./bitburner.ns.gethacktime.md) | Get the execution time of a hack() call. | +| [getHostname()](./bitburner.ns.gethostname.md) | Returns a string with the hostname of the server that the script is running on. | +| [getOwnedSourceFiles()](./bitburner.ns.getownedsourcefiles.md) | Get a list of acquired Source-Files. | +| [getPlayer()](./bitburner.ns.getplayer.md) | Get information about the player. | +| [getPortHandle(port)](./bitburner.ns.getporthandle.md) | Get all data on a port. | +| [getPurchasedServerCost(ram)](./bitburner.ns.getpurchasedservercost.md) | Get cost of purchasing a server. | +| [getPurchasedServerLimit()](./bitburner.ns.getpurchasedserverlimit.md) | Returns the maximum number of servers you can purchase. | +| [getPurchasedServerMaxRam()](./bitburner.ns.getpurchasedservermaxram.md) | Returns the maximum RAM that a purchased server can have. | +| [getPurchasedServers()](./bitburner.ns.getpurchasedservers.md) | Returns an array with the hostnames of all of the servers you have purchased. | +| [getRunningScript(filename, hostname, args)](./bitburner.ns.getrunningscript.md) | Get general info about a running script. | +| [getScriptExpGain(script, host, args)](./bitburner.ns.getscriptexpgain.md) | Get the exp gain of a script. | +| [getScriptIncome(script, host, args)](./bitburner.ns.getscriptincome.md) | Get the income of a script. | +| [getScriptLogs(fn, host, args)](./bitburner.ns.getscriptlogs.md) | Get all the logs of a script. | +| [getScriptName()](./bitburner.ns.getscriptname.md) | Returns the current script name. | +| [getScriptRam(script, host)](./bitburner.ns.getscriptram.md) | Get the ram cost of a script. | +| [getServer(host)](./bitburner.ns.getserver.md) | Returns a server object for the given server. Defaults to the running script's server if host is not specified. | +| [getServerBaseSecurityLevel(host)](./bitburner.ns.getserverbasesecuritylevel.md) | | +| [getServerGrowth(host)](./bitburner.ns.getservergrowth.md) | Get a server growth parameter. | +| [getServerMaxMoney(host)](./bitburner.ns.getservermaxmoney.md) | Get maximum money available on a server. | +| [getServerMaxRam(host)](./bitburner.ns.getservermaxram.md) | Get the max RAM on a server. | +| [getServerMinSecurityLevel(host)](./bitburner.ns.getserverminsecuritylevel.md) | Returns the minimum security level of the target server. | +| [getServerMoneyAvailable(host)](./bitburner.ns.getservermoneyavailable.md) | Get money available on a server. | +| [getServerNumPortsRequired(host)](./bitburner.ns.getservernumportsrequired.md) | Returns the number of open ports required to successfully run NUKE.exe on the specified server. | +| [getServerRam(host)](./bitburner.ns.getserverram.md) | | +| [getServerRequiredHackingLevel(host)](./bitburner.ns.getserverrequiredhackinglevel.md) | Returns the required hacking level of the target server. | +| [getServerSecurityLevel(host)](./bitburner.ns.getserversecuritylevel.md) | Get server security level. | +| [getServerUsedRam(host)](./bitburner.ns.getserverusedram.md) | Get the used RAM on a server. | +| [getTimeSinceLastAug()](./bitburner.ns.gettimesincelastaug.md) | Returns the amount of time in milliseconds that have passed since you last installed Augmentations. | +| [getWeakenTime(host)](./bitburner.ns.getweakentime.md) | Get the execution time of a weaken() call. | +| [grow(host, opts)](./bitburner.ns.grow.md) | Spoof money in a servers bank account, increasing the amount available. | +| [growthAnalyze(host, growthAmount, cores)](./bitburner.ns.growthanalyze.md) | Calculate the number of grow thread needed to grow a server by a certain multiplier. | +| [growthAnalyzeSecurity(threads)](./bitburner.ns.growthanalyzesecurity.md) | Calculate the security increase for a number of thread. | +| [hack(host, opts)](./bitburner.ns.hack.md) | Steal a servers money. | +| [hackAnalyze(host)](./bitburner.ns.hackanalyze.md) | Get the percent of money stolen with a single thread. | +| [hackAnalyzeChance(host)](./bitburner.ns.hackanalyzechance.md) | Get the chance of successfully hacking a server. | +| [hackAnalyzeSecurity(threads)](./bitburner.ns.hackanalyzesecurity.md) | Get the security increase for a number of thread. | +| [hackAnalyzeThreads(host, hackAmount)](./bitburner.ns.hackanalyzethreads.md) | Predict the effect of hack. | +| [hasRootAccess(host)](./bitburner.ns.hasrootaccess.md) | Check if your have root access on a server. | +| [httpworm(host)](./bitburner.ns.httpworm.md) | Runs HTTPWorm.exe on a server. | +| [isLogEnabled(fn)](./bitburner.ns.islogenabled.md) | Checks the status of the logging for the given function. | +| [isRunning(script, host, args)](./bitburner.ns.isrunning.md) | Check if a script is running. | +| [kill(script, host, args)](./bitburner.ns.kill.md) | Terminate another script. | +| [killall(host)](./bitburner.ns.killall.md) | Terminate all scripts on a server. | +| [ls(host, grep)](./bitburner.ns.ls.md) | List files on a server. | +| [nFormat(n, format)](./bitburner.ns.nformat.md) | Format a number | +| [nuke(host)](./bitburner.ns.nuke.md) | Runs NUKE.exe on a server. | +| [peek(port)](./bitburner.ns.peek.md) | Get a copy of the data from a port without popping it. | +| [print(msg)](./bitburner.ns.print.md) | Prints a value or a variable to the script’s logs. | +| [prompt(txt)](./bitburner.ns.prompt.md) | Prompt the player with a Yes/No modal. | +| [ps(host)](./bitburner.ns.ps.md) | List running scripts on a server. | +| [purchaseServer(hostname, ram)](./bitburner.ns.purchaseserver.md) | Purchase a server. | +| [read(handle)](./bitburner.ns.read.md) | Read content of a file. | +| [readPort(port)](./bitburner.ns.readport.md) | Read data from a port. | +| [relaysmtp(host)](./bitburner.ns.relaysmtp.md) | Runs relaySMTP.exe on a server. | +| [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. | +| [run(script, numThreads, args)](./bitburner.ns.run.md) | Start another script on the current server. | +| [scan(host, hostnames)](./bitburner.ns.scan.md) | Get the list servers connected to a server. | +| [scp(files, source, destination)](./bitburner.ns.scp.md) | Copy file between servers. | +| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kill all scripts with a filename. | +| [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Check if any script with a filename is running. | +| [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. | +| [sleep(millis)](./bitburner.ns.sleep.md) | Suspends the script for n milliseconds. | +| [spawn(script, numThreads, args)](./bitburner.ns.spawn.md) | Terminate current script and start another in 10s. | +| [sprintf(format, args)](./bitburner.ns.sprintf.md) | Format a string. | +| [sqlinject(host)](./bitburner.ns.sqlinject.md) | Runs SQLInject.exe on a server. | +| [tail(fn, host, args)](./bitburner.ns.tail.md) | Open the tail window of a script. | +| [tFormat(milliseconds, milliPrecision)](./bitburner.ns.tformat.md) | Format time to readable string | +| [toast(msg, variant)](./bitburner.ns.toast.md) | Queue a toast (bottom-right notification). | +| [tprint(msg)](./bitburner.ns.tprint.md) | Prints a value or a variable to the Terminal. | +| [tprintf(format, values)](./bitburner.ns.tprintf.md) | Prints a raw value or a variable to the Terminal. | +| [tryWritePort(port, data)](./bitburner.ns.trywriteport.md) | Attempt to write to a port. | +| [vsprintf(format, args)](./bitburner.ns.vsprintf.md) | Format a string with an array of arguments. | +| [weaken(host, opts)](./bitburner.ns.weaken.md) | Reduce a server security level. | +| [weakenAnalyze(threads, cores)](./bitburner.ns.weakenanalyze.md) | Predict the effect of weaken. | +| [wget(url, target, host)](./bitburner.ns.wget.md) | Download a file from the internet. | +| [write(handle, data, mode)](./bitburner.ns.write.md) | Write data to a file. | +| [writePort(port, data)](./bitburner.ns.writeport.md) | Write data to a port. | diff --git a/package-lock.json b/package-lock.json index 599d87693..2c4ccd75a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,6 +5,7 @@ "requires": true, "packages": { "": { + "name": "bitburner", "version": "1.1.0", "hasInstallScript": true, "license": "SEE LICENSE IN license.txt", diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 7515919d0..8fcfc544b 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -3726,6 +3726,27 @@ interface Stanek { /** * Collection of all functions passed to scripts * @public + * @remarks + * Basic ns1 usage example: + * ```ts + * // Basic ns functions can be used directly + * methodName(); + * // Some related functions are gathered within a common namespace + * property.methodName(); + * ``` + * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html| ns1 in-game docs} + *
+ * Basic ns2 usage example: + * ```ts + * export async function main(ns) { + * // Basic ns functions can be accessed on the ns object + * await ns.methodName; + * // Some related functions are gathered under a sub-property of the ns object + * await ns.property.methodName; + * } + * ``` + * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html| ns2 in-game docs} + *
*/ export interface NS extends Singularity { /**