phaser/src/const.js

/**
 * @author       Richard Davey <rich@photonstorm.com>
 * @copyright    2020 Photon Storm Ltd.
 * @license      {@link https://opensource.org/licenses/MIT|MIT License}
 */

/**
 * Global constants.
 *
 * @ignore
 */

var CONST = {

    /**
     * Phaser Release Version
     *
     * @name Phaser.VERSION
     * @const
     * @type {string}
     * @since 3.0.0
     */
    VERSION: '3.50.0-beta.7',

    BlendModes: require('./renderer/BlendModes'),

    ScaleModes: require('./renderer/ScaleModes'),

    /**
     * AUTO Detect Renderer.
     *
     * @name Phaser.AUTO
     * @const
     * @type {integer}
     * @since 3.0.0
     */
    AUTO: 0,

    /**
     * Canvas Renderer.
     *
     * @name Phaser.CANVAS
     * @const
     * @type {integer}
     * @since 3.0.0
     */
    CANVAS: 1,

    /**
     * WebGL Renderer.
     *
     * @name Phaser.WEBGL
     * @const
     * @type {integer}
     * @since 3.0.0
     */
    WEBGL: 2,

    /**
     * Headless Renderer.
     *
     * @name Phaser.HEADLESS
     * @const
     * @type {integer}
     * @since 3.0.0
     */
    HEADLESS: 3,

    /**
     * In Phaser the value -1 means 'forever' in lots of cases, this const allows you to use it instead
     * to help you remember what the value is doing in your code.
     *
     * @name Phaser.FOREVER
     * @const
     * @type {integer}
     * @since 3.0.0
     */
    FOREVER: -1,

    /**
     * Direction constant.
     *
     * @name Phaser.NONE
     * @const
     * @type {integer}
     * @since 3.0.0
     */
    NONE: 4,

    /**
     * Direction constant.
     *
     * @name Phaser.UP
     * @const
     * @type {integer}
     * @since 3.0.0
     */
    UP: 5,

    /**
     * Direction constant.
     *
     * @name Phaser.DOWN
     * @const
     * @type {integer}
     * @since 3.0.0
     */
    DOWN: 6,

    /**
     * Direction constant.
     *
     * @name Phaser.LEFT
     * @const
     * @type {integer}
     * @since 3.0.0
     */
    LEFT: 7,

    /**
     * Direction constant.
     *
     * @name Phaser.RIGHT
     * @const
     * @type {integer}
     * @since 3.0.0
     */
    RIGHT: 8,

    
    /**
     * Orientation constant.
     * 
     * @name Phaser.ORTHOGONAL
     * @const
     * @type {integer}
     * @since 3.2.2
     */
    ORTHOGONAL: 0,


    /**
     * Orientation constant.
     * 
     * @name Phaser.ISOMETRIC
     * @const
     * @type {integer}
     * @since 3.2.2
     */
    ISOMETRIC: 1,

    
    /**
     * Orientation constant.
     * 
     * @name Phaser.STAGGERED
     * @const
     * @type {integer}
     * @since 3.2.2
     */
    STAGGERED: 2,
    
    /**
     * Orientation constant.
     * 
     * @name Phaser.HEXAGONAL
     * @const
     * @type {integer}
     * @since 3.2.2
     */
    HEXAGONAL: 3,

    fromOrientationString: function (orientation)
    {
        var constor = CONST.ORTHOGONAL;

        if (orientation === 'isometric')
        {
            constor = CONST.ISOMETRIC;
        }
        else if (orientation === 'staggered')
        {
            constor = CONST.STAGGERED;
        }
        else if (orientation === 'hexagonal')
        {
            constor = CONST.HEXAGONAL;
        }
        return constor;
    }

};

module.exports = CONST;