DOCUMENTATION: Add missing newline after RAM cost (#2570)

This commit is contained in:
catloversg
2026-03-14 09:23:29 +07:00
committed by GitHub
parent 8bdcaf5f83
commit bc3e8ff3d5
32 changed files with 120 additions and 39 deletions

View File

@@ -19,7 +19,9 @@ Array containing current stamina and max stamina.
## Remarks
RAM cost: 4 GB Returns an array with two elements: \* \[Current stamina, Max stamina\]
RAM cost: 4 GB
Returns an array with two elements: \* \[Current stamina, Max stamina\]
## Example

View File

@@ -19,7 +19,9 @@ True if you successfully join the Bladeburner faction, or if you are already a m
## Remarks
RAM cost: 4 GB Attempts to join the Bladeburner faction.
RAM cost: 4 GB
Attempts to join the Bladeburner faction.
Returns true if you successfully join the Bladeburner faction, or if you are already a member.

View File

@@ -56,7 +56,9 @@ true if successful, and false otherwise
## Remarks
RAM cost: 4 GB Attempts to switch to the specified city (for Bladeburner only).
RAM cost: 4 GB
Attempts to switch to the specified city (for Bladeburner only).
Returns true if successful, and false otherwise

View File

@@ -4,7 +4,7 @@
## Go.cheat property
Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use.
Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Source-File 14.2 to use.
**Signature:**

View File

@@ -69,7 +69,7 @@ Tools to analyze the IPvGO subnet.
</td><td>
Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use.
Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Source-File 14.2 to use.
</td></tr>

View File

@@ -62,5 +62,7 @@ A 2D array of numbers identifying the chain ID of each point.
## Remarks
RAM cost: 16 GB (This is intentionally expensive; you can derive this info from just getBoardState() )
RAM cost: 16 GB
(This is intentionally expensive; you can derive this info from just getBoardState() )

View File

@@ -62,5 +62,7 @@ A 2D array of characters indicating the player who controls each empty point.
## Remarks
RAM cost: 16 GB (This is intentionally expensive; you can derive this info from just getBoardState() )
RAM cost: 16 GB
(This is intentionally expensive; you can derive this info from just getBoardState() )

View File

@@ -60,5 +60,7 @@ A 2D array of numbers counting the liberties of each point.
## Remarks
RAM cost: 16 GB (This is intentionally expensive; you can derive this info from just getBoardState() )
RAM cost: 16 GB
(This is intentionally expensive; you can derive this info from just getBoardState() )

View File

@@ -98,5 +98,7 @@ A 2D array of booleans indicating the validity of each move.
## Remarks
RAM cost: 8 GB (This is intentionally expensive; you can derive this info from just getBoardState() and getMoveHistory() )
RAM cost: 8 GB
(This is intentionally expensive; you can derive this info from just getBoardState() and getMoveHistory() )

View File

@@ -100,5 +100,7 @@ a promise that contains the opponent move's x and y coordinates (or pass) in res
## Remarks
RAM cost: 8 GB Requires BitNode 14.2 to use
RAM cost: 8 GB
Requires Source-File 14.2 to use

View File

@@ -56,5 +56,7 @@ The number of times you've attempted to cheat in the current game.
## Remarks
RAM cost: 1 GB Requires BitNode 14.2 to use
RAM cost: 1 GB
Requires Source-File 14.2 to use

View File

@@ -74,5 +74,7 @@ Your chance of successfully playing a cheat move.
## Remarks
RAM cost: 1 GB Requires BitNode 14.2 to use
RAM cost: 1 GB
Requires Source-File 14.2 to use

View File

@@ -4,7 +4,7 @@
## GoCheat interface
Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use.
Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Source-File 14.2 to use.
**Signature:**

View File

@@ -134,5 +134,7 @@ a promise that contains the opponent move's x and y coordinates (or pass) in res
## Remarks
RAM cost: 8 GB Requires BitNode 14.2 to use
RAM cost: 8 GB
Requires Source-File 14.2 to use

View File

@@ -100,5 +100,7 @@ a promise that contains the opponent move's x and y coordinates (or pass) in res
## Remarks
RAM cost: 8 GB Requires BitNode 14.2 to use
RAM cost: 8 GB
Requires Source-File 14.2 to use

View File

@@ -100,5 +100,7 @@ a promise that contains the opponent move's x and y coordinates (or pass) in res
## Remarks
RAM cost: 8 GB Requires BitNode 14.2 to use
RAM cost: 8 GB
Requires Source-File 14.2 to use

View File

@@ -655,7 +655,7 @@ Tools to analyze the IPvGO subnet.
</td><td>
Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use.
Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Source-File 14.2 to use.
</td></tr>

View File

@@ -56,5 +56,7 @@ Base security level of the target server.
## Remarks
RAM cost: 0.1 GB Returns the base security level of the target server. For the server's actual security level, use [ns.getServerSecurityLevel](./bitburner.ns.getserversecuritylevel.md)<!-- -->.
RAM cost: 0.1 GB
Returns the base security level of the target server. For the server's actual security level, use [ns.getServerSecurityLevel](./bitburner.ns.getserversecuritylevel.md)<!-- -->.

View File

@@ -72,7 +72,9 @@ The stock price at which each share was purchased, otherwise 0 if the shares wer
## Remarks
RAM cost: 2.5 GB Attempts to purchase a short position of a stock using a Market Order.
RAM cost: 2.5 GB
Attempts to purchase a short position of a stock using a Market Order.
The ability to short a stock is \*\*not\*\* immediately available to the player and must be unlocked later on in the game.

View File

@@ -72,7 +72,9 @@ The stock price at which each share was purchased, otherwise 0 if the shares wer
## Remarks
RAM cost: 2.5 GB Attempts to purchase shares of a stock using a Market Order.
RAM cost: 2.5 GB
Attempts to purchase shares of a stock using a Market Order.
If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee.

View File

@@ -118,7 +118,9 @@ void
## Remarks
RAM cost: 2.5 GB Cancels an outstanding Limit or Stop order on the stock market.
RAM cost: 2.5 GB
Cancels an outstanding Limit or Stop order on the stock market.
The ability to use limit and stop orders is \*\*not\*\* immediately available to the player and must be unlocked later on in the game.

View File

@@ -56,7 +56,9 @@ Probability that the specified stocks price will increase (as opposed to decr
## Remarks
RAM cost: 2.5 GB The probability is returned in the range 0-1. (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).
RAM cost: 2.5 GB
The probability is returned in the range 0-1. (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).
In other words, if this function returned 0.30 for a stock, then this means that the stocks price has a 30% chance of increasing and a 70% chance of decreasing during the next tick.

View File

@@ -56,5 +56,7 @@ Maximum number of shares that the stock has.
## Remarks
RAM cost: 2 GB This is the maximum amount of the stock that can be purchased in both the Long and Short positions combined.
RAM cost: 2 GB
This is the maximum amount of the stock that can be purchased in both the Long and Short positions combined.

View File

@@ -19,7 +19,9 @@ Object containing information for all the Limit and Stop Orders you have in the
## Remarks
RAM cost: 2.5 GB This is an object containing information for all the Limit and Stop Orders you have in the stock market. For each symbol you have a position in, the returned object will have a key with that symbol's name. The object's properties are each an array of [StockOrder](./bitburner.stockorder.md) The object has the following structure:
RAM cost: 2.5 GB
This is an object containing information for all the Limit and Stop Orders you have in the stock market. For each symbol you have a position in, the returned object will have a key with that symbol's name. The object's properties are each an array of [StockOrder](./bitburner.stockorder.md) The object has the following structure:
```js
{

View File

@@ -56,7 +56,9 @@ Array of four elements that represents the players position in a stock.
## Remarks
RAM cost: 2 GB Returns an array of four elements that represents the players position in a stock.
RAM cost: 2 GB
Returns an array of four elements that represents the players position in a stock.
The first element in the returned array is the number of shares the player owns of the stock in the Long position. The second element in the array is the average price of the players shares in the Long position.

View File

@@ -88,5 +88,7 @@ Cost to buy a given number of shares of a stock.
## Remarks
RAM cost: 2 GB Calculates and returns how much it would cost to buy a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.
RAM cost: 2 GB
Calculates and returns how much it would cost to buy a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.

View File

@@ -88,5 +88,7 @@ Gain from selling a given number of shares of a stock.
## Remarks
RAM cost: 2 GB Calculates and returns how much you would gain from selling a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.
RAM cost: 2 GB
Calculates and returns how much you would gain from selling a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.

View File

@@ -56,7 +56,9 @@ Volatility of the specified stock.
## Remarks
RAM cost: 2.5 GB Volatility represents the maximum percentage by which a stocks price can change every tick. The volatility is returned in the range 0-1. (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).
RAM cost: 2.5 GB
Volatility represents the maximum percentage by which a stocks price can change every tick. The volatility is returned in the range 0-1. (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).
In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.

View File

@@ -120,7 +120,9 @@ True if the order is successfully placed, and false otherwise.
## Remarks
RAM cost: 2.5 GB Places an order on the stock market. This function only works for Limit and Stop Orders.
RAM cost: 2.5 GB
Places an order on the stock market. This function only works for Limit and Stop Orders.
The ability to place limit and stop orders is \*\*not\*\* immediately available to the player and must be unlocked later on in the game.

View File

@@ -72,7 +72,9 @@ The stock price at which each share was sold, otherwise 0 if the shares weren't
## Remarks
RAM cost: 2.5 GB Attempts to sell a short position of a stock using a Market Order.
RAM cost: 2.5 GB
Attempts to sell a short position of a stock using a Market Order.
The ability to short a stock is \*\*not\*\* immediately available to the player and must be unlocked later on in the game.

View File

@@ -72,7 +72,9 @@ The stock price at which each share was sold, otherwise 0 if the shares weren't
## Remarks
RAM cost: 2.5 GB Attempts to sell shares of a stock using a Market Order.
RAM cost: 2.5 GB
Attempts to sell shares of a stock using a Market Order.
If the specified number of shares in the function exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee.

View File

@@ -1359,6 +1359,7 @@ export interface Stock {
* Returns the players position in a stock.
* @remarks
* RAM cost: 2 GB
*
* Returns an array of four elements that represents the players position in a stock.
*
* The first element in the returned array is the number of shares the player owns of
@@ -1384,6 +1385,7 @@ export interface Stock {
* Returns the maximum number of shares of a stock.
* @remarks
* RAM cost: 2 GB
*
* This is the maximum amount of the stock that can be purchased
* in both the Long and Short positions combined.
*
@@ -1396,6 +1398,7 @@ export interface Stock {
* Calculates cost of buying stocks.
* @remarks
* RAM cost: 2 GB
*
* Calculates and returns how much it would cost to buy a given number of shares of a stock.
* This takes into account spread, large transactions influencing the price of the stock and commission fees.
*
@@ -1410,6 +1413,7 @@ export interface Stock {
* Calculate profit of selling stocks.
* @remarks
* RAM cost: 2 GB
*
* Calculates and returns how much you would gain from selling a given number of shares of a stock.
* This takes into account spread, large transactions influencing the price of the stock and commission fees.
*
@@ -1424,6 +1428,7 @@ export interface Stock {
* Buy stocks.
* @remarks
* RAM cost: 2.5 GB
*
* Attempts to purchase shares of a stock using a Market Order.
*
* If the player does not have enough money to purchase the specified number of shares,
@@ -1443,6 +1448,7 @@ export interface Stock {
* Sell stocks.
* @remarks
* RAM cost: 2.5 GB
*
* Attempts to sell shares of a stock using a Market Order.
*
* If the specified number of shares in the function exceeds the amount that the player
@@ -1467,6 +1473,7 @@ export interface Stock {
* Short stocks.
* @remarks
* RAM cost: 2.5 GB
*
* Attempts to purchase a short position of a stock using a Market Order.
*
* The ability to short a stock is **not** immediately available to the player and
@@ -1489,6 +1496,7 @@ export interface Stock {
* Sell short stock.
* @remarks
* RAM cost: 2.5 GB
*
* Attempts to sell a short position of a stock using a Market Order.
*
* The ability to short a stock is **not** immediately available to the player and
@@ -1511,6 +1519,7 @@ export interface Stock {
* Place order for stocks.
* @remarks
* RAM cost: 2.5 GB
*
* Places an order on the stock market. This function only works for Limit and Stop Orders.
*
* The ability to place limit and stop orders is **not** immediately available to the player and
@@ -1531,6 +1540,7 @@ export interface Stock {
* Cancel order for stocks.
* @remarks
* RAM cost: 2.5 GB
*
* Cancels an outstanding Limit or Stop order on the stock market.
*
* The ability to use limit and stop orders is **not** immediately available to the player and
@@ -1548,6 +1558,7 @@ export interface Stock {
* Returns your order book for the stock market.
* @remarks
* RAM cost: 2.5 GB
*
* This is an object containing information for all the Limit and Stop Orders you have in the stock market.
* For each symbol you have a position in, the returned object will have a key with that symbol's name.
* The object's properties are each an array of {@link StockOrder}
@@ -1614,6 +1625,7 @@ export interface Stock {
* Returns the volatility of the specified stock.
* @remarks
* RAM cost: 2.5 GB
*
* Volatility represents the maximum percentage by which a stocks price can change every tick.
* The volatility is returned in the range 0-1.
* (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).
@@ -1630,6 +1642,7 @@ export interface Stock {
* tick.
* @remarks
* RAM cost: 2.5 GB
*
* The probability is returned in the range 0-1.
* (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).
*
@@ -3843,6 +3856,7 @@ export interface Bladeburner {
* Travel to another city in Bladeburner.
* @remarks
* RAM cost: 4 GB
*
* Attempts to switch to the specified city (for Bladeburner only).
*
* Returns true if successful, and false otherwise
@@ -3856,6 +3870,7 @@ export interface Bladeburner {
* Get Bladeburner stamina.
* @remarks
* RAM cost: 4 GB
*
* Returns an array with two elements:
* * [Current stamina, Max stamina]
* @example
@@ -3873,6 +3888,7 @@ export interface Bladeburner {
* Join the Bladeburner faction.
* @remarks
* RAM cost: 4 GB
*
* Attempts to join the Bladeburner faction.
*
* Returns true if you successfully join the Bladeburner faction, or if you are already a member.
@@ -5161,6 +5177,7 @@ export interface GoAnalysis {
*
* @remarks
* RAM cost: 8 GB
*
* (This is intentionally expensive; you can derive this info from just getBoardState() and getMoveHistory() )
*
* @param boardState - Optional. The board state to analyze, in the string[] format used by getBoardState(). Defaults to the current board state. Alternatively can be simply "true" to get current valid moves for white.
@@ -5192,6 +5209,7 @@ export interface GoAnalysis {
*
* @remarks
* RAM cost: 16 GB
*
* (This is intentionally expensive; you can derive this info from just getBoardState() )
*
* @param boardState - Optional. The current board state, as an array of strings. Defaults to the current board state.
@@ -5220,6 +5238,7 @@ export interface GoAnalysis {
*
* @remarks
* RAM cost: 16 GB
*
* (This is intentionally expensive; you can derive this info from just getBoardState() )
*
* @param boardState - Optional. The current board state, as an array of strings. Defaults to the current board state.
@@ -5249,6 +5268,7 @@ export interface GoAnalysis {
*
* @remarks
* RAM cost: 16 GB
*
* (This is intentionally expensive; you can derive this info from just getBoardState() )
*
* @param boardState - Optional. The current board state, as an array of strings. Defaults to the current board state.
@@ -5330,7 +5350,7 @@ export interface GoAnalysis {
}
/**
* Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use.
* Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Source-File 14.2 to use.
*
* @public
*/
@@ -5345,7 +5365,8 @@ export interface GoCheat {
*
* @remarks
* RAM cost: 1 GB
* Requires BitNode 14.2 to use
*
* Requires Source-File 14.2 to use
*
* @param cheatCount - Optional override for the number of cheats already attempted. Defaults to the number of cheats attempted in the current game.
* @param playAsWhite - Optional override for playing as white. Can only be used when playing on a 'No AI' board.
@@ -5357,7 +5378,8 @@ export interface GoCheat {
*
* @remarks
* RAM cost: 1 GB
* Requires BitNode 14.2 to use
*
* Requires Source-File 14.2 to use
*
* @param playAsWhite - Optional override for playing as white. Can only be used when playing on a 'No AI' board.
* @returns The number of times you've attempted to cheat in the current game.
@@ -5373,7 +5395,8 @@ export interface GoCheat {
*
* @remarks
* RAM cost: 8 GB
* Requires BitNode 14.2 to use
*
* Requires Source-File 14.2 to use
*
* @param x - x coordinate of router to remove
* @param y - y coordinate of router to remove
@@ -5400,7 +5423,8 @@ export interface GoCheat {
*
* @remarks
* RAM cost: 8 GB
* Requires BitNode 14.2 to use
*
* Requires Source-File 14.2 to use
*
* @param x1 - x coordinate of first move to make
* @param y1 - y coordinate of first move to make
@@ -5431,7 +5455,8 @@ export interface GoCheat {
*
* @remarks
* RAM cost: 8 GB
* Requires BitNode 14.2 to use
*
* Requires Source-File 14.2 to use
*
* @param x - x coordinate of offline node to repair
* @param y - y coordinate of offline node to repair
@@ -5459,7 +5484,8 @@ export interface GoCheat {
*
* @remarks
* RAM cost: 8 GB
* Requires BitNode 14.2 to use
*
* Requires Source-File 14.2 to use
*
* @param x - x coordinate of empty node to destroy
* @param y - y coordinate of empty node to destroy
@@ -5644,7 +5670,7 @@ export interface Go {
analysis: GoAnalysis;
/**
* Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use.
* Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Source-File 14.2 to use.
*/
cheat: GoCheat;
}
@@ -8184,6 +8210,7 @@ export interface NS {
* Get the base security level of a server.
* @remarks
* RAM cost: 0.1 GB
*
* Returns the base security level of the target server.
* For the server's actual security level, use {@link NS.getServerSecurityLevel | ns.getServerSecurityLevel}.
*