Class Karma
Represents a Karma (master) object.
Defined in: jquery.karma.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Karma(options)
Karma
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
Karma.button(args)
A shortcut for calling 'KButton( )'
|
| <static> |
Karma.group(args)
A shortcut for calling 'KGroup( )'
|
| <static> |
Karma.image(args)
A shortcut for calling 'KImage( )'
|
| <static> |
Karma.init(toLoad)
|
| <static> |
Karma.main(cb)
Main function.
|
| <static> |
Karma.sound(args)
A shortcut for calling 'KSound( )'
|
| <static> |
Karma.surface(options)
A shortcut for calling 'KSurface(.
|
| <static> |
Karma.video(args)
A shortcut for calling 'KVideo( )'
|
Class Detail
Karma(options)
Karma
- Parameters:
- {String | Object} options
- Constructor arguments
- {String | Object} options.container Optional
- Target DIV-class that will contain any canvas element created using Karma functions
- {String} options.language Optional
Method Detail
<static>
{Object}
Karma.button(args)
A shortcut for calling 'KButton( )'
- Parameters:
- args
- Returns:
- {Object} new instance of KButton object
- See:
- KButton
<static>
{Object}
Karma.group(args)
A shortcut for calling 'KGroup( )'
- Parameters:
- args
- Returns:
- {Object} new instance of KGroup object
- See:
- KGroup
<static>
{Object}
Karma.image(args)
A shortcut for calling 'KImage( )'
- Parameters:
- args
- Returns:
- {Object} new instance of KImage object
- See:
- KImage
<static>
{Object}
Karma.init(toLoad)
- Parameters:
- {Object} toLoad Optional
- The Object that has the arrays for preloading.
- {Array} toLoad.images Optional
- The images
- {Array} toLoad.sounds Optional
- The sounds
- {Array} toLoad.videos Optional
- The videos
- Returns:
- {Object} this
<static>
Karma.main(cb)
Main function. Any Karma function call should be inside the callback function.
The callback function will be executed when the preloading finishes.
- Parameters:
- {Function} cb
- The callback funtion
- See:
- Karma#init
<static>
{Object}
Karma.sound(args)
A shortcut for calling 'KSound( )'
- Parameters:
- args
- Returns:
- {Object} new instance of KSound object
- See:
- KSound
<static>
{Object}
Karma.surface(options)
A shortcut for calling 'KSurface(.. )'.
- Parameters:
- options
- Returns:
- {Object} new instance of KSurface object
- See:
- KSurface
<static>
{Object}
Karma.video(args)
A shortcut for calling 'KVideo( )'
- Parameters:
- args
- Returns:
- {Object} new instance of KVideo object
- See:
- KVideo