bitburner-src/markdown/bitburner.ns.getbitnodemultipliers.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

56 lines
1.5 KiB
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [getBitNodeMultipliers](./bitburner.ns.getbitnodemultipliers.md)
## NS.getBitNodeMultipliers() method
Get the current Bitnode multipliers.
<b>Signature:</b>
```typescript
getBitNodeMultipliers(n?: number, lvl?: number): BitNodeMultipliers;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| n | number | |
| lvl | number | |
<b>Returns:</b>
[BitNodeMultipliers](./bitburner.bitnodemultipliers.md)
Object containing the current BitNode multipliers.
## Remarks
RAM cost: 4 GB
Returns an object containing the current (or supplied) BitNode multipliers. This function requires you to be in Bitnode 5 or have Source-File 5 in order to run. The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%). The multipliers represent the difference between the current BitNode and the original BitNode (BitNode-1).
For example, if the CrimeMoney multiplier has a value of 0.1, then that means that committing crimes in the current BitNode will only give 10% of the money you would have received in BitNode-1.
## Example 1
```ts
// NS1:
var mults = getBitNodeMultipliers();
print(mults.ServerMaxMoney);
print(mults.HackExpGain);
```
## Example 2
```ts
// NS2:
const {ServerMaxMoney, HackExpGain} = ns.getBitNodeMultipliers();
print(ServerMaxMoney);
print(HackExpGain);
```