phaser/src/const.js

139 lines
2.8 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@phaser.io>
* @copyright 2013-2024 Phaser Studio Inc.
2019-05-10 15:15:04 +00:00
* @license {@link https://opensource.org/licenses/MIT|MIT License}
2018-02-12 16:01:20 +00:00
*/
2018-03-30 13:38:58 +00:00
/**
2019-05-09 10:41:35 +00:00
* Global constants.
2020-07-13 10:25:27 +00:00
*
2018-03-30 13:38:58 +00:00
* @ignore
*/
2016-11-22 03:11:33 +00:00
var CONST = {
2018-02-09 13:46:04 +00:00
/**
* Phaser Release Version
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.VERSION
* @const
2018-02-09 13:46:04 +00:00
* @type {string}
* @since 3.0.0
*/
2024-06-25 17:50:55 +00:00
VERSION: '3.85.0 Beta 2',
2016-11-22 03:11:33 +00:00
BlendModes: require('./renderer/BlendModes'),
ScaleModes: require('./renderer/ScaleModes'),
2018-02-09 13:46:04 +00:00
/**
2020-09-22 16:00:02 +00:00
* This setting will auto-detect if the browser is capable of suppporting WebGL.
* If it is, it will use the WebGL Renderer. If not, it will fall back to the Canvas Renderer.
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.AUTO
* @const
2020-11-23 10:22:13 +00:00
* @type {number}
2018-02-09 13:46:04 +00:00
* @since 3.0.0
*/
2016-11-22 03:11:33 +00:00
AUTO: 0,
2018-02-09 13:46:04 +00:00
/**
2020-09-22 16:00:02 +00:00
* Forces Phaser to only use the Canvas Renderer, regardless if the browser supports
* WebGL or not.
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.CANVAS
* @const
2020-11-23 10:22:13 +00:00
* @type {number}
2018-02-09 13:46:04 +00:00
* @since 3.0.0
*/
2016-11-22 03:11:33 +00:00
CANVAS: 1,
2018-02-09 13:46:04 +00:00
/**
2020-09-22 16:00:02 +00:00
* Forces Phaser to use the WebGL Renderer. If the browser does not support it, there is
* no fallback to Canvas with this setting, so you should trap it and display a suitable
* message to the user.
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.WEBGL
* @const
2020-11-23 10:22:13 +00:00
* @type {number}
2018-02-09 13:46:04 +00:00
* @since 3.0.0
*/
2017-03-21 20:25:15 +00:00
WEBGL: 2,
2018-02-09 13:46:04 +00:00
/**
2020-09-22 16:00:02 +00:00
* A Headless Renderer doesn't create either a Canvas or WebGL Renderer. However, it still
* absolutely relies on the DOM being present and available. This mode is meant for unit testing,
* not for running Phaser on the server, which is something you really shouldn't do.
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.HEADLESS
* @const
2020-11-23 10:22:13 +00:00
* @type {number}
2018-02-09 13:46:04 +00:00
* @since 3.0.0
*/
HEADLESS: 3,
2018-02-09 13:46:04 +00:00
/**
* 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.
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.FOREVER
* @const
2020-11-23 10:22:13 +00:00
* @type {number}
2018-02-09 13:46:04 +00:00
* @since 3.0.0
*/
FOREVER: -1,
2018-02-09 13:46:04 +00:00
/**
* Direction constant.
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.NONE
* @const
2020-11-23 10:22:13 +00:00
* @type {number}
2018-02-09 13:46:04 +00:00
* @since 3.0.0
*/
NONE: 4,
2018-02-09 13:46:04 +00:00
/**
* Direction constant.
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.UP
* @const
2020-11-23 10:22:13 +00:00
* @type {number}
2018-02-09 13:46:04 +00:00
* @since 3.0.0
*/
UP: 5,
2018-02-09 13:46:04 +00:00
/**
* Direction constant.
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.DOWN
* @const
2020-11-23 10:22:13 +00:00
* @type {number}
2018-02-09 13:46:04 +00:00
* @since 3.0.0
*/
DOWN: 6,
2018-02-09 13:46:04 +00:00
/**
* Direction constant.
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.LEFT
* @const
2020-11-23 10:22:13 +00:00
* @type {number}
2018-02-09 13:46:04 +00:00
* @since 3.0.0
*/
LEFT: 7,
2018-02-09 13:46:04 +00:00
/**
* Direction constant.
2020-07-13 10:25:27 +00:00
*
2018-02-09 13:46:04 +00:00
* @name Phaser.RIGHT
* @const
2020-11-23 10:22:13 +00:00
* @type {number}
2018-02-09 13:46:04 +00:00
* @since 3.0.0
*/
RIGHT: 8
2016-11-22 03:11:33 +00:00
};
module.exports = CONST;