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

36 lines
1.1 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. -->
2022-08-17 14:50:05 +02:00
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [buyStock](./bitburner.tix.buystock.md)
2021-10-30 18:34:14 +02:00
2022-08-17 14:50:05 +02:00
## TIX.buyStock() method
2021-10-30 18:34:14 +02:00
2021-10-30 22:03:34 +02:00
Buy stocks.
2021-10-30 18:34:14 +02:00
<b>Signature:</b>
```typescript
2022-08-17 14:50:05 +02:00
buyStock(sym: string, shares: number): number;
2021-10-30 18:34:14 +02:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
2021-11-03 05:27:21 +01:00
| sym | string | Stock symbol. |
2021-10-30 18:34:14 +02:00
| shares | number | Number of shares to purchased. Must be positive. Will be rounded to nearest integer. |
<b>Returns:</b>
number
The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased.
## Remarks
2021-10-30 22:03:34 +02:00
RAM cost: 2.5 GB Attempts to purchase shares of a stock using a Market Order.
If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee.
If this function successfully purchases the shares, it will return the stock price at which each share was purchased. Otherwise, it will return 0.
2021-10-30 18:34:14 +02:00