API: Rename "TIX" interface to "Stock" (#2351)

This commit is contained in:
catloversg
2025-10-15 01:51:54 +07:00
committed by GitHub
parent 7ca364f49f
commit 30a572cfe6
36 changed files with 174 additions and 174 deletions

View File

@@ -1258,6 +1258,17 @@ Player must have this Source File.
Stanek's Gift API.
</td></tr>
<tr><td>
[Stock](./bitburner.stock.md)
</td><td>
Stock market API
</td></tr>
<tr><td>
@@ -1300,17 +1311,6 @@ Study
</td></tr>
<tr><td>
[TIX](./bitburner.tix.md)
</td><td>
Stock market API
</td></tr>
<tr><td>

View File

@@ -413,12 +413,12 @@ Namespace for [Stanek](./bitburner.stanek.md) functions. Contains spoilers.
</td><td>
[TIX](./bitburner.tix.md)
[Stock](./bitburner.stock.md)
</td><td>
Namespace for [stock](./bitburner.tix.md) functions.
Namespace for [stock](./bitburner.stock.md) functions.
</td></tr>

View File

@@ -4,12 +4,12 @@
## NS.stock property
Namespace for [stock](./bitburner.tix.md) functions.
Namespace for [stock](./bitburner.stock.md) functions.
**Signature:**
```typescript
readonly stock: TIX;
readonly stock: Stock;
```
## Remarks

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [buyShort](./bitburner.tix.buyshort.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [buyShort](./bitburner.stock.buyshort.md)
## TIX.buyShort() method
## Stock.buyShort() method
Short stocks.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [buyStock](./bitburner.tix.buystock.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [buyStock](./bitburner.stock.buystock.md)
## TIX.buyStock() method
## Stock.buyStock() method
Buy stocks.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [cancelOrder](./bitburner.tix.cancelorder.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [cancelOrder](./bitburner.stock.cancelorder.md)
## TIX.cancelOrder() method
## Stock.cancelOrder() method
Cancel order for stocks.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getAskPrice](./bitburner.tix.getaskprice.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getAskPrice](./bitburner.stock.getaskprice.md)
## TIX.getAskPrice() method
## Stock.getAskPrice() method
Returns the ask price of that stock.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getBidPrice](./bitburner.tix.getbidprice.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getBidPrice](./bitburner.stock.getbidprice.md)
## TIX.getBidPrice() method
## Stock.getBidPrice() method
Returns the bid price of that stock.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getBonusTime](./bitburner.tix.getbonustime.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getBonusTime](./bitburner.stock.getbonustime.md)
## TIX.getBonusTime() method
## Stock.getBonusTime() method
Get Stock Market bonus time.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getConstants](./bitburner.tix.getconstants.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getConstants](./bitburner.stock.getconstants.md)
## TIX.getConstants() method
## Stock.getConstants() method
Get game constants for the stock market mechanic.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getForecast](./bitburner.tix.getforecast.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getForecast](./bitburner.stock.getforecast.md)
## TIX.getForecast() method
## Stock.getForecast() method
Returns the probability that the specified stocks price will increase (as opposed to decrease) during the next tick.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getMaxShares](./bitburner.tix.getmaxshares.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getMaxShares](./bitburner.stock.getmaxshares.md)
## TIX.getMaxShares() method
## Stock.getMaxShares() method
Returns the maximum number of shares of a stock.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getOrders](./bitburner.tix.getorders.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getOrders](./bitburner.stock.getorders.md)
## TIX.getOrders() method
## Stock.getOrders() method
Returns your order book for the stock market.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getOrganization](./bitburner.tix.getorganization.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getOrganization](./bitburner.stock.getorganization.md)
## TIX.getOrganization() method
## Stock.getOrganization() method
Returns the organization associated with a stock symbol.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getPosition](./bitburner.tix.getposition.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getPosition](./bitburner.stock.getposition.md)
## TIX.getPosition() method
## Stock.getPosition() method
Returns the players position in a stock.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getPrice](./bitburner.tix.getprice.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getPrice](./bitburner.stock.getprice.md)
## TIX.getPrice() method
## Stock.getPrice() method
Returns the price of a stock.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getPurchaseCost](./bitburner.tix.getpurchasecost.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getPurchaseCost](./bitburner.stock.getpurchasecost.md)
## TIX.getPurchaseCost() method
## Stock.getPurchaseCost() method
Calculates cost of buying stocks.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getSaleGain](./bitburner.tix.getsalegain.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getSaleGain](./bitburner.stock.getsalegain.md)
## TIX.getSaleGain() method
## Stock.getSaleGain() method
Calculate profit of selling stocks.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getSymbols](./bitburner.tix.getsymbols.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getSymbols](./bitburner.stock.getsymbols.md)
## TIX.getSymbols() method
## Stock.getSymbols() method
Returns an array of the symbols of the tradable stocks

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getVolatility](./bitburner.tix.getvolatility.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [getVolatility](./bitburner.stock.getvolatility.md)
## TIX.getVolatility() method
## Stock.getVolatility() method
Returns the volatility of the specified stock.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [has4SData](./bitburner.tix.has4sdata.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [has4SData](./bitburner.stock.has4sdata.md)
## TIX.has4SData() method
## Stock.has4SData() method
Returns true if the player has access to the 4S Data

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [has4SDataTixApi](./bitburner.tix.has4sdatatixapi.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [has4SDataTixApi](./bitburner.stock.has4sdatatixapi.md)
## TIX.has4SDataTixApi() method
## Stock.has4SDataTixApi() method
Returns true if the player has access to the 4SData TIX API

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [hasTixApiAccess](./bitburner.tix.hastixapiaccess.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [hasTixApiAccess](./bitburner.stock.hastixapiaccess.md)
## TIX.hasTixApiAccess() method
## Stock.hasTixApiAccess() method
Returns true if the player has access to the TIX API

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [hasWseAccount](./bitburner.tix.haswseaccount.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [hasWseAccount](./bitburner.stock.haswseaccount.md)
## TIX.hasWseAccount() method
## Stock.hasWseAccount() method
Returns true if the player has access to a WSE Account

View File

@@ -1,15 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md)
## TIX interface
## Stock interface
Stock market API
**Signature:**
```typescript
export interface TIX
export interface Stock
```
## Methods
@@ -27,7 +27,7 @@ Description
</th></tr></thead>
<tbody><tr><td>
[buyShort(sym, shares)](./bitburner.tix.buyshort.md)
[buyShort(sym, shares)](./bitburner.stock.buyshort.md)
</td><td>
@@ -38,7 +38,7 @@ Short stocks.
</td></tr>
<tr><td>
[buyStock(sym, shares)](./bitburner.tix.buystock.md)
[buyStock(sym, shares)](./bitburner.stock.buystock.md)
</td><td>
@@ -49,7 +49,7 @@ Buy stocks.
</td></tr>
<tr><td>
[cancelOrder(sym, shares, price, orderType, positionType)](./bitburner.tix.cancelorder.md)
[cancelOrder(sym, shares, price, orderType, positionType)](./bitburner.stock.cancelorder.md)
</td><td>
@@ -60,7 +60,7 @@ Cancel order for stocks.
</td></tr>
<tr><td>
[getAskPrice(sym)](./bitburner.tix.getaskprice.md)
[getAskPrice(sym)](./bitburner.stock.getaskprice.md)
</td><td>
@@ -71,7 +71,7 @@ Returns the ask price of that stock.
</td></tr>
<tr><td>
[getBidPrice(sym)](./bitburner.tix.getbidprice.md)
[getBidPrice(sym)](./bitburner.stock.getbidprice.md)
</td><td>
@@ -82,7 +82,7 @@ Returns the bid price of that stock.
</td></tr>
<tr><td>
[getBonusTime()](./bitburner.tix.getbonustime.md)
[getBonusTime()](./bitburner.stock.getbonustime.md)
</td><td>
@@ -93,7 +93,7 @@ Get Stock Market bonus time.
</td></tr>
<tr><td>
[getConstants()](./bitburner.tix.getconstants.md)
[getConstants()](./bitburner.stock.getconstants.md)
</td><td>
@@ -104,7 +104,7 @@ Get game constants for the stock market mechanic.
</td></tr>
<tr><td>
[getForecast(sym)](./bitburner.tix.getforecast.md)
[getForecast(sym)](./bitburner.stock.getforecast.md)
</td><td>
@@ -115,7 +115,7 @@ Returns the probability that the specified stocks price will increase (as opp
</td></tr>
<tr><td>
[getMaxShares(sym)](./bitburner.tix.getmaxshares.md)
[getMaxShares(sym)](./bitburner.stock.getmaxshares.md)
</td><td>
@@ -126,7 +126,7 @@ Returns the maximum number of shares of a stock.
</td></tr>
<tr><td>
[getOrders()](./bitburner.tix.getorders.md)
[getOrders()](./bitburner.stock.getorders.md)
</td><td>
@@ -137,7 +137,7 @@ Returns your order book for the stock market.
</td></tr>
<tr><td>
[getOrganization(sym)](./bitburner.tix.getorganization.md)
[getOrganization(sym)](./bitburner.stock.getorganization.md)
</td><td>
@@ -148,7 +148,7 @@ Returns the organization associated with a stock symbol.
</td></tr>
<tr><td>
[getPosition(sym)](./bitburner.tix.getposition.md)
[getPosition(sym)](./bitburner.stock.getposition.md)
</td><td>
@@ -159,7 +159,7 @@ Returns the players position in a stock.
</td></tr>
<tr><td>
[getPrice(sym)](./bitburner.tix.getprice.md)
[getPrice(sym)](./bitburner.stock.getprice.md)
</td><td>
@@ -170,7 +170,7 @@ Returns the price of a stock.
</td></tr>
<tr><td>
[getPurchaseCost(sym, shares, positionType)](./bitburner.tix.getpurchasecost.md)
[getPurchaseCost(sym, shares, positionType)](./bitburner.stock.getpurchasecost.md)
</td><td>
@@ -181,7 +181,7 @@ Calculates cost of buying stocks.
</td></tr>
<tr><td>
[getSaleGain(sym, shares, positionType)](./bitburner.tix.getsalegain.md)
[getSaleGain(sym, shares, positionType)](./bitburner.stock.getsalegain.md)
</td><td>
@@ -192,7 +192,7 @@ Calculate profit of selling stocks.
</td></tr>
<tr><td>
[getSymbols()](./bitburner.tix.getsymbols.md)
[getSymbols()](./bitburner.stock.getsymbols.md)
</td><td>
@@ -203,7 +203,7 @@ Returns an array of the symbols of the tradable stocks
</td></tr>
<tr><td>
[getVolatility(sym)](./bitburner.tix.getvolatility.md)
[getVolatility(sym)](./bitburner.stock.getvolatility.md)
</td><td>
@@ -214,7 +214,7 @@ Returns the volatility of the specified stock.
</td></tr>
<tr><td>
[has4SData()](./bitburner.tix.has4sdata.md)
[has4SData()](./bitburner.stock.has4sdata.md)
</td><td>
@@ -225,7 +225,7 @@ Returns true if the player has access to the 4S Data
</td></tr>
<tr><td>
[has4SDataTixApi()](./bitburner.tix.has4sdatatixapi.md)
[has4SDataTixApi()](./bitburner.stock.has4sdatatixapi.md)
</td><td>
@@ -236,7 +236,7 @@ Returns true if the player has access to the 4SData TIX API
</td></tr>
<tr><td>
[hasTixApiAccess()](./bitburner.tix.hastixapiaccess.md)
[hasTixApiAccess()](./bitburner.stock.hastixapiaccess.md)
</td><td>
@@ -247,7 +247,7 @@ Returns true if the player has access to the TIX API
</td></tr>
<tr><td>
[hasWseAccount()](./bitburner.tix.haswseaccount.md)
[hasWseAccount()](./bitburner.stock.haswseaccount.md)
</td><td>
@@ -258,7 +258,7 @@ Returns true if the player has access to a WSE Account
</td></tr>
<tr><td>
[nextUpdate()](./bitburner.tix.nextupdate.md)
[nextUpdate()](./bitburner.stock.nextupdate.md)
</td><td>
@@ -269,7 +269,7 @@ Sleep until the next Stock Market price update has happened.
</td></tr>
<tr><td>
[placeOrder(sym, shares, price, orderType, positionType)](./bitburner.tix.placeorder.md)
[placeOrder(sym, shares, price, orderType, positionType)](./bitburner.stock.placeorder.md)
</td><td>
@@ -280,20 +280,20 @@ Place order for stocks.
</td></tr>
<tr><td>
[purchase4SMarketData()](./bitburner.tix.purchase4smarketdata.md)
[purchase4SMarketData()](./bitburner.stock.purchase4smarketdata.md)
</td><td>
Purchase 4S Market Data UI access (UI only).
You need to have a WSE account. Note that this feature only unlocks access to 4S Market Data in the Stock Market UI. If you want to access 4S Market Data via NS APIs, you have to unlock "4S Market Data TIX API access" via [purchase4SMarketDataTixApi](./bitburner.tix.purchase4smarketdatatixapi.md)<!-- -->, which is unrelated to this feature.
You need to have a WSE account. Note that this feature only unlocks access to 4S Market Data in the Stock Market UI. If you want to access 4S Market Data via NS APIs, you have to unlock "4S Market Data TIX API access" via [purchase4SMarketDataTixApi](./bitburner.stock.purchase4smarketdatatixapi.md)<!-- -->, which is unrelated to this feature.
</td></tr>
<tr><td>
[purchase4SMarketDataTixApi()](./bitburner.tix.purchase4smarketdatatixapi.md)
[purchase4SMarketDataTixApi()](./bitburner.stock.purchase4smarketdatatixapi.md)
</td><td>
@@ -306,7 +306,7 @@ You need to have TIX API access. Note that this feature only unlocks access to 4
</td></tr>
<tr><td>
[purchaseTixApi()](./bitburner.tix.purchasetixapi.md)
[purchaseTixApi()](./bitburner.stock.purchasetixapi.md)
</td><td>
@@ -319,7 +319,7 @@ You need to have TIX API access to perform actions via NS APIs. Note that you ca
</td></tr>
<tr><td>
[purchaseWseAccount()](./bitburner.tix.purchasewseaccount.md)
[purchaseWseAccount()](./bitburner.stock.purchasewseaccount.md)
</td><td>
@@ -332,7 +332,7 @@ You need to have this account to perform actions via the Stock Market UI. Note t
</td></tr>
<tr><td>
[sellShort(sym, shares)](./bitburner.tix.sellshort.md)
[sellShort(sym, shares)](./bitburner.stock.sellshort.md)
</td><td>
@@ -343,7 +343,7 @@ Sell short stock.
</td></tr>
<tr><td>
[sellStock(sym, shares)](./bitburner.tix.sellstock.md)
[sellStock(sym, shares)](./bitburner.stock.sellstock.md)
</td><td>

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [nextUpdate](./bitburner.tix.nextupdate.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [nextUpdate](./bitburner.stock.nextupdate.md)
## TIX.nextUpdate() method
## Stock.nextUpdate() method
Sleep until the next Stock Market price update has happened.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [placeOrder](./bitburner.tix.placeorder.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [placeOrder](./bitburner.stock.placeorder.md)
## TIX.placeOrder() method
## Stock.placeOrder() method
Place order for stocks.

View File

@@ -1,12 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [purchase4SMarketData](./bitburner.tix.purchase4smarketdata.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [purchase4SMarketData](./bitburner.stock.purchase4smarketdata.md)
## TIX.purchase4SMarketData() method
## Stock.purchase4SMarketData() method
Purchase 4S Market Data UI access (UI only).
You need to have a WSE account. Note that this feature only unlocks access to 4S Market Data in the Stock Market UI. If you want to access 4S Market Data via NS APIs, you have to unlock "4S Market Data TIX API access" via [purchase4SMarketDataTixApi](./bitburner.tix.purchase4smarketdatatixapi.md)<!-- -->, which is unrelated to this feature.
You need to have a WSE account. Note that this feature only unlocks access to 4S Market Data in the Stock Market UI. If you want to access 4S Market Data via NS APIs, you have to unlock "4S Market Data TIX API access" via [purchase4SMarketDataTixApi](./bitburner.stock.purchase4smarketdatatixapi.md)<!-- -->, which is unrelated to this feature.
**Signature:**

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [purchase4SMarketDataTixApi](./bitburner.tix.purchase4smarketdatatixapi.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [purchase4SMarketDataTixApi](./bitburner.stock.purchase4smarketdatatixapi.md)
## TIX.purchase4SMarketDataTixApi() method
## Stock.purchase4SMarketDataTixApi() method
Purchase 4S Market Data TIX API access (NS APIs only).

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [purchaseTixApi](./bitburner.tix.purchasetixapi.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [purchaseTixApi](./bitburner.stock.purchasetixapi.md)
## TIX.purchaseTixApi() method
## Stock.purchaseTixApi() method
Purchase TIX API access.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [purchaseWseAccount](./bitburner.tix.purchasewseaccount.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [purchaseWseAccount](./bitburner.stock.purchasewseaccount.md)
## TIX.purchaseWseAccount() method
## Stock.purchaseWseAccount() method
Purchase a WSE account.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [sellShort](./bitburner.tix.sellshort.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [sellShort](./bitburner.stock.sellshort.md)
## TIX.sellShort() method
## Stock.sellShort() method
Sell short stock.

View File

@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [sellStock](./bitburner.tix.sellstock.md)
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stock](./bitburner.stock.md) &gt; [sellStock](./bitburner.stock.sellstock.md)
## TIX.sellStock() method
## Stock.sellStock() method
Sell stocks.

View File

@@ -1338,6 +1338,36 @@ import nsDoc_bitburner_stanek_giftwidth_md from "../../markdown/bitburner.stanek
import nsDoc_bitburner_stanek_md from "../../markdown/bitburner.stanek.md?raw";
import nsDoc_bitburner_stanek_placefragment_md from "../../markdown/bitburner.stanek.placefragment.md?raw";
import nsDoc_bitburner_stanek_removefragment_md from "../../markdown/bitburner.stanek.removefragment.md?raw";
import nsDoc_bitburner_stock_buyshort_md from "../../markdown/bitburner.stock.buyshort.md?raw";
import nsDoc_bitburner_stock_buystock_md from "../../markdown/bitburner.stock.buystock.md?raw";
import nsDoc_bitburner_stock_cancelorder_md from "../../markdown/bitburner.stock.cancelorder.md?raw";
import nsDoc_bitburner_stock_getaskprice_md from "../../markdown/bitburner.stock.getaskprice.md?raw";
import nsDoc_bitburner_stock_getbidprice_md from "../../markdown/bitburner.stock.getbidprice.md?raw";
import nsDoc_bitburner_stock_getbonustime_md from "../../markdown/bitburner.stock.getbonustime.md?raw";
import nsDoc_bitburner_stock_getconstants_md from "../../markdown/bitburner.stock.getconstants.md?raw";
import nsDoc_bitburner_stock_getforecast_md from "../../markdown/bitburner.stock.getforecast.md?raw";
import nsDoc_bitburner_stock_getmaxshares_md from "../../markdown/bitburner.stock.getmaxshares.md?raw";
import nsDoc_bitburner_stock_getorders_md from "../../markdown/bitburner.stock.getorders.md?raw";
import nsDoc_bitburner_stock_getorganization_md from "../../markdown/bitburner.stock.getorganization.md?raw";
import nsDoc_bitburner_stock_getposition_md from "../../markdown/bitburner.stock.getposition.md?raw";
import nsDoc_bitburner_stock_getprice_md from "../../markdown/bitburner.stock.getprice.md?raw";
import nsDoc_bitburner_stock_getpurchasecost_md from "../../markdown/bitburner.stock.getpurchasecost.md?raw";
import nsDoc_bitburner_stock_getsalegain_md from "../../markdown/bitburner.stock.getsalegain.md?raw";
import nsDoc_bitburner_stock_getsymbols_md from "../../markdown/bitburner.stock.getsymbols.md?raw";
import nsDoc_bitburner_stock_getvolatility_md from "../../markdown/bitburner.stock.getvolatility.md?raw";
import nsDoc_bitburner_stock_has4sdata_md from "../../markdown/bitburner.stock.has4sdata.md?raw";
import nsDoc_bitburner_stock_has4sdatatixapi_md from "../../markdown/bitburner.stock.has4sdatatixapi.md?raw";
import nsDoc_bitburner_stock_hastixapiaccess_md from "../../markdown/bitburner.stock.hastixapiaccess.md?raw";
import nsDoc_bitburner_stock_haswseaccount_md from "../../markdown/bitburner.stock.haswseaccount.md?raw";
import nsDoc_bitburner_stock_md from "../../markdown/bitburner.stock.md?raw";
import nsDoc_bitburner_stock_nextupdate_md from "../../markdown/bitburner.stock.nextupdate.md?raw";
import nsDoc_bitburner_stock_placeorder_md from "../../markdown/bitburner.stock.placeorder.md?raw";
import nsDoc_bitburner_stock_purchase4smarketdata_md from "../../markdown/bitburner.stock.purchase4smarketdata.md?raw";
import nsDoc_bitburner_stock_purchase4smarketdatatixapi_md from "../../markdown/bitburner.stock.purchase4smarketdatatixapi.md?raw";
import nsDoc_bitburner_stock_purchasetixapi_md from "../../markdown/bitburner.stock.purchasetixapi.md?raw";
import nsDoc_bitburner_stock_purchasewseaccount_md from "../../markdown/bitburner.stock.purchasewseaccount.md?raw";
import nsDoc_bitburner_stock_sellshort_md from "../../markdown/bitburner.stock.sellshort.md?raw";
import nsDoc_bitburner_stock_sellstock_md from "../../markdown/bitburner.stock.sellstock.md?raw";
import nsDoc_bitburner_stockmarketconstants_marketdata4scost_md from "../../markdown/bitburner.stockmarketconstants.marketdata4scost.md?raw";
import nsDoc_bitburner_stockmarketconstants_marketdatatixapi4scost_md from "../../markdown/bitburner.stockmarketconstants.marketdatatixapi4scost.md?raw";
import nsDoc_bitburner_stockmarketconstants_md from "../../markdown/bitburner.stockmarketconstants.md?raw";
@@ -1363,36 +1393,6 @@ import nsDoc_bitburner_tailproperties_width_md from "../../markdown/bitburner.ta
import nsDoc_bitburner_tailproperties_x_md from "../../markdown/bitburner.tailproperties.x.md?raw";
import nsDoc_bitburner_tailproperties_y_md from "../../markdown/bitburner.tailproperties.y.md?raw";
import nsDoc_bitburner_task_md from "../../markdown/bitburner.task.md?raw";
import nsDoc_bitburner_tix_buyshort_md from "../../markdown/bitburner.tix.buyshort.md?raw";
import nsDoc_bitburner_tix_buystock_md from "../../markdown/bitburner.tix.buystock.md?raw";
import nsDoc_bitburner_tix_cancelorder_md from "../../markdown/bitburner.tix.cancelorder.md?raw";
import nsDoc_bitburner_tix_getaskprice_md from "../../markdown/bitburner.tix.getaskprice.md?raw";
import nsDoc_bitburner_tix_getbidprice_md from "../../markdown/bitburner.tix.getbidprice.md?raw";
import nsDoc_bitburner_tix_getbonustime_md from "../../markdown/bitburner.tix.getbonustime.md?raw";
import nsDoc_bitburner_tix_getconstants_md from "../../markdown/bitburner.tix.getconstants.md?raw";
import nsDoc_bitburner_tix_getforecast_md from "../../markdown/bitburner.tix.getforecast.md?raw";
import nsDoc_bitburner_tix_getmaxshares_md from "../../markdown/bitburner.tix.getmaxshares.md?raw";
import nsDoc_bitburner_tix_getorders_md from "../../markdown/bitburner.tix.getorders.md?raw";
import nsDoc_bitburner_tix_getorganization_md from "../../markdown/bitburner.tix.getorganization.md?raw";
import nsDoc_bitburner_tix_getposition_md from "../../markdown/bitburner.tix.getposition.md?raw";
import nsDoc_bitburner_tix_getprice_md from "../../markdown/bitburner.tix.getprice.md?raw";
import nsDoc_bitburner_tix_getpurchasecost_md from "../../markdown/bitburner.tix.getpurchasecost.md?raw";
import nsDoc_bitburner_tix_getsalegain_md from "../../markdown/bitburner.tix.getsalegain.md?raw";
import nsDoc_bitburner_tix_getsymbols_md from "../../markdown/bitburner.tix.getsymbols.md?raw";
import nsDoc_bitburner_tix_getvolatility_md from "../../markdown/bitburner.tix.getvolatility.md?raw";
import nsDoc_bitburner_tix_has4sdata_md from "../../markdown/bitburner.tix.has4sdata.md?raw";
import nsDoc_bitburner_tix_has4sdatatixapi_md from "../../markdown/bitburner.tix.has4sdatatixapi.md?raw";
import nsDoc_bitburner_tix_hastixapiaccess_md from "../../markdown/bitburner.tix.hastixapiaccess.md?raw";
import nsDoc_bitburner_tix_haswseaccount_md from "../../markdown/bitburner.tix.haswseaccount.md?raw";
import nsDoc_bitburner_tix_md from "../../markdown/bitburner.tix.md?raw";
import nsDoc_bitburner_tix_nextupdate_md from "../../markdown/bitburner.tix.nextupdate.md?raw";
import nsDoc_bitburner_tix_placeorder_md from "../../markdown/bitburner.tix.placeorder.md?raw";
import nsDoc_bitburner_tix_purchase4smarketdata_md from "../../markdown/bitburner.tix.purchase4smarketdata.md?raw";
import nsDoc_bitburner_tix_purchase4smarketdatatixapi_md from "../../markdown/bitburner.tix.purchase4smarketdatatixapi.md?raw";
import nsDoc_bitburner_tix_purchasetixapi_md from "../../markdown/bitburner.tix.purchasetixapi.md?raw";
import nsDoc_bitburner_tix_purchasewseaccount_md from "../../markdown/bitburner.tix.purchasewseaccount.md?raw";
import nsDoc_bitburner_tix_sellshort_md from "../../markdown/bitburner.tix.sellshort.md?raw";
import nsDoc_bitburner_tix_sellstock_md from "../../markdown/bitburner.tix.sellstock.md?raw";
import nsDoc_bitburner_toastvariant_md from "../../markdown/bitburner.toastvariant.md?raw";
import nsDoc_bitburner_toastvariantenumtype_md from "../../markdown/bitburner.toastvariantenumtype.md?raw";
import nsDoc_bitburner_universityclassenumtype_md from "../../markdown/bitburner.universityclassenumtype.md?raw";
@@ -2846,6 +2846,36 @@ AllPages["nsDoc/bitburner.stanek.giftwidth.md"] = nsDoc_bitburner_stanek_giftwid
AllPages["nsDoc/bitburner.stanek.md"] = nsDoc_bitburner_stanek_md;
AllPages["nsDoc/bitburner.stanek.placefragment.md"] = nsDoc_bitburner_stanek_placefragment_md;
AllPages["nsDoc/bitburner.stanek.removefragment.md"] = nsDoc_bitburner_stanek_removefragment_md;
AllPages["nsDoc/bitburner.stock.buyshort.md"] = nsDoc_bitburner_stock_buyshort_md;
AllPages["nsDoc/bitburner.stock.buystock.md"] = nsDoc_bitburner_stock_buystock_md;
AllPages["nsDoc/bitburner.stock.cancelorder.md"] = nsDoc_bitburner_stock_cancelorder_md;
AllPages["nsDoc/bitburner.stock.getaskprice.md"] = nsDoc_bitburner_stock_getaskprice_md;
AllPages["nsDoc/bitburner.stock.getbidprice.md"] = nsDoc_bitburner_stock_getbidprice_md;
AllPages["nsDoc/bitburner.stock.getbonustime.md"] = nsDoc_bitburner_stock_getbonustime_md;
AllPages["nsDoc/bitburner.stock.getconstants.md"] = nsDoc_bitburner_stock_getconstants_md;
AllPages["nsDoc/bitburner.stock.getforecast.md"] = nsDoc_bitburner_stock_getforecast_md;
AllPages["nsDoc/bitburner.stock.getmaxshares.md"] = nsDoc_bitburner_stock_getmaxshares_md;
AllPages["nsDoc/bitburner.stock.getorders.md"] = nsDoc_bitburner_stock_getorders_md;
AllPages["nsDoc/bitburner.stock.getorganization.md"] = nsDoc_bitburner_stock_getorganization_md;
AllPages["nsDoc/bitburner.stock.getposition.md"] = nsDoc_bitburner_stock_getposition_md;
AllPages["nsDoc/bitburner.stock.getprice.md"] = nsDoc_bitburner_stock_getprice_md;
AllPages["nsDoc/bitburner.stock.getpurchasecost.md"] = nsDoc_bitburner_stock_getpurchasecost_md;
AllPages["nsDoc/bitburner.stock.getsalegain.md"] = nsDoc_bitburner_stock_getsalegain_md;
AllPages["nsDoc/bitburner.stock.getsymbols.md"] = nsDoc_bitburner_stock_getsymbols_md;
AllPages["nsDoc/bitburner.stock.getvolatility.md"] = nsDoc_bitburner_stock_getvolatility_md;
AllPages["nsDoc/bitburner.stock.has4sdata.md"] = nsDoc_bitburner_stock_has4sdata_md;
AllPages["nsDoc/bitburner.stock.has4sdatatixapi.md"] = nsDoc_bitburner_stock_has4sdatatixapi_md;
AllPages["nsDoc/bitburner.stock.hastixapiaccess.md"] = nsDoc_bitburner_stock_hastixapiaccess_md;
AllPages["nsDoc/bitburner.stock.haswseaccount.md"] = nsDoc_bitburner_stock_haswseaccount_md;
AllPages["nsDoc/bitburner.stock.md"] = nsDoc_bitburner_stock_md;
AllPages["nsDoc/bitburner.stock.nextupdate.md"] = nsDoc_bitburner_stock_nextupdate_md;
AllPages["nsDoc/bitburner.stock.placeorder.md"] = nsDoc_bitburner_stock_placeorder_md;
AllPages["nsDoc/bitburner.stock.purchase4smarketdata.md"] = nsDoc_bitburner_stock_purchase4smarketdata_md;
AllPages["nsDoc/bitburner.stock.purchase4smarketdatatixapi.md"] = nsDoc_bitburner_stock_purchase4smarketdatatixapi_md;
AllPages["nsDoc/bitburner.stock.purchasetixapi.md"] = nsDoc_bitburner_stock_purchasetixapi_md;
AllPages["nsDoc/bitburner.stock.purchasewseaccount.md"] = nsDoc_bitburner_stock_purchasewseaccount_md;
AllPages["nsDoc/bitburner.stock.sellshort.md"] = nsDoc_bitburner_stock_sellshort_md;
AllPages["nsDoc/bitburner.stock.sellstock.md"] = nsDoc_bitburner_stock_sellstock_md;
AllPages["nsDoc/bitburner.stockmarketconstants.marketdata4scost.md"] = nsDoc_bitburner_stockmarketconstants_marketdata4scost_md;
AllPages["nsDoc/bitburner.stockmarketconstants.marketdatatixapi4scost.md"] = nsDoc_bitburner_stockmarketconstants_marketdatatixapi4scost_md;
AllPages["nsDoc/bitburner.stockmarketconstants.md"] = nsDoc_bitburner_stockmarketconstants_md;
@@ -2871,36 +2901,6 @@ AllPages["nsDoc/bitburner.tailproperties.width.md"] = nsDoc_bitburner_tailproper
AllPages["nsDoc/bitburner.tailproperties.x.md"] = nsDoc_bitburner_tailproperties_x_md;
AllPages["nsDoc/bitburner.tailproperties.y.md"] = nsDoc_bitburner_tailproperties_y_md;
AllPages["nsDoc/bitburner.task.md"] = nsDoc_bitburner_task_md;
AllPages["nsDoc/bitburner.tix.buyshort.md"] = nsDoc_bitburner_tix_buyshort_md;
AllPages["nsDoc/bitburner.tix.buystock.md"] = nsDoc_bitburner_tix_buystock_md;
AllPages["nsDoc/bitburner.tix.cancelorder.md"] = nsDoc_bitburner_tix_cancelorder_md;
AllPages["nsDoc/bitburner.tix.getaskprice.md"] = nsDoc_bitburner_tix_getaskprice_md;
AllPages["nsDoc/bitburner.tix.getbidprice.md"] = nsDoc_bitburner_tix_getbidprice_md;
AllPages["nsDoc/bitburner.tix.getbonustime.md"] = nsDoc_bitburner_tix_getbonustime_md;
AllPages["nsDoc/bitburner.tix.getconstants.md"] = nsDoc_bitburner_tix_getconstants_md;
AllPages["nsDoc/bitburner.tix.getforecast.md"] = nsDoc_bitburner_tix_getforecast_md;
AllPages["nsDoc/bitburner.tix.getmaxshares.md"] = nsDoc_bitburner_tix_getmaxshares_md;
AllPages["nsDoc/bitburner.tix.getorders.md"] = nsDoc_bitburner_tix_getorders_md;
AllPages["nsDoc/bitburner.tix.getorganization.md"] = nsDoc_bitburner_tix_getorganization_md;
AllPages["nsDoc/bitburner.tix.getposition.md"] = nsDoc_bitburner_tix_getposition_md;
AllPages["nsDoc/bitburner.tix.getprice.md"] = nsDoc_bitburner_tix_getprice_md;
AllPages["nsDoc/bitburner.tix.getpurchasecost.md"] = nsDoc_bitburner_tix_getpurchasecost_md;
AllPages["nsDoc/bitburner.tix.getsalegain.md"] = nsDoc_bitburner_tix_getsalegain_md;
AllPages["nsDoc/bitburner.tix.getsymbols.md"] = nsDoc_bitburner_tix_getsymbols_md;
AllPages["nsDoc/bitburner.tix.getvolatility.md"] = nsDoc_bitburner_tix_getvolatility_md;
AllPages["nsDoc/bitburner.tix.has4sdata.md"] = nsDoc_bitburner_tix_has4sdata_md;
AllPages["nsDoc/bitburner.tix.has4sdatatixapi.md"] = nsDoc_bitburner_tix_has4sdatatixapi_md;
AllPages["nsDoc/bitburner.tix.hastixapiaccess.md"] = nsDoc_bitburner_tix_hastixapiaccess_md;
AllPages["nsDoc/bitburner.tix.haswseaccount.md"] = nsDoc_bitburner_tix_haswseaccount_md;
AllPages["nsDoc/bitburner.tix.md"] = nsDoc_bitburner_tix_md;
AllPages["nsDoc/bitburner.tix.nextupdate.md"] = nsDoc_bitburner_tix_nextupdate_md;
AllPages["nsDoc/bitburner.tix.placeorder.md"] = nsDoc_bitburner_tix_placeorder_md;
AllPages["nsDoc/bitburner.tix.purchase4smarketdata.md"] = nsDoc_bitburner_tix_purchase4smarketdata_md;
AllPages["nsDoc/bitburner.tix.purchase4smarketdatatixapi.md"] = nsDoc_bitburner_tix_purchase4smarketdatatixapi_md;
AllPages["nsDoc/bitburner.tix.purchasetixapi.md"] = nsDoc_bitburner_tix_purchasetixapi_md;
AllPages["nsDoc/bitburner.tix.purchasewseaccount.md"] = nsDoc_bitburner_tix_purchasewseaccount_md;
AllPages["nsDoc/bitburner.tix.sellshort.md"] = nsDoc_bitburner_tix_sellshort_md;
AllPages["nsDoc/bitburner.tix.sellstock.md"] = nsDoc_bitburner_tix_sellstock_md;
AllPages["nsDoc/bitburner.toastvariant.md"] = nsDoc_bitburner_toastvariant_md;
AllPages["nsDoc/bitburner.toastvariantenumtype.md"] = nsDoc_bitburner_toastvariantenumtype_md;
AllPages["nsDoc/bitburner.universityclassenumtype.md"] = nsDoc_bitburner_universityclassenumtype_md;

View File

@@ -18,13 +18,13 @@ import {
getStockMarketTixApiCost,
} from "../StockMarket/StockMarketCosts";
import type { Stock } from "../StockMarket/Stock";
import type { StockOrder, TIX } from "@nsdefs";
import type { StockOrder, Stock as StockAPI } from "@nsdefs";
import { setRemovedFunctions, type InternalAPI, type NetscriptContext } from "../Netscript/APIWrapper";
import { helpers } from "../Netscript/NetscriptHelpers";
import { StockMarketConstants } from "../StockMarket/data/Constants";
import { getEnumHelper } from "../utils/EnumHelper";
export function NetscriptStockMarket(): InternalAPI<TIX> {
export function NetscriptStockMarket(): InternalAPI<StockAPI> {
/** Checks if the player has TIX API access. Throws an error if the player does not */
const checkTixApiAccess = function (ctx: NetscriptContext): void {
if (!Player.hasTixApiAccess) {
@@ -41,7 +41,7 @@ export function NetscriptStockMarket(): InternalAPI<TIX> {
return stock;
};
const stockFunctions: InternalAPI<TIX> = {
const stockFunctions: InternalAPI<StockAPI> = {
getConstants: () => () => structuredClone(StockMarketConstants),
hasWseAccount: () => () => Player.hasWseAccount,
hasTixApiAccess: () => () => Player.hasTixApiAccess,

View File

@@ -1237,7 +1237,7 @@ export interface NetscriptPort {
* Stock market API
* @public
*/
export interface TIX {
export interface Stock {
/**
* Get game constants for the stock market mechanic.
*
@@ -1639,7 +1639,7 @@ export interface TIX {
*
* You need to have a WSE account. Note that this feature only unlocks access to 4S Market Data in the Stock Market
* UI. If you want to access 4S Market Data via NS APIs, you have to unlock "4S Market Data TIX API access" via
* {@link TIX.purchase4SMarketDataTixApi | purchase4SMarketDataTixApi}, which is unrelated to this feature.
* {@link Stock.purchase4SMarketDataTixApi | purchase4SMarketDataTixApi}, which is unrelated to this feature.
*
* @remarks RAM cost: 2.5 GB
* @returns True if you successfully purchased it or if you already have access, false otherwise.
@@ -6251,10 +6251,10 @@ export interface NS {
readonly sleeve: Sleeve;
/**
* Namespace for {@link TIX | stock} functions.
* Namespace for {@link Stock | stock} functions.
* @remarks RAM cost: 0 GB
*/
readonly stock: TIX;
readonly stock: Stock;
/**
* Namespace for {@link Formulas | formulas} functions.