js Module

This module provides some JavaScript utilities. All members can be accessed with "cc.js".

Classes

• array
• Pool

Index

Properties

• _registeredClassIds Unknown All classes registered in the engine, indexed by ID.
• _registeredClassNames Unknown All classes registered in the engine, indexed by name.

Methods

• isNumber If a number is created by using 'new Number(10086)', the typeof it will be "object"...
• isString Check the obj whether is string or not.
• addon Copy all properties not defined in obj from arguments[1...n]
• mixin copy all properties from arguments[1...n] to obj
• extend Derive the class from the supplied base class.
• getSuper Get super class
• isChildClassOf Checks whether subclass is child of superclass or equals to superclass
• clear Removes all enumerable properties from object
• isEmptyObject Checks whether obj is an empty object
• getPropertyDescriptor Get property descriptor in object and all its ancestors
• value Define value, just help to call Object.defineProperty.
  ...
• getset Define get set accessor, just help to call Object.defineProperty(...)
• get Define get accessor, just help to call Object.defineProperty(...)
• set Define set accessor, just help to call Object.defineProperty(...)
• getClassName Get class name of the object, if object is just a {} (and which class named 'Object'), it will return "".
• _setClassId Register the class by specified id, if its classname is not defined, the class name will also be set.
• setClassName Register the class by specified name manually
• unregisterClass Unregister a class from fireball.
• _getClassById Get the registered class by id
• getClassByName Get the registered class by name
• _getClassId Get class id of the object
• obsolete Defines a polyfill field for obsoleted codes.
• obsoletes Defines all polyfill fields for obsoleted codes corresponding to the enumerable properties of props.
• formatStr A string tool to construct a string with format string.
• createMap A simple wrapper of Object.create(null) which ensures the return object have no prototype (and thus no inherited members).

Details

Properties

_registeredClassIds

All classes registered in the engine, indexed by ID.

Examples

// save all registered classes before loading scripts
let builtinClassIds = cc.js._registeredClassIds;
let builtinClassNames = cc.js._registeredClassNames;
// load some scripts that contain CCClass
...
// clear all loaded classes
cc.js._registeredClassIds = builtinClassIds;
cc.js._registeredClassNames = builtinClassNames;

_registeredClassNames

All classes registered in the engine, indexed by name.

Examples

// save all registered classes before loading scripts
let builtinClassIds = cc.js._registeredClassIds;
let builtinClassNames = cc.js._registeredClassNames;
// load some scripts that contain CCClass
...
// clear all loaded classes
cc.js._registeredClassIds = builtinClassIds;
cc.js._registeredClassNames = builtinClassNames;

Methods

isNumber

Check the obj whether is number or not If a number is created by using 'new Number(10086)', the typeof it will be "object"... Then you can use this function if you care about this case.

Parameters

• obj Any

isString

Check the obj whether is string or not. If a string is created by using 'new String("blabla")', the typeof it will be "object"... Then you can use this function if you care about this case.

Parameters

• obj Any

addon

Copy all properties not defined in obj from arguments[1...n]

Parameters

• obj Object object to extend its properties
• sourceObj Object source object to copy properties from

mixin

copy all properties from arguments[1...n] to obj

Parameters

• obj Object
• sourceObj Object

extend

Derive the class from the supplied base class. Both classes are just native javascript constructors, not created by cc.Class, so usually you will want to inherit using cc.Class instead.

Parameters

• cls Function
• base Function the baseclass to inherit

getSuper

Get super class

Parameters

• ctor Function the constructor of subclass

isChildClassOf

Checks whether subclass is child of superclass or equals to superclass

Parameters

• subclass Function
• superclass Function

clear

Removes all enumerable properties from object

Parameters

• obj Any

isEmptyObject

Checks whether obj is an empty object

Parameters

• obj Any

getPropertyDescriptor

Get property descriptor in object and all its ancestors

Parameters

• obj Object
• name String

value

Define value, just help to call Object.defineProperty.
The configurable will be true.

Parameters

• obj Object
• prop String
• value Any
• writable Boolean
• enumerable Boolean

getset

Define get set accessor, just help to call Object.defineProperty(...)

Parameters

• obj Object
• prop String
• getter Function
• setter Function
• enumerable Boolean

get

Define get accessor, just help to call Object.defineProperty(...)

Parameters

• obj Object
• prop String
• getter Function
• enumerable Boolean
• configurable Boolean

set

Define set accessor, just help to call Object.defineProperty(...)

Parameters

• obj Object
• prop String
• setter Function
• enumerable Boolean
• configurable Boolean

getClassName

Get class name of the object, if object is just a {} (and which class named 'Object'), it will return "". (modified from the code from this stackoverflow post)

Parameters

• objOrCtor Object | Function instance or constructor

_setClassId

Register the class by specified id, if its classname is not defined, the class name will also be set.

Parameters

• classId String
• constructor Function

setClassName

Register the class by specified name manually

Parameters

• className String
• constructor Function

unregisterClass

Unregister a class from fireball.

If you dont need a registered class anymore, you should unregister the class so that Fireball will not keep its reference anymore. Please note that its still your responsibility to free other references to the class.

Parameters

• constructor Function the class you will want to unregister, any number of classes can be added

_getClassById

Get the registered class by id

Parameters

• classId String

getClassByName

Get the registered class by name

Parameters

• classname String

_getClassId

Get class id of the object

Parameters

• obj Object | Function instance or constructor
• allowTempId Boolean can return temp id in editor

obsolete

Defines a polyfill field for obsoleted codes.

Parameters

• obj Any YourObject or YourClass.prototype
• obsoleted String "OldParam" or "YourClass.OldParam"
• newExpr String "NewParam" or "YourClass.NewParam"
• writable Boolean

obsoletes

Defines all polyfill fields for obsoleted codes corresponding to the enumerable properties of props.

Parameters

• obj Any YourObject or YourClass.prototype
• objName Any "YourObject" or "YourClass"
• props Object
• writable Boolean

formatStr

A string tool to construct a string with format string.

Parameters

• msg String | Any A JavaScript string containing zero or more substitution strings (%s).
• subst Any JavaScript objects with which to replace substitution strings within msg. This gives you additional control over the format of the output.

Examples

cc.js.formatStr("a: %s, b: %s", a, b);
cc.js.formatStr(a, b, c);

createMap

A simple wrapper of Object.create(null) which ensures the return object have no prototype (and thus no inherited members). So we can skip hasOwnProperty calls on property lookups. It is a worthwhile optimization than the {} literal when hasOwnProperty calls are necessary.

Parameters

• forceDictMode Boolean Apply the delete operator to newly created map object. This causes V8 to put the object in "dictionary mode" and disables creation of hidden classes which are very expensive for objects that are constantly changing shape.