@projectsophon/procgen

@projectsophon/procgen

Table of contents

Type Aliases

• PixelCoords
• QuoteData

Variables

• grayColors
• mockCommon
• mockEpic
• mockLegendary
• mockRare

Functions

• 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

PixelCoords

Ƭ PixelCoords: Object

Type declaration

Name	Type
x	number
y	number

---

QuoteData

Ƭ QuoteData: Object

Type declaration

Name	Type
author	string
quote	string

Variables

grayColors

• Const grayColors: PlanetCosmeticInfo

---

mockCommon

• Const mockCommon: Artifact

---

mockEpic

• Const mockEpic: Artifact

---

mockLegendary

• Const mockLegendary: Artifact

---

mockRare

• Const mockRare: Artifact

Functions

artifactName

▸ artifactName(artifact): string

Parameters

Name	Type
artifact	undefined | Artifact

Returns

string

---

artifactRandom

▸ artifactRandom(loc): () => number

Parameters

Name	Type
loc	ArtifactId

Returns

fn

▸ (): number

Returns

number

---

artifactRandomInt

▸ artifactRandomInt(loc): () => number

Parameters

Name	Type
loc	ArtifactId

Returns

fn

▸ (): number

Returns

number

---

getBiomeRgbStr

▸ getBiomeRgbStr(biome): string

Parameters

Name	Type
biome	Biome

Returns

string

---

getHatSizeName

▸ getHatSizeName(planet): string

Parameters

Name	Type
planet	Planet

Returns

string

---

getOwnerColor

▸ getOwnerColor(planet): string

Parameters

Name	Type
planet	Planet

Returns

string

---

getOwnerColorVec

▸ getOwnerColorVec(planet): RGBAVec

Parameters

Name	Type
planet	Planet

Returns

RGBAVec

---

getPlanetBlurb

▸ getPlanetBlurb(planet): string

Parameters

Name	Type
planet	undefined | Planet

Returns

string

---

getPlanetBlurb2

▸ getPlanetBlurb2(planet): string

Parameters

Name	Type
planet	undefined | Planet

Returns

string

---

getPlanetClass

▸ getPlanetClass(planet): UpgradeBranchName

Parameters

Name	Type
planet	Planet

Returns

UpgradeBranchName

---

getPlanetCosmetic

▸ getPlanetCosmetic(planet): PlanetCosmeticInfo

Parameters

Name	Type
planet	undefined | Planet

Returns

PlanetCosmeticInfo

---

getPlanetName

▸ getPlanetName(planet): string

Parameters

Name	Type
planet	undefined | Planet

Returns

string

---

getPlanetNameHash

▸ getPlanetNameHash(locId): string

Parameters

Name	Type
locId	LocationId

Returns

string

---

getPlanetTagline

▸ getPlanetTagline(planet): string

Parameters

Name	Type
planet	undefined | Planet

Returns

string

---

getPlanetTitle

▸ getPlanetTitle(planet): string

Parameters

Name	Type
planet	undefined | Planet

Returns

string

---

getPlayerColor

▸ getPlayerColor(player): string

Parameters

Name	Type
player	EthAddress

Returns

string

---

getPlayerColorVec

▸ getPlayerColorVec(player): RGBAVec

Parameters

Name	Type
player	EthAddress

Returns

RGBAVec

---

getRuinsInfo

▸ getRuinsInfo(loc): RuinsInfo

Parameters

Name	Type
loc	LocationId

Returns

RuinsInfo

---

hashToHue

▸ hashToHue(hash): number

Parameters

Name	Type
hash	string

Returns

number

---

hatTypeFromHash

▸ hatTypeFromHash(hash): HatType

Parameters

Name	Type
hash	LocationId

Returns

HatType

---

hslStr

▸ hslStr(h, s, l): string

Parameters

Name	Type
h	number
s	number
l	number

Returns

string

---

hslToRgb

▸ hslToRgb(__namedParameters): RGBVec

Parameters

Name	Type
__namedParameters	HSLVec

Returns

RGBVec

---

mockArtifact

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

Parameters

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

Returns

Artifact

---

mockArtifactWithRarity

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

Parameters

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

Returns

Artifact

---

planetPerlin

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

Parameters

Name	Type
loc	LocationId

Returns

fn

▸ (coords): number

Parameters

Name	Type
coords	PixelCoords

Returns

number

---

planetRandom

▸ planetRandom(loc): () => number

Parameters

Name	Type
loc	LocationId

Returns

fn

▸ (): number

Returns

number

---

planetRandomInt

▸ planetRandomInt(loc): () => number

Parameters

Name	Type
loc	LocationId

Returns

fn

▸ (): number

Returns

number

---

rgbStr

▸ rgbStr(rgb): string

Parameters

Name	Type
rgb	RGBVec

Returns

string

---

titleCase

▸ titleCase(title): string

Parameters

Name	Type
title	string

Returns

string