Cocos2D JavaScript (v0.1) API Documentation

BObject
- SpriteFrameCache

Class: SpriteFrameCache

Module: cocos
Defined In: libs/cocos2d/SpriteFrameCache.js
Extends: BObject

Public Properties

Property		Defined By
Expand id	id : Integer <read-only> Unique ID for this object	BObject
Expand sharedSpriteFrameCache	sharedSpriteFrameCache : cocos.SpriteFrameCache <static>	SpriteFrameCache
Expand spriteFrameAliases	spriteFrameAliases : Object List of sprite frame aliases	SpriteFrameCache
Expand spriteFrames	spriteFrames : Object List of sprite frames	SpriteFrameCache

Public Methods

Method		Defined By
Expand SpriteFrameCache	new SpriteFrameCache () : cocos.SpriteFrameCache <constructor> Returns cocos.SpriteFrameCache New instance of cocos.SpriteFrameCache	SpriteFrameCache
Expand addSpriteFrames	addSpriteFrames ({file:String}) : void Add SpriteFrame(s) to the cache Named Arguments file : String The filename of a Zwoptex .plist containing the frame definiitons. Returns void	SpriteFrameCache
Expand bindTo	bindTo (key:String,target:BOject,[targetKey:String],[noNotify:Boolean]) : void Bind the value of a property on this object to that of another object so they always have the same value. Setting the value on either object will update the other too. Arguments key : String Name of the property on this object that should be bound target : BOject Object to bind to targetKey : String (Optional) Key on the target object to bind to noNotify : Boolean (Optional) Set to true to prevent this object's property triggering a 'changed' event when adding the binding Returns void	BObject
Expand changed	changed (key:*) : void Arguments key : Returns void	BObject
Expand get	get (key:String) : * Get a property from the object. Always use this instead of trying to access the property directly. This will ensure all bindings, setters and getters work correctly. Arguments key : String Name of property to get Returns * Value of the property	BObject
Expand getSpriteFrame	getSpriteFrame ({name:String}) : cocos.SpriteFrame Get a single SpriteFrame Named Arguments name : String The name of the sprite frame Returns cocos.SpriteFrame The sprite frame	SpriteFrameCache
Expand get_sharedSpriteFrameCache	get_sharedSpriteFrameCache (key:*) : void <static> Arguments key : Returns void	SpriteFrameCache
Expand set	set (key:String,value:) : void Set a property on the object. Always use this instead of trying to access the property directly. This will ensure all bindings, setters and getters work correctly. Arguments key : String Name of property to get value : New value for the property Returns void	BObject
Expand setValues	setValues (kvp:Object) : void Set multiple propertys in one go Arguments kvp : Object An Object where the key is a property name and the value is the value to assign to the property Returns void	BObject
Expand unbind	unbind (key:String) : void Remove binding from a property which set setup using BObject#bindTo. Arguments key : String Name of the property on this object to unbind Returns void	BObject
Expand unbindAll	unbindAll () : void Remove all bindings on this object Returns void	BObject

Private Members

This class has no private members.