LiveAtlas/src/index.d.ts

156 lines
3.5 KiB
TypeScript
Raw Normal View History

2021-05-27 13:30:56 +00:00
import {State} from "@/store";
2021-07-19 15:40:30 +00:00
import {DynmapPlayer, DynmapUrlConfig, LiveAtlasWorldMap} from "@/dynmap";
2021-05-15 19:25:03 +00:00
declare module "*.png" {
const value: any;
export = value;
}
declare module '*.vue' {
2021-07-19 15:40:30 +00:00
import type {DefineComponent} from 'vue'
const component: DefineComponent<{}, {}, any>
2021-05-15 19:25:03 +00:00
export default component
2020-12-20 16:01:15 +00:00
}
declare global {
// noinspection JSUnusedGlobalSymbols
interface Window {
liveAtlasConfig: LiveAtlasGlobalConfig,
}
}
2021-07-19 15:40:30 +00:00
interface Coordinate {
x: number;
y: number;
z: number;
}
interface LiveAtlasLocation {
x: number;
y: number;
z: number;
world?: string;
}
interface LiveAtlasGlobalConfig {
servers: Map<string, LiveAtlasServerDefinition>;
messages: LiveAtlasGlobalMessageConfig;
ui: LiveAtlasUIConfig;
}
interface LiveAtlasServerDefinition {
2021-05-17 02:39:25 +00:00
id: string
label?: string
}
interface LiveAtlasDynmapServerDefinition extends LiveAtlasServerDefinition {
type: 'dynmap',
dynmap: DynmapUrlConfig,
2021-05-20 15:13:25 +00:00
}
// Messages defined directly in LiveAtlas and used for all servers
interface LiveAtlasGlobalMessageConfig {
2021-05-20 15:13:25 +00:00
chatNoMessages: string;
2021-05-20 15:39:41 +00:00
chatTitle: string;
2021-05-20 15:13:25 +00:00
chatLogin: string;
chatLoginLink: string;
chatSend: string;
2021-05-20 15:39:41 +00:00
chatPlaceholder: string;
2021-05-20 15:13:25 +00:00
chatErrorDisabled: string;
chatErrorUnknown: string;
2021-05-20 15:39:41 +00:00
serversHeading: string;
worldsSkeleton: string;
playersSkeleton: string;
playersTitle: string;
playersTitleHidden: string;
playersTitleOtherWorld: string;
2021-07-21 15:19:18 +00:00
playersSearchPlaceholder: string;
playersSearchSkeleton: string;
2021-05-20 15:39:41 +00:00
followingHeading: string;
followingUnfollow: string;
followingTitleUnfollow: string;
followingHidden: string;
linkTitle: string;
loadingTitle: string;
locationRegion: string;
locationChunk: string;
contextMenuCopyLink: string;
contextMenuCenterHere: string;
2021-05-25 18:26:14 +00:00
toggleTitle: string;
2021-05-26 20:13:54 +00:00
mapTitle: string;
2021-05-28 20:28:21 +00:00
layersTitle: string;
copyToClipboardSuccess: string;
copyToClipboardError: string;
2021-05-25 18:26:14 +00:00
}
// Messages defined by dynmap configuration responses and can vary per server
interface LiveAtlasServerMessageConfig {
chatPlayerJoin: string;
chatPlayerQuit: string;
chatAnonymousJoin: string;
chatAnonymousQuit: string;
chatErrorNotAllowed: string;
chatErrorRequiresLogin: string;
chatErrorCooldown: string;
worldsHeading: string;
playersHeading: string;
}
type LiveAtlasMessageConfig = LiveAtlasGlobalMessageConfig & LiveAtlasServerMessageConfig;
interface LiveAtlasUIConfig {
playersAboveMarkers: boolean;
2021-07-21 15:19:18 +00:00
playersSearch: boolean;
}
export type LiveAtlasUIElement = 'layers' | 'chat' | 'players' | 'maps' | 'settings';
export type LiveAtlasSidebarSection = 'servers' | 'players' | 'maps';
2021-07-21 16:27:24 +00:00
export type LiveAtlasDimension = 'overworld' | 'nether' | 'end';
interface LiveAtlasSortedPlayers extends Array<DynmapPlayer> {
dirty?: boolean;
}
2021-07-19 15:40:30 +00:00
interface LiveAtlasWorld {
seaLevel: number;
name: string;
2021-07-21 16:27:24 +00:00
dimension: LiveAtlasDimension;
2021-07-19 15:40:30 +00:00
protected: boolean;
title: string;
height: number;
center: Coordinate;
maps: Map<string, LiveAtlasWorldMap>;
}
interface LiveAtlasWorldState {
raining: boolean;
thundering: boolean;
timeOfDay: number;
}
interface LiveAtlasWorldMap {
world: LiveAtlasWorld;
name: string;
icon: string;
title: string;
background: string;
nightAndDay: boolean;
backgroundDay?: string;
backgroundNight?: string;
imageFormat: string;
prefix: string;
protected: boolean;
mapToWorld: [number, number, number, number, number, number, number, number, number];
worldToMap: [number, number, number, number, number, number, number, number, number];
nativeZoomLevels: number;
extraZoomLevels: number;
}
interface LiveAtlasParsedUrl {
world?: string;
map?: string;
location?: Coordinate;
zoom?: number;
legacy: boolean;
}