bitburner-src/markdown/bitburner.tix.getsalegain.md
Olivier Gagnon 2b79871c02 doc
2021-11-03 00:27:21 -04:00

33 lines
950 B
Markdown

<!-- 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
Calculate profit of setting stocks.
<b>Signature:</b>
```typescript
getSaleGain(sym: string, shares: number, posType: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sym | string | Stock symbol. |
| shares | number | Number of shares to sell. |
| posType | string | Specifies whether the order is a “Long” or “Short” position. |
<b>Returns:</b>
number
Gain from selling a given number of shares of a stock.
## Remarks
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.