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

33 lines
1.0 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; [getSaleGain](./bitburner.tix.getsalegain.md)
## TIX.getSaleGain() method
2021-10-30 22:03:34 +02:00
Calculate profit of setting stocks.
2021-10-30 18:34:14 +02:00
<b>Signature:</b>
```typescript
2021-10-30 21:46:34 +02:00
getSaleGain(sym: StockSymbol, shares: number, posType: OrderPosition): number;
2021-10-30 18:34:14 +02:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. |
| shares | number | Number of shares to sell. |
2021-10-30 21:46:34 +02:00
| posType | [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>
number
Gain from selling a given number of shares of a stock.
## Remarks
2021-10-30 22:03:34 +02:00
RAM cost: 2 GB Calculates and returns how much you would gain from selling a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.
2021-10-30 18:34:14 +02:00