felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-18 15:28:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

DOCUMENTATION: Fix wrong examples in NetscriptDefinitions.d.ts (#1309)

Browse Source
This commit is contained in:
catloversg
2024-05-28 04:42:31 +07:00
committed by GitHub
parent 70521c9156
commit 48a7eb364f
21 changed files with 64 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1449,7 +1449,7 @@ export interface TIX {
* The object's properties are each an array of {@link StockOrderObject}
* The object has the following structure:
*
* ```ts
* ```js
* {
* string1: [ // Array of orders for this stock
* {
@@ -1474,7 +1474,7 @@ export interface TIX {
* Note that the order book will only contain information for stocks that you actually have orders in.
*
* @example
* ```ts
* ```js
* "If you do not have orders in Nova Medical (NVMD), then the returned object will not have a “NVMD” property."
* {
* ECP: [
@@ -1797,9 +1797,9 @@ export interface Singularity {
*
* @example
* ```js
* const programName = "BruteSSH.exe"
* const programName = "BruteSSH.exe";
* const success = ns.singularity.purchaseProgram(programName);
* if (!success) ns.tprint("ERROR: Failed to purchase ${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.
@@ -2053,7 +2053,8 @@ export interface Singularity {
*
* @example
* ```js
* ns.singularity.getFactionInviteRequirements("The Syndicate")
* ns.singularity.getFactionInviteRequirements("The Syndicate");
*
* [
* { "type": "someCondition", "conditions": [
* { "type": "city", "city": "Aevum" },
@@ -2070,7 +2071,10 @@ export interface Singularity {
* },
* { "type": "money", "money": 10000000 },
* { "type": "skills", "skills": { "hacking": 200 } },
* { "type": "skills", "skills": { "strength": 200, "defense": 200, "dexterity": 200, "agility": 200 } },
* { "type": "skills", "skills": { "strength": 200 } },
* { "type": "skills", "skills": { "defense": 200 } },
* { "type": "skills", "skills": { "dexterity": 200 } },
* { "type": "skills", "skills": { "agility": 200 } },
* { "type": "karma", "karma": -90 }
* ]
* ```
@@ -2136,7 +2140,7 @@ export interface Singularity {
* 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}.`)
* 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.
@@ -2230,7 +2234,7 @@ export interface Singularity {
* ```js
* const programName = "BruteSSH.exe";
* const success = ns.singularity.createProgram(programName);
* if (!success) ns.tprint("ERROR: Failed to start working on ${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.
@@ -2537,7 +2541,7 @@ export interface Singularity {
* @example
* ```js
* const programs = ns.singularity.getDarkwebPrograms();
* ns.tprint(`Available programs are: ${programs.split(", ")}`);
* ns.tprint(`Available programs are: ${programs}`);
* ```
* @returns - a list of programs available for purchase on the dark web, or [] if Tor has not
* been purchased
@@ -3516,8 +3520,10 @@ export interface CodingContract {
* ```js
* const reward = ns.codingcontract.attempt(yourSolution, filename, hostname);
* if (reward) {
* ns.tprint(`Contract solved successfully! Reward: ${reward}`)
* } else ns.tprint("Failed to solve contract.")
* ns.tprint(`Contract solved successfully! Reward: ${reward}`);
* } else {
* ns.tprint("Failed to solve contract.");
* }
* ```
*
* @param answer - Attempted solution for the contract.
@@ -4398,13 +4404,13 @@ export interface Sleeve {
* Return a boolean indicating whether or not this action was set successfully (false if an invalid action is specified).
*
* @example
* ```ts
* ```js
* // 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)
* ns.sleeve.setToCommitCrime(1, crimes.grandTheftAuto);
* ```
*
* @param sleeveNumber - Index of the sleeve to start committing crime. Sleeves are numbered starting from 0.
@@ -5211,7 +5217,7 @@ interface UserInterface {
* RAM cost: 0 GB
* @example
* Usage example (NS2)
* ```ts
* ```js
* const theme = ns.ui.getTheme();
* theme.primary = '#ff5500';
* ns.ui.setTheme(theme);
@@ -5241,7 +5247,7 @@ interface UserInterface {
* RAM cost: 0 GB
* @example
* Usage example (NS2)
* ```ts
* ```js
* const styles = ns.ui.getStyles();
* styles.fontFamily = 'Comic Sans Ms';
* ns.ui.setStyles(styles);
@@ -5466,7 +5472,7 @@ export interface NS {
* @example
* ```js
* let currentMoney = ns.getServerMoneyAvailable("n00dles");
* currentMoney *= await ns.grow("foodnstuff");
* currentMoney *= await ns.grow("n00dles");
* ```
* @param host - Hostname of the target server to grow.
* @param opts - Optional parameters for configuring function behavior.
@@ -5523,12 +5529,12 @@ export interface NS {
*
*
* @example
* ```ts
* ```js
* // Calculate threadcount of a single hack that would take $100k from n00dles
* const hackThreads = ns.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))
* ns.run("noodleHack.js", Math.floor(hackThreads));
*
* ```
* @param host - Hostname of the target server to analyze.
@@ -5652,7 +5658,7 @@ export interface NS {
* @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++) {
* for (let i = 1; i <= 10; ++i) {
* ns.tprint(i);
* await ns.sleep(5000);
* }
@@ -5750,7 +5756,7 @@ export interface NS {
* 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.printf("Am I a nibble? %t", (4 === age));
* ns.tail();
* ```
*
@@ -5878,7 +5884,7 @@ export interface NS {
* This is configurable in the game's options as `Recently killed scripts size`.
*
* @example
* ```ts
* ```js
* let recentScripts = ns.getRecentScripts();
* let mostRecent = recentScripts.shift();
* if (mostRecent)
@@ -6143,7 +6149,7 @@ export interface NS {
* 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');
* 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.
@@ -6209,7 +6215,7 @@ export interface NS {
* @example
* ```js
* //The following example will execute the script ‘foo.js’ with 10 threads, in 500 milliseconds and the arguments ‘foodnstuff’ and 90:
* ns.spawn('foo.js', {threads: 10, spawnDelay: 500}, 'foodnstuff', 90);
* ns.spawn("foo.js", {threads: 10, spawnDelay: 500}, "foodnstuff", 90);
* ```
* @param script - Filename of script to execute.
* @param threadOrOptions - Either an integer number of threads for new script, or a {@link SpawnOptions} object. Threads defaults to 1 and spawnDelay defaults to 10,000 ms.
@@ -6338,7 +6344,7 @@ export interface NS {
* @example
* ```js
* const ps = ns.ps("home");
* for (let script of ps) {
* for (const script of ps) {
* ns.tprint(`${script.filename} ${script.threads}`);
* ns.tprint(script.args);
* }
@@ -6680,7 +6686,7 @@ export interface NS {
* // Attempt to purchase 5 servers with 64GB of ram each
* const ram = 64;
* const prefix = "pserv-";
* for (i = 0; i < 5; ++i) {
* for (let i = 0; i < 5; ++i) {
* ns.purchaseServer(prefix + i, ram);
* }
* ```
@@ -7392,7 +7398,7 @@ export interface NS {
* 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.`);
* ns.tprint(`It has been ${Date.now() - lastAugReset} ms since the last augmentation reset.`);
* ```
* */
getResetInfo(): ResetInfo;