mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 14:28:36 +02:00
DOCUMENTATION: Add missing newline after RAM cost (#2570)
This commit is contained in:
catloversg
GitHub
43
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
43
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
@@ -1359,6 +1359,7 @@ export interface Stock {
|
||||
* Returns the player’s position in a stock.
|
||||
* @remarks
|
||||
* RAM cost: 2 GB
|
||||
*
|
||||
* Returns an array of four elements that represents the player’s 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 stock’s 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}.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user