@projectsophon/hexgen
TypeScript icon, indicating that this package has built-in type declarations

0.1.3 • Public • Published

@projectsophon/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 @projectsophon/hexgen
yarn add @projectsophon/hexgen

When using this in a plugin, you might want to load it with skypack

import * as hexgen from 'http://cdn.skypack.dev/@projectsophon/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): bigint

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

bigint


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

Readme

Keywords

none

Package Sidebar

Install

npm i @projectsophon/hexgen

Weekly Downloads

0

Version

0.1.3

License

MIT

Unpacked Size

11.1 kB

Total Files

7

Last publish

Collaborators

  • phated
  • sophonbot