Class default

Represents the worlds island Items, Creatures, Npcs, etc.. all exist on the island

Hierarchy

Implements

Constructors

constructor

Properties

biomeType brokenReferencesCount civilizationScore civilizationScoreTiles contaminatedWater corpses creatureSpawnTimer creatures details? doodads event flowFieldManager game id items loadCount mapGenBuildTime? mapGenVersion mapSize mapSizeSq modifiersCollection? moveTypesInFov name? npcs players ports position previousSaveVersion referenceId? saveBuildTime saveVersion seededRandom seeds spawnPoint temperature templateBiomeOptions tileContainers tileData tileEvents time treasureMaps version wellData world

Accessors

biome hasLoadedItemReferences isActive isDefaultIsland isLoaded isLocalIsland isTransient mapGenVersionInfo tiles

Methods

addCivilizationScore addPlayer calculateDamageOutcome calculateTileLightLevel calculateWell checkForTargetInRange checkTileState checkWaterFill clearGameOptionsCache coolFires createTile damage delete ensureUpgraded fireBreath getBenignity getDefaultTerrainType getDetails getDirectionFromMovement getGameOptions getGrowingSpeed getIslandDistance getLightSourceAt getLiquidGatherType getMalignity getMaxHealth getMaxWeight getName getNeighboringIslands getOrCreateTile getPlayerAverage getPlayers getQualityDurabilityBonus getRandomQuality getReputation getSkillPercent getSpawnPoint getSuitableSpawnPoint getTerrainItems getTile getTileFromPoint getTileSafe hydrateFromOldGame load loadReferences onUnserialized postSerializeObject postSerializeProperty preSerializeObject preSerializeProperty processTickFlags processTickFlagsAsync processWaterContamination rangeFinder recalculateCivilizationScore refreshTileCivilizationScore removePlayer rename setTile synchronizeStates toString unload updateFlowFieldTile updateReputation

Constructors

constructor

  • Parameters

    • Optional game: Game
    • Optional position: IVector2
    • Optional seed: number
    • Optional mapSize: number

    Returns default

Properties

biomeType

biomeType: BiomeTypes = BiomeType.Coastal

brokenReferencesCount

brokenReferencesCount: number = 0

civilizationScore

civilizationScore: number = 0

civilizationScoreTiles

civilizationScoreTiles: Record<number, number> = {}

contaminatedWater

contaminatedWater: IWaterContamination[] = []

Readonly corpses

corpses: default = ...

creatureSpawnTimer

creatureSpawnTimer: number = 0

Readonly creatures

creatures: default = ...

Optional details

details?: IIslandDetails

Readonly doodads

doodads: default = ...

Readonly event

event: IEventEmitter<default, IIslandEvents> = ...

Readonly flowFieldManager

flowFieldManager: default = ...

Readonly game

game: Game

Readonly id

id: `${number},${number}`

Readonly items

items: default = ...

loadCount

loadCount: number = 0

Optional mapGenBuildTime

mapGenBuildTime?: number

mapGenVersion

mapGenVersion: String

The version the mapgen for this island uses

Readonly mapSize

mapSize: number

Readonly mapSizeSq

mapSizeSq: number

Optional modifiersCollection

modifiersCollection?: IslandModifiersCollection

Readonly moveTypesInFov

moveTypesInFov: Map<"-1-0" | "-1-1" | "-1-2" | "-1-4" | "-1-8" | "-1-16" | "-1-32" | "-1-64" | "-1-128" | "-1-256" | "-1-512" | "-1-1024" | "-1-15" | "0-0" | "0-1" | "0-2" | "0-4" | "0-8" | "0-16" | "0-32" | "0-64" | "0-128" | "0-256" | "0-512" | "0-1024" | "0-15" | "1-0" | "1-1" | "1-2" | "1-4" | "1-8" | "1-16" | "1-32" | "1-64" | "1-128" | "1-256" | "1-512" | "1-1024" | "1-15", Set<default<number>>> = ...

Entity move types in fov on this island

Optional name

name?: string

Readonly npcs

npcs: default = ...

Readonly players

players: Set<default<number>> = ...

Set of players on this island

Readonly ports

ports: PortManager = ...

position

position: IVector2

previousSaveVersion

previousSaveVersion: undefined | IVersionInfo

Optional referenceId

referenceId?: number

Do not use this property directly, instead use `game.references.getReference()

saveBuildTime

saveBuildTime: number = saveData.gameBuildTime

saveVersion

saveVersion: String

The version this island was last loaded on

Readonly seededRandom

seededRandom: Random<LegacySeededGenerator | PCGSeededGenerator>

Readonly seeds

seeds: ISeeds

spawnPoint

spawnPoint: IVector3 = ...

Readonly temperature

temperature: default = ...

templateBiomeOptions

templateBiomeOptions: undefined | ITemplateBiomeOptions

tileContainers

tileContainers: ITileContainer[] = []

tileData

tileData: SaferNumberIndexedObject<SaferNumberIndexedObject<SaferNumberIndexedObject<ITileData[]>>> = {}

Readonly tileEvents

tileEvents: default = ...

Readonly time

time: default = ...

Readonly treasureMaps

treasureMaps: default[] = []

version

version: String = gameVersion

The version this island was originally made on

Readonly wellData

wellData: SaferNumberIndexedObject<IWell> = {}

Readonly world

world: default = ...

Accessors

biome

hasLoadedItemReferences

  • get hasLoadedItemReferences(): boolean

  • Returns boolean

isActive

  • get isActive(): boolean

  • Check if this island has players on it

    Returns boolean

isDefaultIsland

  • get isDefaultIsland(): boolean

  • Returns boolean

isLoaded

  • get isLoaded(): boolean

  • Returns boolean

isLocalIsland

  • get isLocalIsland(): boolean

  • Returns boolean

isTransient

  • get isTransient(): boolean

  • Returns boolean

mapGenVersionInfo

  • get mapGenVersionInfo(): Info

  • Returns Info

tiles

  • get tiles(): Record<number, undefined | default>

  • Returns Record<number, undefined | default>

Methods

addCivilizationScore

  • Adds civilization score

    Parameters

    • score: number
    • source: undefined | string

    Returns void

addPlayer

  • Parameters

    • human: default<number>
    • refreshStatusEffects: boolean = true

    Returns void

calculateDamageOutcome

calculateTileLightLevel

  • Calculates the light level of a tile.

    Returns

    32bit number representing RED GREEN BLUE ALPHA

    Parameters

    Returns number

calculateWell

  • Parameters

    Returns IWell

checkForTargetInRange

checkTileState

  • Checks if island.tileData is synced with Tile.data

    Returns void

checkWaterFill

clearGameOptionsCache

  • Returns void

coolFires

createTile

  • Parameters

    • x: number
    • y: number
    • z: number
    • index: number
    • rendererData: number
    • quality: Quality

    Returns default

damage

  • Parameters

    Returns undefined | number

delete

  • Returns void

ensureUpgraded

  • Parameters

    • isSynced: boolean

    Returns void

fireBreath

  • Parameters

    • x: number
    • y: number
    • z: number
    • facingDirection: Direction
    • Optional itemName: default
    • Optional player: boolean

    Returns void

getBenignity

  • Returns number

getDefaultTerrainType

  • Gets the default terrain type that should be under a tile (in the case of melting or removing it in some way).

    Returns

    The default terrain type with a fallback to dirt (which shouldn't happen without mods or bugs).

    Parameters

    • tile: default

      Tile that we are getting the default terrain type for.

    Returns TerrainType

getDetails

getDirectionFromMovement

  • Parameters

    • x: number
    • y: number

    Returns East | North | West | South

getGameOptions

getGrowingSpeed

  • Gets the growing speed (or chance to grow more every tick).

    Parameters

    • terrainType: TerrainType
    • Optional quality: Quality

      Quality of the item or tile to check the growing speed of.

    • Optional magicValue: number

    Returns number

getIslandDistance

  • Gets the total distance away the current island is from 0, 0 as a positive value.

    Returns

    The distance as a positive number.

    Returns number

getLightSourceAt

  • Parameters

    • x: number
    • y: number
    • z: number

    Returns number

getLiquidGatherType

getMalignity

  • Returns number

getMaxHealth

  • Returns number

getMaxWeight

  • Returns number

getName

  • Parameters

    • useGenerated: boolean = false

    Returns string

getNeighboringIslands

  • Returns default[]

getOrCreateTile

  • Parameters

    • index: number
    • x: number
    • y: number
    • z: number
    • rendererData: number
    • quality: Quality

    Returns default

getPlayerAverage

  • Parameters

    • calc: ((player: default<number>) => undefined | number)
        • (player: default<number>): undefined | number

        • Parameters

          Returns undefined | number

    • Optional round: boolean

    Returns number

getPlayers

  • Parameters

    • Optional includeGhosts: boolean
    • Optional includeConnecting: boolean

    Returns default<number>[]

getQualityDurabilityBonus

  • Parameters

    • quality: Quality
    • itemDurability: number
    • Optional getMax: boolean

    Returns number

getRandomQuality

getReputation

  • Returns number

getSkillPercent

  • Parameters

    Returns number

getSpawnPoint

  • Returns default

getSuitableSpawnPoint

  • Returns default

getTerrainItems

  • Gets the items/resources from terrain based on the TerrainResources definition and checks if it is based on the current biome type.

    Returns

    undefined if nothing set, or an array of ITerrainLootItem.

    Parameters

    Returns undefined | ITerrainLootItem[]

getTile

  • Parameters

    • x: number
    • y: number
    • z: number
    • Optional disableLog: boolean

    Returns default

getTileFromPoint

getTileSafe

  • Parameters

    • x: number
    • y: number
    • z: number

    Returns undefined | default

hydrateFromOldGame

  • Parameters

    Returns void

load

loadReferences

  • Only allow loading references once Even if an island is unloaded, the loaded references will remain

    Parameters

    • allowFixes: boolean

    Returns void

onUnserialized

  • Parameters

    Returns void

postSerializeObject

postSerializeProperty

preSerializeObject

preSerializeProperty

processTickFlags

  • Parameters

    Returns void

processTickFlagsAsync

  • Parameters

    • tickFlag: TickFlag
    • ticks: number
    • playingHumans: default<number>[]
    • onProgress: ((progess: number) => Promise<void>)
        • (progess: number): Promise<void>

        • Parameters

          • progess: number

          Returns Promise<void>

    Returns Promise<void>

processWaterContamination

  • Returns void

rangeFinder

  • Returns

    a range value for the weapon being shot based on the weapon range and the players skill with that weapon type. This value then becomes the maximum potential range of the current shot.

    Parameters

    • weaponRange: number
    • playerSkillLevel: number
    • get: "min" | "max" | "random" = "random"

    Returns number

recalculateCivilizationScore

  • Resets & recalculates the civilization score

    Returns void

refreshTileCivilizationScore

  • Refreshes the provided civ score for the given tile

    Parameters

    • tile: default
    • Optional isRecalculating: boolean

    Returns void

removePlayer

  • Parameters

    • human: default<number>
    • isAbsentPlayer: boolean = false

    Returns void

rename

  • Parameters

    • human: default<number>
    • newName: string

    Returns void

setTile

  • Parameters

    • x: number
    • y: number
    • z: number
    • tile: default

    Returns default

synchronizeStates

  • Synchronizes player events Usually called when a new player joins

    Parameters

    • playerIds: number[]

    Returns void

toString

  • Returns string

unload

  • Unload the island from memory Removes all players and stores tiles references

    Returns void

updateFlowFieldTile

  • Parameters

    Returns void

updateReputation

  • Parameters

    • reputation: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc