JSDoc: Class: Director

new lime.Director(parentElement, opt_width, opt_height)

Director object. Base object for every game.

Parameters:

Name	Type	Argument	Description
`parentElement`	Element		Parent element for director.
`opt_width`	number	<optional>	Optionaly define what height and width the director should have.
`opt_height`	number	<optional>	Optionaly define what height and width the director should have.

Source:

director.js, line 31

Extends

lime.Node

Summary

Members
<static, constant>	`DEFAULT_HEIGHT` :number Default height of the Director
<static, constant>	`DEFAULT_WIDTH` :number Default width of the Director
<static, constant>	`FPS_INTERVAL` :number Milliseconds between recalculating FPS value
<private>	`coverStack_` :Array.<lime.CoverNode> Array of CoverNode instances.
<private>	`sceneStack_` :Array.<lime.Scene> Array of Scene instances. Last one is the active scene.

Inherited

lime.Node.allow3DCSSTransform_, lime.Node.customEvent_, lime.Node.eventHandlers_, lime.Node.supportedRenderers, lime.Node.transitionsAdd_, lime.Node.transitionsClear_

Methods
	`addCover`(cover, opt_addAboveDirector) Add CoverNode object to the viewport
	`getBounds`(box) → {goog.math.Box} Return bounds of director,
	`getCurrentScene`() → {lime.Scene} Get current active scene
	`getDirector`()
	`getScene`()
	`hitTest`()
<private>	`invalidateSize_`() Update dimensions based on viewport dimension changes
	`isDisplayFPS`() → {boolean} Returns true if FPS counter is displayed
	`isPaused`() → {boolean} Returns true if director is paused? On paused state the update timer doesn't fire.
<private>	`keyUpHandler_`()
	`localToScreen`()
	`makeMobileWebAppCapable`() Add support for adding game to Springboard as a web application on iOS devices
	`popScene`(opt_transition, opt_duration) Remove current scene from the stack
	`pushScene`(scene, opt_transition, opt_duration) Push scene to the top of scene stack
	`removeCover`(cover) Remove CoverNode object from the viewport
	`replaceScene`(scene, opt_transition, opt_duration) Replace current scene with new scene
	`screenToLocal`()
	`setDisplayFPS`(value) → {lime.Director} Show or hide FPS counter
	`setPaused`(value) → {lime.Director} Pauses or resumes the director
<private>	`step_`(delta) Timeline function.
	`update`()
<private>	`updateDomOffset_`() Updates the cached value of directors parentelement position in the viewport
	`updateLayout`()

Inherited

lime.Node.addEventListener, lime.Node.addTransition, lime.Node.appendChild, lime.Node.calcRelativeQuality, lime.Node.clearTransition, lime.Node.createDomElement, lime.Node.getAnchorPoint, lime.Node.getAutoResize, lime.Node.getBoundingBox, lime.Node.getChildAt, lime.Node.getChildIndex, lime.Node.getCSS3DTransformsAllowed, lime.Node.getDeepestDomElement, lime.Node.getDeepestParentWithDom, lime.Node.getDirty, lime.Node.getFrame, lime.Node.getHidden, lime.Node.getMask, lime.Node.getNumberOfChildren, lime.Node.getOpacity, lime.Node.getParent, lime.Node.getParentStack_, lime.Node.getPosition, lime.Node.getQuality, lime.Node.getRelativeQuality, lime.Node.getRotation, lime.Node.getScale, lime.Node.getSize, lime.Node.localToNode, lime.Node.localToParent, lime.Node.measureContents, lime.Node.needsDomElement, lime.Node.parentToLocal, lime.Node.removeAllChildren, lime.Node.removeChild, lime.Node.removeChildAt, lime.Node.removeDomElement, lime.Node.removeEventListener, lime.Node.runAction, lime.Node.setAllow3DCSSTransforms, lime.Node.setAnchorPoint, lime.Node.setAutoResize, lime.Node.setChildIndex, lime.Node.setDirty, lime.Node.setHidden, lime.Node.setMask, lime.Node.setOpacity, lime.Node.setPosition, lime.Node.setQuality, lime.Node.setRenderer, lime.Node.setRotation, lime.Node.setScale, lime.Node.setSize, lime.Node.updateDomElement, lime.Node.wasAddedToTree, lime.Node.wasRemovedFromTree

Members

<static, constant> DEFAULT_HEIGHT :number

Default height of the Director

Source:

director.js, line 167

<static, constant> DEFAULT_WIDTH :number

Default width of the Director

Source:

director.js, line 159

<static, constant> FPS_INTERVAL :number

Milliseconds between recalculating FPS value

Source:

director.js, line 152

<private> coverStack_ :Array.<lime.CoverNode>

Array of CoverNode instances.

Source:

director.js, line 54

<private> sceneStack_ :Array.<lime.Scene>

Array of Scene instances. Last one is the active scene.

Source:

director.js, line 47

Methods

addCover(cover, opt_addAboveDirector)

Add CoverNode object to the viewport

Parameters:

Name	Type	Description
`cover`	lime.CoverNode	Covernode.
`opt_addAboveDirector`	boolean	Cover is added above director object.

Source:

director.js, line 406

getBounds(box) → {goog.math.Box}

Return bounds of director,

Parameters:

Name	Type	Description
`box`	goog.math.Box	Edges.

Source:

director.js, line 441

Returns:

new bounds.

Type: goog.math.Box

getCurrentScene() → {lime.Scene}

Get current active scene

Source:

director.js, line 235

Returns:

Currently active scene.

Type: lime.Scene

getDirector()

Source:

director.js, line 241

getScene()

Source:

director.js, line 246

hitTest()

Source:

director.js, line 592

<private> invalidateSize_()

Update dimensions based on viewport dimension changes

Source:

director.js, line 497

isDisplayFPS() → {boolean}

Returns true if FPS counter is displayed

Source:

director.js, line 205

Returns:

FPS is displayed.

Type: boolean

isPaused() → {boolean}

Returns true if director is paused? On paused state the update timer doesn't fire.

Source:

director.js, line 175

Returns:

If director is paused.

Type: boolean

<private> keyUpHandler_()

Source:

director.js, line 575

localToScreen()

Source:

director.js, line 468

makeMobileWebAppCapable()

Add support for adding game to Springboard as a web application on iOS devices

Source:

director.js, line 536

popScene(opt_transition, opt_duration)

Remove current scene from the stack

Parameters:

Name	Type	Argument	Description
`opt_transition`	function	<optional>	Transition played.
`opt_duration`	number	<optional>	Duration of transition.

Source:

director.js, line 370

Returns:

Transition object if opt_transition is defined

pushScene(scene, opt_transition, opt_duration)

Push scene to the top of scene stack

Parameters:

Name	Type	Argument	Description
`scene`	lime.Scene		New scene.
`opt_transition`	function	<optional>	Transition played.
`opt_duration`	number	<optional>	Duration of transition.

Source:

director.js, line 338

Returns:

Transition object if opt_transition is defined

removeCover(cover)

Remove CoverNode object from the viewport

Parameters:

Name	Type	Description
`cover`	lime.CoverNode	Cover to remove.

Source:

director.js, line 430

replaceScene(scene, opt_transition, opt_duration)

Replace current scene with new scene

Parameters:

Name	Type	Argument	Description
`scene`	lime.Scene		New scene.
`opt_transition`	function	<optional>	Transition played.
`opt_duration`	number	<optional>	Duration of transition.

Source:

director.js, line 277

screenToLocal()

Source:

director.js, line 455

setDisplayFPS(value) → {lime.Director}

Show or hide FPS counter

Parameters:

Name	Type	Description
`value`	boolean	Display FPS?

Source:

director.js, line 214

Returns:

The director object itself.

Type: lime.Director

setPaused(value) → {lime.Director}

Pauses or resumes the director

Parameters:

Name	Type	Description
`value`	boolean	Pause or resume.

Source:

director.js, line 185

Returns:

The director object itself.

Type: lime.Director

<private> step_(delta)

Timeline function.

Parameters:

Name	Type	Description
`delta`	number	Milliseconds since last step.

Source:

director.js, line 255

update()

Source:

director.js, line 483

<private> updateDomOffset_()

Updates the cached value of directors parentelement position in the viewport

Source:

director.js, line 568

updateLayout()

Source:

director.js, line 326