mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-10 09:43:54 +01:00
38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [sellShort](./bitburner.tix.sellshort.md)
|
||
|
|
|
||
|
|
## TIX.sellShort() method
|
||
|
|
|
||
|
|
Attempts to sell a short position of a stock using a Market Order.
|
||
|
|
|
||
|
|
The ability to short a stock is \*\*not\*\* immediately available to the player and must be unlocked later on in the game.
|
||
|
|
|
||
|
|
If the specified number of shares exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee.
|
||
|
|
|
||
|
|
If the sale is successful, this function will return the stock price at which each share was sold. Otherwise it will return 0.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
sellShort(sym: StockSymbol, shares: number): number;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. |
|
||
|
|
| shares | number | Number of shares to sell. Must be positive. Will be rounded to nearest integer. |
|
||
|
|
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
number
|
||
|
|
|
||
|
|
The stock price at which each share was sold, otherwise 0 if the shares weren't sold.
|
||
|
|
|
||
|
|
## Remarks
|
||
|
|
|
||
|
|
2.5 GB
|
||
|
|
|