tobspr_shapez.io/src/js/game/game_mode.js

/* typehints:start */
import { GameRoot } from "./root";
/* typehints:end */

import { Rectangle } from "../core/rectangle";
import { gGameModeRegistry } from "../core/global_registries";
import { types, BasicSerializableObject } from "../savegame/serialization";
import { MetaBuilding } from "./meta_building";
import { MetaItemProducerBuilding } from "./buildings/item_producer";
import { BaseHUDPart } from "./hud/base_hud_part";

/** @enum {string} */
export const enumGameModeIds = {
    puzzleEdit: "puzzleEditMode",
    puzzlePlay: "puzzlePlayMode",
    regular: "regularMode",
};

/** @enum {string} */
export const enumGameModeTypes = {
    default: "defaultModeType",
    puzzle: "puzzleModeType",
};

export class GameMode extends BasicSerializableObject {
    /** @returns {string} */
    static getId() {
        abstract;
        return "unknownMode";
    }

    /** @returns {string} */
    static getType() {
        abstract;
        return "unknownType";
    }
    /**
     * @param {GameRoot} root
     * @param {string} [id=Regular]
     * @param {object|undefined} payload
     */
    static create(root, id = enumGameModeIds.regular, payload = undefined) {
        return new (gGameModeRegistry.findById(id))(root, payload);
    }

    /**
     * @param {GameRoot} root
     */
    constructor(root) {
        super();
        this.root = root;

        /**
         * @type {Record<string, typeof BaseHUDPart>}
         */
        this.additionalHudParts = {};

        /** @type {typeof MetaBuilding[]} */
        this.hiddenBuildings = [MetaItemProducerBuilding];
    }

    /** @returns {object} */
    serialize() {
        return {
            $: this.getId(),
            data: super.serialize(),
        };
    }

    /** @param {object} savedata */
    deserialize({ data }) {
        super.deserialize(data, this.root);
    }

    /** @returns {string} */
    getId() {
        // @ts-ignore
        return this.constructor.getId();
    }

    /** @returns {string} */
    getType() {
        // @ts-ignore
        return this.constructor.getType();
    }

    /**
     * @param {typeof MetaBuilding} building - Class name of building
     * @returns {boolean}
     */
    isBuildingExcluded(building) {
        return this.hiddenBuildings.indexOf(building) >= 0;
    }

    /** @returns {undefined|Rectangle[]} */
    getBuildableZones() {
        return;
    }

    /** @returns {Rectangle|undefined} */
    getCameraBounds() {
        return;
    }

    /** @returns {boolean} */
    hasHub() {
        return true;
    }

    /** @returns {boolean} */
    hasResources() {
        return true;
    }

    /** @returns {boolean} */
    hasAchievements() {
        return false;
    }

    /** @returns {number} */
    getMinimumZoom() {
        return 0.1;
    }

    /** @returns {number} */
    getMaximumZoom() {
        return 3.5;
    }

    /** @returns {Object<string, Array>} */
    getUpgrades() {
        return {
            belt: [],
            miner: [],
            processors: [],
            painting: [],
        };
    }

    throughputDoesNotMatter() {
        return false;
    }

    /**
     * @param {number} w
     * @param {number} h
     */
    adjustZone(w = 0, h = 0) {
        abstract;
        return;
    }

    /** @returns {array} */
    getLevelDefinitions() {
        return [];
    }

    /** @returns {boolean} */
    getIsFreeplayAvailable() {
        return false;
    }

    /** @returns {boolean} */
    getIsSaveable() {
        return true;
    }

    /** @returns {boolean} */
    getHasFreeCopyPaste() {
        return false;
    }

    /** @returns {boolean} */
    getSupportsWires() {
        return true;
    }

    /** @returns {boolean} */
    getIsEditor() {
        return false;
    }

    /** @returns {boolean} */
    getIsDeterministic() {
        return false;
    }

    /** @returns {number | undefined} */
    getFixedTickrate() {
        return;
    }

    /** @returns {string} */
    getBlueprintShapeKey() {
        return "CbCbCbRb:CwCwCwCw";
    }
}