zerk Class
The Zerk main object and namespace
Item Index
Methods
Properties
Methods
_classLoaded
-
className
Checks if a class is loaded and defined already
Parameters:
-
classNameStringThe name of the class
Returns:
_classLoading
-
className
Checks if a class is loading already
Parameters:
-
classNameStringThe name of the class
Returns:
_createObject
-
parent
Creates an object from parent object definition
This is an implementation of Douglas Crockfords prototypal inheritance in JavaScript.
Parameters:
-
parentObject
Returns:
_defineClass
-
meta -
body -
callback
Defines a class
Parameters:
-
metaObjectClass meta object
-
bodyObjectClass body
-
callbackFunctionCallback function that fires after the class was defined
Returns:
_delayDefine
-
meta -
body -
callback -
waitFor
Creates a delayed define entry and returns its handle
Parameters:
-
metaObjectClass meta object
-
bodyObjectClass body
-
callbackFunctionCallback function
-
waitForArray
Returns:
_getClassURL
-
className
Returns the url for given class name
Parameters:
-
classNameStringThe name of the class
Returns:
_loadScript
-
url
Loads a JavaScript file
Parameters:
-
urlStringThe target url of the script to be loaded
_onLoad
()
private
Fires when all classes ever required are loaded and defined
_parseClassName
-
className
Parses given class name and returns detailed information
Parameters:
-
classNameStringThe name of the class
Returns:
_parseMeta
-
meta
Normalize meta data
Parameters:
-
metaString | ObjectA class meta data object or name
Returns:
_processLoadedClass
-
className
Process delayed defines after dependencies are resolved
Parameters:
-
classNameStringThe name of the class
_ready
()
private
Fires when all classes ever required are loaded and defined and the document is ready
_requireClass
-
className
Loads the related script file of the given class name
Parameters:
-
classNameString
apply
-
obj -
props
Apply properties to an object/class
Parameters:
-
objObjectThe object witch the properties should be applied to
-
propsObjectA JSON property structure
create
-
name
Creates a class instance
All arguments after 'name' are passed to the init method of the class.
Parameters:
-
nameStringThe name of the class
Returns:
define
-
name -
body -
callback
Defines a new class
// Class definition without meta object
zerk.define('myNamespace.myClass',{
// ...
});
// Class definition with meta object
zerk.define({
name: 'myNamespace.myClass',
extend: 'myNamespace.myParentClass'
require: [
'myNamespace.myParentClass'
]
},{
// ...
});
Parameters:
-
nameString | ObjectThe name of the class or a meta object
-
bodyObjectThe body of the class
-
callbackFunctionCallback function that fires when the class definition is done
init
-
config
The main bootstrap method
Parameters:
-
configObjectConfiguration object
parent
-
name
Method for inheritance like parent class calls
Use this with the apply method to inject the local scope.
zerk.parent('myClass').myMethod.apply(
this,
arguments
);
Parameters:
-
nameStringThe name of the class
Returns:
Properties
_classMap
Object
private
Class name to instance map
_classState
Object
private
Load state of classes
_config
Object
private
The game engine configuration
_delayedDefine
Object
private
Defines that got delayed by requires