API Docs for: 0.5.5
Show:

kick.core.Engine Class

Defined in: kick/core/Engine.js:13
Module: kick.core

Game engine object

Constructor

kick.core.Engine

(
  • idOrElement
  • config={}
)

Defined in kick/core/Engine.js:13

Parameters:

  • idOrElement String | Canvas

    elementid of canvas tag or the canvas element

  • config={} kick.core.Config

    Configuration object

Example:

 <canvas id="3dCanvas" width="50" height="50"></canvas>
 <script src="require.js"></script>
 <script type="text/javascript">
     var req = require.config({
             paths: {
                 kick: 'kick-debug' // loads kick-debug.js (must be in same path)
             }
         });
     req(['kick'],
             function (kick) {
                 // init engine (create 3d context)
                 var engine = new kick.core.Engine('3dCanvas');
             }
     );
 </script>

Methods

_gameLoop

(
  • time
)
private

Defined in kick/core/Engine.js:326

Parameters:

  • time Number

    current time in milliseconds

addContextListener

(
  • contextLostListener
)
deprecated

Defined in kick/core/Engine.js:374

Parameters:

  • contextLostListener Object

    implements contextLost() and contextRestored(gl)

addFrameListener

(
  • frameListener
)
deprecated

Defined in kick/core/Engine.js:352

Deprecated: Use addEventListener("postUpdateListener", frameListener) instead

Add a framelistener. Frame listeners are invoked last thing in update loop.
Frame listener object must define the method frameUpdated()

Parameters:

  • frameListener Object

canvasResized

() deprecated

Defined in kick/core/Engine.js:419

This method should be invoked when the canvas is resized.
This will change the viewport size of the WebGL state.
Instead of calling this method explicit, the configuration parameter checkCanvasResizeInterval can also be set to support automatically checks

createUID

() Number

Defined in kick/core/Engine.js:397

Creates a uniq id

Returns:

Number:

uniq id

getGLExtension

(
  • extensionName
)

Defined in kick/core/Engine.js:267

Query WebGL for a specific extension. If found, the extension object is returned. "WEBKIT_", "MOZ_" vendor prefixes are used.

Parameters:

  • extensionName String

Returns:

Object|null

getUID

(
  • object
)
String

Defined in kick/core/Engine.js:406

Get the uid of a component (or creates the uid if not defined)

Parameters:

  • object Object

Returns:

String:

init

() private

Defined in kick/core/Engine.js:435

isFullScreenSupported

()

Defined in kick/core/Engine.js:259

Returns:

Boolean

removeContextListener

(
  • contextLostListener
)
deprecated

Defined in kick/core/Engine.js:385

Parameters:

  • contextLostListener Object

removeFrameListener

(
  • frameListener
)
deprecated

Defined in kick/core/Engine.js:364

Parameters:

  • frameListener Object

setFullscreen

(
  • fullscreen
)

Defined in kick/core/Engine.js:287

Note that fullscreen needs to be invoked directly from a keyboard event or a mouse event from outside the gameLoop. This means it is currently not possible to set fullscreen from a Component's update method.

Parameters:

  • fullscreen Boolean

Properties

activeScene

kick.scene.Scene

Defined in kick/core/Engine.js:151

If null then nothing is rendered

canvas

HTML-Element final

Defined in kick/core/Engine.js:142

The canvas element (readonly)

canvasDimension

kick.math.Vec2

Defined in kick/core/Engine.js:209

The width and height of the canvas

config

kick.core.Config

Defined in kick/core/Engine.js:227

Configuration of the engine

eventQueue

kick.core.EventQueue final

Defined in kick/core/Engine.js:199

gl

WebGLRenderingContext final

Defined in kick/core/Engine.js:133

The WebGL context (readonly)

glState

kick.core.GLState protected final

Defined in kick/core/Engine.js:123

The WebGL state(readonly). (Only used to keep track on webgl state across different objects)

instance

kick.core.Engine static

Defined in kick/core/Engine.js:551

Returns the singleton engine object

keyInput

kick.core.KeyInput

Defined in kick/core/Engine.js:185

Returns a keyInput object. This object is used to detect key input.

mouseInput

kick.core.MouseInput

Defined in kick/core/Engine.js:171

Returns a mouseInput object. This object is used to detect mouse input.

paused

Boolean

Defined in kick/core/Engine.js:235

Controls is the gameloop is running

project

kick.core.Project final

Defined in kick/core/Engine.js:114

Project describes the resources available for a given projects (such as Scenes, Materials, Shader and Meshes)

resourceLoader

kick.core.ResourceLoader final

Defined in kick/core/Engine.js:105

Resource manager of the engine. Loads and cache resources.

time

kick.core.Time

Defined in kick/core/Engine.js:219

Time object of the engine. Is updated every frame

version

String final

Defined in kick/core/Engine.js:96

The current version of KickJS

Events

canvasResized

Defined in kick/core/Engine.js:86

Fired when canvas is resized.

Event Payload:

contextLost

Defined in kick/core/Engine.js:65

Fired when gl-context is lost

contextRestored

Defined in kick/core/Engine.js:70

Fired when gl-context is restored (after context has been lost).

Event Payload:

  • glContext WebGLRenderingContext

postUpdateListener

Defined in kick/core/Engine.js:81

Fired after script updates methods has been run invoked

preUpdateListener

Defined in kick/core/Engine.js:76

Fired before script updates methods has been run invoked