bitburner-src/markdown/bitburner.tix.placeorder.md

39 lines
1.3 KiB
Markdown
Raw Normal View History

2021-10-30 18:34:14 +02:00
<!-- 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)
## TIX.placeOrder() method
Places an order on the stock market. This function only works for Limit and Stop Orders.
The ability to place limit and stop orders is \*\*not\*\* immediately available to the player and must be unlocked later on in the game.
Returns true if the order is successfully placed, and false otherwise.
<b>Signature:</b>
```typescript
2021-10-30 21:46:34 +02:00
placeOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPosition): boolean;
2021-10-30 18:34:14 +02:00
```
## 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. |
2021-10-30 21:46:34 +02:00
| pos | [OrderPosition](./bitburner.orderposition.md) | Specifies whether the order is a “Long” or “Short” position. |
2021-10-30 18:34:14 +02:00
<b>Returns:</b>
boolean
True if the order is successfully placed, and false otherwise.
## Remarks
2021-10-30 21:46:34 +02:00
RAM cost: 2.5 GB
2021-10-30 18:34:14 +02:00