mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 23:08:36 +02:00
API: Rename "TIX" interface to "Stock" (#2351)
This commit is contained in:
catloversg
GitHub
@@ -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;
|
||||
|
||||
@@ -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,
|
||||
|
||||
8
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
8
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user