bitburner-src/doc/source/netscript/netscriptscriptarguments.rst

.. _netscript_script_arguments:

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...).
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.
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 argument. The code would look like:

..  code:: javascript

    var fileName = args[0];
    var threads = args[1];
    run(fileName, threads);

And it could be ran from the terminal like:

``run generic-run.script myscript.script 7``

In .js / ns2, the above script would look like:

.. code:: javascript

    export async function main(ns) {
      let fileName = ns.args[0];
      let threads = ns.args[1];
      ns.run(fileName, threads);
    }

It is also possible to get the number of arguments that were passed
into a script using ``args.length``.

If we want to make a script like ``foo.js`` that gets 2 arguments: a string to print
and a number of time to print that string, the code could look like:

.. code:: javascript

    export async function main(ns) {
      for (let i=0; i<ns.args[1];i++){
        ns.tprint(ns.args[0])
      }
    }

Then we can have another script launch ``foo.js`` with the 2 arguments like:

.. code:: javascript

    export async function main(ns) {
      ns.exec("foo.js","n00dles",1,"this will be printed twice", 2)
    }