mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-14 11:43:50 +01:00
36 lines
1.1 KiB
Markdown
36 lines
1.1 KiB
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [buy](./bitburner.tix.buy.md)
|
||
|
|
|
||
|
|
## TIX.buy() method
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
buy(sym: StockSymbol, shares: number): number;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. |
|
||
|
|
| 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
|
||
|
|
|
||
|
|
2.5 GB
|
||
|
|
|