mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-22 17:23:00 +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>
129 lines
1.5 KiB
Markdown
129 lines
1.5 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [placeOrder](./bitburner.tix.placeorder.md)
|
|
|
|
## TIX.placeOrder() method
|
|
|
|
Place order for stocks.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
placeOrder(sym: string, shares: number, price: number, orderType: OrderType, positionType: PositionType): boolean;
|
|
```
|
|
|
|
## 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:**
|
|
|
|
boolean
|
|
|
|
True if the order is successfully placed, and false otherwise.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 2.5 GB 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.
|
|
|