Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-23 22:52:29 +01:00
Code Issues Packages Projects Releases Wiki Activity
bf095ea9e3
bitburner-src/markdown/bitburner.runningscript.md
G4mingJon4s 651b17739c
NETSCRIPT: Add ns.self() as a free info function (#1636) 
* added utility info

* moved info to running script

* fix for RAM cost

* description changes

Co-authored-by: David Walker <d0sboots@gmail.com>

* fixed wrong formatting

* Added parent to ignored fields

---------

Co-authored-by: David Walker <d0sboots@gmail.com>
2024-09-07 17:34:24 -07:00

3.6 KiB
Raw Blame History

Home > bitburner > RunningScript

RunningScript interface

Signature:

interface RunningScript

Properties

Property Modifiers Type Description
args ScriptArg[] Arguments the script was called with
dynamicRamUsage number | undefined

The dynamic RAM usage of (one thread of) this script instance. Does not affect overall RAM consumption (ramUsage is for that), but rather shows how much of the reserved RAM is currently in use via all the ns functions the script has called. Initially 1.6GB, this increases as new functions are called.

Only set for scripts that are still running.
filename string Filename of the script
logs string[] Script logs as an array. The newest log entries are at the bottom. Timestamps, if enabled, are placed inside [brackets] at the start of each line.
offlineExpGained number Total amount of hacking experience earned from this script when offline
offlineMoneyMade number Total amount of money made by this script when offline
offlineRunningTime number Number of seconds that the script has been running offline
onlineExpGained number Total amount of hacking experience earned from this script when online
onlineMoneyMade number Total amount of money made by this script when online
onlineRunningTime number Number of seconds that this script has been running online
parent number

Process ID of the parent process.

If this script was started by another script, this will be the PID of that script. If this script was started directly through the terminal, the value will be 0.
pid number Process ID. Must be an integer
ramUsage number How much RAM this script uses for ONE thread. Also known as "static RAM usage," this value does not change once the script is started, unless you call ns.ramOverride().
server string Hostname of the server on which this script runs
tailProperties TailProperties | null Properties of the tail window, or null if it is not shown
temporary boolean Whether this RunningScript is excluded from saves
threads number Number of threads that this script runs with
title string | ReactElement The title, as shown in the script's log box. Defaults to the name + args, but can be changed by the user. If it is set to a React element (only by the user), that will not be persisted, and will be restored to default on load.