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

66 lines
2.2 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module Waves3D
-- @extend Grid3DAction
-- @parent_module cc
2014-03-10 14:04:58 +08:00
--------------------------------
-- brief Get the amplitude rate of the effect.<br>
-- return Return the amplitude rate of the effect.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Waves3D] getAmplitudeRate
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- brief Set the amplitude to the effect.<br>
-- param amplitude The value of amplitude will be set.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Waves3D] setAmplitude
-- @param self
-- @param #float amplitude
-- @return Waves3D#Waves3D self (return value: cc.Waves3D)
2014-03-10 14:04:58 +08:00
--------------------------------
-- brief Set the ampliture rate of the effect.<br>
-- param amplitudeRate The value of amplitude rate will be set.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Waves3D] setAmplitudeRate
-- @param self
-- @param #float amplitudeRate
-- @return Waves3D#Waves3D self (return value: cc.Waves3D)
2014-03-10 14:04:58 +08:00
--------------------------------
-- brief Get the amplitude of the effect.<br>
-- return Return the amplitude of the effect.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Waves3D] getAmplitude
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- brief Create an action with duration, grid size, waves and amplitude.<br>
-- param duration Specify the duration of the Waves3D action. It's a value in seconds.<br>
-- param gridSize Specify the size of the grid.<br>
-- param waves Specify the waves count of the Waves3D action.<br>
-- param amplitude Specify the amplitude of the Waves3D action.<br>
-- return If the creation sucess, return a pointer of Waves3D action; otherwise, return nil.
2014-03-10 14:04:58 +08:00
-- @function [parent=#Waves3D] create
-- @param self
-- @param #float duration
-- @param #size_table gridSize
-- @param #unsigned int waves
-- @param #float amplitude
2014-03-10 14:04:58 +08:00
-- @return Waves3D#Waves3D ret (return value: cc.Waves3D)
--------------------------------
--
-- @function [parent=#Waves3D] clone
-- @param self
-- @return Waves3D#Waves3D ret (return value: cc.Waves3D)
--------------------------------
--
-- @function [parent=#Waves3D] update
-- @param self
-- @param #float time
-- @return Waves3D#Waves3D self (return value: cc.Waves3D)
2014-03-10 14:04:58 +08:00
return nil