bitburner-src/markdown/bitburner.ns.formatpercent.md
omuretsu 6b8ae1b351 Change high% display to mult form
Also includes some documentation updates from a previous PR (sleeve.setToIdle)
2023-02-19 15:24:27 -05:00

1.2 KiB

Home > bitburner > NS > formatPercent

NS.formatPercent() method

Format a number as a percentage.

Signature:

formatPercent(n: number, fractionalDigits?: number, multStart?: number): string;

Parameters

Parameter Type Description
n number Number to format as a percentage.
fractionalDigits number (Optional) Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2.
multStart number (Optional)

Returns:

string

Formatted percentage.

Remarks

RAM cost: 0 GB

Converts a number into a percentage string with the specified number of fractional digits. This is the same function that the game itself uses to display percentages. The format also depends on the Numeric Display settings (all options on the "Numeric Display" options page) To format plain numbers or ram, see formatNumber and formatRam