/* typehints:start */ import { ModLoader } from "./modloader"; import { GameSystem } from "../game/game_system"; import { Component } from "../game/component"; import { MetaBuilding } from "../game/meta_building"; /* typehints:end */ import { defaultBuildingVariant } from "../game/meta_building"; import { AtlasSprite, SpriteAtlasLink } from "../core/sprites"; import { enumShortcodeToSubShape, enumSubShape, enumSubShapeToShortcode, MODS_ADDITIONAL_SUB_SHAPE_DRAWERS, } from "../game/shape_definition"; import { Loader } from "../core/loader"; import { LANGUAGES } from "../languages"; import { matchDataRecursive, T } from "../translations"; import { gBuildingVariants, registerBuildingVariant } from "../game/building_codes"; import { gComponentRegistry, gMetaBuildingRegistry } from "../core/global_registries"; import { MODS_ADDITIONAL_SHAPE_MAP_WEIGHTS } from "../game/map_chunk"; import { MODS_ADDITIONAL_SYSTEMS } from "../game/game_system_manager"; import { MOD_CHUNK_DRAW_HOOKS } from "../game/map_chunk_view"; import { KEYMAPPINGS } from "../game/key_action_mapper"; import { HUDModalDialogs } from "../game/hud/parts/modal_dialogs"; export class ModInterface { /** * * @param {ModLoader} modLoader */ constructor(modLoader) { this.modLoader = modLoader; } registerCss(cssString) { const element = document.createElement("style"); element.textContent = cssString; document.head.appendChild(element); } registerSprite(spriteId, base64string) { assert(base64string.startsWith("data:image")); const img = new Image(); const sprite = new AtlasSprite(spriteId); sprite.frozen = true; img.addEventListener("load", () => { for (const resolution in sprite.linksByResolution) { const link = sprite.linksByResolution[resolution]; link.w = img.width; link.h = img.height; link.packedW = img.width; link.packedH = img.height; } }); img.src = base64string; const link = new SpriteAtlasLink({ w: 1, h: 1, atlas: img, packOffsetX: 0, packOffsetY: 0, packedW: 1, packedH: 1, packedX: 0, packedY: 0, }); sprite.linksByResolution["0.25"] = link; sprite.linksByResolution["0.5"] = link; sprite.linksByResolution["0.75"] = link; Loader.sprites.set(spriteId, sprite); } /** * * @param {string} imageBase64 * @param {string} jsonTextData */ registerAtlas(imageBase64, jsonTextData) { const atlasData = JSON.parse(jsonTextData); const img = new Image(); img.src = imageBase64; const sourceData = atlasData.frames; for (const spriteName in sourceData) { const { frame, sourceSize, spriteSourceSize } = sourceData[spriteName]; const sprite = new AtlasSprite(spriteName); Loader.sprites.set(spriteName, sprite); sprite.frozen = true; const link = new SpriteAtlasLink({ packedX: frame.x, packedY: frame.y, packedW: frame.w, packedH: frame.h, packOffsetX: spriteSourceSize.x, packOffsetY: spriteSourceSize.y, atlas: img, w: sourceSize.w, h: sourceSize.h, }); sprite.linksByResolution["0.25"] = link; sprite.linksByResolution["0.5"] = link; sprite.linksByResolution["0.75"] = link; } } /** * * @param {object} param0 * @param {string} param0.id * @param {string} param0.shortCode * @param {(distanceToOriginInChunks: number) => number} param0.weightComputation * @param {(options: import("../game/shape_definition").SubShapeDrawOptions) => void} param0.draw */ registerSubShapeType({ id, shortCode, weightComputation, draw }) { if (shortCode.length !== 1) { throw new Error("Bad short code: " + shortCode); } enumSubShape[id] = id; enumSubShapeToShortcode[id] = shortCode; enumShortcodeToSubShape[shortCode] = id; MODS_ADDITIONAL_SHAPE_MAP_WEIGHTS[id] = weightComputation; MODS_ADDITIONAL_SUB_SHAPE_DRAWERS[id] = draw; } registerTranslations(language, translations) { const data = LANGUAGES[language]; if (!data) { throw new Error("Unknown language: " + language); } matchDataRecursive(data.data, translations, true); if (language === "en") { matchDataRecursive(T, translations, true); } } /** * * @param {typeof Component} component */ registerComponent(component) { gComponentRegistry.register(component); } /** * * @param {Object} param0 * @param {string} param0.id * @param {new (any) => GameSystem} param0.systemClass * @param {string=} param0.before * @param {string[]=} param0.drawHooks */ registerGameSystem({ id, systemClass, before, drawHooks }) { const key = before || "key"; const payload = { id, systemClass }; if (MODS_ADDITIONAL_SYSTEMS[key]) { MODS_ADDITIONAL_SYSTEMS[key].push(payload); } else { MODS_ADDITIONAL_SYSTEMS[key] = [payload]; } if (drawHooks) { drawHooks.forEach(hookId => this.registerGameSystemDrawHook(hookId, id)); } } /** * * @param {string} hookId * @param {string} systemId */ registerGameSystemDrawHook(hookId, systemId) { if (!MOD_CHUNK_DRAW_HOOKS[hookId]) { throw new Error("bad game system draw hook: " + hookId); } MOD_CHUNK_DRAW_HOOKS[hookId].push(systemId); } /** * * @param {object} param0 * @param {typeof MetaBuilding} param0.metaClass * @param {string=} param0.buildingIconBase64 * @param {({ * variant?: string; * rotationVariant?: number; * name: string; * description: string; * blueprintImageBase64?: string; * regularImageBase64?: string; * tutorialImageBase64?: string; * }[])} param0.variantsAndRotations */ registerNewBuilding({ metaClass, variantsAndRotations, buildingIconBase64 }) { const id = new /** @type {new () => MetaBuilding} */ (metaClass)().getId(); if (gMetaBuildingRegistry.hasId(id)) { throw new Error("Tried to register building twice: " + id); } gMetaBuildingRegistry.register(metaClass); const metaInstance = gMetaBuildingRegistry.findByClass(metaClass); T.buildings[id] = {}; variantsAndRotations.forEach(payload => { const actualVariant = payload.variant || defaultBuildingVariant; registerBuildingVariant(id, metaClass, actualVariant, payload.rotationVariant || 0); gBuildingVariants[id].metaInstance = metaInstance; T.buildings[id][actualVariant] = { name: payload.name, description: payload.description, }; const buildingIdentifier = id + (actualVariant === defaultBuildingVariant ? "" : "-" + actualVariant); if (payload.regularImageBase64) { this.registerSprite( "sprites/buildings/" + buildingIdentifier + ".png", payload.regularImageBase64 ); } if (payload.blueprintImageBase64) { this.registerSprite( "sprites/blueprints/" + buildingIdentifier + ".png", payload.blueprintImageBase64 ); } if (payload.tutorialImageBase64) { this.setBuildingTutorialImage(id, actualVariant, payload.tutorialImageBase64); } }); if (buildingIconBase64) { this.setBuildingToolbarIcon(id, buildingIconBase64); } } /** * * @param {Object} param0 * @param {string} param0.id * @param {number} param0.keyCode * @param {string} param0.translation * @param {boolean=} param0.repeated * @param {((GameRoot) => void)=} param0.handler * @param {{shift?: boolean; alt?: boolean; ctrl?: boolean}=} param0.modifiers * @param {boolean=} param0.builtin */ registerIngameKeybinding({ id, keyCode, translation, modifiers = {}, repeated = false, builtin = false, handler = null, }) { if (!KEYMAPPINGS.mods) { KEYMAPPINGS.mods = {}; } const binding = (KEYMAPPINGS.mods[id] = { keyCode, id, repeated, modifiers, builtin, }); this.registerTranslations("en", { keybindings: { mappings: { [id]: translation, }, }, }); if (handler) { this.modLoader.signals.gameStarted.add(root => { root.keyMapper.getBindingById(id).addToTop(handler.bind(null, root)); }); } return binding; } /** * @returns {HUDModalDialogs} */ get dialogs() { const state = this.modLoader.app.stateMgr.currentState; // @ts-ignore if (state.dialogs) { // @ts-ignore return state.dialogs; } throw new Error("Tried to access dialogs but current state doesn't support it"); } setBuildingToolbarIcon(buildingId, iconBase64) { this.registerCss(` [data-icon="building_icons/${buildingId}.png"] .icon { background-image: url('${iconBase64}') !important; } `); } setBuildingTutorialImage(buildingId, variant, imageBase64) { const buildingIdentifier = buildingId + (variant === defaultBuildingVariant ? "" : "-" + variant); this.registerCss(` [data-icon="building_tutorials/${buildingIdentifier}.png"] { background-image: url('${imageBase64}') !important; } `); } }