From 7500ef0da28e07977d625444b83b505af7840889 Mon Sep 17 00:00:00 2001 From: missymae#2783 <141260118+myCatsName@users.noreply.github.com> Date: Wed, 16 Aug 2023 15:08:55 -0600 Subject: [PATCH] DOCUMENTATION: ns.share and getSharePower definition updates (#734) --- markdown/bitburner.ns.getsharepower.md | 2 +- markdown/bitburner.ns.md | 3 +-- markdown/bitburner.ns.share.md | 2 +- src/ScriptEditor/NetscriptDefinitions.d.ts | 7 ++++--- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/markdown/bitburner.ns.getsharepower.md b/markdown/bitburner.ns.getsharepower.md index 932d4bfb6..6be43f8bd 100644 --- a/markdown/bitburner.ns.getsharepower.md +++ b/markdown/bitburner.ns.getsharepower.md @@ -4,7 +4,7 @@ ## NS.getSharePower() method -Calculate your share power. Based on all the active share calls. +Share Power has a multiplicative effect on rep/second while doing work for a faction. Share Power increases incrementally for every thread of share running on your server network, but at a sharply decreasing rate. **Signature:** diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index aea80c386..2625724b1 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -26,7 +26,6 @@ export async function main(ns) { await ns.hack('n00dles'); } ``` -[ns2 in-game docs](https://bitburner-official.readthedocs.io/en/latest/netscript/netscriptjs.html)
For (deprecated) .script usage, see: [ns1 in-game docs](https://bitburner-official.readthedocs.io/en/latest/netscript/netscript1.html)
## Properties @@ -108,7 +107,7 @@ export async function main(ns) { | [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. | -| [getSharePower()](./bitburner.ns.getsharepower.md) | Calculate your share power. Based on all the active share calls. | +| [getSharePower()](./bitburner.ns.getsharepower.md) | Share Power has a multiplicative effect on rep/second while doing work for a faction. Share Power increases incrementally for every thread of share running on your server network, but at a sharply decreasing rate. | | [getTimeSinceLastAug()](./bitburner.ns.gettimesincelastaug.md) | Returns the amount of time in milliseconds that have passed since you last installed Augmentations. | | [getTotalScriptExpGain()](./bitburner.ns.gettotalscriptexpgain.md) | Get the exp gain of all scripts. | | [getTotalScriptIncome()](./bitburner.ns.gettotalscriptincome.md) | Get the income of all scripts. | diff --git a/markdown/bitburner.ns.share.md b/markdown/bitburner.ns.share.md index 2fda9c188..6e0b7e20f 100644 --- a/markdown/bitburner.ns.share.md +++ b/markdown/bitburner.ns.share.md @@ -19,5 +19,5 @@ Promise<void> RAM cost: 2.4 GB -Increases your rep gain of all faction work types while share is called. Scales with thread count. +Increases rep/second for all faction work while share is running. Each cycle of ns.share() is 10 seconds. Scales with thread count, but at a sharply decreasing rate. diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 42b5f587e..7d3abb2c9 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -6678,13 +6678,14 @@ export interface NS { * @remarks * RAM cost: 2.4 GB * - * Increases your rep gain of all faction work types while share is called. - * Scales with thread count. + * Increases rep/second for all faction work while share is running. Each cycle of ns.share() is 10 seconds. + * Scales with thread count, but at a sharply decreasing rate. */ share(): Promise; /** - * Calculate your share power. Based on all the active share calls. + * Share Power has a multiplicative effect on rep/second while doing work for a faction. + * Share Power increases incrementally for every thread of share running on your server network, but at a sharply decreasing rate. * @remarks * RAM cost: 0.2 GB */