API Docs for: 0.1.1
Show:

Engine Class

Module: Joy

Engine context. Start your application from here.

Constructor

Engine

()

Methods

createScene

(
  • setupMethod
)
Engine

Create a new scene

Parameters:

  • setupMethod Function

Returns:

Engine:

Example:

// Creating a scene with setup
engine.createScene(function(scene) {
   scene.addChild(...);
});

gotoNextScene

(
  • fadeMilliseconds
  • color
)
Engine

Parameters:

  • fadeMilliseconds Number

    (default=1000)

  • color String | Color

    (default=#000)

Returns:

Engine: this

gotoScene

(
  • scene
  • fadeMilliseconds
  • color
)
Engine

Parameters:

  • scene Scene
  • fadeMilliseconds Number

    (default=1000)

  • color String | Color

    (default=#000)

Returns:

Engine: this

onEnterFrame

()

Call window's requestAnimationFrame.

onEnterFrameDebug

()

Inspect application frame rate. Call window's requestAnimationFrame

pause

(
  • options
)

Pause engine

Parameters:

  • options Object

resume

()

Resume if engine is paused.

setSceneLoader

(
  • setupMethod
  • fadeMilliseconds
  • fadeColor
)
Scene

Create a new scene loader. The first scene loader created will be the default to appear whenever a loader is requested.

Parameters:

  • setupMethod Function | Scene

    or target loader scene

  • fadeMilliseconds Number
  • fadeColor String | Color

Returns:

Scene: sceneLoader

Example:

//
// Setup custom scene loader
//
engine.setSceneLoader(function(scene) {
   scene.addChild(...).bind(Joy.Events.UPDATE, function () {
     console.log(scene.loader.percentage);
   });
});

//
// Set based on created scene
//
// => Set your first scene loader
var firstLoader = engine.setSceneLoader(function(scene) {
   scene.addChild(...).bind(Joy.Events.UPDATE, function () {
     console.log(scene.loader.percentage);
   });
});

// => Change the loader
var secondLoader = engine.setSceneLoader(function(scene) {
   scene.addChild(...);
});
// => Change it again, using the first one
engine.setSceneLoader(firstLoader);

Properties

sceneLoader

Scene

Scene that will show when your current scene is loading.

Attributes

currentScene

Scene

paused

Boolean

Is engine paused?