diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts index 32afd2832..f9e541aa0 100644 --- a/dist/bitburner.d.ts +++ b/dist/bitburner.d.ts @@ -2127,17 +2127,24 @@ export declare interface NodeStats { * @remarks * Basic ns1 usage example: * ```ts - * property.methodName; + * // Basic ns functions can be used directly + * methodName(); + * // Some related functions are gathered within a common namespace + * property.methodName() * ``` * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html| ns1 in-game docs} *
* Basic ns2 usage example: * ```ts * export async function main(ns) { - * ns.property.methodName; + * // Basic ns functions can be accessed on the ns object + * ns.methodName; + * // Some related functions are gathered under a sub-property of the ns object + * ns.property.methodName * } * ``` * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html| ns2 in-game docs} + *
*/ export declare interface NS extends Singularity { /** diff --git a/input/bitburner.api.json b/input/bitburner.api.json index 416ce0dcb..448926938 100644 --- a/input/bitburner.api.json +++ b/input/bitburner.api.json @@ -14221,7 +14221,7 @@ { "kind": "Interface", "canonicalReference": "bitburner!NS:interface", - "docComment": "/**\n * Collection of all functions passed to scripts\n *\n * @remarks\n *\n * Basic ns1 usage example:\n * ```ts\n * property.methodName;\n * ```\n *\n * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html | ns1 in-game docs}
Basic ns2 usage example:\n * ```ts\n * export async function main(ns) {\n * ns.property.methodName;\n * }\n * ```\n *\n * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html | ns2 in-game docs}\n *\n * @public\n */\n", + "docComment": "/**\n * Collection of all functions passed to scripts\n *\n * @remarks\n *\n * Basic ns1 usage example:\n * ```ts\n * // Basic ns functions can be used directly\n * methodName();\n * // Some related functions are gathered within a common namespace\n * property.methodName()\n * ```\n *\n * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html | ns1 in-game docs}
Basic ns2 usage example:\n * ```ts\n * export async function main(ns) {\n * // Basic ns functions can be accessed on the ns object\n * ns.methodName;\n * // Some related functions are gathered under a sub-property of the ns object\n * ns.property.methodName\n * }\n * ```\n *\n * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html | ns2 in-game docs}
\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index 7e1a2fdae..f35fda80b 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -18,16 +18,22 @@ export interface NS extends Singularity Basic ns1 usage example: ```ts -property.methodName; + // Basic ns functions can be used directly + methodName(); + // Some related functions are gathered within a common namespace + property.methodName() ``` [ns1 in-game docs](https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html)
Basic ns2 usage example: ```ts export async function main(ns) { - ns.property.methodName; + // Basic ns functions can be accessed on the ns object + ns.methodName; + // Some related functions are gathered under a sub-property of the ns object + ns.property.methodName } ``` -[ns2 in-game docs](https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html) +[ns2 in-game docs](https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html)
## Properties diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index c6ca3bab6..84bd5b67f 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -3710,17 +3710,24 @@ interface Stanek { * @remarks * Basic ns1 usage example: * ```ts - * property.methodName; + * // Basic ns functions can be used directly + * methodName(); + * // Some related functions are gathered within a common namespace + * property.methodName() * ``` * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html| ns1 in-game docs} *
* Basic ns2 usage example: * ```ts * export async function main(ns) { - * ns.property.methodName; + * // Basic ns functions can be accessed on the ns object + * ns.methodName; + * // Some related functions are gathered under a sub-property of the ns object + * ns.property.methodName * } * ``` * {@link https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html| ns2 in-game docs} + *
*/ export interface NS extends Singularity { /**