Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-19 04:35:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

DOCUMENTATION: Clarify maximum number of ports (#1388)

Browse Source
This commit is contained in:
catloversg 2024-06-13 09:07:05 +07:00 committed by GitHub
parent 39b18e7659
commit 344054f10d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
markdown/bitburner.ns.writeport.md
View File

@ -31,3 +31,5 @@ RAM cost: 0 GB
Write data to the given Netscript port. 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.

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

@ -6891,11 +6891,18 @@ export interface NS {
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* Write data to the given Netscript port. * 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.
*
* @param portNumber - Port to write to. Must be a positive integer. * @param portNumber - Port to write to. Must be a positive integer.
* @param data - Data to write, it's cloned with structuredClone(). * @param data - Data to write, it's cloned with structuredClone().
* @returns The data popped off the queue if it was full, or null if it was not full. * @returns The data popped off the queue if it was full, or null if it was not full.
*/ */
writePort(portNumber: number, data: any): any; writePort(portNumber: number, data: any): any;
/** /**
* Read data from a port. * Read data from a port.
* @remarks * @remarks