mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-23 01:32:55 +02:00
Michael Taylor
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
349 lines
4.2 KiB
Markdown
349 lines
4.2 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md)
|
||
|
||
## TIX interface
|
||
|
||
Stock market API
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
export interface TIX
|
||
```
|
||
|
||
## Methods
|
||
|
||
<table><thead><tr><th>
|
||
|
||
Method
|
||
|
||
|
||
</th><th>
|
||
|
||
Description
|
||
|
||
|
||
</th></tr></thead>
|
||
<tbody><tr><td>
|
||
|
||
[buyShort(sym, shares)](./bitburner.tix.buyshort.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Short stocks.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[buyStock(sym, shares)](./bitburner.tix.buystock.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Buy stocks.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[cancelOrder(sym, shares, price, orderType, positionType)](./bitburner.tix.cancelorder.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Cancel order for stocks.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getAskPrice(sym)](./bitburner.tix.getaskprice.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns the ask price of that stock.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getBidPrice(sym)](./bitburner.tix.getbidprice.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns the bid price of that stock.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getBonusTime()](./bitburner.tix.getbonustime.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Get Stock Market bonus time.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getConstants()](./bitburner.tix.getconstants.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Get game constants for the stock market mechanic.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getForecast(sym)](./bitburner.tix.getforecast.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getMaxShares(sym)](./bitburner.tix.getmaxshares.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns the maximum number of shares of a stock.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getOrders()](./bitburner.tix.getorders.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns your order book for the stock market.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getOrganization(sym)](./bitburner.tix.getorganization.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns the organization associated with a stock symbol.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getPosition(sym)](./bitburner.tix.getposition.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns the player’s position in a stock.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getPrice(sym)](./bitburner.tix.getprice.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns the price of a stock.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getPurchaseCost(sym, shares, positionType)](./bitburner.tix.getpurchasecost.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Calculates cost of buying stocks.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getSaleGain(sym, shares, positionType)](./bitburner.tix.getsalegain.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Calculate profit of selling stocks.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getSymbols()](./bitburner.tix.getsymbols.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns an array of the symbols of the tradable stocks
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[getVolatility(sym)](./bitburner.tix.getvolatility.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns the volatility of the specified stock.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[has4SData()](./bitburner.tix.has4sdata.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns true if the player has access to the 4S Data
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[has4SDataTixApi()](./bitburner.tix.has4sdatatixapi.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns true if the player has access to the 4SData TIX API
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[hasTixApiAccess()](./bitburner.tix.hastixapiaccess.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns true if the player has access to the TIX API
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[hasWseAccount()](./bitburner.tix.haswseaccount.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Returns true if the player has access to a WSE Account
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[nextUpdate()](./bitburner.tix.nextupdate.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Sleep until the next Stock Market price update has happened.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[placeOrder(sym, shares, price, orderType, positionType)](./bitburner.tix.placeorder.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Place order for stocks.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[purchase4SMarketData()](./bitburner.tix.purchase4smarketdata.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Purchase 4S Market Data Access.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[purchase4SMarketDataTixApi()](./bitburner.tix.purchase4smarketdatatixapi.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Purchase 4S Market Data TIX API Access.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[purchaseTixApi()](./bitburner.tix.purchasetixapi.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Purchase TIX API Access
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[purchaseWseAccount()](./bitburner.tix.purchasewseaccount.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Purchase WSE Account.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[sellShort(sym, shares)](./bitburner.tix.sellshort.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Sell short stock.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
[sellStock(sym, shares)](./bitburner.tix.sellstock.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Sell stocks.
|
||
|
||
|
||
</td></tr>
|
||
</tbody></table>
|
||
|