diff --git a/markdown/bitburner.ns.exec.md b/markdown/bitburner.ns.exec.md index 9c4074d30..b17ceec54 100644 --- a/markdown/bitburner.ns.exec.md +++ b/markdown/bitburner.ns.exec.md @@ -110,7 +110,7 @@ Run a script as a separate process on a specified server. This is similar to the 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. The PID will always be a positive integer. +PID stands for Process ID. The PID is a unique identifier for each script across all hosts. The PID will always be a positive integer. Running this function with 0 or fewer threads will cause a runtime error. diff --git a/markdown/bitburner.ns.getporthandle.md b/markdown/bitburner.ns.getporthandle.md index 05a7d2900..addbf0d70 100644 --- a/markdown/bitburner.ns.getporthandle.md +++ b/markdown/bitburner.ns.getporthandle.md @@ -56,5 +56,5 @@ Port number. Must be a positive integer. RAM cost: 0 GB -Get a handle to a Netscript Port. +Get a handle to a Netscript Port. Ports are shared across all hosts and contents are reset on game restart. diff --git a/markdown/bitburner.ns.kill.md b/markdown/bitburner.ns.kill.md index df191e6c6..5e05c2d76 100644 --- a/markdown/bitburner.ns.kill.md +++ b/markdown/bitburner.ns.kill.md @@ -58,7 +58,7 @@ True if the script is successfully killed, and false otherwise. RAM cost: 0.5 GB -Kills the script with the provided PID. To instead kill a script using its filename, host, and args, see [the other ns.kill entry](./bitburner.ns.kill_1.md). +Kills the script with the provided PID. PIDs are unique across all hosts. To instead kill a script using its filename, host, and args, see [the other ns.kill entry](./bitburner.ns.kill_1.md). ## Example diff --git a/markdown/bitburner.ns.nextportwrite.md b/markdown/bitburner.ns.nextportwrite.md index 203a18771..eb3c7a913 100644 --- a/markdown/bitburner.ns.nextportwrite.md +++ b/markdown/bitburner.ns.nextportwrite.md @@ -56,5 +56,5 @@ Promise<void> RAM cost: 0 GB -Sleeps until the port is written to. +Sleeps until the port is written to. Ports are shared across all hosts and contents are reset on game restart. diff --git a/markdown/bitburner.ns.peek.md b/markdown/bitburner.ns.peek.md index 7bfd6e843..dd154bbe7 100644 --- a/markdown/bitburner.ns.peek.md +++ b/markdown/bitburner.ns.peek.md @@ -58,5 +58,5 @@ Data in the specified port. RAM cost: 0 GB -This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned. +This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned. Ports are shared across all hosts and contents are reset on game restart. diff --git a/markdown/bitburner.ns.readport.md b/markdown/bitburner.ns.readport.md index 24656fd8a..3fe7286dc 100644 --- a/markdown/bitburner.ns.readport.md +++ b/markdown/bitburner.ns.readport.md @@ -58,5 +58,5 @@ The data read. RAM cost: 0 GB -Read data from that port. A port is a serialized queue. This function will remove the first element from that queue and return it. If the queue is empty, then the string “NULL PORT DATA” will be returned. +Read data from that port. A port is a serialized queue. This function will remove the first element from that queue and return it. If the queue is empty, then the string “NULL PORT DATA” will be returned. Ports are shared across all hosts and contents are reset on game restart. diff --git a/markdown/bitburner.ns.run.md b/markdown/bitburner.ns.run.md index 2838d9b1f..85504043f 100644 --- a/markdown/bitburner.ns.run.md +++ b/markdown/bitburner.ns.run.md @@ -96,7 +96,7 @@ The second argument is either a thread count, or a [RunOptions](./bitburner.runo If the script was successfully started, then this functions returns the PID of that script. Otherwise, it returns 0. -PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer. +PID stands for Process ID. The PID is a unique identifier for each script across all hosts. The PID will always be a positive integer. Running this function with 0 or fewer threads will cause a runtime error. diff --git a/markdown/bitburner.ns.trywriteport.md b/markdown/bitburner.ns.trywriteport.md index b301cdb04..16b7260b0 100644 --- a/markdown/bitburner.ns.trywriteport.md +++ b/markdown/bitburner.ns.trywriteport.md @@ -74,5 +74,5 @@ True if the data is successfully written to the port, and false otherwise. RAM cost: 0 GB -Attempts to write data to the specified Netscript port. If the port is full, the data will not be written. Otherwise, the data will be written normally. +Attempts to write data to the specified Netscript port. If the port is full, the data will not be written. Otherwise, the data will be written normally. Ports are shared across all hosts and contents are reset on game restart. diff --git a/markdown/bitburner.ns.writeport.md b/markdown/bitburner.ns.writeport.md index 191fd1e05..b3a550eb1 100644 --- a/markdown/bitburner.ns.writeport.md +++ b/markdown/bitburner.ns.writeport.md @@ -76,5 +76,5 @@ RAM cost: 0 GB Write data to the given Netscript port. -There is a limit on the maximum number of ports, but you won't reach that limit in normal situations. If you do, it usually means that there is a bug in your script that leaks port data. A port is freed when it does not have any data in its underlying queue. `ns.clearPort` deletes all data on a port. `ns.readPort` reads the first element in the port's queue, then removes it from the queue. +There is a limit on the maximum number of ports, but you won't reach that limit in normal situations. If you do, it usually means that there is a bug in your script that leaks port data. A port is freed when it does not have any data in its underlying queue. `ns.clearPort` deletes all data on a port. `ns.readPort` reads the first element in the port's queue, then removes it from the queue. Ports are shared across all hosts and contents are reset on game restart. diff --git a/markdown/bitburner.runningscript.md b/markdown/bitburner.runningscript.md index 649d78c40..ac76ac05c 100644 --- a/markdown/bitburner.runningscript.md +++ b/markdown/bitburner.runningscript.md @@ -262,7 +262,7 @@ number -Process ID. Must be an integer +A Process ID unique to this script across all hosts. Must be an integer starting from 1 for the first process spawned at game launch and incrementing from there. Note that PIDs are not saved in the savegame and are regenerated at launch. diff --git a/markdown/bitburner.runningscript.pid.md b/markdown/bitburner.runningscript.pid.md index b104637cc..5ac6e2c00 100644 --- a/markdown/bitburner.runningscript.pid.md +++ b/markdown/bitburner.runningscript.pid.md @@ -4,7 +4,7 @@ ## RunningScript.pid property -Process ID. Must be an integer +A Process ID unique to this script across all hosts. Must be an integer starting from 1 for the first process spawned at game launch and incrementing from there. Note that PIDs are not saved in the savegame and are regenerated at launch. **Signature:** diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index ed7e8ae89..89ae900e2 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -264,7 +264,10 @@ interface RunningScript { onlineMoneyMade: number; /** Number of seconds that this script has been running online */ onlineRunningTime: number; - /** Process ID. Must be an integer */ + /** A Process ID unique to this script across all hosts. Must be an integer starting + * from 1 for the first process spawned at game launch and incrementing from there. + * Note that PIDs are not saved in the savegame and are regenerated at launch. + */ pid: number; /** * Process ID of the parent process. @@ -7003,7 +7006,7 @@ export interface NS { * If the script was successfully started, then this functions returns the PID of that script. * Otherwise, it returns 0. * - * PID stands for Process ID. The PID is a unique identifier for each script. + * PID stands for Process ID. The PID is a unique identifier for each script across all hosts. * The PID will always be a positive integer. * * Running this function with 0 or fewer threads will cause a runtime error. @@ -7037,7 +7040,7 @@ export interface NS { * 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. + * PID stands for Process ID. The PID is a unique identifier for each script across all hosts. * The PID will always be a positive integer. * * Running this function with 0 or fewer threads will cause a runtime error. @@ -7106,7 +7109,7 @@ export interface NS { * @remarks * RAM cost: 0.5 GB * - * Kills the script with the provided PID. + * Kills the script with the provided PID. PIDs are unique across all hosts. * To instead kill a script using its filename, host, and args, see {@link NS.(kill:2) | the other ns.kill entry}. * * @example @@ -7715,6 +7718,7 @@ export interface NS { * Attempts to write data to the specified Netscript port. * If the port is full, the data will not be written. * Otherwise, the data will be written normally. + * Ports are shared across all hosts and contents are reset on game restart. * * @param portNumber - Port to attempt to write to. Must be a positive integer. * @param data - Data to write, it's cloned with structuredClone(). @@ -7728,6 +7732,7 @@ export interface NS { * RAM cost: 0 GB * * Sleeps until the port is written to. + * Ports are shared across all hosts and contents are reset on game restart. * * @param port - Port to listen for a write on. Must be a positive integer. */ @@ -7769,6 +7774,7 @@ export interface NS { * This function is used to peek at the data from a port. It returns the * first element in the specified port without removing that element. If * the port is empty, the string “NULL PORT DATA” will be returned. + * Ports are shared across all hosts and contents are reset on game restart. * * @param portNumber - Port to peek. Must be a positive integer. * @returns Data in the specified port. @@ -7808,6 +7814,7 @@ export interface NS { * usually means that there is a bug in your script that leaks port data. A port is freed when it does not have any * data in its underlying queue. `ns.clearPort` deletes all data on a port. `ns.readPort` reads the first element in * the port's queue, then removes it from the queue. + * Ports are shared across all hosts and contents are reset on game restart. * * @param portNumber - Port to write to. Must be a positive integer. * @param data - Data to write, it's cloned with structuredClone(). @@ -7823,6 +7830,8 @@ export interface NS { * Read data from that port. A port is a serialized queue. * This function will remove the first element from that queue and return it. * If the queue is empty, then the string “NULL PORT DATA” will be returned. + * Ports are shared across all hosts and contents are reset on game restart. + * * @param portNumber - Port to read from. Must be a positive integer. * @returns The data read. */ @@ -7834,6 +7843,7 @@ export interface NS { * RAM cost: 0 GB * * Get a handle to a Netscript Port. + * Ports are shared across all hosts and contents are reset on game restart. * * @param portNumber - Port number. Must be a positive integer. */