Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-28 02:23:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3913 from danielyxie/dev

Browse Source 
doc
This commit is contained in:
hydroflame 2022-07-15 23:47:43 -04:00 committed by GitHub
commit eb7f381fba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
24 changed files with 127 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
dist/bitburner.d.ts vendored
View File

@ -313,7 +313,7 @@ export declare interface Bladeburner {
* @remarks * @remarks
* RAM cost: 4 GB * RAM cost: 4 GB
* *
* Returns the number of seconds it takes to complete the specified action * Returns the number of milliseconds it takes to complete the specified action
* *
* @param type - Type of action. * @param type - Type of action.
* @param name - Name of action. Must be an exact match. * @param name - Name of action. Must be an exact match.
@ -321,6 +321,17 @@ export declare interface Bladeburner {
*/ */
getActionTime(type: string, name: string): number; 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. * Get estimate success chance of an action.
* @remarks * @remarks
@ -496,28 +507,30 @@ export declare interface Bladeburner {
* @remarks * @remarks
* RAM cost: 4 GB * RAM cost: 4 GB
* *
* This function returns the number of skill points needed to upgrade the specified skill. * 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. * 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 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. * @returns Number of skill points needed to upgrade the specified skill.
*/ */
getSkillUpgradeCost(name: string): number; getSkillUpgradeCost(name: string, count?: number): number;
/** /**
* Upgrade skill. * Upgrade skill.
* @remarks * @remarks
* RAM cost: 4 GB * RAM cost: 4 GB
* *
* Attempts to upgrade the specified Bladeburner skill. * Attempts to upgrade the specified Bladeburner skill the specified number of times.
* *
* Returns true if the skill is successfully upgraded, and false otherwise. * 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 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. * @returns true if the skill is successfully upgraded, and false otherwise.
*/ */
upgradeSkill(name: string): boolean; upgradeSkill(name: string, count?: number): boolean;
/** /**
* Get team size. * Get team size.
@ -673,7 +686,7 @@ export declare interface Bladeburner {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. * 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” is accumulated when the game is offline or if the game is inactive in the browser.
* *
@ -1483,7 +1496,7 @@ export declare interface Gang {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic. * 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” is accumulated when the game is offline or if the game is inactive in the browser.
* *
@ -3059,6 +3072,7 @@ export declare interface NS {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* see: https://github.com/alexei/sprintf.js
* @param format - format of the message * @param format - format of the message
* @param msg - Value to be printed. * @param msg - Value to be printed.
*/ */
@ -3150,7 +3164,7 @@ export declare interface NS {
* @param args - Arguments to identify which scripts to get logs for. * @param args - Arguments to identify which scripts to get logs for.
* @returns Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array. * @returns Returns an 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: any[]): string[]; getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[];
/** /**
* Get an array of recently killed scripts across all servers. * Get an array of recently killed scripts across all servers.
@ -3213,7 +3227,7 @@ export declare interface NS {
* @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 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. * @param args - Arguments for the script being tailed.
*/ */
tail(fn?: FilenameOrPID, host?: string, ...args: any[]): void; tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): void;
/** /**
* Close the tail window of a script. * Close the tail window of a script.
@ -3418,7 +3432,7 @@ export declare interface NS {
* @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 numThreads must be filled in with a value. * @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 numThreads must be filled in with a value.
* @returns Returns the PID of a successfully started script, and 0 otherwise. * @returns Returns the PID of a successfully started script, and 0 otherwise.
*/ */
run(script: string, numThreads?: number, ...args: Array<string | number | boolean>): number; run(script: string, numThreads?: number, ...args: (string | number | boolean)[]): number;
/** /**
* Start another script on any server. * Start another script on any server.
@ -3466,7 +3480,7 @@ export declare interface NS {
* @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 numThreads must be filled in with a value. * @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 numThreads must be filled in with a value.
* @returns Returns the PID of a successfully started script, and 0 otherwise. * @returns Returns the PID of a successfully started script, and 0 otherwise.
*/ */
exec(script: string, host: string, numThreads?: number, ...args: Array<string | number | boolean>): number; exec(script: string, host: string, numThreads?: number, ...args: (string | number | boolean)[]): number;
/** /**
* Terminate current script and start another in 10s. * Terminate current script and start another in 10s.
@ -3496,7 +3510,7 @@ export declare interface NS {
* @param numThreads - Number of threads to spawn new script with. Will be rounded to nearest integer. * @param numThreads - Number of threads to spawn new script with. Will be rounded to nearest integer.
* @param args - Additional arguments to pass into the new script that is being run. * @param args - Additional arguments to pass into the new script that is being run.
*/ */
spawn(script: string, numThreads?: number, ...args: string[]): void; spawn(script: string, numThreads?: number, ...args: (string | number | boolean)[]): void;
/** /**
* Terminate another script. * Terminate another script.
@ -3566,7 +3580,7 @@ export declare interface NS {
* ns.kill("foo.script", getHostname(), 1, "foodnstuff"); * ns.kill("foo.script", getHostname(), 1, "foodnstuff");
* ``` * ```
*/ */
kill(script: string, host: string, ...args: string[]): boolean; kill(script: string, host: string, ...args: (string | number | boolean)[]): boolean;
/** /**
* Terminate all scripts on a server. * Terminate all scripts on a server.
@ -4063,7 +4077,7 @@ export declare interface NS {
* @param args - Arguments to specify/identify which scripts to search for. * @param args - Arguments to specify/identify which scripts to search for.
* @returns True if specified script is running on the target server, and false otherwise. * @returns True if specified script is running on the target server, and false otherwise.
*/ */
isRunning(script: FilenameOrPID, host: string, ...args: string[]): boolean; isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): boolean;
/** /**
* Get general info about a running script. * Get general info about a running script.
@ -4078,7 +4092,11 @@ export declare interface NS {
* @param args - Arguments to identify the script * @param args - Arguments to identify the script
* @returns The info about the running script if found, and null otherwise. * @returns The info about the running script if found, and null otherwise.
*/ */
getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string | number)[]): RunningScript | null; getRunningScript(
filename?: FilenameOrPID,
hostname?: string,
...args: (string | number | boolean)[]
): RunningScript | null;
/** /**
* Get cost of purchasing a server. * Get cost of purchasing a server.
@ -4404,13 +4422,13 @@ export declare interface NS {
* Get the execution time of a hack() call. * Get the execution time of a hack() call.
* @remarks * @remarks
* RAM cost: 0.05 GB * RAM cost: 0.05 GB
*
* When `hack` completes an amount of money is stolen depending on the player's skills. * 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 hack Netscript function on the target server. * Returns the amount of time in milliseconds it takes to execute the hack Netscript function on the target server.
* The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels.
* The required time is increased by the security level of the target server and decreased by the player's hacking level. * The required time is increased by the security level of the target server and decreased by the player's hacking level.
* *
* @param host - Host of target server. * @param host - Host of target server.
* @returns Returns the amount of time in milliseconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server. * @returns Returns the amount of time in milliseconds it takes to execute the hack Netscript function.
*/ */
getHackTime(host: string): number; getHackTime(host: string): number;
@ -4420,11 +4438,10 @@ export declare interface NS {
* RAM cost: 0.05 GB * RAM cost: 0.05 GB
* *
* Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server. * Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server.
* The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels.
* The required time is increased by the security level of the target server and decreased by the player's hacking level. * The required time is increased by the security level of the target server and decreased by the player's hacking level.
* *
* @param host - Host of target server. * @param host - Host of target server.
* @returns Returns the amount of time in milliseconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. * @returns Returns the amount of time in milliseconds it takes to execute the grow Netscript function.
*/ */
getGrowTime(host: string): number; getGrowTime(host: string): number;
@ -4434,11 +4451,10 @@ export declare interface NS {
* RAM cost: 0.05 GB * RAM cost: 0.05 GB
* *
* Returns the amount of time in milliseconds it takes to execute the weaken Netscript function on the target server. * Returns the amount of time in milliseconds it takes to execute the weaken Netscript function on the target server.
* The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels.
* The required time is increased by the security level of the target server and decreased by the player's hacking level. * The required time is increased by the security level of the target server and decreased by the player's hacking level.
* *
* @param host - Host of target server. * @param host - Host of target server.
* @returns Returns the amount of time in milliseconds it takes to execute the weaken Netscript function. Returns Infinity if called on a Hacknet Server. * @returns Returns the amount of time in milliseconds it takes to execute the weaken Netscript function.
*/ */
getWeakenTime(host: string): number; getWeakenTime(host: string): number;
@ -4471,7 +4487,7 @@ export declare interface NS {
/** /**
* {@inheritDoc NS.(getScriptIncome:1)} * {@inheritDoc NS.(getScriptIncome:1)}
*/ */
getScriptIncome(script: string, host: string, ...args: string[]): number; getScriptIncome(script: string, host: string, ...args: (string | number | boolean)[]): number;
/** /**
* Get the exp gain of a script. * Get the exp gain of a script.
@ -4495,7 +4511,7 @@ export declare interface NS {
/** /**
* {@inheritDoc NS.(getScriptExpGain:1)} * {@inheritDoc NS.(getScriptExpGain:1)}
*/ */
getScriptExpGain(script: string, host: string, ...args: string[]): number; 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. * Returns the amount of time in milliseconds that have passed since you last installed Augmentations.
@ -6439,6 +6455,8 @@ export declare interface SleeveTask {
gymStatType: string; gymStatType: string;
/** Faction work type being performed, if any */ /** Faction work type being performed, if any */
factionWorkType: string; factionWorkType: string;
/** Class being taken at university, if any */
className: string;
} }
/** /**

25
markdown/bitburner.bladeburner.getactioncurrenttime.md Normal file
View File

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getActionCurrentTime](./bitburner.bladeburner.getactioncurrenttime.md)
## Bladeburner.getActionCurrentTime() method
Get the time elapsed on current action.
<b>Signature:</b>
```typescript
getActionCurrentTime(): number;
```
<b>Returns:</b>
number
Number of milliseconds already spent on the current action.
## Remarks
RAM cost: 4 GB
Returns the number of milliseconds already spent on the current action.

2
markdown/bitburner.bladeburner.getactiontime.md
View File

@ -29,5 +29,5 @@ Number of milliseconds it takes to complete the specified action.
RAM cost: 4 GB RAM cost: 4 GB
Returns the number of seconds it takes to complete the specified action Returns the number of milliseconds it takes to complete the specified action

2
markdown/bitburner.bladeburner.getbonustime.md
View File

@ -21,7 +21,7 @@ Amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechan
RAM cost: 0 GB RAM cost: 0 GB
Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. 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” is accumulated when the game is offline or if the game is inactive in the browser.

5
markdown/bitburner.bladeburner.getskillupgradecost.md
View File

@ -9,7 +9,7 @@ Get cost to upgrade skill.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getSkillUpgradeCost(name: string): number; getSkillUpgradeCost(name: string, count?: number): number;
``` ```
## Parameters ## Parameters
@ -17,6 +17,7 @@ getSkillUpgradeCost(name: string): number;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | string | | | name | string | |
| count | number | Number of times to upgrade the skill. Defaults to 1 if not specified. |
<b>Returns:</b> <b>Returns:</b>
@ -28,7 +29,7 @@ Number of skill points needed to upgrade the specified skill.
RAM cost: 4 GB RAM cost: 4 GB
This function returns the number of skill points needed to upgrade the specified skill. 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. The function returns -1 if an invalid skill name is passed in.

5
markdown/bitburner.bladeburner.md
View File

@ -23,6 +23,7 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have
| [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | Get whether an action is set to autolevel. | | [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | Get whether an action is set to autolevel. |
| [getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) | Get action count remaining. | | [getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) | Get action count remaining. |
| [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | Get the current level of an action. | | [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | Get the current level of an action. |
| [getActionCurrentTime()](./bitburner.bladeburner.getactioncurrenttime.md) | Get the time elapsed on current action. |
| [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | Get estimate success chance of an action. | | [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | Get estimate success chance of an action. |
| [getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) | Get the maximum level of an action. | | [getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) | Get the maximum level of an action. |
| [getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) | Get the reputation gain of an action. | | [getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) | Get the reputation gain of an action. |
@ -42,7 +43,7 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have
| [getSkillLevel(name)](./bitburner.bladeburner.getskilllevel.md) | Get skill level. | | [getSkillLevel(name)](./bitburner.bladeburner.getskilllevel.md) | Get skill level. |
| [getSkillNames()](./bitburner.bladeburner.getskillnames.md) | List all skills. | | [getSkillNames()](./bitburner.bladeburner.getskillnames.md) | List all skills. |
| [getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) | Get bladeburner skill points. | | [getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) | Get bladeburner skill points. |
| [getSkillUpgradeCost(name)](./bitburner.bladeburner.getskillupgradecost.md) | Get cost to upgrade skill. | | [getSkillUpgradeCost(name, count)](./bitburner.bladeburner.getskillupgradecost.md) | Get cost to upgrade skill. |
| [getStamina()](./bitburner.bladeburner.getstamina.md) | Get bladeburner stamina. | | [getStamina()](./bitburner.bladeburner.getstamina.md) | Get bladeburner stamina. |
| [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | Get team size. | | [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | Get team size. |
| [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | Join the bladeburner division. | | [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | Join the bladeburner division. |
@ -53,5 +54,5 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have
| [startAction(type, name)](./bitburner.bladeburner.startaction.md) | Start an action. | | [startAction(type, name)](./bitburner.bladeburner.startaction.md) | Start an action. |
| [stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) | Stop current action. | | [stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) | Stop current action. |
| [switchCity(name)](./bitburner.bladeburner.switchcity.md) | Travel to another city in bladeburner. | | [switchCity(name)](./bitburner.bladeburner.switchcity.md) | Travel to another city in bladeburner. |
| [upgradeSkill(name)](./bitburner.bladeburner.upgradeskill.md) | Upgrade skill. | | [upgradeSkill(name, count)](./bitburner.bladeburner.upgradeskill.md) | Upgrade skill. |

5
markdown/bitburner.bladeburner.upgradeskill.md
View File

@ -9,7 +9,7 @@ Upgrade skill.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
upgradeSkill(name: string): boolean; upgradeSkill(name: string, count?: number): boolean;
``` ```
## Parameters ## Parameters
@ -17,6 +17,7 @@ upgradeSkill(name: string): boolean;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | string | | | name | string | |
| count | number | Number of times to upgrade the skill. Defaults to 1 if not specified. |
<b>Returns:</b> <b>Returns:</b>
@ -28,7 +29,7 @@ true if the skill is successfully upgraded, and false otherwise.
RAM cost: 4 GB RAM cost: 4 GB
Attempts to upgrade the specified Bladeburner skill. Attempts to upgrade the specified Bladeburner skill the specified number of times.
Returns true if the skill is successfully upgraded, and false otherwise. Returns true if the skill is successfully upgraded, and false otherwise.

2
markdown/bitburner.gang.getbonustime.md
View File

@ -21,7 +21,7 @@ Bonus time for the Gang mechanic in milliseconds.
RAM cost: 0 GB RAM cost: 0 GB
Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic. 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” is accumulated when the game is offline or if the game is inactive in the browser.

4
markdown/bitburner.ns.exec.md
View File

@ -9,7 +9,7 @@ Start another script on any server.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
exec(script: string, host: string, numThreads?: number, ...args: Array<string | number | boolean>): number; exec(script: string, host: string, numThreads?: number, ...args: (string | number | boolean)[]): number;
``` ```
## Parameters ## Parameters
@ -19,7 +19,7 @@ exec(script: string, host: string, numThreads?: number, ...args: Array<string |
| script | string | Filename of script to execute. | | script | string | Filename of script to execute. |
| host | string | Hostname of the <code>target server</code> on which to execute the script. | | host | string | Hostname of the <code>target server</code> on which to execute the script. |
| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. | | numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. |
| args | Array&lt;string \| number \| boolean&gt; | 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 numThreads must be filled in with a value. | | args | (string \| number \| boolean)\[\] | 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 numThreads must be filled in with a value. |
<b>Returns:</b> <b>Returns:</b>

4
markdown/bitburner.ns.getgrowtime.md
View File

@ -22,11 +22,11 @@ getGrowTime(host: string): number;
number number
Returns the amount of time in milliseconds it takes to execute the grow 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.
## Remarks ## Remarks
RAM cost: 0.05 GB 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 function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels. The required time is increased by the security level of the target server and decreased by the player's hacking level. 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.

6
markdown/bitburner.ns.gethacktime.md
View File

@ -22,9 +22,11 @@ getHackTime(host: string): number;
number number
Returns the amount of time in milliseconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server. Returns the amount of time in milliseconds it takes to execute the hack Netscript function.
## Remarks ## 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 hack Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels. The required time is increased by the security level of the target server and decreased by the player's hacking level. 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 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.

8
markdown/bitburner.ns.getrunningscript.md
View File

@ -9,7 +9,11 @@ Get general info about a running script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string | number)[]): RunningScript | null; getRunningScript(
filename?: FilenameOrPID,
hostname?: string,
...args: (string | number | boolean)[]
): RunningScript | null;
``` ```
## Parameters ## Parameters
@ -18,7 +22,7 @@ getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string |
| --- | --- | --- | | --- | --- | --- |
| filename | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script. | | filename | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script. |
| hostname | string | Optional. Name of host server the script is running on. | | hostname | string | Optional. Name of host server the script is running on. |
| args | (string \| number)\[\] | Arguments to identify the script | | args | (string \| number \| boolean)\[\] | Arguments to identify the script |
<b>Returns:</b> <b>Returns:</b>

4
markdown/bitburner.ns.getscriptexpgain_1.md
View File

@ -9,7 +9,7 @@ Get the exp gain of a script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getScriptExpGain(script: string, host: string, ...args: string[]): number; getScriptExpGain(script: string, host: string, ...args: (string | number | boolean)[]): number;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ getScriptExpGain(script: string, host: string, ...args: string[]): number;
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename of script. | | script | string | Filename of script. |
| host | string | Server on which script is running. | | host | string | Server on which script is running. |
| args | string\[\] | Arguments that the script is running with. | | args | (string \| number \| boolean)\[\] | Arguments that the script is running with. |
<b>Returns:</b> <b>Returns:</b>

4
markdown/bitburner.ns.getscriptincome_1.md
View File

@ -9,7 +9,7 @@ Get the income of a script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getScriptIncome(script: string, host: string, ...args: string[]): number; getScriptIncome(script: string, host: string, ...args: (string | number | boolean)[]): number;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ getScriptIncome(script: string, host: string, ...args: string[]): number;
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename of script. | | script | string | Filename of script. |
| host | string | Server on which script is running. | | host | string | Server on which script is running. |
| args | string\[\] | Arguments that the script is running with. | | args | (string \| number \| boolean)\[\] | Arguments that the script is running with. |
<b>Returns:</b> <b>Returns:</b>

4
markdown/bitburner.ns.getscriptlogs.md
View File

@ -9,7 +9,7 @@ Get all the logs of a script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getScriptLogs(fn?: string, host?: string, ...args: any[]): string[]; getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[];
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ getScriptLogs(fn?: string, host?: string, ...args: any[]): string[];
| --- | --- | --- | | --- | --- | --- |
| fn | string | Optional. Filename of script to get logs from. | | fn | string | Optional. Filename of script to get logs from. |
| host | string | Optional. Hostname of the server that the script is on. | | host | string | Optional. Hostname of the server that the script is on. |
| args | any\[\] | Arguments to identify which scripts to get logs for. | | args | (string \| number \| boolean)\[\] | Arguments to identify which scripts to get logs for. |
<b>Returns:</b> <b>Returns:</b>

4
markdown/bitburner.ns.getweakentime.md
View File

@ -22,11 +22,11 @@ getWeakenTime(host: string): number;
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 weaken Netscript function.
## Remarks ## Remarks
RAM cost: 0.05 GB RAM cost: 0.05 GB
Returns the amount of time in milliseconds it takes to execute the weaken Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels. The required time is increased by the security level of the target server and decreased by the player's hacking level. Returns the amount of time in milliseconds it takes to execute the 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.

4
markdown/bitburner.ns.isrunning.md
View File

@ -9,7 +9,7 @@ Check if a script is running.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
isRunning(script: FilenameOrPID, host: string, ...args: string[]): boolean; isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): boolean;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ isRunning(script: FilenameOrPID, host: string, ...args: string[]): boolean;
| --- | --- | --- | | --- | --- | --- |
| script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. | | script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. |
| host | string | Host of target server. | | host | string | Host of target server. |
| args | string\[\] | Arguments to specify/identify which scripts to search for. | | args | (string \| number \| boolean)\[\] | Arguments to specify/identify which scripts to search for. |
<b>Returns:</b> <b>Returns:</b>

4
markdown/bitburner.ns.kill_1.md
View File

@ -9,7 +9,7 @@ Terminate another script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
kill(script: string, host: string, ...args: string[]): boolean; kill(script: string, host: string, ...args: (string | number | boolean)[]): boolean;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ kill(script: string, host: string, ...args: string[]): boolean;
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename or pid of the script to kill | | script | string | Filename or pid of the script to kill |
| host | string | Hostname of the server on which to kill the script. | | host | string | Hostname of the server on which to kill the script. |
| args | string\[\] | Arguments to identify which script to kill. | | args | (string \| number \| boolean)\[\] | Arguments to identify which script to kill. |
<b>Returns:</b> <b>Returns:</b>

4
markdown/bitburner.ns.run.md
View File

@ -9,7 +9,7 @@ Start another script on the current server.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
run(script: string, numThreads?: number, ...args: Array<string | number | boolean>): number; run(script: string, numThreads?: number, ...args: (string | number | boolean)[]): number;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ run(script: string, numThreads?: number, ...args: Array<string | number | boolea
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename of script to run. | | script | string | Filename of script to run. |
| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. | | numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. |
| args | Array&lt;string \| number \| boolean&gt; | 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 numThreads must be filled in with a value. | | args | (string \| number \| boolean)\[\] | 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 numThreads must be filled in with a value. |
<b>Returns:</b> <b>Returns:</b>

4
markdown/bitburner.ns.spawn.md
View File

@ -9,7 +9,7 @@ Terminate current script and start another in 10s.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
spawn(script: string, numThreads?: number, ...args: string[]): void; spawn(script: string, numThreads?: number, ...args: (string | number | boolean)[]): void;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ spawn(script: string, numThreads?: number, ...args: string[]): void;
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename of script to execute. | | script | string | Filename of script to execute. |
| numThreads | number | Number of threads to spawn new script with. Will be rounded to nearest integer. | | numThreads | number | Number of threads to spawn new script with. Will be rounded to nearest integer. |
| args | string\[\] | Additional arguments to pass into the new script that is being run. | | args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. |
<b>Returns:</b> <b>Returns:</b>

4
markdown/bitburner.ns.tail.md
View File

@ -9,7 +9,7 @@ Open the tail window of a script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
tail(fn?: FilenameOrPID, host?: string, ...args: any[]): void; tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): void;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ tail(fn?: FilenameOrPID, host?: string, ...args: any[]): void;
| --- | --- | --- | | --- | --- | --- |
| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. | | fn | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. |
| host | string | Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. | | host | string | Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. |
| args | any\[\] | Arguments for the script being tailed. | | args | (string \| number \| boolean)\[\] | Arguments for the script being tailed. |
<b>Returns:</b> <b>Returns:</b>

2
markdown/bitburner.ns.tprintf.md
View File

@ -27,3 +27,5 @@ void
RAM cost: 0 GB RAM cost: 0 GB
see: https://github.com/alexei/sprintf.js

13
markdown/bitburner.sleevetask.classname.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [SleeveTask](./bitburner.sleevetask.md) &gt; [className](./bitburner.sleevetask.classname.md)
## SleeveTask.className property
Class being taken at university, if any
<b>Signature:</b>
```typescript
className: string;
```

1
markdown/bitburner.sleevetask.md
View File

@ -16,6 +16,7 @@ export interface SleeveTask
| Property | Type | Description | | Property | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| [className](./bitburner.sleevetask.classname.md) | string | Class being taken at university, if any |
| [crime](./bitburner.sleevetask.crime.md) | string | Crime currently attempting, if any | | [crime](./bitburner.sleevetask.crime.md) | string | Crime currently attempting, if any |
| [factionWorkType](./bitburner.sleevetask.factionworktype.md) | string | Faction work type being performed, if any | | [factionWorkType](./bitburner.sleevetask.factionworktype.md) | string | Faction work type being performed, if any |
| [gymStatType](./bitburner.sleevetask.gymstattype.md) | string | Stat being trained at the gym, if any | | [gymStatType](./bitburner.sleevetask.gymstattype.md) | string | Stat being trained at the gym, if any |