felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-16 22:38:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

DOCS: Update documentation for ns.args (#220)

Browse Source
This commit is contained in:
Snarling
2022-11-21 12:19:16 -05:00
committed by GitHub
parent 79fd5f6089
commit 6616f7ba15
2 changed files with 42 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
doc/source/netscript/netscriptscriptarguments.rst
View File

@@ -4,33 +4,28 @@ Netscript Script Arguments
==========================
Arguments passed into a script can be accessed in Netscript using a
special array called *args*. The arguments can be
accessed using a normal array using the [] operator
(args[0], args[1], etc...).
special array called ``args``. The arguments can be accessed using a
normal array using the ``[]`` operator (``args[0]``, ``args[1]``, etc...).
These arguments can be string, number, or boolean.
For example, let's say we want to make a generic script
'generic-run.script' and we plan to pass two arguments into that script.
``generic-run.script`` and we plan to pass two arguments into that script.
The first argument will be the name of another script, and the second
argument will be a number. This generic script will run the
script specified in the first argument with the amount of threads
specified in the second element. The code would look like::
specified in the second argument. The code would look like::
run(args[0], args[1]);
It is also possible to get the number of arguments that was passed
into a script using::
And it could be ran from the terminal like:
args.length
``run generic-run.script myscript.script 7``
**WARNING: Do not try to modify the args array. This will break the game.**
In .js / ns2, the above script would look like::
export async function main(ns) {
ns.run(ns.args[0], ns.args[1]);
}
example for accessing arguments in ns2 from terminal execution:
terminal command:
run name_of_script.js -t 10 --tail argument1 argument2
ns2 script:
const args_obj = arguments[0]
const argument1 = (args_obj.server.args[0])
const argument2 = (args_obj.server.args[1])
It is also possible to get the number of arguments that were passed
into a script using ``args.length``.