Difference between revisions of "B2.createWheelJointDef"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
<languages />
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[Special:MyLanguage/b2|b2]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
Creates and returns a wheel joint definition table.
Creates and returns a wheel joint definition table.<br />
+
 
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a wheel joint).<br />
+
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a wheel joint).
<br />
+
<syntaxhighlight lang="lua">
<source lang="lua">
 
 
(table) = b2.createWheelJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)
 
(table) = b2.createWheelJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)
</source>
+
</syntaxhighlight>
 +
 
 
=== Parameters ===
 
=== Parameters ===
 
'''bodyA''': (b2.Body) the first attached body <br/>
 
'''bodyA''': (b2.Body) the first attached body <br/>
Line 16: Line 19:
 
'''axisx''': (number) the x coordinate of the world translation axis in bodyA <br/>
 
'''axisx''': (number) the x coordinate of the world translation axis in bodyA <br/>
 
'''axisy''': (number) the y coordinate of the world translation axis in bodyA <br/>
 
'''axisy''': (number) the y coordinate of the world translation axis in bodyA <br/>
 +
 
=== Return values ===
 
=== Return values ===
'''Returns''' (table) A new wheel joint definition table<br/>
+
'''Returns''' (table) a new wheel joint definition table<br/>
 +
 
 
=== Examples ===
 
=== Examples ===
'''Wheel joint'''<br/>
+
'''Wheel joint'''
<source lang="lua">--create empty box2d body for joint
+
<syntaxhighlight lang="lua">
 +
--create empty box2d body for joint
 
local ground = world:createBody({})
 
local ground = world:createBody({})
 
ground:setPosition(350, 480)
 
ground:setPosition(350, 480)
  
--axisx, axisy values usually between 0 and 1
+
--axisx, axisy values usually between 0 and 1
--0 0 moves freely
+
--0 0 moves freely
--0 1 force pulling back on y axis
+
--0 1 force pulling back on y axis
--1 0 force pulling back on x axis
+
--1 0 force pulling back on x axis
--1 1 force pulling back all diretions
+
--1 1 force pulling back all diretions
 
local jointDef = b2.createWheelJointDef(body, ground, 350, 200, 1, 1)
 
local jointDef = b2.createWheelJointDef(body, ground, 350, 200, 1, 1)
local wheelJoint = world:createJoint(jointDef)</source>
+
local wheelJoint = world:createJoint(jointDef)
 +
</syntaxhighlight>
 +
 
 +
{{B2}}

Latest revision as of 15:27, 13 July 2023


Available since: Gideros 2011.6
Class: b2

Description

Creates and returns a wheel joint definition table.

(Please refer to b2.World:createJoint function for more information about all the information needed to create a wheel joint).

(table) = b2.createWheelJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)

Parameters

bodyA: (b2.Body) the first attached body
bodyB: (b2.Body) the second attached body
anchorx: (number) the x coordinate of the world anchor point
anchory: (number) the y coordinate of the world anchor point
axisx: (number) the x coordinate of the world translation axis in bodyA
axisy: (number) the y coordinate of the world translation axis in bodyA

Return values

Returns (table) a new wheel joint definition table

Examples

Wheel joint

--create empty box2d body for joint
local ground = world:createBody({})
ground:setPosition(350, 480)

--axisx, axisy values usually between 0 and 1
--0 0 moves freely
--0 1 force pulling back on y axis
--1 0 force pulling back on x axis
--1 1 force pulling back all diretions
local jointDef = b2.createWheelJointDef(body, ground, 350, 200, 1, 1)
local wheelJoint = world:createJoint(jointDef)





LiquidFun