axmol/cocos/scripting/lua-bindings/auto/api/AnimationCache.lua

87 lines
3.1 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module AnimationCache
-- @extend Ref
-- @parent_module cc
2014-03-10 14:04:58 +08:00
--------------------------------
-- Returns a Animation that was previously added.<br>
-- If the name is not found it will return nil.<br>
-- You should retain the returned copy if you are going to use it.<br>
-- return A Animation that was previously added. If the name is not found it will return nil.
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationCache] getAnimation
-- @param self
-- @param #string name
2014-03-10 14:04:58 +08:00
-- @return Animation#Animation ret (return value: cc.Animation)
--------------------------------
-- Adds a Animation with a name.<br>
-- param animation An animation.<br>
-- param name The name of animation.
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationCache] addAnimation
-- @param self
-- @param #cc.Animation animation
-- @param #string name
-- @return AnimationCache#AnimationCache self (return value: cc.AnimationCache)
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationCache] init
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Adds an animation from an NSDictionary.<br>
-- Make sure that the frames were previously loaded in the SpriteFrameCache.<br>
-- param dictionary An NSDictionary.<br>
-- param plist The path of the relative file,it use to find the plist path for load SpriteFrames.<br>
-- since v1.1<br>
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationCache] addAnimationsWithDictionary
-- @param self
-- @param #map_table dictionary
-- @param #string plist
-- @return AnimationCache#AnimationCache self (return value: cc.AnimationCache)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Deletes a Animation from the cache.<br>
-- param name The name of animation.
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationCache] removeAnimation
-- @param self
-- @param #string name
-- @return AnimationCache#AnimationCache self (return value: cc.AnimationCache)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Adds an animation from a plist file.<br>
-- Make sure that the frames were previously loaded in the SpriteFrameCache.<br>
-- since v1.1<br>
-- js addAnimations<br>
-- lua addAnimations<br>
-- param plist An animation from a plist file.
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationCache] addAnimationsWithFile
-- @param self
-- @param #string plist
-- @return AnimationCache#AnimationCache self (return value: cc.AnimationCache)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Purges the cache. It releases all the Animation objects and the shared instance.<br>
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationCache] destroyInstance
-- @param self
-- @return AnimationCache#AnimationCache self (return value: cc.AnimationCache)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Returns the shared instance of the Animation cache <br>
-- js NA
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationCache] getInstance
-- @param self
-- @return AnimationCache#AnimationCache ret (return value: cc.AnimationCache)
--------------------------------
-- js ctor
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationCache] AnimationCache
-- @param self
-- @return AnimationCache#AnimationCache self (return value: cc.AnimationCache)
2014-03-10 14:04:58 +08:00
return nil