This repository has been archived on 2021-02-20. You can view files and clone it, but cannot push or open issues or pull requests.
shapez.io/src/js/game/component.js

51 lines
1.2 KiB
JavaScript
Raw Normal View History

2020-05-09 16:45:23 +02:00
import { BasicSerializableObject } from "../savegame/serialization";
export class Component extends BasicSerializableObject {
/**
* Returns the components unique id
* @returns {string}
*/
static getId() {
abstract;
return "unknown-component";
}
/**
* Should return the schema used for serialization
*/
static getSchema() {
return {};
}
2020-05-27 14:30:59 +02:00
/**
2020-09-19 21:41:48 +02:00
* Copy the current state to another component
* @param {Component} otherComponent
2020-05-27 14:30:59 +02:00
*/
2020-09-19 21:41:48 +02:00
copyAdditionalStateTo(otherComponent) {}
2020-05-27 14:30:59 +02:00
2020-05-09 16:45:23 +02:00
/* dev:start */
/**
* Fixes typeof DerivedComponent is not assignable to typeof Component, compiled out
* in non-dev builds
*/
constructor(...args) {
super();
}
/**
* Returns a string representing the components data, only in dev builds
* @returns {string}
*/
getDebugString() {
return null;
}
/* dev:end */
}
2020-08-06 11:28:28 +02:00
/**
* TypeScript does not support Abstract Static methods (https://github.com/microsoft/TypeScript/issues/34516)
* One workaround is to declare the type of the component and reference that for static methods
* @typedef {typeof Component} StaticComponent
*/