1.0.2 • Published 4 months ago

adnot-beport-small v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

Antimatter Dimensions Notations - break_eternity.js Port

All the notations that are included in the current version of Antimatter Dimensions, and the upcoming Reality Update, however they have been ported to break_eternity.js

Setup

CDN

The simplest way to use this package is to include these scripts in your HTML page:

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/break_eternity.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/adnot-beport-small"></script>

You can also grab specific versions here:

All the notations are included inside ADNotations object:

const scientific = new ADNotations.ScientificNotation();

The main method that notations provide is format(value, places, placesUnder1000)

  • value can be Decimal, number or string which you want to format
  • places is used to format mantissa when number is greater than 1000
  • placesUnder1000 is used to format the number when it is lesser than 1000
const scientific = new ADNotations.ScientificNotation();

// Outputs "1000.00"
console.log(scientific.format(1000, 2, 2));
// Outputs "1.00e100"
console.log(scientific.format("1e100", 2, 0));
// Outputs "1e100"
console.log(scientific.format(new Decimal(1e100), 0, 0));

You can configure some formatting aspects via ADNotations.Settings object:

const scientific = new ADNotations.ScientificNotation();

// Outputs "1e100,000"
console.log(scientific.format("1e100000", 2, 2));

// Outputs "1e100000"
ADNotations.Settings.exponentCommas.show = false;
console.log(scientific.format("1e100000", 2, 2));

// Outputs "Infinite"
ADNotations.Settings.isInfinite = decimal => decimal.gte(1e100);
console.log(scientific.format(1e101, 2, 2));

Configuration settings:

  • Settings.isInfinite - function that determines if a Decimal value is infinite (default is decimal => decimal.gte(Decimal.MAX_VALUE))
  • Settings.exponentCommas.show - show commas in formatted output (default is true)
  • Settings.exponentCommas.min - lower bound for exponent to be formatted with commas (default is 100000)
  • Settings.exponentCommas.max - upper bound for exponent to be formatted with commas (default is 1000000000)

Extend

Creating your own notations is very simple! Just extend base class Notation and implement the required methods get name() and formatDecimal:

class SimpleNotation extends ADNotations.Notation {
  get name() {
    return "Simple";
  }

  formatDecimal(value, places) {
    return `Mantissa: ${value.mantissa.toFixed(places)}, Exponent: ${value.exponent}`;
  }
}

You can also extend existing notations (like EmojiNotation does) and override other methods, but this is a more advanced case which you can figure out by looking at the source code of existing notations.

Community Notations

To use community notations, download community pack from the releases page. The community pack can be used separately from the base pack.

If you want your notation to be publicly available via this library, you should start by adding your notation to a src/community folder and making a pull request with it.

After your PR is merged (which means that one of the maintainers decided that it is good enough), you can reach out to AD devs about adding it to a base game. There is no guarantee that it will be added, but all well-made notations will be available as a community pack.

Acknowledgements

Special thanks to the authors of notations:

Thanks to the authors of community notations:

And a thanks to the base notations code. You can find it here, however it is intended for use with break_infinity.

notationsnumbers
break_eternity.jsjsmintslib
@everything-registry/sub-chunk-1100
1.0.2

4 months ago

1.0.1

6 months ago

1.0.0

6 months ago