HTML5 shell class reference

Projects exported for the Web expose the Engine() class to the JavaScript environment, that allows fine control over the engine's start-up process.

This API is built in an asynchronous manner and requires basic understanding of Promises.

Engine

The Engine class provides methods for loading and starting exported projects on the Web. For default export settings, this is already part of the exported HTML page. To understand practical use of the Engine class, see Custom HTML page for Web export.

Static Methods

Promise

load ( string basePath )

void

unload ( )

boolean

isWebGLAvailable ( [ number majorVersion=1 ] )

Instance Methods

Promise

init ( [ string basePath ] )

Promise

preloadFile ( string|ArrayBuffer file [, string path ] )

Promise

start ( EngineConfig override )

Promise

startGame ( EngineConfig override )

void

copyToFS ( string path, ArrayBuffer buffer )

void

requestQuit ( )

class Engine(initConfig)

Create a new Engine instance with the given configuration.

Arguments
  • initConfig (EngineConfig()) -- The initial config for this instance.

Static Methods

Engine.load(basePath)

Load the engine from the specified base path.

Arguments
  • basePath (string()) -- Base path of the engine to load.

Returns

A Promise that resolves once the engine is loaded.

Return type

Promise

Engine.unload()

Unload the engine to free memory.

This method will be called automatically depending on the configuration. See unloadAfterInit.

Engine.isWebGLAvailable([majorVersion=1])

Check whether WebGL is available. Optionally, specify a particular version of WebGL to check for.

Arguments
  • majorVersion (number()) -- The major WebGL version to check for.

Returns

If the given major version of WebGL is available.

Return type

boolean

Instance Methods

Engine.prototype.init([basePath])

Initialize the engine instance. Optionally, pass the base path to the engine to load it, if it hasn't been loaded yet. See Engine.load().

Arguments
  • basePath (string()) -- Base path of the engine to load.

Returns

A Promise that resolves once the engine is loaded and initialized.

Return type

Promise

Engine.prototype.preloadFile(file[, path])

Load a file so it is available in the instance's file system once it runs. Must be called before starting the instance.

If not provided, the path is derived from the URL of the loaded file.

Arguments
  • file (string|ArrayBuffer()) --

    The file to preload.

    If a string the file will be loaded from that path.

    If an ArrayBuffer or a view on one, the buffer will used as the content of the file.

  • path (string()) -- Path by which the file will be accessible. Required, if file is not a string.

Returns

A Promise that resolves once the file is loaded.

Return type

Promise

Engine.prototype.start(override)

Start the engine instance using the given override configuration (if any). startGame can be used in typical cases instead.

This will initialize the instance if it is not initialized. For manual initialization, see init. The engine must be loaded beforehand.

Fails if a canvas cannot be found on the page, or not specified in the configuration.

Arguments
Returns

Promise that resolves once the engine started.

Return type

Promise

Engine.prototype.startGame<