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

87 lines
3.0 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module AnimationFrame
-- @extend Ref
-- @parent_module cc
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set the SpriteFrame.<br>
-- param frame A SpriteFrame will be used.
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationFrame] setSpriteFrame
-- @param self
-- @param #cc.SpriteFrame frame
-- @return AnimationFrame#AnimationFrame self (return value: cc.AnimationFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- @overload self
-- @overload self
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationFrame] getUserInfo
-- @param self
-- @return map_table#map_table ret (return value: map_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Sets the units of time the frame takes.<br>
-- param delayUnits The units of time the frame takes.
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationFrame] setDelayUnits
-- @param self
-- @param #float delayUnits
-- @return AnimationFrame#AnimationFrame self (return value: cc.AnimationFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
--
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationFrame] clone
-- @param self
-- @return AnimationFrame#AnimationFrame ret (return value: cc.AnimationFrame)
--------------------------------
-- Return a SpriteFrameName to be used.<br>
-- return a SpriteFrameName to be used.
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationFrame] getSpriteFrame
-- @param self
-- @return SpriteFrame#SpriteFrame ret (return value: cc.SpriteFrame)
--------------------------------
-- Gets the units of time the frame takes.<br>
-- return The units of time the frame takes.
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationFrame] getDelayUnits
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Sets user infomation.<br>
-- param userInfo A dictionary as UserInfo.
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationFrame] setUserInfo
-- @param self
-- @param #map_table userInfo
-- @return AnimationFrame#AnimationFrame self (return value: cc.AnimationFrame)
2014-03-10 14:04:58 +08:00
--------------------------------
-- initializes the animation frame with a spriteframe, number of delay units and a notification user info
-- @function [parent=#AnimationFrame] initWithSpriteFrame
-- @param self
-- @param #cc.SpriteFrame spriteFrame
-- @param #float delayUnits
-- @param #map_table userInfo
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Creates the animation frame with a spriteframe, number of delay units and a notification user info.<br>
-- param spriteFrame The animation frame with a spriteframe.<br>
-- param delayUnits Number of delay units.<br>
-- param userInfo A notification user info.<br>
-- since 3.0
2014-03-10 14:04:58 +08:00
-- @function [parent=#AnimationFrame] create
-- @param self
-- @param #cc.SpriteFrame spriteFrame
-- @param #float delayUnits
-- @param #map_table userInfo
2014-03-10 14:04:58 +08:00
-- @return AnimationFrame#AnimationFrame ret (return value: cc.AnimationFrame)
--------------------------------
-- js ctor
-- @function [parent=#AnimationFrame] AnimationFrame
-- @param self
-- @return AnimationFrame#AnimationFrame self (return value: cc.AnimationFrame)
2014-03-10 14:04:58 +08:00
return nil