mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-09-19 20:38:42 +02:00
35 lines
1.1 KiB
Markdown
35 lines
1.1 KiB
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [cancelOrder](./bitburner.tix.cancelorder.md)
|
||
|
|
|
||
|
|
## TIX.cancelOrder() method
|
||
|
|
|
||
|
|
Cancels an oustanding 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.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
cancelOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPos): void;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. |
|
||
|
|
| shares | number | Number of shares for order. Must be positive. Will be rounded to nearest integer. |
|
||
|
|
| price | number | Execution price for the order. |
|
||
|
|
| type | [OrderType](./bitburner.ordertype.md) | Type of order. |
|
||
|
|
| pos | [OrderPos](./bitburner.orderpos.md) | Specifies whether the order is a “Long” or “Short” position. |
|
||
|
|
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
void
|
||
|
|
|
||
|
|
## Remarks
|
||
|
|
|
||
|
|
2.5 GB
|
||
|
|
|