API Docs for: 0.5.5
Show:

kick.core.ProjectAsset Class

Defined in: kick/core/ProjectAsset.js:6
Module: kick.core

A project asset is an object that can be serialized into a project and restored at a later state.
The class is used to describe the behavior any project asset must implement, but instanceof operator does not work.
The constructor must take the following two parameters: kick.core.Engine engine, {Object} config
The config parameter is used to initialize the object and the content should match the output of the toJSON method
A toJSON method should exist on the object. This method should as a minimum write out the object's uid property.
ProjectAsset objects may reference other ProjectAsset objects, however cyclic references are not allowed.

Item Index

Methods

Properties

Methods

init

(
  • config
  • [resourceTracker]
)

Defined in kick/core/ProjectAsset.js:41

Configures the object using the configuration data.

Parameters:

  • config Object

    configuration data in JSON format

  • [resourceTracker] ResourceTracker optional

toJSON

() Object

Defined in kick/core/ProjectAsset.js:51

Returns:

Object:

configuration in JSON

Properties

uid

Number

Defined in kick/core/ProjectAsset.js:20