@df0/hexgen
v0.0.6
Published
This package contains functions for determining various properties of Dark Forest objects based on their ID in hex. You could think of this package like procedural generation for Ethereum addresses.
Downloads
7
Readme
@df0/hexgen
This package contains functions for determining various properties of Dark Forest objects based on their ID in hex. You could think of this package like procedural generation for Ethereum addresses.
Note: This package might go away when objects become classes that contain a lot of these helpers as instance methods.
Installation
You can install this package using npm
or
yarn
by running:
npm install --save @df0/hexgen
yarn add @df0/hexgen
When using this in a plugin, you might want to load it with skypack
import * as hexgen from 'http://cdn.skypack.dev/@df0/hexgen';
Table of contents
Functions
Functions
bonusFromHex
▸ bonusFromHex(hex
): PlanetBonus
Extracts the bonuses of a planet given its LocationID.
Parameters
| Name | Type | Description |
| :---- | :----------- | :---------------------- |
| hex
| LocationId
| LocationID of a planet. |
Returns
PlanetBonus
getBytesFromHex
▸ getBytesFromHex(hexStr
, startByte
, endByte
): BigInteger
The core method for extracting planet details from a LocationID.
Parameters
| Name | Type | Description |
| :---------- | :------- | :------------------------------------------------------- |
| hexStr
| string
| LocationID of a planet. |
| startByte
| number
| The first byte to include in the result. |
| endByte
| number
| The byte after the last byte to include in the result. |
Returns
BigInteger
planetHasBonus
▸ planetHasBonus(planet?
): boolean
Checks if the LocationID of the planet indicates any bonuses.
Parameters
| Name | Type | Description |
| :-------- | :------- | :--------------------------- |
| planet?
| Planet
| Planet to check for bonuses. |
Returns
boolean