@projectsophon/procgen

Table of contents

$3

- PixelCoords
- QuoteData

$3

- grayColors
- mockCommon
- mockEpic
- mockLegendary
- mockRare

$3

- artifactName
- artifactRandom
- artifactRandomInt
- getBiomeRgbStr
- getHatSizeName
- getOwnerColor
- getOwnerColorVec
- getPlanetBlurb
- getPlanetBlurb2
- getPlanetClass
- getPlanetCosmetic
- getPlanetName
- getPlanetNameHash
- getPlanetTagline
- getPlanetTitle
- getPlayerColor
- getPlayerColorVec
- getRuinsInfo
- hashToHue
- hatTypeFromHash
- hslStr
- hslToRgb
- mockArtifact
- mockArtifactWithRarity
- planetPerlin
- planetRandom
- planetRandomInt
- rgbStr
- titleCase

Type Aliases

$3

Ƭ PixelCoords: Object

#### Type declaration

| Name | Type |
| :------ | :------ |
| x | number |
| y | number |

___

$3

Ƭ QuoteData: Object

#### Type declaration

| Name | Type |
| :------ | :------ |
| author | string |
| quote | string |

Variables

$3

• Const grayColors: PlanetCosmeticInfo

___

$3

• Const mockCommon: Artifact

___

$3

• Const mockEpic: Artifact

___

$3

• Const mockLegendary: Artifact

___

$3

• Const mockRare: Artifact

Functions

$3

▸ artifactName(artifact): string

#### Parameters

| Name | Type |
| :------ | :------ |
| artifact | undefined \| Artifact |

#### Returns

string

___

$3

▸ artifactRandom(loc): () => number

#### Parameters

| Name | Type |
| :------ | :------ |
| loc | ArtifactId |

#### Returns

fn

▸ (): number

##### Returns

number

___

$3

▸ artifactRandomInt(loc): () => number

#### Parameters

| Name | Type |
| :------ | :------ |
| loc | ArtifactId |

#### Returns

fn

▸ (): number

##### Returns

number

___

$3

▸ getBiomeRgbStr(biome): string

#### Parameters

| Name | Type |
| :------ | :------ |
| biome | Biome |

#### Returns

string

___

$3

▸ getHatSizeName(planet): string

#### Parameters

| Name | Type |
| :------ | :------ |
| planet | Planet |

#### Returns

string

___

$3

▸ getOwnerColor(planet): string

#### Parameters

| Name | Type |
| :------ | :------ |
| planet | Planet |

#### Returns

string

___

$3

▸ getOwnerColorVec(planet): RGBAVec

#### Parameters

| Name | Type |
| :------ | :------ |
| planet | Planet |

#### Returns

RGBAVec

___

$3

▸ getPlanetBlurb(planet): string

#### Parameters

| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |

#### Returns

string

___

$3

▸ getPlanetBlurb2(planet): string

#### Parameters

| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |

#### Returns

string

___

$3

▸ getPlanetClass(planet): UpgradeBranchName

#### Parameters

| Name | Type |
| :------ | :------ |
| planet | Planet |

#### Returns

UpgradeBranchName

___

$3

▸ getPlanetCosmetic(planet): PlanetCosmeticInfo

#### Parameters

| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |

#### Returns

PlanetCosmeticInfo

___

$3

▸ getPlanetName(planet): string

#### Parameters

| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |

#### Returns

string

___

$3

▸ getPlanetNameHash(locId): string

#### Parameters

| Name | Type |
| :------ | :------ |
| locId | LocationId |

#### Returns

string

___

$3

▸ getPlanetTagline(planet): string

#### Parameters

| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |

#### Returns

string

___

$3

▸ getPlanetTitle(planet): string

#### Parameters

| Name | Type |
| :------ | :------ |
| planet | undefined \| Planet |

#### Returns

string

___

$3

▸ getPlayerColor(player): string

#### Parameters

| Name | Type |
| :------ | :------ |
| player | EthAddress |

#### Returns

string

___

$3

▸ getPlayerColorVec(player): RGBAVec

#### Parameters

| Name | Type |
| :------ | :------ |
| player | EthAddress |

#### Returns

RGBAVec

___

$3

▸ getRuinsInfo(loc): RuinsInfo

#### Parameters

| Name | Type |
| :------ | :------ |
| loc | LocationId |

#### Returns

RuinsInfo

___

$3

▸ hashToHue(hash): number

#### Parameters

| Name | Type |
| :------ | :------ |
| hash | string |

#### Returns

number

___

$3

▸ hatTypeFromHash(hash): HatType

#### Parameters

| Name | Type |
| :------ | :------ |
| hash | LocationId |

#### Returns

HatType

___

$3

▸ hslStr(h, s, l): string

#### Parameters

| Name | Type |
| :------ | :------ |
| h | number |
| s | number |
| l | number |

#### Returns

string

___

$3

▸ hslToRgb(__namedParameters): RGBVec

#### Parameters

| Name | Type |
| :------ | :------ |
| __namedParameters | HSLVec |

#### Returns

RGBVec

___

$3

▸ mockArtifact(rarity, artifactType?, planetBiome?): Artifact

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| rarity | ArtifactRarity | undefined |
| artifactType | ArtifactType | ArtifactType.Spaceship |
| planetBiome | Biome | Biome.WASTELAND |

#### Returns

Artifact

___

$3

▸ mockArtifactWithRarity(rarity, artifactType?, planetBiome?): Artifact

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| rarity | ArtifactRarity | undefined |
| artifactType | ArtifactType | ArtifactType.Spaceship |
| planetBiome | Biome | Biome.WASTELAND |

#### Returns

Artifact

___

$3

▸ planetPerlin(loc): (coords: PixelCoords) => number

#### Parameters

| Name | Type |
| :------ | :------ |
| loc | LocationId |

#### Returns

fn

▸ (coords): number

##### Parameters

| Name | Type |
| :------ | :------ |
| coords | PixelCoords |

##### Returns

number

___

$3

▸ planetRandom(loc): () => number

#### Parameters

| Name | Type |
| :------ | :------ |
| loc | LocationId |

#### Returns

fn

▸ (): number

##### Returns

number

___

$3

▸ planetRandomInt(loc): () => number

#### Parameters

| Name | Type |
| :------ | :------ |
| loc | LocationId |

#### Returns

fn

▸ (): number

##### Returns

number

___

$3

▸ rgbStr(rgb): string

#### Parameters

| Name | Type |
| :------ | :------ |
| rgb | RGBVec |

#### Returns

string

___

$3

▸ titleCase(title): string

#### Parameters

| Name | Type |
| :------ | :------ |
| title | string |

#### Returns

string