https://wiki.perfecttower2.com/w/index.php?action=history&feed=atom&title=Module%3AFormatNumber%2FdocModule:FormatNumber/doc - Revision history2026-10-07T07:06:52ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.perfecttower2.com/w/index.php?title=Module:FormatNumber/doc&diff=4324&oldid=prevSpeedybrain: Documentation2026-10-07T01:41:23Z<p>Documentation</p>
<p><b>New page</b></p><div>Formats numbers as the game does. It backs [[Template:Number|<nowiki>{{Number}}</nowiki>]] and, through it, [[Template:Cost|<nowiki>{{Cost}}</nowiki>]]. [[Module:UI]] (crafting cost) and [[Module:ModuleView]] (full view) call it directly.<br />
<br />
Numbers below a million show in full, with thousands separators (<code>120,000</code>). Larger numbers show as scientific notation (<code>1.2E7</code>) or as named numbers (<code>12 M</code>); the reader picks under '''Appearance > Numbers''', and scientific notation is the default. The module writes both forms, in <code>span.wiki-num__sci</code> and <code>span.wiki-num__named</code>, and [[MediaWiki:Common.css]] shows the one the reader picked. Each form has the other in its tooltip. The E is uppercase, as in the game, inside the brand kit class <code>.tpt-num__e</code>, which sets it smaller than the digits. Page previews (TextExtracts) leave out the named form. <code>inf</code> and <code>Infinity</code> show as Infinity.<br />
<br />
== Entry points ==<br />
* <code>main(frame)</code>: for the template. It reads the arguments of the invoke, or else of the calling template: <code>1</code> (the number; thousands separators and <code>1e7</code> notation work, and anything that isn't a number comes back unchanged), <code>format</code>, <code>prefix</code>, <code>suffix</code>, <code>sortkey</code>, <code>icon</code> and <code>iconpos</code>. The result is wrapped in a span with <code>data-sort-value</code>, for sortable tables.<br />
* <code>format(value, prefix, suffix, icon, iconPos, format)</code>: for other modules. <code>value</code> must be a number; it isn't checked. <code>format</code> set to <code>named</code> or <code>scientific</code> forces one form for every reader, with the other in an <code>abbr</code> tooltip. <code>icon</code> follows the number, or comes before it with <code>iconPos = "left"</code>.<br />
<br />
<syntaxhighlight lang="lua"><br />
local formatNumber = require('Module:FormatNumber').format<br />
formatNumber(1.8e12, nil, '%') -- 1.8E12% or 1.8 T%, as the reader chose<br />
</syntaxhighlight><br />
<includeonly><br />
<!-- Categories below this line --><br />
<br />
</includeonly><noinclude><br />
[[Category:Module documentation pages]]<br />
</noinclude></div>Speedybrain