Class CreatureZone

Hierarchy

  • CreatureZone

Constructors

constructor

Properties

civilizationScoreTiles islandId kills rectangle spawnedCreatures tames zonePoint

Accessors

description island

Methods

addCivilizationScore getCivilizationScore getCreatureSet getCreaturesWithinZoneBounds getCurrentCreatures getPlayersWithinZoneBounds getSpawnableCreatures getTier lowerTier processTimers raiseTier randomizeBiome randomizeLayer recalculateCivilizationScore refreshTileCivilizationScore reroll setBiome setLayer setTier spawnCreature spawnDefaultCreatures

Constructors

constructor

Properties

civilizationScoreTiles

civilizationScoreTiles: SaferNumberIndexedObject<number> = {}

islandId

islandId: `${number},${number}`

kills

kills: number = 0

rectangle

rectangle: default

spawnedCreatures

spawnedCreatures: boolean = false

tames

tames: number = 0

zonePoint

zonePoint: IVector3

Accessors

description

island

  • get island(): default

  • Returns default

Methods

addCivilizationScore

  • Adds civilization score to this zone.

    If civilization score for this zone is "dirty", this method does nothing

    Parameters

    • score: number
    • source: undefined | string

    Returns void

getCivilizationScore

  • Returns number

getCreatureSet

  • Gets the current creature set for this zone

    Returns CreatureType[]

getCreaturesWithinZoneBounds

  • Returns default[]

getCurrentCreatures

  • Returns default[]

getPlayersWithinZoneBounds

  • Returns default<unknown, number, NPC | Player>[]

getSpawnableCreatures

  • Parameters

    • atAnyTier: boolean = false

    Returns CreatureType[]

getTier

  • Gets the tier of this zone.

    • Either this zone's saved tier, if it was overwritten
    • Or the island's randomly generated starting tier + the zone's distance from the island's starting zone

    Returns number

lowerTier

  • Returns boolean

processTimers

  • Called when this zone is "active", ie, a human is in this zone or an adjacent zone

    Parameters

    Returns void

raiseTier

  • Returns void

randomizeBiome

  • Parameters

    • random: Random<IRandomGenerator<any>> = ...

    Returns void

randomizeLayer

  • Parameters

    • random: Random<IRandomGenerator<any>> = ...

    Returns void

recalculateCivilizationScore

  • Resets & recalculates the civilization score for the zone.

    Returns void

refreshTileCivilizationScore

  • Refreshes the provided civilization score for the given tile

    If civilization score for this zone is "dirty", this method does nothing

    Parameters

    • tile: default
    • Optional isRecalculating: boolean

    Returns void

reroll

  • Parameters

    • random: Random<IRandomGenerator<any>> = ...

    Returns void

setBiome

  • Parameters

    Returns void

setLayer

  • Parameters

    • zLayer: WorldZ

    Returns void

setTier

  • Parameters

    • tier: number

    Returns void

spawnCreature

  • Gets a random tile in the zone and attempts to spawn a creature there.

    Parameters

    • Optional playingHumans: default<unknown, number, NPC | Player>[]

      The humans currently playing on the island, if nothing is set, then the creature will spawn regardless of player LOS

    Returns void

spawnDefaultCreatures

  • Attempts to spawns some creatures for this zone to start with. Method will no-op if called more than once.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc