Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-18 04:05:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
Olivier Gagnon 2022-04-13 23:53:50 -04:00
parent 0288e5c2ba
commit a6ed2b9ed1
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1,4 +1,5 @@
.DS_Store .DS_Store
.history
.vscode .vscode
Changelog.txt Changelog.txt
Netburner.txt Netburner.txt

11
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -3258,7 +3258,7 @@ export interface CodingContract {
* Attempts to solve the Coding Contract with the provided solution. * Attempts to solve the Coding Contract with the provided solution.
* *
* @param answer - Solution for the contract. * @param answer - Solution for the contract.
* @param fn - Filename of 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. * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @param opts - Optional parameters for configuring function behavior. * @param opts - Optional parameters for configuring function behavior.
* @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string. * @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string.
@ -3273,7 +3273,7 @@ export interface CodingContract {
* Returns a name describing the type of problem posed by the Coding Contract. * Returns a name describing the type of problem posed by the Coding Contract.
* (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) * (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.)
* *
* @param fn - Filename of 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. * @param host - Host 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. * @returns Name describing the type of problem posed by the Coding Contract.
*/ */
@ -3286,7 +3286,7 @@ export interface CodingContract {
* *
* Get the full text description for the problem posed by the Coding Contract. * Get the full text description for the problem posed by the Coding Contract.
* *
* @param fn - Filename of 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. * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns Contract’s text description. * @returns Contract’s text description.
*/ */
@ -3314,7 +3314,7 @@ export interface CodingContract {
* *
* Get the number of tries remaining on the contract before it self-destructs. * Get the number of tries remaining on the contract before it self-destructs.
* *
* @param fn - Filename of 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. * @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns How many attempts are remaining for the contract; * @returns How many attempts are remaining for the contract;
*/ */
@ -5109,8 +5109,7 @@ export interface NS {
* PID stands for Process ID. The PID is a unique identifier for each script. * PID stands for Process ID. The PID is a unique identifier for each script.
* The PID will always be a positive integer. * The PID will always be a positive integer.
* *
* Running this function with a numThreads argument of 0 will return 0 without running the script. * Running this function with 0 or a negative numThreads argument will cause a runtime error.
* However, running this function with a negative numThreads argument will cause a runtime error.
* *
* @example * @example
* ```ts * ```ts