Class default

Hierarchy

Map<IslandId, default>
- default

Index

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:27

Accessors

active

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

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

default

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

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

loaded

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

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

Methods

cleanup

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

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

compute

compute<ARGS>(key: `${number},${number}`, computer: ((key: `${number},${number}`, ...args: any[]) => default), ...args: ARGS): default
Type Parameters
- ARGS extends any[]
Parameters
- key: `${number},${number}`
- computer: ((key: `${number},${number}`, ...args: any[]) => default)
  - - (key: `${number},${number}`, ...args: any[]): default
    - Parameters
      
      key: `${number},${number}`
      
      Rest ...args: any[]
      
      Returns default
- Rest ...args: ARGS
Returns default
Inherited from Map.compute
- Defined in mods/types/definitions/utilities/prototype/Map.d.ts:13

findKey

findKey(predicate: ((value: default) => unknown)): undefined | `${number},${number}`
Parameters
- predicate: ((value: default) => unknown)
  - - (value: default): unknown
    - Parameters
      
      value: default
      
      Returns unknown
Returns undefined | `${number},${number}`
Inherited from Map.findKey
- Defined in mods/types/definitions/utilities/prototype/Map.d.ts:15

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:178

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:58

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:79
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:80

getBiomeType

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

getDetails

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

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:72

getKey

getKey(value: default): undefined | `${number},${number}`
Parameters
- value: default
Returns undefined | `${number},${number}`
Inherited from Map.getKey
- Defined in mods/types/definitions/utilities/prototype/Map.d.ts:14

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:93

Class default

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

game: Game

Returns default

Accessors

active

Returns default[]

default

Returns default

loaded

Returns default[]

Methods

cleanup

Returns void

compute

Type Parameters

ARGS extends any[]

Parameters

key: `${number},${number}`

computer: ((key: `${number},${number}`, ...args: any[]) => default)

Parameters

key: `${number},${number}`

Rest ...args: any[]

Returns default

Rest ...args: ARGS

Returns default

findKey

Parameters

predicate: ((value: default) => unknown)

Parameters

value: default

Returns unknown

Returns undefined | `${number},${number}`

generateDetails

Parameters

position: IVector2

seedType: SeedType

Optional seed: number

Returns IIslandDetails

get

Throws

Parameters

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

Returns default

getAt

Parameters

x: number

y: number

Returns undefined | default

Parameters

x: number

y: number

error: true

Returns default

getBiomeType

Parameters

x: number

y: number

Returns BiomeTypes

getDetails

Parameters

x: number

y: number

Returns IIslandDetails

getIfExists

Returns

Parameters

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

Returns undefined | default

getKey

Parameters

value: default

Returns undefined | `${number},${number}`

`Rest` ...args: any[]

`Rest` ...args: ARGS

`Optional` seed: number

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

`Optional` ensureUpgraded: boolean

`Optional` mapSize: number