CreateGearJoint

Family: 2DPhysics · 2 forms

What it does

CreateGearJoint brings a 2DPhysics object into being: it is how the rest of the program comes to have one. It takes jointID (an integer), jointID1 (an integer), jointID2 (an integer) and ratio (a float), and returns nothing. That is the first of 2 forms. jointID is the id you are giving a Joint object: every later call names it by that number.

Syntax

1
CreateGearJoint(jointID integer, jointID1 integer, jointID2 integer, ratio float)
2
CreateGearJoint(jointID1 integer, jointID2 integer, ratio float) → integer

Parameters

NameTypeIn forms
jointIDinteger1
jointID1integerall
jointID2integerall
ratiofloatall

What each form returns

1CreateGearJoint(1, 1, 1, 1.0)nothing
2gearJoint = CreateGearJoint(1, 1, 1.0)integer

Example · generated

Form 1, you choose the id yourself

CreateGearJoint(1, 1, 1, 1.0)DO  Sync()LOOP

Form 2, the command hands back the id

gearJoint = CreateGearJoint(1, 1, 1.0)DO  Sync()LOOP

CreateGearJoint is called with values of the types its signature asks for. The DO … LOOP is not decoration: a classic BASIC program ends the moment it runs out of lines, and Sync() is what draws the frame.

66 commands in 2DPhysics