From 2e9dc32debe364844b95e2fe2df85b8e123c3afa Mon Sep 17 00:00:00 2001 From: Nikolai Korolev Date: Thu, 18 May 2023 06:28:56 +0100 Subject: [PATCH] DOC: Specify optional parameters in hacknet functions (#515) --- .../bitburner.hacknet.getcacheupgradecost.md | 4 +-- .../bitburner.hacknet.getcoreupgradecost.md | 4 +-- .../bitburner.hacknet.getlevelupgradecost.md | 4 +-- .../bitburner.hacknet.getramupgradecost.md | 4 +-- markdown/bitburner.hacknet.upgradecache.md | 4 +-- markdown/bitburner.hacknet.upgradecore.md | 4 +-- markdown/bitburner.hacknet.upgradelevel.md | 4 +-- markdown/bitburner.hacknet.upgraderam.md | 4 +-- src/ScriptEditor/NetscriptDefinitions.d.ts | 32 +++++++++---------- 9 files changed, 32 insertions(+), 32 deletions(-) diff --git a/markdown/bitburner.hacknet.getcacheupgradecost.md b/markdown/bitburner.hacknet.getcacheupgradecost.md index 101ad8e53..89441dfb7 100644 --- a/markdown/bitburner.hacknet.getcacheupgradecost.md +++ b/markdown/bitburner.hacknet.getcacheupgradecost.md @@ -9,7 +9,7 @@ Calculate the cost of upgrading hacknet node cache. **Signature:** ```typescript -getCacheUpgradeCost(index: number, n: number): number; +getCacheUpgradeCost(index: number, n?: number): number; ``` ## Parameters @@ -17,7 +17,7 @@ getCacheUpgradeCost(index: number, n: number): number; | Parameter | Type | Description | | --- | --- | --- | | index | number | Index/Identifier of Hacknet Node. | -| n | number | Number of times to upgrade cache. Must be positive. Rounded to nearest integer. | +| n | number | _(Optional)_ Number of times to upgrade cache. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified. | **Returns:** diff --git a/markdown/bitburner.hacknet.getcoreupgradecost.md b/markdown/bitburner.hacknet.getcoreupgradecost.md index 6f34adad5..01477e7e1 100644 --- a/markdown/bitburner.hacknet.getcoreupgradecost.md +++ b/markdown/bitburner.hacknet.getcoreupgradecost.md @@ -9,7 +9,7 @@ Calculate the cost of upgrading hacknet node cores. **Signature:** ```typescript -getCoreUpgradeCost(index: number, n: number): number; +getCoreUpgradeCost(index: number, n?: number): number; ``` ## Parameters @@ -17,7 +17,7 @@ getCoreUpgradeCost(index: number, n: number): number; | Parameter | Type | Description | | --- | --- | --- | | index | number | Index/Identifier of Hacknet Node. | -| n | number | Number of times to upgrade cores. Must be positive. Rounded to nearest integer. | +| n | number | _(Optional)_ Number of times to upgrade cores. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified. | **Returns:** diff --git a/markdown/bitburner.hacknet.getlevelupgradecost.md b/markdown/bitburner.hacknet.getlevelupgradecost.md index 8410bef52..5f20f7494 100644 --- a/markdown/bitburner.hacknet.getlevelupgradecost.md +++ b/markdown/bitburner.hacknet.getlevelupgradecost.md @@ -9,7 +9,7 @@ Calculate the cost of upgrading hacknet node levels. **Signature:** ```typescript -getLevelUpgradeCost(index: number, n: number): number; +getLevelUpgradeCost(index: number, n?: number): number; ``` ## Parameters @@ -17,7 +17,7 @@ getLevelUpgradeCost(index: number, n: number): number; | Parameter | Type | Description | | --- | --- | --- | | index | number | Index/Identifier of Hacknet Node. | -| n | number | Number of levels to upgrade. Must be positive. Rounded to nearest integer. | +| n | number | _(Optional)_ Number of levels to upgrade. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified. | **Returns:** diff --git a/markdown/bitburner.hacknet.getramupgradecost.md b/markdown/bitburner.hacknet.getramupgradecost.md index a8c207316..e38b2e06e 100644 --- a/markdown/bitburner.hacknet.getramupgradecost.md +++ b/markdown/bitburner.hacknet.getramupgradecost.md @@ -9,7 +9,7 @@ Calculate the cost of upgrading hacknet node RAM. **Signature:** ```typescript -getRamUpgradeCost(index: number, n: number): number; +getRamUpgradeCost(index: number, n?: number): number; ``` ## Parameters @@ -17,7 +17,7 @@ getRamUpgradeCost(index: number, n: number): number; | Parameter | Type | Description | | --- | --- | --- | | index | number | Index/Identifier of Hacknet Node. | -| n | number | Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. | +| n | number | _(Optional)_ Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified. | **Returns:** diff --git a/markdown/bitburner.hacknet.upgradecache.md b/markdown/bitburner.hacknet.upgradecache.md index 7a19e4028..310cab522 100644 --- a/markdown/bitburner.hacknet.upgradecache.md +++ b/markdown/bitburner.hacknet.upgradecache.md @@ -9,7 +9,7 @@ Upgrade the cache of a hacknet node. **Signature:** ```typescript -upgradeCache(index: number, n: number): boolean; +upgradeCache(index: number, n?: number): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ upgradeCache(index: number, n: number): boolean; | Parameter | Type | Description | | --- | --- | --- | | index | number | Index/Identifier of Hacknet Node. | -| n | number | Number of cache levels to purchase. Must be positive. Rounded to nearest integer. | +| n | number | _(Optional)_ Number of cache levels to purchase. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified. | **Returns:** diff --git a/markdown/bitburner.hacknet.upgradecore.md b/markdown/bitburner.hacknet.upgradecore.md index 8f8e06c46..5901c9627 100644 --- a/markdown/bitburner.hacknet.upgradecore.md +++ b/markdown/bitburner.hacknet.upgradecore.md @@ -9,7 +9,7 @@ Upgrade the core of a hacknet node. **Signature:** ```typescript -upgradeCore(index: number, n: number): boolean; +upgradeCore(index: number, n?: number): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ upgradeCore(index: number, n: number): boolean; | Parameter | Type | Description | | --- | --- | --- | | index | number | Index/Identifier of Hacknet Node. | -| n | number | Number of cores to purchase. Must be positive. Rounded to nearest integer. | +| n | number | _(Optional)_ Number of cores to purchase. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified. | **Returns:** diff --git a/markdown/bitburner.hacknet.upgradelevel.md b/markdown/bitburner.hacknet.upgradelevel.md index a7b43cf75..fcbaf1e46 100644 --- a/markdown/bitburner.hacknet.upgradelevel.md +++ b/markdown/bitburner.hacknet.upgradelevel.md @@ -9,7 +9,7 @@ Upgrade the level of a hacknet node. **Signature:** ```typescript -upgradeLevel(index: number, n: number): boolean; +upgradeLevel(index: number, n?: number): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ upgradeLevel(index: number, n: number): boolean; | Parameter | Type | Description | | --- | --- | --- | | index | number | Index/Identifier of Hacknet Node. | -| n | number | Number of levels to purchase. Must be positive. Rounded to nearest integer. | +| n | number | _(Optional)_ Number of levels to purchase. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified. | **Returns:** diff --git a/markdown/bitburner.hacknet.upgraderam.md b/markdown/bitburner.hacknet.upgraderam.md index 8fe15e2ea..d0e862534 100644 --- a/markdown/bitburner.hacknet.upgraderam.md +++ b/markdown/bitburner.hacknet.upgraderam.md @@ -9,7 +9,7 @@ Upgrade the RAM of a hacknet node. **Signature:** ```typescript -upgradeRam(index: number, n: number): boolean; +upgradeRam(index: number, n?: number): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ upgradeRam(index: number, n: number): boolean; | Parameter | Type | Description | | --- | --- | --- | | index | number | Index/Identifier of Hacknet Node. | -| n | number | Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. | +| n | number | _(Optional)_ Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified. | **Returns:** diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index cb895900b..f3ff2ab89 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -2405,10 +2405,10 @@ export interface Hacknet { * Returns false otherwise. * * @param index - Index/Identifier of Hacknet Node. - * @param n - Number of levels to purchase. Must be positive. Rounded to nearest integer. + * @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; + upgradeLevel(index: number, n?: number): boolean; /** * Upgrade the RAM of a hacknet node. @@ -2425,10 +2425,10 @@ export interface Hacknet { * 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. + * @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; + upgradeRam(index: number, n?: number): boolean; /** * Upgrade the core of a hacknet node. @@ -2443,10 +2443,10 @@ export interface Hacknet { * Returns false otherwise. * * @param index - Index/Identifier of Hacknet Node. - * @param n - Number of cores to purchase. Must be positive. Rounded to nearest integer. + * @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; + upgradeCore(index: number, n?: number): boolean; /** * Upgrade the cache of a hacknet node. @@ -2463,10 +2463,10 @@ export interface Hacknet { * 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. + * @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; + upgradeCache(index: number, n?: number): boolean; /** * Calculate the cost of upgrading hacknet node levels. @@ -2479,10 +2479,10 @@ export interface Hacknet { * 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. + * @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; + getLevelUpgradeCost(index: number, n?: number): number; /** * Calculate the cost of upgrading hacknet node RAM. @@ -2495,10 +2495,10 @@ export interface Hacknet { * 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. + * @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; + getRamUpgradeCost(index: number, n?: number): number; /** * Calculate the cost of upgrading hacknet node cores. @@ -2511,10 +2511,10 @@ export interface Hacknet { * 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. + * @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; + getCoreUpgradeCost(index: number, n?: number): number; /** * Calculate the cost of upgrading hacknet node cache. @@ -2529,10 +2529,10 @@ export interface Hacknet { * 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. + * @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; + getCacheUpgradeCost(index: number, n?: number): number; /** * Get the total number of hashes stored.