Class default

Hierarchy

Constructors

constructor

Properties

event initialized isLoaded island offset scaling tier zoneSize zones

Accessors

axisCount description

Methods

all delete getActiveZones getMaxTier getMinTier getSpawnableCreatures getTotalCivilizationScore getZone getZoneAt getZoneById getZoneDistanceTierModifier initialize load onUnserialized processTimers recalculateCivilizationScore spawnDefaultCreatures

Constructors

constructor

  • Parameters

    Returns default

Properties

Readonly event

event: IEventEmitter<default, ICreatureZoneManagerEvents>

initialized

initialized: boolean = false

isLoaded

isLoaded: boolean = false

island

island: default

offset

offset: IVector2

scaling

scaling: number

tier

tier: number

Islands have a higher chance of starting at a higher tier the further out you get.

This should be displayed in island tooltips and such

zoneSize

zoneSize: number

zones

zones: PartialRecord<WorldZ, (undefined | CreatureZone)[]> = {}

Accessors

axisCount

  • get axisCount(): number

  • Gets the number of zones on each axis

    Returns number

description

Methods

all

  • Returns an array of all CreatureZones for valid Z layers.
    (Loading a save that previously had Troposphere doesn't return any zones from the troposphere layer)

    Returns CreatureZone[]

delete

  • Returns void

getActiveZones

  • Note: Active zones are cached on call, and reset whenever spawns are attempted.

    Parameters

    • playingHumans: default<unknown, number, NPC | Player>[] = ...
    • recalculate: boolean = false

    Returns CreatureZone[]

getMaxTier

  • Gets the estimated maximum tier on this island

    Note: Does not work correctly on initial island, requires the centre of the island to be the centre zone

    Returns number

getMinTier

  • Gets the minimum tier on this island (biome starting tier + randomly generated additional tier)

    Returns number

getSpawnableCreatures

  • Returns all spawnable creatures for this island

    Returns CreatureType[]

  • Returns spawnable creatures from the given tier

    Parameters

    • tier: number

    Returns CreatureType[]

  • Returns spawnable creatures from minTier to maxTier (inclusive)

    Parameters

    • minTier: number
    • maxTier: number

    Returns CreatureType[]

getTotalCivilizationScore

  • Returns

    The total civilization score of all zones

    Returns number

getZone

  • Parameters

    • zonePoint: IVector3

      The zone's internal position (not a tile position)

    Returns CreatureZone

getZoneAt

  • Parameters

    • point: IVector3

      A tile position as an IVector3. Most objects can be passed in as the IVector3

    Returns CreatureZone

getZoneById

  • Parameters

    • id: number

      The zone's internal id

    • z: WorldZ

    Returns CreatureZone

getZoneDistanceTierModifier

  • Calculates the distance tier modifier for a zone. Uses euclidean currently

    Parameters

    • point: IVector2
    • reverse: boolean = !this.island.isDefaultIsland

    Returns number

initialize

    • Set up the zones using the island's default spawn point (initial island) or the centre (travelled islands)
    • Save the zone size & distance scaling multiplier permanently as well so us rebalancing doesn't shift existing islands

    Parameters

    • force: boolean = false

      Re-initialize even if already initialized

    Returns void

load

  • Re-initialise CreatureZones (so this data doesn't have to be saved on them)

    Returns void

onUnserialized

  • Returns void

processTimers

  • Parameters

    Returns void

recalculateCivilizationScore

  • Resets & recalculates the civilization score for all zones

    Returns void

spawnDefaultCreatures

  • Ensures all zones spawned default creatures one time

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc