API Docs for: 0.5.5
Show:

kick.scene.Scene Class

Extends kick.core.ProjectAsset
Defined in: kick/scene/Scene.js:10
Module: kick.scene

A scene objects contains a list of GameObjects

Constructor

kick.scene.Scene

(
  • config
)

Defined in kick/scene/Scene.js:10

Parameters:

  • config Object

Methods

addNewGameObjects

() private

Defined in kick/scene/Scene.js:81

Handle insertions of new gameobjects and components. This is done in a separate step to avoid problems with missed updates (or multiple updates) due to modifying the array while iterating it.

cameraSortFunc

(
  • a
  • b
  • difference
)
private

Defined in kick/scene/Scene.js:70

Compares two camera objects by their cameraIndex attribute

Parameters:

createDefault

() kick.scene.Scene static

Defined in kick/scene/Scene.js:538

Create empty scene with camera

Returns:

kick.scene.Scene:

createGameObject

(
  • [config]
)
kick.scene.GameObject

Defined in kick/scene/Scene.js:343

Parameters:

  • [config] Object optional

    Optionally configuration passed to the game objects

Returns:

kick.scene.GameObject:

destroy

()

Defined in kick/scene/Scene.js:230

destroyGameObject

(
  • gameObject
)

Defined in kick/scene/Scene.js:374

Destroys the game object and delete it from the scene. This call will call destroy on the gameObject

Parameters:

destroyObject

(
  • gameObject
)
deprecated

Defined in kick/scene/Scene.js:355

Destroys the game object and delete it from the scene. This call will call destroy on the gameObject

Parameters:

findComponentsOfType

(
  • componentType
)
Array_kick.scene.Component

Defined in kick/scene/Scene.js:240

Search the scene for components of the specified type in the scene. Note that this method is slow - do not run in the the update function.

Parameters:

  • componentType Function

Returns:

Array_kick.scene.Component:

components

findComponentsWithMethod

(
  • methodName
)
Array_kick.scene.Component

Defined in kick/scene/Scene.js:266

Search the scene for components of the specified type in the scene. Note that this method is slow - do not run in the the update function.

Parameters:

  • methodName String

Returns:

Array_kick.scene.Component:

components

getGameObject

(
  • index
)
kick.scene.GameObject

Defined in kick/scene/Scene.js:399

Parameters:

  • index Number

Returns:

kick.scene.GameObject:

getGameObjectByName

(
  • name
)
kick.scene.GameObject

Defined in kick/scene/Scene.js:301

Returns a GameObject identified by name

Parameters:

  • name String

Returns:

kick.scene.GameObject:

GameObject or undefined if not found

getNumberOfGameObjects

() Number

Defined in kick/scene/Scene.js:391

Returns:

Number:

number of gameobjects

getObjectByUID

(
  • uid
)
Object

Defined in kick/scene/Scene.js:292

Parameters:

  • uid Number

Returns:

Object:

GameObject or component

init

(
  • config
)

Inherited from kick.core.ProjectAsset but overwritten in kick/scene/Scene.js:440

Configures the object using the configuration data.

Parameters:

  • config Object

    configuration data in JSON format

sortByScriptPriority

(
  • a
  • b
)
Number private

Defined in kick/scene/Scene.js:59

Compares two objects based on scriptPriority

Parameters:

Returns:

Number:

order of a,b

toJSON

(
  • [filterFn]
)
Object

Inherited from kick.core.ProjectAsset but overwritten in kick/scene/Scene.js:417

Parameters:

  • [filterFn] Function optional

    Optional. Filter with function(object): return boolean, where true means include in export.

Returns:

Object:

updateAndRender

()

Defined in kick/scene/Scene.js:408

Called by engine every frame. Updates and render scene

Properties

engine

kick.core.Engine

Defined in kick/scene/Scene.js:319

Reference to the engine

name

String

Defined in kick/scene/Scene.js:327

Name of the scene

Events

componentAdded

Defined in kick/scene/Scene.js:215

Fired when a new component is added to scene

Event Payload:

componentRemoved

Defined in kick/scene/Scene.js:221

Fired when a new component is removed from scene

Event Payload: