mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-22 23:53:48 +01:00
ae15914efa
Unfortunately, I haven't used most of the specialty APIs yet, so I'm not intimately familiar with where their documentation might be wrong. I figured some fixes were better than no fixes, and I can always make more fixes later. Fixes #1023.
27 lines
1.3 KiB
ReStructuredText
27 lines
1.3 KiB
ReStructuredText
write() Netscript Function
|
|
===========================
|
|
|
|
.. js:function:: write(portOrFilename, data="", mode="a")
|
|
|
|
:RAM cost: 1 GB
|
|
:param string/number portOrFilename: Port or text file/script that will be written to
|
|
:param string data: Data to write
|
|
:param string mode: Defines the write mode. Only valid when writing to text files or scripts.
|
|
|
|
This function can be used to either write data to a port, a text file
|
|
(.txt), or a script (.script, .js, .ns)
|
|
|
|
If the first argument is a number between 1 and 20, then it specifies a port
|
|
and this function will write ``data`` to that port. Read about how
|
|
:ref:`netscript_ports` work here. The third argument, ``mode``, is not used
|
|
when writing to a port.
|
|
|
|
If the first argument is a string, then it specifies the name of a text file
|
|
or script and this function will write ``data`` to that text file/script. If
|
|
the specified text file/script does not exist, then it will be created. The
|
|
third argument ``mode``, defines how the data will be written. If ``mode``
|
|
is set to "w", then the data is written in "write" mode which means that it
|
|
will overwrite all existing data on the text file/script. If ``mode`` is set
|
|
to any other value then the data will be written in "append" mode which
|
|
means that the data will be added at the end of the file.
|