Files
bitburner-src/markdown/bitburner.runningscript.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* Update api-documentor and api-extractor. #1566 follow-up.

I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.

I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).

Stylisticly it could use some whitespace, but it is correctly rendered.

This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.

* Follow up to 5f732a6f35, include `npm run doc` changed docs.

* Add missing license info

* Fix React warning

---------

Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
2025-09-26 14:52:39 -07:00

4.4 KiB

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.