mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-24 18:22:58 +02:00
catloversg
125 lines
1.4 KiB
Markdown
125 lines
1.4 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stock](./bitburner.stock.md) > [cancelOrder](./bitburner.stock.cancelorder.md)
|
|
|
|
## Stock.cancelOrder() method
|
|
|
|
Cancel order for stocks.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
cancelOrder(sym: string, shares: number, price: number, orderType: OrderType, positionType: PositionType): void;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
sym
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Stock symbol.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
shares
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Number of shares for order. Must be positive. Will be rounded to the nearest integer.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
price
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Execution price for the order.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
orderType
|
|
|
|
|
|
</td><td>
|
|
|
|
[OrderType](./bitburner.ordertype.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Type of order.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
positionType
|
|
|
|
|
|
</td><td>
|
|
|
|
[PositionType](./bitburner.positiontype.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Specifies whether the order is a Long ("L") or Short ("S") position.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
void
|
|
|
|
## 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 must be unlocked later on in the game.
|
|
|