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

112 lines
3.9 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module Action
-- @extend Ref
-- @parent_module cc
2014-03-10 14:04:58 +08:00
--------------------------------
-- Called before the action start. It will also set the target. <br>
-- param target A certain target.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] startWithTarget
-- @param self
-- @param #cc.Node target
-- @return Action#Action self (return value: cc.Action)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set the original target, since target can be nil.<br>
-- Is the target that were used to run the action. Unless you are doing something complex, like ActionManager, you should NOT call this method.<br>
-- The target is 'assigned', it is not 'retained'.<br>
-- since v0.8.2<br>
-- param originalTarget Is 'assigned', it is not 'retained'.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] setOriginalTarget
-- @param self
-- @param #cc.Node originalTarget
-- @return Action#Action self (return value: cc.Action)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Returns a clone of action.<br>
-- return A clone action.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] clone
-- @param self
-- @return Action#Action ret (return value: cc.Action)
--------------------------------
-- Return a original Target. <br>
-- return A original Target.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] getOriginalTarget
-- @param self
-- @return Node#Node ret (return value: cc.Node)
--------------------------------
-- Called after the action has finished. It will set the 'target' to nil.<br>
-- IMPORTANT: You should never call "Action::stop()" manually. Instead, use: "target->stopAction(action);".
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] stop
-- @param self
-- @return Action#Action self (return value: cc.Action)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Called once per frame. time a value between 0 and 1.<br>
-- For example:<br>
-- - 0 Means that the action just started.<br>
-- - 0.5 Means that the action is in the middle.<br>
-- - 1 Means that the action is over.<br>
-- param time A value between 0 and 1.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] update
-- @param self
-- @param #float time
-- @return Action#Action self (return value: cc.Action)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Return certain target..<br>
-- return A certain target.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] getTarget
-- @param self
-- @return Node#Node ret (return value: cc.Node)
--------------------------------
-- Called every frame with it's delta time, dt in seconds. DON'T override unless you know what you are doing. <br>
-- param dt In seconds.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] step
-- @param self
-- @param #float dt
-- @return Action#Action self (return value: cc.Action)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Changes the tag that is used to identify the action easily. <br>
-- param tag Used to identify the action easily.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] setTag
-- @param self
-- @param #int tag
-- @return Action#Action self (return value: cc.Action)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Returns a tag that is used to identify the action easily. <br>
-- return A tag.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] getTag
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- The action will modify the target properties. <br>
-- param target A certain target.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] setTarget
-- @param self
-- @param #cc.Node target
-- @return Action#Action self (return value: cc.Action)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Return true if the action has finished. <br>
-- return Is true if the action has finished.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] isDone
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Returns a new action that performs the exactly the reverse action. <br>
-- return A new action that performs the exactly the reverse action.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Action] reverse
-- @param self
-- @return Action#Action ret (return value: cc.Action)
return nil