From b7881eab888007d5523b2aa8cc7df5d8ce879bd2 Mon Sep 17 00:00:00 2001 From: CocosRobot Date: Wed, 18 Mar 2015 14:02:42 +0000 Subject: [PATCH] [AUTO]: updating luabinding automatically --- .../lua-bindings/auto/api/ActionInstant.lua | 4 +- .../lua-bindings/auto/api/ActionInterval.lua | 9 ++-- .../lua-bindings/auto/api/ActionManager.lua | 44 ++++++++++++----- .../lua-bindings/auto/api/Animate.lua | 9 ++-- .../lua-bindings/auto/api/BezierBy.lua | 2 +- .../scripting/lua-bindings/auto/api/Blink.lua | 8 ++-- .../lua-bindings/auto/api/CallFunc.lua | 10 ++-- .../lua-bindings/auto/api/ClippingNode.lua | 8 ++++ .../lua-bindings/auto/api/DelayTime.lua | 7 +-- .../lua-bindings/auto/api/FadeIn.lua | 5 +- .../lua-bindings/auto/api/FadeOut.lua | 4 +- .../lua-bindings/auto/api/FadeTo.lua | 8 ++-- .../scripting/lua-bindings/auto/api/FlipX.lua | 6 ++- .../scripting/lua-bindings/auto/api/FlipY.lua | 6 ++- .../scripting/lua-bindings/auto/api/Hide.lua | 5 +- .../lua-bindings/auto/api/JumpBy.lua | 10 ++-- .../lua-bindings/auto/api/JumpTo.lua | 8 +++- .../scripting/lua-bindings/auto/api/Label.lua | 8 ++++ .../scripting/lua-bindings/auto/api/Place.lua | 6 ++- .../lua-bindings/auto/api/RemoveSelf.lua | 6 ++- .../lua-bindings/auto/api/Repeat.lua | 13 +++-- .../lua-bindings/auto/api/RepeatForever.lua | 12 +++-- .../lua-bindings/auto/api/RotateBy.lua | 2 +- .../lua-bindings/auto/api/RotateTo.lua | 2 +- .../lua-bindings/auto/api/ScaleTo.lua | 2 +- .../scripting/lua-bindings/auto/api/Scene.lua | 13 +++-- .../lua-bindings/auto/api/Sequence.lua | 2 +- .../scripting/lua-bindings/auto/api/Show.lua | 5 +- .../lua-bindings/auto/api/SkewBy.lua | 7 ++- .../lua-bindings/auto/api/SkewTo.lua | 9 ++-- .../scripting/lua-bindings/auto/api/Spawn.lua | 2 +- .../lua-bindings/auto/api/SpriteFrame.lua | 48 ++++++++++++------- .../auto/api/SpriteFrameCache.lua | 32 +++++++++---- .../lua-bindings/auto/api/TargetedAction.lua | 10 ++-- .../lua-bindings/auto/api/TintBy.lua | 10 ++-- .../lua-bindings/auto/api/TintTo.lua | 2 +- .../auto/api/ToggleVisibility.lua | 5 +- 37 files changed, 236 insertions(+), 113 deletions(-) diff --git a/cocos/scripting/lua-bindings/auto/api/ActionInstant.lua b/cocos/scripting/lua-bindings/auto/api/ActionInstant.lua index d8bd528b8a..c6d645b819 100644 --- a/cocos/scripting/lua-bindings/auto/api/ActionInstant.lua +++ b/cocos/scripting/lua-bindings/auto/api/ActionInstant.lua @@ -5,7 +5,7 @@ -- @parent_module cc -------------------------------- --- param dt in seconds +-- param dt In seconds. -- @function [parent=#ActionInstant] step -- @param self -- @param #float dt @@ -30,7 +30,7 @@ -- @return bool#bool ret (return value: bool) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#ActionInstant] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/ActionInterval.lua b/cocos/scripting/lua-bindings/auto/api/ActionInterval.lua index 48e405310b..0d536409a3 100644 --- a/cocos/scripting/lua-bindings/auto/api/ActionInterval.lua +++ b/cocos/scripting/lua-bindings/auto/api/ActionInterval.lua @@ -5,20 +5,23 @@ -- @parent_module cc -------------------------------- --- +-- Gets the ampliture rate, extension in GridAction
+-- return The ampliture rate. -- @function [parent=#ActionInterval] getAmplitudeRate -- @param self -- @return float#float ret (return value: float) -------------------------------- --- +-- Sets the ampliture rate, extension in GridAction
+-- param amp The ampliture rate. -- @function [parent=#ActionInterval] setAmplitudeRate -- @param self -- @param #float amp -- @return ActionInterval#ActionInterval self (return value: cc.ActionInterval) -------------------------------- --- how many seconds had elapsed since the actions started to run. +-- How many seconds had elapsed since the actions started to run.
+-- return The seconds had elapsed since the ations started to run. -- @function [parent=#ActionInterval] getElapsed -- @param self -- @return float#float ret (return value: float) diff --git a/cocos/scripting/lua-bindings/auto/api/ActionManager.lua b/cocos/scripting/lua-bindings/auto/api/ActionManager.lua index b855208a92..2cad557be4 100644 --- a/cocos/scripting/lua-bindings/auto/api/ActionManager.lua +++ b/cocos/scripting/lua-bindings/auto/api/ActionManager.lua @@ -5,8 +5,10 @@ -- @parent_module cc -------------------------------- --- Gets an action given its tag an a target
--- return the Action the with the given tag +-- Gets an action given its tag an a target.
+-- param tag The action's tag.
+-- param target A certain target.
+-- return The Action the with the given tag. -- @function [parent=#ActionManager] getActionByTag -- @param self -- @param #int tag @@ -14,7 +16,9 @@ -- @return Action#Action ret (return value: cc.Action) -------------------------------- --- Removes an action given its tag and the target +-- Removes an action given its tag and the target.
+-- param tag The action's tag.
+-- param target A certain target. -- @function [parent=#ActionManager] removeActionByTag -- @param self -- @param #int tag @@ -31,7 +35,10 @@ -- Adds an action with a target.
-- If the target is already present, then the action will be added to the existing target.
-- If the target is not present, a new instance of this target will be created either paused or not, and the action will be added to the newly created target.
--- When the target is paused, the queued actions won't be 'ticked'. +-- When the target is paused, the queued actions won't be 'ticked'.
+-- param action A certain action.
+-- param target The target which need to be added an action.
+-- param paused Is the target paused or not. -- @function [parent=#ActionManager] addAction -- @param self -- @param #cc.Action action @@ -40,21 +47,24 @@ -- @return ActionManager#ActionManager self (return value: cc.ActionManager) -------------------------------- --- Resumes the target. All queued actions will be resumed. +-- Resumes the target. All queued actions will be resumed.
+-- param target A certain target. -- @function [parent=#ActionManager] resumeTarget -- @param self -- @param #cc.Node target -- @return ActionManager#ActionManager self (return value: cc.ActionManager) -------------------------------- --- param dt in seconds +-- Main loop of ActionManager.
+-- param dt In seconds. -- @function [parent=#ActionManager] update -- @param self -- @param #float dt -- @return ActionManager#ActionManager self (return value: cc.ActionManager) -------------------------------- --- Pauses the target: all running actions and newly added actions will be paused. +-- Pauses the target: all running actions and newly added actions will be paused.
+-- param target A certain target. -- @function [parent=#ActionManager] pauseTarget -- @param self -- @param #cc.Node target @@ -64,7 +74,9 @@ -- Returns the numbers of actions that are running in a certain target.
-- Composable actions are counted as 1 action. Example:
-- - If you are running 1 Sequence of 7 actions, it will return 1.
--- - If you are running 7 Sequences of 2 actions, it will return 7. +-- - If you are running 7 Sequences of 2 actions, it will return 7.
+-- param target A certain target.
+-- return The numbers of actions that are running in a certain target. -- @function [parent=#ActionManager] getNumberOfRunningActionsInTarget -- @param self -- @param #cc.Node target @@ -72,28 +84,33 @@ -------------------------------- -- Removes all actions from a certain target.
--- All the actions that belongs to the target will be removed. +-- All the actions that belongs to the target will be removed.
+-- param target A certain target. -- @function [parent=#ActionManager] removeAllActionsFromTarget -- @param self -- @param #cc.Node target -- @return ActionManager#ActionManager self (return value: cc.ActionManager) -------------------------------- --- Resume a set of targets (convenience function to reverse a pauseAllRunningActions call) +-- Resume a set of targets (convenience function to reverse a pauseAllRunningActions call).
+-- param targetsToResume A set of targets need to be resumed. -- @function [parent=#ActionManager] resumeTargets -- @param self -- @param #array_table targetsToResume -- @return ActionManager#ActionManager self (return value: cc.ActionManager) -------------------------------- --- Removes an action given an action reference. +-- Removes an action given an action reference.
+-- param action A certain target. -- @function [parent=#ActionManager] removeAction -- @param self -- @param #cc.Action action -- @return ActionManager#ActionManager self (return value: cc.ActionManager) -------------------------------- --- Removes all actions given its tag and the target +-- Removes all actions given its tag and the target.
+-- param tag The actions' tag.
+-- param target A certain target. -- @function [parent=#ActionManager] removeAllActionsByTag -- @param self -- @param #int tag @@ -101,7 +118,8 @@ -- @return ActionManager#ActionManager self (return value: cc.ActionManager) -------------------------------- --- Pauses all running actions, returning a list of targets whose actions were paused. +-- Pauses all running actions, returning a list of targets whose actions were paused.
+-- return A list of targets whose actions were paused. -- @function [parent=#ActionManager] pauseAllRunningActions -- @param self -- @return array_table#array_table ret (return value: array_table) diff --git a/cocos/scripting/lua-bindings/auto/api/Animate.lua b/cocos/scripting/lua-bindings/auto/api/Animate.lua index df2b7ed0ea..53b00178a5 100644 --- a/cocos/scripting/lua-bindings/auto/api/Animate.lua +++ b/cocos/scripting/lua-bindings/auto/api/Animate.lua @@ -12,14 +12,17 @@ -- @return Animation#Animation ret (return value: cc.Animation) -------------------------------- --- sets the Animation object to be animated +-- Sets the Animation object to be animated
+-- param A certain animation. -- @function [parent=#Animate] setAnimation -- @param self -- @param #cc.Animation animation -- @return Animate#Animate self (return value: cc.Animate) -------------------------------- --- creates the action with an Animation and will restore the original frame when the animation is over +-- Creates the action with an Animation and will restore the original frame when the animation is over.
+-- param animation A certain animation.
+-- return An autoreleased Animate object. -- @function [parent=#Animate] create -- @param self -- @param #cc.Animation animation @@ -51,7 +54,7 @@ -- @return Animate#Animate ret (return value: cc.Animate) -------------------------------- --- param t in seconds +-- param t In seconds. -- @function [parent=#Animate] update -- @param self -- @param #float t diff --git a/cocos/scripting/lua-bindings/auto/api/BezierBy.lua b/cocos/scripting/lua-bindings/auto/api/BezierBy.lua index 63562dc820..ed37b6b69c 100644 --- a/cocos/scripting/lua-bindings/auto/api/BezierBy.lua +++ b/cocos/scripting/lua-bindings/auto/api/BezierBy.lua @@ -24,7 +24,7 @@ -- @return BezierBy#BezierBy ret (return value: cc.BezierBy) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#BezierBy] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/Blink.lua b/cocos/scripting/lua-bindings/auto/api/Blink.lua index e52c6dd300..1302b5d217 100644 --- a/cocos/scripting/lua-bindings/auto/api/Blink.lua +++ b/cocos/scripting/lua-bindings/auto/api/Blink.lua @@ -5,8 +5,10 @@ -- @parent_module cc -------------------------------- --- creates the action
--- param duration in seconds +-- Creates the action.
+-- param duration Duration time, in seconds.
+-- param blinks Blink times.
+-- return An autoreleased Blink object. -- @function [parent=#Blink] create -- @param self -- @param #float duration @@ -39,7 +41,7 @@ -- @return Blink#Blink ret (return value: cc.Blink) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#Blink] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/CallFunc.lua b/cocos/scripting/lua-bindings/auto/api/CallFunc.lua index 686b2f333d..d53bf3019b 100644 --- a/cocos/scripting/lua-bindings/auto/api/CallFunc.lua +++ b/cocos/scripting/lua-bindings/auto/api/CallFunc.lua @@ -5,19 +5,21 @@ -- @parent_module cc -------------------------------- --- executes the callback +-- Executes the callback. -- @function [parent=#CallFunc] execute -- @param self -- @return CallFunc#CallFunc self (return value: cc.CallFunc) -------------------------------- --- +-- Get the selector target.
+-- return The selector target. -- @function [parent=#CallFunc] getTargetCallback -- @param self -- @return Ref#Ref ret (return value: cc.Ref) -------------------------------- --- +-- Set the selector target.
+-- param The selector target. -- @function [parent=#CallFunc] setTargetCallback -- @param self -- @param #cc.Ref sel @@ -30,7 +32,7 @@ -- @return CallFunc#CallFunc ret (return value: cc.CallFunc) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#CallFunc] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/ClippingNode.lua b/cocos/scripting/lua-bindings/auto/api/ClippingNode.lua index 688394d901..9c8b443cf8 100644 --- a/cocos/scripting/lua-bindings/auto/api/ClippingNode.lua +++ b/cocos/scripting/lua-bindings/auto/api/ClippingNode.lua @@ -67,6 +67,14 @@ -- @param #cc.Node stencil -- @return ClippingNode#ClippingNode ret (return value: cc.ClippingNode) +-------------------------------- +-- +-- @function [parent=#ClippingNode] setCameraMask +-- @param self +-- @param #unsigned short mask +-- @param #bool applyChildren +-- @return ClippingNode#ClippingNode self (return value: cc.ClippingNode) + -------------------------------- -- -- @function [parent=#ClippingNode] visit diff --git a/cocos/scripting/lua-bindings/auto/api/DelayTime.lua b/cocos/scripting/lua-bindings/auto/api/DelayTime.lua index b242508b3d..61f50ecbf4 100644 --- a/cocos/scripting/lua-bindings/auto/api/DelayTime.lua +++ b/cocos/scripting/lua-bindings/auto/api/DelayTime.lua @@ -5,8 +5,9 @@ -- @parent_module cc -------------------------------- --- creates the action
--- param d in seconds +-- Creates the action.
+-- param d Duration time, in seconds.
+-- return An autoreleased DelayTime object. -- @function [parent=#DelayTime] create -- @param self -- @param #float d @@ -19,7 +20,7 @@ -- @return DelayTime#DelayTime ret (return value: cc.DelayTime) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#DelayTime] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/FadeIn.lua b/cocos/scripting/lua-bindings/auto/api/FadeIn.lua index 6eb753261a..65d36ab3df 100644 --- a/cocos/scripting/lua-bindings/auto/api/FadeIn.lua +++ b/cocos/scripting/lua-bindings/auto/api/FadeIn.lua @@ -12,8 +12,9 @@ -- @return FadeIn#FadeIn self (return value: cc.FadeIn) -------------------------------- --- creates the action
--- param d in seconds +-- Creates the action.
+-- param d Duration time, in seconds.
+-- return An autoreleased FadeIn object. -- @function [parent=#FadeIn] create -- @param self -- @param #float d diff --git a/cocos/scripting/lua-bindings/auto/api/FadeOut.lua b/cocos/scripting/lua-bindings/auto/api/FadeOut.lua index ff435c63f9..ee53f3037b 100644 --- a/cocos/scripting/lua-bindings/auto/api/FadeOut.lua +++ b/cocos/scripting/lua-bindings/auto/api/FadeOut.lua @@ -12,8 +12,8 @@ -- @return FadeOut#FadeOut self (return value: cc.FadeOut) -------------------------------- --- creates the action
--- param d in seconds +-- Creates the action.
+-- param d Duration time, in seconds. -- @function [parent=#FadeOut] create -- @param self -- @param #float d diff --git a/cocos/scripting/lua-bindings/auto/api/FadeTo.lua b/cocos/scripting/lua-bindings/auto/api/FadeTo.lua index 496e858cb2..da89a78b98 100644 --- a/cocos/scripting/lua-bindings/auto/api/FadeTo.lua +++ b/cocos/scripting/lua-bindings/auto/api/FadeTo.lua @@ -5,8 +5,10 @@ -- @parent_module cc -------------------------------- --- creates an action with duration and opacity
--- param duration in seconds +-- Creates an action with duration and opacity.
+-- param duration Duration time, in seconds.
+-- param opacity A certain opacity, the range is from 0 to 255.
+-- return An autoreleased FadeTo object. -- @function [parent=#FadeTo] create -- @param self -- @param #float duration @@ -33,7 +35,7 @@ -- @return FadeTo#FadeTo ret (return value: cc.FadeTo) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#FadeTo] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/FlipX.lua b/cocos/scripting/lua-bindings/auto/api/FlipX.lua index 5fd2e9f635..d4aec03f60 100644 --- a/cocos/scripting/lua-bindings/auto/api/FlipX.lua +++ b/cocos/scripting/lua-bindings/auto/api/FlipX.lua @@ -5,7 +5,9 @@ -- @parent_module cc -------------------------------- --- create the action +-- Create the action.
+-- param x Flips the sprite horizontally if true.
+-- return An autoreleased FlipX object. -- @function [parent=#FlipX] create -- @param self -- @param #bool x @@ -18,7 +20,7 @@ -- @return FlipX#FlipX ret (return value: cc.FlipX) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#FlipX] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/FlipY.lua b/cocos/scripting/lua-bindings/auto/api/FlipY.lua index 6e812d081f..a5249b575d 100644 --- a/cocos/scripting/lua-bindings/auto/api/FlipY.lua +++ b/cocos/scripting/lua-bindings/auto/api/FlipY.lua @@ -5,7 +5,9 @@ -- @parent_module cc -------------------------------- --- create the action +-- Create the action.
+-- param y Flips the sprite vertically if true.
+-- return An autoreleased FlipY object. -- @function [parent=#FlipY] create -- @param self -- @param #bool y @@ -18,7 +20,7 @@ -- @return FlipY#FlipY ret (return value: cc.FlipY) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#FlipY] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/Hide.lua b/cocos/scripting/lua-bindings/auto/api/Hide.lua index 01b9c01754..eaf0a678f3 100644 --- a/cocos/scripting/lua-bindings/auto/api/Hide.lua +++ b/cocos/scripting/lua-bindings/auto/api/Hide.lua @@ -5,7 +5,8 @@ -- @parent_module cc -------------------------------- --- Allocates and initializes the action +-- Allocates and initializes the action.
+-- return An autoreleased Hide object. -- @function [parent=#Hide] create -- @param self -- @return Hide#Hide ret (return value: cc.Hide) @@ -17,7 +18,7 @@ -- @return Hide#Hide ret (return value: cc.Hide) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#Hide] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/JumpBy.lua b/cocos/scripting/lua-bindings/auto/api/JumpBy.lua index 5848e73862..167aa0df79 100644 --- a/cocos/scripting/lua-bindings/auto/api/JumpBy.lua +++ b/cocos/scripting/lua-bindings/auto/api/JumpBy.lua @@ -5,8 +5,12 @@ -- @parent_module cc -------------------------------- --- creates the action
--- param duration in seconds +-- Creates the action.
+-- param duration Duration time, in seconds.
+-- param position The jumping distance.
+-- param height The jumping height.
+-- param jumps The jumping times.
+-- return An autoreleased JumpBy object. -- @function [parent=#JumpBy] create -- @param self -- @param #float duration @@ -35,7 +39,7 @@ -- @return JumpBy#JumpBy ret (return value: cc.JumpBy) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#JumpBy] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/JumpTo.lua b/cocos/scripting/lua-bindings/auto/api/JumpTo.lua index 12dc13ddba..bb6faf2ca4 100644 --- a/cocos/scripting/lua-bindings/auto/api/JumpTo.lua +++ b/cocos/scripting/lua-bindings/auto/api/JumpTo.lua @@ -5,8 +5,12 @@ -- @parent_module cc -------------------------------- --- creates the action
--- param duration in seconds +-- Creates the action.
+-- param duration Duration time, in seconds.
+-- param position The jumping destination position.
+-- param height The jumping height.
+-- param jumps The jumping times.
+-- return An autoreleased JumpTo object. -- @function [parent=#JumpTo] create -- @param self -- @param #float duration diff --git a/cocos/scripting/lua-bindings/auto/api/Label.lua b/cocos/scripting/lua-bindings/auto/api/Label.lua index 4d389c0c55..dad4b8b300 100644 --- a/cocos/scripting/lua-bindings/auto/api/Label.lua +++ b/cocos/scripting/lua-bindings/auto/api/Label.lua @@ -478,4 +478,12 @@ -- @param #color3b_table parentColor -- @return Label#Label self (return value: cc.Label) +-------------------------------- +-- +-- @function [parent=#Label] setCameraMask +-- @param self +-- @param #unsigned short mask +-- @param #bool applyChildren +-- @return Label#Label self (return value: cc.Label) + return nil diff --git a/cocos/scripting/lua-bindings/auto/api/Place.lua b/cocos/scripting/lua-bindings/auto/api/Place.lua index 347ddfc5a7..a8f7302df1 100644 --- a/cocos/scripting/lua-bindings/auto/api/Place.lua +++ b/cocos/scripting/lua-bindings/auto/api/Place.lua @@ -5,7 +5,9 @@ -- @parent_module cc -------------------------------- --- creates a Place action with a position +-- Creates a Place action with a position.
+-- param pos A certain position.
+-- return An autoreleased Place object. -- @function [parent=#Place] create -- @param self -- @param #vec2_table pos @@ -18,7 +20,7 @@ -- @return Place#Place ret (return value: cc.Place) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#Place] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/RemoveSelf.lua b/cocos/scripting/lua-bindings/auto/api/RemoveSelf.lua index 2c2c6b62df..97a3c0a7e0 100644 --- a/cocos/scripting/lua-bindings/auto/api/RemoveSelf.lua +++ b/cocos/scripting/lua-bindings/auto/api/RemoveSelf.lua @@ -5,7 +5,9 @@ -- @parent_module cc -------------------------------- --- create the action +-- Create the action.
+-- param isNeedCleanUp Is need to clean up, the default value is true.
+-- return An autoreleased RemoveSelf object. -- @function [parent=#RemoveSelf] create -- @param self -- @return RemoveSelf#RemoveSelf ret (return value: cc.RemoveSelf) @@ -17,7 +19,7 @@ -- @return RemoveSelf#RemoveSelf ret (return value: cc.RemoveSelf) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#RemoveSelf] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/Repeat.lua b/cocos/scripting/lua-bindings/auto/api/Repeat.lua index dd19d588e0..a8a69defbe 100644 --- a/cocos/scripting/lua-bindings/auto/api/Repeat.lua +++ b/cocos/scripting/lua-bindings/auto/api/Repeat.lua @@ -5,20 +5,25 @@ -- @parent_module cc -------------------------------- --- +-- Sets the inner action.
+-- param action The inner action. -- @function [parent=#Repeat] setInnerAction -- @param self -- @param #cc.FiniteTimeAction action -- @return Repeat#Repeat self (return value: cc.Repeat) -------------------------------- --- +-- Gets the inner action.
+-- return The inner action. -- @function [parent=#Repeat] getInnerAction -- @param self -- @return FiniteTimeAction#FiniteTimeAction ret (return value: cc.FiniteTimeAction) -------------------------------- --- creates a Repeat action. Times is an unsigned integer between 1 and pow(2,30) +-- Creates a Repeat action. Times is an unsigned integer between 1 and pow(2,30).
+-- param action The action needs to repeat.
+-- param times The repeat times.
+-- return An autoreleased Repeat object. -- @function [parent=#Repeat] create -- @param self -- @param #cc.FiniteTimeAction action @@ -51,7 +56,7 @@ -- @return Repeat#Repeat self (return value: cc.Repeat) -------------------------------- --- param dt in seconds +-- param dt In seconds. -- @function [parent=#Repeat] update -- @param self -- @param #float dt diff --git a/cocos/scripting/lua-bindings/auto/api/RepeatForever.lua b/cocos/scripting/lua-bindings/auto/api/RepeatForever.lua index 618307ccc2..c3ca792892 100644 --- a/cocos/scripting/lua-bindings/auto/api/RepeatForever.lua +++ b/cocos/scripting/lua-bindings/auto/api/RepeatForever.lua @@ -5,20 +5,24 @@ -- @parent_module cc -------------------------------- --- +-- Sets the inner action.
+-- param action The inner action. -- @function [parent=#RepeatForever] setInnerAction -- @param self -- @param #cc.ActionInterval action -- @return RepeatForever#RepeatForever self (return value: cc.RepeatForever) -------------------------------- --- +-- Gets the inner action.
+-- return The inner action. -- @function [parent=#RepeatForever] getInnerAction -- @param self -- @return ActionInterval#ActionInterval ret (return value: cc.ActionInterval) -------------------------------- --- creates the action +-- Creates the action.
+-- param action The action need to repeat forever.
+-- return An autoreleased RepeatForever object. -- @function [parent=#RepeatForever] create -- @param self -- @param #cc.ActionInterval action @@ -50,7 +54,7 @@ -- @return RepeatForever#RepeatForever ret (return value: cc.RepeatForever) -------------------------------- --- param dt in seconds +-- param dt In seconds. -- @function [parent=#RepeatForever] step -- @param self -- @param #float dt diff --git a/cocos/scripting/lua-bindings/auto/api/RotateBy.lua b/cocos/scripting/lua-bindings/auto/api/RotateBy.lua index c84bb5b013..55b4c2d000 100644 --- a/cocos/scripting/lua-bindings/auto/api/RotateBy.lua +++ b/cocos/scripting/lua-bindings/auto/api/RotateBy.lua @@ -35,7 +35,7 @@ -- @return RotateBy#RotateBy ret (return value: cc.RotateBy) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#RotateBy] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/RotateTo.lua b/cocos/scripting/lua-bindings/auto/api/RotateTo.lua index a335de693a..cd9e646b14 100644 --- a/cocos/scripting/lua-bindings/auto/api/RotateTo.lua +++ b/cocos/scripting/lua-bindings/auto/api/RotateTo.lua @@ -35,7 +35,7 @@ -- @return RotateTo#RotateTo ret (return value: cc.RotateTo) -------------------------------- --- param dt in seconds +-- param dt In seconds. -- @function [parent=#RotateTo] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/ScaleTo.lua b/cocos/scripting/lua-bindings/auto/api/ScaleTo.lua index 1e94538890..0b711f5686 100644 --- a/cocos/scripting/lua-bindings/auto/api/ScaleTo.lua +++ b/cocos/scripting/lua-bindings/auto/api/ScaleTo.lua @@ -36,7 +36,7 @@ -- @return ScaleTo#ScaleTo ret (return value: cc.ScaleTo) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#ScaleTo] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/Scene.lua b/cocos/scripting/lua-bindings/auto/api/Scene.lua index 1425478c09..f9866d5072 100644 --- a/cocos/scripting/lua-bindings/auto/api/Scene.lua +++ b/cocos/scripting/lua-bindings/auto/api/Scene.lua @@ -5,27 +5,32 @@ -- @parent_module cc -------------------------------- --- render the scene +-- Render the scene.
+-- param renderer The renderer use to render the scene. -- @function [parent=#Scene] render -- @param self -- @param #cc.Renderer renderer -- @return Scene#Scene self (return value: cc.Scene) -------------------------------- --- +-- Get the default camera.
+-- return The default camera of scene. -- @function [parent=#Scene] getDefaultCamera -- @param self -- @return Camera#Camera ret (return value: cc.Camera) -------------------------------- --- creates a new Scene object with a predefined Size +-- Creates a new Scene object with a predefined Size.
+-- param size The predefined size of scene.
+-- return An autoreleased Scene object. -- @function [parent=#Scene] createWithSize -- @param self -- @param #size_table size -- @return Scene#Scene ret (return value: cc.Scene) -------------------------------- --- creates a new Scene object +-- Creates a new Scene object.
+-- return An autoreleased Scene object. -- @function [parent=#Scene] create -- @param self -- @return Scene#Scene ret (return value: cc.Scene) diff --git a/cocos/scripting/lua-bindings/auto/api/Sequence.lua b/cocos/scripting/lua-bindings/auto/api/Sequence.lua index f51c7191c9..27dbe41fe5 100644 --- a/cocos/scripting/lua-bindings/auto/api/Sequence.lua +++ b/cocos/scripting/lua-bindings/auto/api/Sequence.lua @@ -30,7 +30,7 @@ -- @return Sequence#Sequence ret (return value: cc.Sequence) -------------------------------- --- param t in seconds +-- param t In seconds. -- @function [parent=#Sequence] update -- @param self -- @param #float t diff --git a/cocos/scripting/lua-bindings/auto/api/Show.lua b/cocos/scripting/lua-bindings/auto/api/Show.lua index 4239131ed8..b5029d7c78 100644 --- a/cocos/scripting/lua-bindings/auto/api/Show.lua +++ b/cocos/scripting/lua-bindings/auto/api/Show.lua @@ -5,7 +5,8 @@ -- @parent_module cc -------------------------------- --- Allocates and initializes the action +-- Allocates and initializes the action.
+-- return An autoreleased Show object. -- @function [parent=#Show] create -- @param self -- @return Show#Show ret (return value: cc.Show) @@ -17,7 +18,7 @@ -- @return Show#Show ret (return value: cc.Show) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#Show] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/SkewBy.lua b/cocos/scripting/lua-bindings/auto/api/SkewBy.lua index 06e999176e..7d7770e794 100644 --- a/cocos/scripting/lua-bindings/auto/api/SkewBy.lua +++ b/cocos/scripting/lua-bindings/auto/api/SkewBy.lua @@ -5,8 +5,11 @@ -- @parent_module cc -------------------------------- --- creates the action
--- param t in seconds +-- Creates the action.
+-- param t Duration time, in seconds.
+-- param deltaSkewX Skew x delta angle.
+-- param deltaSkewY Skew y delta angle.
+-- return An autoreleased SkewBy object. -- @function [parent=#SkewBy] create -- @param self -- @param #float t diff --git a/cocos/scripting/lua-bindings/auto/api/SkewTo.lua b/cocos/scripting/lua-bindings/auto/api/SkewTo.lua index 006572d0a8..2e07f7bbf6 100644 --- a/cocos/scripting/lua-bindings/auto/api/SkewTo.lua +++ b/cocos/scripting/lua-bindings/auto/api/SkewTo.lua @@ -5,8 +5,11 @@ -- @parent_module cc -------------------------------- --- creates the action
--- param t in seconds +-- Creates the action.
+-- param t Duration time, in seconds.
+-- param sx Skew x angle.
+-- param sy Skew y angle.
+-- return An autoreleased SkewTo object. -- @function [parent=#SkewTo] create -- @param self -- @param #float t @@ -34,7 +37,7 @@ -- @return SkewTo#SkewTo ret (return value: cc.SkewTo) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#SkewTo] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/Spawn.lua b/cocos/scripting/lua-bindings/auto/api/Spawn.lua index 52dc2fdaf1..99efefbfa8 100644 --- a/cocos/scripting/lua-bindings/auto/api/Spawn.lua +++ b/cocos/scripting/lua-bindings/auto/api/Spawn.lua @@ -30,7 +30,7 @@ -- @return Spawn#Spawn ret (return value: cc.Spawn) -------------------------------- --- param dt in seconds +-- param dt In seconds. -- @function [parent=#Spawn] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/SpriteFrame.lua b/cocos/scripting/lua-bindings/auto/api/SpriteFrame.lua index d4b64b8409..68acc861d4 100644 --- a/cocos/scripting/lua-bindings/auto/api/SpriteFrame.lua +++ b/cocos/scripting/lua-bindings/auto/api/SpriteFrame.lua @@ -11,105 +11,121 @@ -- @return SpriteFrame#SpriteFrame ret (return value: cc.SpriteFrame) -------------------------------- --- +-- Set rotated of the sprite frame.
+-- param rotated Rotated the sprite frame if true. -- @function [parent=#SpriteFrame] setRotated -- @param self -- @param #bool rotated -- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame) -------------------------------- --- set texture of the frame, the texture is retained +-- Set texture of the frame, the texture is retained.
+-- param pobTexture The texture of the sprite frame. -- @function [parent=#SpriteFrame] setTexture -- @param self -- @param #cc.Texture2D pobTexture -- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame) -------------------------------- --- +-- Get offset of the frame.
+-- return The offset of the sprite frame. -- @function [parent=#SpriteFrame] getOffset -- @param self -- @return vec2_table#vec2_table ret (return value: vec2_table) -------------------------------- --- +-- Set rect of the sprite frame.
+-- param rectInPixels The rect of the sprite frame, in pixels. -- @function [parent=#SpriteFrame] setRectInPixels -- @param self -- @param #rect_table rectInPixels -- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame) -------------------------------- --- get texture of the frame +-- Get texture of the frame.
+-- return The texture of the sprite frame. -- @function [parent=#SpriteFrame] getTexture -- @param self -- @return Texture2D#Texture2D ret (return value: cc.Texture2D) -------------------------------- --- get rect of the frame +-- Get rect of the frame.
+-- return The rect of the sprite frame. -- @function [parent=#SpriteFrame] getRect -- @param self -- @return rect_table#rect_table ret (return value: rect_table) -------------------------------- --- set offset of the frame +-- Set offset of the frame.
+-- param offsetInPixels The offset of the sprite frame, in pixels. -- @function [parent=#SpriteFrame] setOffsetInPixels -- @param self -- @param #vec2_table offsetInPixels -- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame) -------------------------------- --- +-- Get rect of the sprite frame.
+-- return The rect of the sprite frame, in pixels. -- @function [parent=#SpriteFrame] getRectInPixels -- @param self -- @return rect_table#rect_table ret (return value: rect_table) -------------------------------- --- set original size of the trimmed image +-- Set original size of the trimmed image.
+-- param sizeInPixels The original size of the trimmed image. -- @function [parent=#SpriteFrame] setOriginalSize -- @param self -- @param #size_table sizeInPixels -- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame) -------------------------------- --- get original size of the trimmed image +-- Get original size of the trimmed image.
+-- return The original size of the trimmed image, in pixels. -- @function [parent=#SpriteFrame] getOriginalSizeInPixels -- @param self -- @return size_table#size_table ret (return value: size_table) -------------------------------- --- set original size of the trimmed image +-- Set original size of the trimmed image.
+-- param sizeInPixels The original size of the trimmed image, in pixels. -- @function [parent=#SpriteFrame] setOriginalSizeInPixels -- @param self -- @param #size_table sizeInPixels -- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame) -------------------------------- --- +-- Set offset of the frame.
+-- param offsets The offset of the sprite frame. -- @function [parent=#SpriteFrame] setOffset -- @param self -- @param #vec2_table offsets -- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame) -------------------------------- --- +-- Is the sprite frame rotated or not.
+-- return Is rotated if true. -- @function [parent=#SpriteFrame] isRotated -- @param self -- @return bool#bool ret (return value: bool) -------------------------------- --- set rect of the frame +-- Set rect of the frame.
+-- param The rect of the sprite. -- @function [parent=#SpriteFrame] setRect -- @param self -- @param #rect_table rect -- @return SpriteFrame#SpriteFrame self (return value: cc.SpriteFrame) -------------------------------- --- get offset of the frame +-- Get offset of the frame.
+-- return The offset of the sprite frame, in pixels. -- @function [parent=#SpriteFrame] getOffsetInPixels -- @param self -- @return vec2_table#vec2_table ret (return value: vec2_table) -------------------------------- --- get original size of the trimmed image +-- Get original size of the trimmed image.
+-- return The original size of the trimmed image. -- @function [parent=#SpriteFrame] getOriginalSize -- @param self -- @return size_table#size_table ret (return value: size_table) diff --git a/cocos/scripting/lua-bindings/auto/api/SpriteFrameCache.lua b/cocos/scripting/lua-bindings/auto/api/SpriteFrameCache.lua index 5e61dfb4b9..c07ec82113 100644 --- a/cocos/scripting/lua-bindings/auto/api/SpriteFrameCache.lua +++ b/cocos/scripting/lua-bindings/auto/api/SpriteFrameCache.lua @@ -7,7 +7,9 @@ -------------------------------- -- Adds multiple Sprite Frames from a plist file content. The texture will be associated with the created sprite frames.
-- js addSpriteFrames
--- lua addSpriteFrames +-- lua addSpriteFrames
+-- param plist_content Plist file content string.
+-- param texture Texture pointer. -- @function [parent=#SpriteFrameCache] addSpriteFramesWithFileContent -- @param self -- @param #string plist_content @@ -26,7 +28,9 @@ -------------------------------- -- Adds an sprite frame with a given name.
--- If the name already exists, then the contents of the old name will be replaced with the new one. +-- If the name already exists, then the contents of the old name will be replaced with the new one.
+-- param frame A certain sprite frame.
+-- param frameName The name of the sprite frame. -- @function [parent=#SpriteFrameCache] addSpriteFrame -- @param self -- @param #cc.SpriteFrame frame @@ -46,7 +50,9 @@ -- If the name is not found it will return nil.
-- You should retain the returned copy if you are going to use it.
-- js getSpriteFrame
--- lua getSpriteFrame +-- lua getSpriteFrame
+-- param name A certain sprite frame name.
+-- return The sprite frame. -- @function [parent=#SpriteFrameCache] getSpriteFrameByName -- @param self -- @param #string name @@ -56,14 +62,16 @@ -- Removes multiple Sprite Frames from a plist file.
-- Sprite Frames stored in this file will be removed.
-- It is convenient to call this method when a specific texture needs to be removed.
--- since v0.99.5 +-- since v0.99.5
+-- param plist The name of the plist that needs to removed. -- @function [parent=#SpriteFrameCache] removeSpriteFramesFromFile -- @param self -- @param #string plist -- @return SpriteFrameCache#SpriteFrameCache self (return value: cc.SpriteFrameCache) -------------------------------- --- +-- Initialize method.
+-- return if success return true. -- @function [parent=#SpriteFrameCache] init -- @param self -- @return bool#bool ret (return value: bool) @@ -81,7 +89,8 @@ -------------------------------- -- Removes all Sprite Frames associated with the specified textures.
-- It is convenient to call this method when a specific texture needs to be removed.
--- since v0.995. +-- since v0.995.
+-- param texture The texture that needs to removed. -- @function [parent=#SpriteFrameCache] removeSpriteFramesFromTexture -- @param self -- @param #cc.Texture2D texture @@ -90,27 +99,30 @@ -------------------------------- -- Removes multiple Sprite Frames from a plist file content.
-- Sprite Frames stored in this file will be removed.
--- It is convenient to call this method when a specific texture needs to be removed. +-- It is convenient to call this method when a specific texture needs to be removed.
+-- param plist_content The string of the plist content that needs to removed. -- @function [parent=#SpriteFrameCache] removeSpriteFramesFromFileContent -- @param self -- @param #string plist_content -- @return SpriteFrameCache#SpriteFrameCache self (return value: cc.SpriteFrameCache) -------------------------------- --- Deletes an sprite frame from the sprite frame cache. +-- Deletes an sprite frame from the sprite frame cache.
+-- param name The name of the sprite frame that needs to removed. -- @function [parent=#SpriteFrameCache] removeSpriteFrameByName -- @param self -- @param #string name -- @return SpriteFrameCache#SpriteFrameCache self (return value: cc.SpriteFrameCache) -------------------------------- --- Destroys the cache. It releases all the Sprite Frames and the retained instance. +-- Destroys the cache. It releases all the Sprite Frames and the retained instance. -- @function [parent=#SpriteFrameCache] destroyInstance -- @param self -- @return SpriteFrameCache#SpriteFrameCache self (return value: cc.SpriteFrameCache) -------------------------------- --- Returns the shared instance of the Sprite Frame cache +-- Returns the shared instance of the Sprite Frame cache.
+-- return The instance of the Sprite Frame Cache. -- @function [parent=#SpriteFrameCache] getInstance -- @param self -- @return SpriteFrameCache#SpriteFrameCache ret (return value: cc.SpriteFrameCache) diff --git a/cocos/scripting/lua-bindings/auto/api/TargetedAction.lua b/cocos/scripting/lua-bindings/auto/api/TargetedAction.lua index 0b7bcb475a..9c94b325b6 100644 --- a/cocos/scripting/lua-bindings/auto/api/TargetedAction.lua +++ b/cocos/scripting/lua-bindings/auto/api/TargetedAction.lua @@ -12,14 +12,18 @@ -- @return Node#Node ret (return value: cc.Node) -------------------------------- --- Sets the target that the action will be forced to run with +-- Sets the target that the action will be forced to run with.
+-- param forcedTarget The target that the action will be forced to run with. -- @function [parent=#TargetedAction] setForcedTarget -- @param self -- @param #cc.Node forcedTarget -- @return TargetedAction#TargetedAction self (return value: cc.TargetedAction) -------------------------------- --- Create an action with the specified action and forced target +-- Create an action with the specified action and forced target.
+-- param target The target needs to override.
+-- param action The action needs to override.
+-- return An autoreleased TargetedAction object. -- @function [parent=#TargetedAction] create -- @param self -- @param #cc.Node target @@ -52,7 +56,7 @@ -- @return TargetedAction#TargetedAction ret (return value: cc.TargetedAction) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#TargetedAction] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/TintBy.lua b/cocos/scripting/lua-bindings/auto/api/TintBy.lua index 685973f75c..389dbfe440 100644 --- a/cocos/scripting/lua-bindings/auto/api/TintBy.lua +++ b/cocos/scripting/lua-bindings/auto/api/TintBy.lua @@ -5,8 +5,12 @@ -- @parent_module cc -------------------------------- --- creates an action with duration and color
--- param duration in seconds +-- Creates an action with duration and color.
+-- param duration Duration time, in seconds.
+-- param deltaRed Delta red color.
+-- param deltaGreen Delta green color.
+-- param deltaBlue Delta blue color.
+-- return An autoreleased TintBy object. -- @function [parent=#TintBy] create -- @param self -- @param #float duration @@ -35,7 +39,7 @@ -- @return TintBy#TintBy ret (return value: cc.TintBy) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#TintBy] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/TintTo.lua b/cocos/scripting/lua-bindings/auto/api/TintTo.lua index 86c5032d04..c99dcfe625 100644 --- a/cocos/scripting/lua-bindings/auto/api/TintTo.lua +++ b/cocos/scripting/lua-bindings/auto/api/TintTo.lua @@ -35,7 +35,7 @@ -- @return TintTo#TintTo ret (return value: cc.TintTo) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#TintTo] update -- @param self -- @param #float time diff --git a/cocos/scripting/lua-bindings/auto/api/ToggleVisibility.lua b/cocos/scripting/lua-bindings/auto/api/ToggleVisibility.lua index a95136e69a..e014680cb3 100644 --- a/cocos/scripting/lua-bindings/auto/api/ToggleVisibility.lua +++ b/cocos/scripting/lua-bindings/auto/api/ToggleVisibility.lua @@ -5,7 +5,8 @@ -- @parent_module cc -------------------------------- --- Allocates and initializes the action +-- Allocates and initializes the action.
+-- return An autoreleased ToggleVisibility object. -- @function [parent=#ToggleVisibility] create -- @param self -- @return ToggleVisibility#ToggleVisibility ret (return value: cc.ToggleVisibility) @@ -17,7 +18,7 @@ -- @return ToggleVisibility#ToggleVisibility ret (return value: cc.ToggleVisibility) -------------------------------- --- param time in seconds +-- param time In seconds. -- @function [parent=#ToggleVisibility] update -- @param self -- @param #float time