Core Module

Matt Karl edited this page Sep 28, 2015 · 3 revisions

The main framework module (or "core") is required for including before any other modules. The core provides shared methods and services which other modules can use.

Features

  • Loading of assets
  • Providing updates
  • Manages different displays (multiple canvases)
  • Managing page visibility to pause/resume application
  • Debugging
  • Saving session data
  • Managing browser cache
  • Event dispatching functionality
  • namespace and include functions

Dependencies

  • PreloadJS Required for external loading of assets. Works with a variety of file-types like JSON, images, JavaScript, Sounds.

Installing

In order to use the Core module, make sure to include the module's JavaScript file within your springroll.json project file under libraries and librariesDebug.

"libraries": [
	"components/preloadjs/lib/preloadjs.min.js",
	"components/springroll/dist/core.min.js"
],
"librariesDebug": [
	"components/preloadjs/lib/preloadjs.min.js",
	"components/springroll/dist/core.js"
]

Classes

Workflows