bitburner-src/markdown/bitburner.ns.kill_1.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks ()
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

2.1 KiB
Raw Blame History

Home > bitburner > NS > kill

NS.kill() method

Terminate another script.

Signature:

kill(script: string, host: string, ...args: (string | number | boolean)[]): boolean;

Parameters

Parameter Type Description
script string Filename or PID of the script to kill.
host string Hostname of the server on which to kill the script.
args (string | number | boolean)[] Arguments to identify which script to kill.

Returns:

boolean

True if the script is successfully killed, and false otherwise.

Remarks

RAM cost: 0.5 GB

Kills the script on the target server specified by the scripts name and arguments. Remember that scripts are uniquely identified by both their names and arguments. For example, if foo.script is run with the argument 1, then this is not the same as foo.script run with the argument 2, even though they have the same name.

Example 1

// NS1:
//The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments:
kill("foo.script", "foodnstuff");

//The following will try to kill a script named foo.script on the current server that was ran with no arguments:
kill("foo.script", getHostname());

//The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”:
kill("foo.script", getHostname(), 1, "foodnstuff");

Example 2

// NS2:
//The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments:
ns.kill("foo.script", "foodnstuff");

//The following will try to kill a script named foo.script on the current server that was ran with no arguments:
ns.kill("foo.script", getHostname());

//The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”:
ns.kill("foo.script", getHostname(), 1, "foodnstuff");