Class default

Hierarchy

Map<IslandId, default>
- default

Index

Constructors

Accessors

active default loaded

Methods

cleanup generateDetails get getAt getBiomeType getDetails getIfExists getOrCreate

Constructors

constructor

new default(game: Game): default
Parameters
- game: Game
Returns default
Overrides Map<IslandId, Island>.constructor
- Defined in src/game/game/island/IslandManager.ts:26

Accessors

active

get active(): default[]
Get the list of islands that contain players

Returns default[]
- Defined in src/game/game/island/IslandManager.ts:33

default

get default(): default
Get the island at position 0,0

Returns default
- Defined in src/game/game/island/IslandManager.ts:49

loaded

get loaded(): default[]
Get the list of islands that are loaded

Returns default[]
- Defined in src/game/game/island/IslandManager.ts:41

Methods

cleanup

cleanup(): void
Unloads islands that are no longer needed

Returns void
- Defined in src/game/game/island/IslandManager.ts:115

generateDetails

generateDetails(position: IVector2, seedType: SeedType, seed?: number): IIslandDetails
Parameters
- position: IVector2
- seedType: SeedType
- Optional seed: number
Returns IIslandDetails
- Defined in src/game/game/island/IslandManager.ts:177

get

get(islandId: `${number},${number}`): default
Gets an island by id

Throws
Errors if the island does not exist
Parameters
- islandId: `${number},${number}`
Returns default
Overrides Map.get
- Defined in src/game/game/island/IslandManager.ts:57

getAt

getAt(x: number, y: number): undefined | default
Gets an island by position
Parameters
- x: number
- y: number
Returns undefined | default
- Defined in src/game/game/island/IslandManager.ts:78
getAt(x: number, y: number, error: true): default
Parameters
- x: number
- y: number
- error: true
Returns default
- Defined in src/game/game/island/IslandManager.ts:79

getBiomeType

getBiomeType(x: number, y: number): BiomeTypes
Parameters
- x: number
- y: number
Returns BiomeTypes
- Defined in src/game/game/island/IslandManager.ts:167

getDetails

getDetails(x: number, y: number): IIslandDetails
Parameters
- x: number
- y: number
Returns IIslandDetails
- Defined in src/game/game/island/IslandManager.ts:172

getIfExists

getIfExists(islandId?: `${number},${number}`): undefined | default
Gets an island by id. Try to use "get" instead!

Returns
Island or undefined if it does not exist
Parameters
- Optional islandId: `${number},${number}`
Returns undefined | default
- Defined in src/game/game/island/IslandManager.ts:71

getOrCreate

getOrCreate(islandId: `${number},${number}`, ensureUpgraded?: boolean, mapSize?: number): default
Gets or creates a new island by id
Parameters
- islandId: `${number},${number}`
- Optional ensureUpgraded: boolean
- Optional mapSize: number
Returns default
- Defined in src/game/game/island/IslandManager.ts:92

Generated using TypeDoc