starblast-modding/src/structures/UI/BasicShape.js

A powerful library for interacting with the Starblast Modding API

'use strict';

const UIBaseElement = require("./Element.js");
const toString = require("../../utils/toString.js");
const parseColor = require("../../utils/parseColor.js");
const limitedJSON = require("../../utils/limitedJSON.js");

/**
 * The UI BasicShape Element instance
 * @extends {UIBaseElement}
 * @param {string|number} [data.fill = "hsla(0,0%,0%,0)"] - Background fill color of this element, in CSS value or color hex value (ARGB or RGB format)
 * @param {string|number} [data.stroke = "hsla(0,0%,0%,0)"] - Border color of this element, in CSS value or color hex value (ARGB or RGB format)
 * @param {number} [data.width = 0] Border width of this text element
 * @since 1.4.6-alpha6
 */

class UIBasicShapeElement extends UIBaseElement {
	constructor (data, strictMode = false) {
		super(data, strictMode);

		this.raw.width = null;
		
		this.setFill(data?.fill, strictMode).setWidth(data?.width, strictMode).setStroke(data?.stroke, strictMode);
	}

	set (data, strictMode = false) {
		super.set(data, strictMode);

		data = data || {};

		if ("fill" in data) this.setFill(data.fill, strictMode);

		if ("width" in data) this.setWidth(data.width, strictMode);

		if ("stroke" in data) this.setStroke(data.stroke, strictMode);

		return this;
	}

	/**
	 * Sets border width of this UI BasicShape Element
	 * @param {number | null} width - Width value to set, non-negative in (1 / ({@link https://en.wikipedia.org/wiki/Pixel_density|End user screen's pixel density})) {@link https://developer.mozilla.org/en-US/docs/Glossary/CSS_pixel|pixels (px)} or `null` if to inherit from previous box or round element
	 * @param {boolean} [strictMode = false] Whether strict mode will be enabled (invalid value will be silently replaced with default value) or throw an error instead
	 * @returns {UIBasicShapeElement} The UI BasicShape Element in question
	 */

	setWidth (width, strictMode = false) {
		if (width != null) {
			if ("number" !== typeof width) {
				if (strictMode) throw new Error(`Expects ${this.constructor.name}.width to be a number. Got ${toString(width)} instead.`);
				width = 0;
			}
			else if (isNaN(width) || width < 0) {
				if (strictMode) throw new Error(`Expects ${this.constructor.name}.width to be non-negative. Got ${toString(width)} instead.`);
				width = 0;
			}
		}
		else width = null;

		this.raw.width = width;
		return this;
	}

	/**
	 * Sets background fill color of this UI BasicShape Element
	 * @param {string | number} fill - Color value to set, either an CSS color string or a hex color value (ARGB or RGB format)
	 * @param {boolean} [strictMode = false] Whether strict mode will be enabled (invalid value will be silently replaced with default value) or throw an error instead
	 * @returns {UIBasicShapeElement} The UI BasicShape Element in question
	 */

	setFill (fill, strictMode = false) {
		this.raw.fill = parseColor(fill, strictMode, "hsla(0,0%,0%,0)", `${this.constructor.name}.fill`);
		return this;
	}

	/**
	 * Sets border color of this UI BasicShape Element
	 * @param {string | number} stroke - Color value to set, either an CSS color string or a hex color value (ARGB or RGB format)
	 * @param {boolean} [strictMode = false] Whether strict mode will be enabled (invalid value will be silently replaced with default value) or throw an error instead
	 * @returns {UIBasicShapeElement} The UI BasicShape Element in question
	 */

	setStroke (stroke, strictMode = false) {
		this.raw.stroke = parseColor(stroke, strictMode, "hsla(0,0%,0%,0)", `${this.constructor.name}.stroke`);
		return this;
	}

	/**
	 * Border width of this BasicShape element, a number in (1 / ({@link https://en.wikipedia.org/wiki/Pixel_density|End user screen's pixel density})) {@link https://developer.mozilla.org/en-US/docs/Glossary/CSS_pixel|pixels (px)} or `null` if inherit from previous box or round element
	 * @type {number | null}
	 * @readonly
	 */

	get width () {
		return this.raw.width;
	}

	/**
	 * CSS background color value of this BasicShape element
	 * @type {string}
	 * @readonly
	 */

	get fill () {
		return this.raw.fill;
	}

	/**
	 * CSS border color value of this BasicShape element
	 * @type {string}
	 * @readonly
	 */

	get stroke () {
		return this.raw.stroke;
	}

	toJSON () {
		let raw = {
			...super.toJSON(),
			...limitedJSON(this, ["fill", "width", "stroke"])
		}

		if (raw.width == null) delete raw.width;

		return raw;
	}
}

module.exports = UIBasicShapeElement;