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

163 lines
5.8 KiB
Lua
Raw Normal View History

2014-03-10 14:04:58 +08:00
--------------------------------
-- @module PhysicsWorld
-- @parent_module cc
2014-03-10 14:04:58 +08:00
--------------------------------
-- set the gravity value
-- @function [parent=#PhysicsWorld] setGravity
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #vec2_table gravity
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get all the bodys that in the physics world.
2014-03-10 14:04:58 +08:00
-- @function [parent=#PhysicsWorld] getAllBodies
-- @param self
-- @return array_table#array_table ret (return value: array_table)
--------------------------------
-- get the bebug draw mask
-- @function [parent=#PhysicsWorld] getDebugDrawMask
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- set the number of substeps in an update of the physics world.<br>
-- One physics update will be divided into several substeps to increase its accuracy.<br>
-- default value is 1
-- @function [parent=#PhysicsWorld] setSubsteps
-- @param self
-- @param #int steps
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
2014-03-10 14:04:58 +08:00
--------------------------------
-- To control the step of physics, if you want control it by yourself( fixed-timestep for example ), you can set this to false and call step by yourself.<br>
-- Defaut value is true.<br>
-- Note: if you set auto step to false, setSpeed setSubsteps and setUpdateRate won't work, you need to control the time step by yourself.
-- @function [parent=#PhysicsWorld] setAutoStep
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #bool autoStep
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
--------------------------------
-- Adds a joint to the physics world.
-- @function [parent=#PhysicsWorld] addJoint
-- @param self
-- @param #cc.PhysicsJoint joint
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
--------------------------------
-- Remove all joints from physics world.
-- @function [parent=#PhysicsWorld] removeAllJoints
-- @param self
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
--------------------------------
-- Get the auto step
-- @function [parent=#PhysicsWorld] isAutoStep
-- @param self
-- @return bool#bool ret (return value: bool)
2014-03-10 14:04:58 +08:00
--------------------------------
-- @overload self, int
-- @overload self, cc.PhysicsBody
2014-03-10 14:04:58 +08:00
-- @function [parent=#PhysicsWorld] removeBody
-- @param self
-- @param #cc.PhysicsBody body
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Remove a joint from physics world.
2014-03-10 14:04:58 +08:00
-- @function [parent=#PhysicsWorld] removeJoint
-- @param self
-- @param #cc.PhysicsJoint joint
-- @param #bool destroy
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get phsyics shapes that contains the point.
-- @function [parent=#PhysicsWorld] getShapes
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #vec2_table point
-- @return array_table#array_table ret (return value: array_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- The step for physics world, The times passing for simulate the physics.<br>
-- Note: you need to setAutoStep(false) first before it can work.
-- @function [parent=#PhysicsWorld] step
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #float delta
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
2014-03-10 14:04:58 +08:00
--------------------------------
-- set the debug draw mask
-- @function [parent=#PhysicsWorld] setDebugDrawMask
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #int mask
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
2014-03-10 14:04:58 +08:00
--------------------------------
-- get the gravity value
-- @function [parent=#PhysicsWorld] getGravity
2014-03-10 14:04:58 +08:00
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
2014-03-10 14:04:58 +08:00
--------------------------------
-- set the update rate of physics world, update rate is the value of EngineUpdateTimes/PhysicsWorldUpdateTimes.<br>
-- set it higher can improve performance, set it lower can improve accuracy of physics world simulation.<br>
-- default value is 1.0<br>
-- Note: if you setAutoStep(false), this won't work.
-- @function [parent=#PhysicsWorld] setUpdateRate
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #int rate
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
2014-03-10 14:04:58 +08:00
--------------------------------
-- get the number of substeps
-- @function [parent=#PhysicsWorld] getSubsteps
-- @param self
-- @return int#int ret (return value: int)
2014-03-10 14:04:58 +08:00
--------------------------------
-- get the speed of physics world
-- @function [parent=#PhysicsWorld] getSpeed
2014-03-10 14:04:58 +08:00
-- @param self
-- @return float#float ret (return value: float)
2014-03-10 14:04:58 +08:00
--------------------------------
-- get the update rate
-- @function [parent=#PhysicsWorld] getUpdateRate
2014-03-10 14:04:58 +08:00
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- Remove all bodies from physics world.
-- @function [parent=#PhysicsWorld] removeAllBodies
2014-03-10 14:04:58 +08:00
-- @param self
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Set the speed of physics world, speed is the rate at which the simulation executes. default value is 1.0<br>
-- Note: if you setAutoStep(false), this won't work.
-- @function [parent=#PhysicsWorld] setSpeed
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #float speed
-- @return PhysicsWorld#PhysicsWorld self (return value: cc.PhysicsWorld)
2014-03-10 14:04:58 +08:00
--------------------------------
-- return physics shape that contains the point.
-- @function [parent=#PhysicsWorld] getShape
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #vec2_table point
-- @return PhysicsShape#PhysicsShape ret (return value: cc.PhysicsShape)
2014-03-10 14:04:58 +08:00
--------------------------------
-- Get body by tag
-- @function [parent=#PhysicsWorld] getBody
2014-03-10 14:04:58 +08:00
-- @param self
-- @param #int tag
-- @return PhysicsBody#PhysicsBody ret (return value: cc.PhysicsBody)
2014-03-10 14:04:58 +08:00
return nil