Class Dynmap

Hierarchy (view full)

default
- Dynmap

Index

Constructors

Properties

GPS Nations Players Residents Towns inviteRange name

Accessors

Methods

configData getFromCache isWilderness mapData markerset onlinePlayerData playerData putInCache setKeyTTL withinBounds withinTown

Constructors

constructor

new Dynmap(mapName, cacheTimeoutMs?): Dynmap
Parameters
- mapName: "nova"
- cacheTimeoutMs: number = ...
Returns Dynmap
Overrides default.constructor
- Defined in src/api/dynmap/Dynmap.ts:35

Properties

`Readonly`GPS

GPS: GPS

`Readonly`Nations

Nations: Nations

`Readonly`Players

Players: Players

`Readonly`Residents

Residents: Residents

`Readonly`Towns

Towns: Towns

`Readonly`inviteRange

inviteRange: number

`Readonly`name

name: "nova"

Accessors

map

get map(): AnyMap
Returns AnyMap
Inherited from DataHandler.map
- Defined in src/helpers/DataHandler.ts:10

Methods

`Readonly`configData

configData<T>(): Promise<T>
Type Parameters
- T
Returns Promise<T>
Inherited from default.configData
- Defined in src/helpers/DataHandler.ts:46

`Readonly`getFromCache

getFromCache(key): any
Parameters
- key: string
Returns any
Inherited from default.getFromCache
- Defined in src/helpers/DataHandler.ts:41

`Readonly`isWilderness

isWilderness(location): Promise<boolean>
Parameters
- location: Point2D
Returns Promise<boolean>
- Defined in src/api/dynmap/Dynmap.ts:54

`Readonly`mapData

mapData<T>(): Promise<T>
Type Parameters
- T
Returns Promise<T>
Inherited from default.mapData
- Defined in src/helpers/DataHandler.ts:48

`Readonly`markerset

markerset(): Promise<Markerset>
Returns Promise<Markerset>
- Defined in src/api/dynmap/Dynmap.ts:62

`Readonly`onlinePlayerData

onlinePlayerData(): Promise<{
    name: string;
    nickname?: string;
    underground?: boolean;
    world?: string;
    x: string | number;
    y?: string | number;
    z: string | number;
}[]>
Returns Promise<{
    name: string;
    nickname?: string;
    underground?: boolean;
    world?: string;
    x: string | number;
    y?: string | number;
    z: string | number;
}[]>
- Defined in src/api/dynmap/Dynmap.ts:57

`Readonly`playerData

playerData<T>(): Promise<T>
Type Parameters
- T
Returns Promise<T>
Inherited from default.playerData
- Defined in src/helpers/DataHandler.ts:45

`Readonly`putInCache

putInCache<T>(key, value): TTLCache<string, any>
Type Parameters
- T
Parameters
- key: string
- value: T
Returns TTLCache<string, any>
Inherited from default.putInCache
- Defined in src/helpers/DataHandler.ts:42

`Readonly`setKeyTTL

setKeyTTL(key, ttl): void
Parameters
- key: string
- ttl: number
Returns void
Inherited from default.setKeyTTL
- Defined in src/helpers/DataHandler.ts:43

`Readonly`withinBounds

withinBounds(location, bounds): boolean
Parameters
- location: Point2D
- bounds: TownBounds
Returns boolean
- Defined in src/api/dynmap/Dynmap.ts:55

`Readonly`withinTown

withinTown(location): Promise<boolean>
Parameters
- location: Point2D
Returns Promise<boolean>
- Defined in src/api/dynmap/Dynmap.ts:49