Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-20 21:25:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4206 from quacksouls/doc-exec

Browse Source 
DOC: `ns.exec()`: typo fixes and clean presentation
This commit is contained in:
hydroflame 2022-10-09 00:22:54 -04:00 committed by GitHub
commit b4d6ead5d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -5369,10 +5369,10 @@ export interface NS {
* @remarks
* RAM cost: 1.3 GB
*
* Run a script as a separate process on a specified server. This is similar to the run function
* Run a script as a separate process on a specified server. This is similar to the function {@link NS.run | run}
* except that it can be used to run a script on any server, instead of just the current server.
*
* If the script was successfully started, then this functions returns the PID of that script.
* If the script was successfully started, then this function returns the PID of that script.
* Otherwise, it returns 0.
*
* PID stands for Process ID. The PID is a unique identifier for each script.
@ -5383,30 +5383,40 @@ export interface NS {
* @example
* ```ts
* // NS1:
* //The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server:
* // The simplest way to use the exec command is to call it with just the script name
* // and the target server. The following example will try to run generic-hack.script
* // on the foodnstuff server.
* exec("generic-hack.script", "foodnstuff");
*
* //The following example will try to run the script generic-hack.script on the joesguns server with 10 threads:
* // The following example will try to run the script generic-hack.script on the
* // joesguns server with 10 threads.
* exec("generic-hack.script", "joesguns", 10);
*
* //This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script:
* // This last example will try to run the script foo.script on the foodnstuff server
* // with 5 threads. It will also pass the number 1 and the string “test” in as
* // arguments to the script.
* exec("foo.script", "foodnstuff", 5, 1, "test");
* ```
* * @example
* @example
* ```ts
* // NS2:
* //The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server:
* // The simplest way to use the exec command is to call it with just the script name
* // and the target server. The following example will try to run generic-hack.script
* // on the foodnstuff server.
* ns.exec("generic-hack.script", "foodnstuff");
*
* //The following example will try to run the script generic-hack.script on the joesguns server with 10 threads:
* // The following example will try to run the script generic-hack.script on the
* // joesguns server with 10 threads.
* ns.exec("generic-hack.script", "joesguns", 10);
*
* //This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script:
* // This last example will try to run the script foo.script on the foodnstuff server
* // with 5 threads. It will also pass the number 1 and the string “test” in as
* // arguments to the script.
* ns.exec("foo.script", "foodnstuff", 5, 1, "test");
* ```
* @param script - Filename of script to execute.
* @param host - Hostname of the `target server` on which to execute the script.
* @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer.
* @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded down to the nearest integer.
* @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument numThreads must be filled in with a value.
* @returns Returns the PID of a successfully started script, and 0 otherwise.
*/