@woosh/meep-engine/src/engine/ecs/speaker/lines/LineDescription.js

Pure JavaScript game engine. Fully featured and production ready.

import { assert } from "../../../../core/assert.js";

export class LineDescription {
    /**
     * Unique id
     * @type {string}
     */
    id = "";
    /**
     * Comment about the line, useful for development purposes
     * @type {string}
     */
    comment = "";
    /**
     * Localization key for the line of text
     * @type {string}
     */
    text = "";
    /**
     * Time the line should be displayed on the screen before being removed, normalized value, 1 means standard, 1.5 means 50% longer
     * @type {number}
     */
    displayDuration = 1;

    fromJSON({
                 id,
                 text,
                 comment = "",
                 displayDuration = 1
             }) {

        assert.isString(text, 'text');

        this.id = id;
        this.text = text;
        this.comment = comment;

        this.displayDuration = displayDuration;
    }
}