@theatrejs/theatrejs/sources/core/timeline-keyframe.js

🎮 A JavaScript 2D Game Engine focused on creating pixel art games.

import {Timeline} from '../index.js';

void Timeline;

/**
 * Creates timeline keyframes.
 *
 * @example
 *
 * // minimal
 * const keyframe = new TimelineKeyframe({$onEnter, $timecode});
 *
 * @example
 *
 * // full
 * const keyframe = new TimelineKeyframe({$name, $onEnter, $timecode});
 */
class TimelineKeyframe {

    /**
     * @callback TypeHandlerEnter A handler to execute when entering a keyframe.
     * @param {Timeline} $timeline The reference timeline.
     * @returns {void}
     * @protected
     *
     * @memberof TimelineKeyframe
     */

    /**
     * Stores the name.
     * @type {string}
     * @private
     */
    $name;

    /**
     * Stores the keyframe entering handler.
     * @type {TypeHandlerEnter}
     * @private
     */
    $onEnter;

    /**
     * Stores the timecode.
     * @type {number}
     * @private
     */
    $timecode;

    /**
     * Gets the name.
     * @type {string}
     * @public
     */
    get name() {

        return this.$name;
    }

    /**
     * Gets the keyframe entering handler.
     * @type {TypeHandlerEnter}
     * @public
     */
    get onEnter() {

        return this.$onEnter;
    }

    /**
     * Gets the timecode.
     * @type {number}
     * @public
     */
    get timecode() {

        return this.$timecode;
    }

    /**
     * Creates a new timeline keyframe.
     * @param {object} $parameters The given parameters.
     * @param {string} [$parameters.$name] The name.
     * @param {TypeHandlerEnter} $parameters.$onEnter The keyframe entering handler.
     * @param {number} $parameters.$timecode The timecode.
     */
    constructor({$name, $onEnter, $timecode}) {

        this.$name = $name;
        this.$onEnter = $onEnter;
        this.$timecode = $timecode;
    }

    /**
     * Clones the timeline keyframe.
     * @returns {TimelineKeyframe}
     * @public
     */
    clone() {

        return new TimelineKeyframe({

            $name: this.$name,
            $onEnter: this.$onEnter,
            $timecode: this.$timecode
        });
    }

    /**
     * Adds a timecode offset.
     * @param {number} $timecode The timecode offset to add.
     * @returns {this}
     * @public
     */
    offset($timecode) {

        this.$timecode += $timecode;

        return this;
    }
}

export {

    TimelineKeyframe
};

export default TimelineKeyframe;