Class default

Hierarchy

Host<IDrawnMapEvents>
- default

Implements

Properties

`Optional` drawnMapRadius

drawnMapRadius?: number

`Readonly` event

event: IEventEmitter<default, IDrawnMapEvents>

islandId

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

tiles

tiles: default<IMapTileData>

`Readonly` type

type: DrawnMapType

Accessors

isValid

get isValid(): boolean
Returns boolean
- Defined in src/game/game/mapping/DrawnMap.ts:404

island

get island(): default
Returns default
- Defined in src/game/game/mapping/DrawnMap.ts:408

position

get position(): Readonly<IVector3>
The top-left position of this map

Returns Readonly<IVector3>
- Defined in src/game/game/mapping/DrawnMap.ts:380

radius

get radius(): number
Returns number
- Defined in src/game/game/mapping/DrawnMap.ts:384

Methods

addTreasure

addTreasure(x: number, y: number, chest: DoodadType): default
Parameters
- x: number
- y: number
- chest: DoodadType
Returns default
- Defined in src/game/game/mapping/DrawnMap.ts:465

discoverTreasure

discoverTreasure(x: number, y: number, discoverer: default<unknown, number, NPC | Player>): default
Parameters
- x: number
- y: number
- discoverer: default<unknown, number, NPC | Player>
Returns default
- Defined in src/game/game/mapping/DrawnMap.ts:476

getBackground

getBackground(): default
Returns default
- Defined in src/game/game/mapping/DrawnMap.ts:607

getCenterPosition

getCenterPosition(): IVector3
Returns IVector3
- Defined in src/game/game/mapping/DrawnMap.ts:487

getObfuscator

getObfuscator(): default
Returns default
- Defined in src/game/game/mapping/DrawnMap.ts:603

getRiddle

getRiddle(): undefined | default
Returns undefined | default
- Defined in src/game/game/mapping/DrawnMap.ts:611

getTreasure

getTreasure(): readonly ITreasure[]
Returns readonly ITreasure[]
- Defined in src/game/game/mapping/DrawnMap.ts:440

getUndiscoveredTreasure

getUndiscoveredTreasure(): ITreasure[]
Returns ITreasure[]
- Defined in src/game/game/mapping/DrawnMap.ts:444

hasDiscoveredAll

hasDiscoveredAll(): boolean
Returns boolean
- Defined in src/game/game/mapping/DrawnMap.ts:457

hasDiscoveredAny

hasDiscoveredAny(): boolean
Returns boolean
- Defined in src/game/game/mapping/DrawnMap.ts:461

isTreasureDiscovered

isTreasureDiscovered(treasure: ITreasure): boolean
Parameters
- treasure: ITreasure
Returns boolean
- Defined in src/game/game/mapping/DrawnMap.ts:448
isTreasureDiscovered(x: number, y: number): boolean
Parameters
- x: number
- y: number
Returns boolean
- Defined in src/game/game/mapping/DrawnMap.ts:449

onUnserialized

onUnserialized(): void
Returns void
Implementation of IUnserializedCallback.onUnserialized
- Defined in src/game/game/mapping/DrawnMap.ts:432

preSerializeObject

preSerializeObject(): void
Returns void
Implementation of IPreSerializeCallback.preSerializeObject
- Defined in src/game/game/mapping/DrawnMap.ts:428

render

render(theme: DrawnMapTheme): Promise<undefined | HTMLCanvasElement>
Parameters
- theme: DrawnMapTheme
Returns Promise<undefined | HTMLCanvasElement>
- Defined in src/game/game/mapping/DrawnMap.ts:495

toString

toString(): string
Returns string
- Defined in src/game/game/mapping/DrawnMap.ts:423

`Static` generateIslandTreasureMaps

generateIslandTreasureMaps(island: default, generationSettings: ITreasureMapGenerationSettings): void
Generates island treasure maps.

This should only be called a single time, when a world is first generated. This first generation stores a list of things that only get generated the first time, such as doodads. Subsequent loads of the maps will only re-initialise them from the things that are regenerated on each load.
Parameters
- island: default
- generationSettings: ITreasureMapGenerationSettings
Returns void
- Defined in src/game/game/mapping/DrawnMap.ts:137

`Static` initializeIslandTreasureMaps

initializeIslandTreasureMaps(island: default, generationSettings: ITreasureMapGenerationSettings, mapGenOutput: IMapGenGenerateOutput): void
Initialise an island's treasure maps.

This should be called after island treasure map generation, every time the island is loaded.
Parameters
- island: default
- generationSettings: ITreasureMapGenerationSettings
- mapGenOutput: IMapGenGenerateOutput
Returns void
- Defined in src/game/game/mapping/DrawnMap.ts:151

`Static` initializeIslandTreasureMapsDifferences

initializeIslandTreasureMapsDifferences(island: default): void
Parameters
- island: default
Returns void
- Defined in src/game/game/mapping/DrawnMap.ts:194

`Static` plotRegion

plotRegion(island: default, x: number, y: number, z: number, random?: Random<LegacySeededGenerator | PCGSeededGenerator>, map?: default, radius?: number): default
Parameters
- island: default
- x: number
- y: number
- z: number
- random: Random<LegacySeededGenerator | PCGSeededGenerator> = island.seededRandom
- map: default = ...
- radius: number = DRAWN_MAP_DEFAULT_RADIUS
Returns default
- Defined in src/game/game/mapping/DrawnMap.ts:207

Generated using TypeDoc