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

48 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; [getPosition](./bitburner.tix.getposition.md)
## TIX.getPosition() method
2021-10-30 22:03:34 +02:00
Returns the players position in a stock.
2021-10-30 18:34:14 +02:00
<b>Signature:</b>
```typescript
getPosition(sym: StockSymbol): [number, number, number, number];
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. |
<b>Returns:</b>
\[number, number, number, number\]
Array of four elements that represents the players position in a stock.
## Remarks
2021-10-30 22:03:34 +02:00
RAM cost: 2 GB Returns an array of four elements that represents the players position in a stock.
The first element is the returned array is the number of shares the player owns of the stock in the Long position. The second element in the array is the average price of the players shares in the Long position.
The third element in the array is the number of shares the player owns of the stock in the Short position. The fourth element in the array is the average price of the players Short position.
All elements in the returned array are numeric.
2021-10-30 18:34:14 +02:00
## Example
2021-10-30 21:46:34 +02:00
```ts
2021-10-30 18:34:14 +02:00
pos = getPosition("ECP");
shares = pos[0];
avgPx = pos[1];
sharesShort = pos[2];
avgPxShort = pos[3];
```