Class: Box2dObject

Constructor

new Box2dObject(posopt, sizeopt, tileInfoopt, angleopt, coloropt, bodyTypeopt, renderOrderopt)

Create a LittleJS object with Box2d physics

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2	<optional>
`size`	Vector2	<optional>
`tileInfo`	TileInfo	<optional>
`angle`	number	<optional>	0
`color`	Color	<optional>
`bodyType`	number	<optional>
`renderOrder`	number	<optional>	0

Source: plugins/box2d.js, line 43

Extends

EngineObject

Members

additiveColor

Properties

Type	Description
Color	Additive color to apply when rendered

Overrides: EngineObject#additiveColor
Source: src/engineObject.js, line 65

angle

Properties

Type	Description
number	Angle to rotate the object

Overrides: EngineObject#angle
Source: src/engineObject.js, line 61

angleDamping

Properties

Name	Type	Attributes	Default	Description
`angleDamping`	number	<optional>	objectDefaultAngleDamping	How much to slow down rotation each frame (0-1)

Overrides: EngineObject#angleDamping
Source: src/engineObject.js, line 75

angleVelocity

Properties

Type	Description
number	Angular velocity of the object

Overrides: EngineObject#angleVelocity
Source: src/engineObject.js, line 87

children

Properties

Type	Description
Array.<EngineObject>	List of children of this object

Overrides: EngineObject#children
Source: src/engineObject.js, line 91

clampSpeed

Properties

Type	Description
boolean	Limit object speed along x and y axis

Overrides: EngineObject#clampSpeed
Source: src/engineObject.js, line 93

collideRaycast

Properties

Type	Description
boolean	Object collides with raycasts

Overrides: EngineObject#collideRaycast
Source: src/engineObject.js, line 113

collideSolidObjects

Properties

Type	Description
boolean	Object collides with solid objects

Overrides: EngineObject#collideSolidObjects
Source: src/engineObject.js, line 109

collideTiles

Properties

Type	Description
boolean	Object collides with the tile collision

Overrides: EngineObject#collideTiles
Source: src/engineObject.js, line 107

color

Properties

Type	Description
Color	Color to apply when rendered

Overrides: EngineObject#color
Source: src/engineObject.js, line 63

damping

Properties

Name	Type	Attributes	Default	Description
`damping`	number	<optional>	objectDefaultDamping	How much to slow down velocity each frame (0-1)

Overrides: EngineObject#damping
Source: src/engineObject.js, line 73

drawSize

Properties

Type	Description
Vector2	Size of object used for drawing, uses size if not set

Overrides: EngineObject#drawSize
Source: src/engineObject.js, line 57

friction

Properties

Name	Type	Attributes	Default	Description
`friction`	number	<optional>	objectDefaultFriction	How much friction to apply when sliding (0-1)

Overrides: EngineObject#friction
Source: src/engineObject.js, line 79

gravityScale

Properties

Type	Description
number	How much to scale gravity by for this object

Overrides: EngineObject#gravityScale
Source: src/engineObject.js, line 81

groundObject

Properties

Type	Description
EngineObject	Object we are standing on, if any

Overrides: EngineObject#groundObject
Source: src/engineObject.js, line 95

isSolid

Properties

Type	Description
boolean	Object collides with and blocks other objects

Overrides: EngineObject#isSolid
Source: src/engineObject.js, line 111

localAngle

Properties

Type	Description
number	Local angle if child

Overrides: EngineObject#localAngle
Source: src/engineObject.js, line 103

localPos

Properties

Type	Description
Vector2	Local position if child

Overrides: EngineObject#localPos
Source: src/engineObject.js, line 101

mass

Properties

Name	Type	Attributes	Default	Description
`mass`	number	<optional>	objectDefaultMass	How heavy the object is, static if 0

Overrides: EngineObject#mass
Source: src/engineObject.js, line 71

mirror

Properties

Type	Description
boolean	Should it flip along y axis when rendered

Overrides: EngineObject#mirror
Source: src/engineObject.js, line 67

parent

Properties

Type	Description
EngineObject	Parent of object if in local space

Overrides: EngineObject#parent
Source: src/engineObject.js, line 99

pos

Properties

Type	Description
Vector2	World space position of the object

Overrides: EngineObject#pos
Source: src/engineObject.js, line 53

renderOrder

Properties

Type	Description
number	Objects are sorted by render order

Overrides: EngineObject#renderOrder
Source: src/engineObject.js, line 83

restitution

Properties

Name	Type	Attributes	Default	Description
`restitution`	number	<optional>	objectDefaultRestitution	How bouncy the object is when colliding (0-1)

Overrides: EngineObject#restitution
Source: src/engineObject.js, line 77

size

Properties

Type	Description
Vector2	World space width and height of the object

Overrides: EngineObject#size
Source: src/engineObject.js, line 55

spawnTime

Properties

Type	Description
number	Track when object was created

Overrides: EngineObject#spawnTime
Source: src/engineObject.js, line 89

tileInfo

Properties

Type	Description
TileInfo	Tile info to render object (undefined is untextured)

Overrides: EngineObject#tileInfo
Source: src/engineObject.js, line 59

velocity

Properties

Type	Description
Vector2	Velocity of the object

Overrides: EngineObject#velocity
Source: src/engineObject.js, line 85

Methods

addBox(sizeopt, offsetopt, angleopt, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a box shape to the body

Parameters:

Name	Type	Attributes	Default
`size`	Vector2	<optional>
`offset`	Vector2	<optional>
`angle`	number	<optional>	0
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 153

addChild(child, localPosopt, localAngleopt)

Attaches a child to this with a given local transform

Parameters:

Name	Type	Attributes	Default
`child`	EngineObject
`localPos`	Vector2	<optional>	(0,0)
`localAngle`	number	<optional>	0

Overrides: EngineObject#addChild
Source: src/engineObject.js, line 402

addCircle(diameteropt, offsetopt, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a circle shape to the body

Parameters:

Name	Type	Attributes	Default
`diameter`	number	<optional>	1
`offset`	Vector2	<optional>
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 233

addEdge(point1, point2, densityopt, frictionopt, restitutionopt, isSensoropt)

Add an edge shape to the body

Parameters:

Name	Type	Attributes
`point1`	Vector2
`point2`	Vector2
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 248

addEdgeList(points, densityopt, frictionopt, restitutionopt, isSensoropt)

Add an edge list to the body

Parameters:

Name	Type	Attributes
`points`	Array.<Vector2>
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 284

addEdgeLoop(points, densityopt, frictionopt, restitutionopt, isSensoropt)

Add an edge loop to the body, an edge loop connects the end points

Parameters:

Name	Type	Attributes
`points`	Array.<Vector2>
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 261

addPoly(points, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a polygon shape to the body

Parameters:

Name	Type	Attributes
`points`	Array.<Vector2>
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 166

addRandomPoly(diameteropt, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a random polygon shape to the body

Parameters:

Name	Type	Attributes	Default
`diameter`	number	<optional>	1
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 216

addRegularPoly(diameteropt, sidesopt, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a regular polygon shape to the body

Parameters:

Name	Type	Attributes	Default
`diameter`	number	<optional>	1
`sides`	number	<optional>	8
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 201

addShape(shape, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a shape fixture to the body

Parameters:

Name	Type	Attributes	Default
`shape`	Object
`density`	number	<optional>	1
`friction`	number	<optional>	0.2
`restitution`	number	<optional>	0
`isSensor`	boolean	<optional>	false

Source: plugins/box2d.js, line 134

applyAcceleration(acceleration, posopt)

Apply acceleration to this object

Parameters:

Name	Type	Attributes	Description
`acceleration`	Vector2
`pos`	Vector2	<optional>

Overrides: EngineObject#applyAcceleration
Source: plugins/box2d.js, line 457

applyAngularAcceleration(acceleration)

Apply angular acceleration to this object

Parameters:

Name	Type	Description
`acceleration`	number

Overrides: EngineObject#applyAngularAcceleration
Source: plugins/box2d.js, line 474

applyForce(force, posopt)

Apply force to this object

Parameters:

Name	Type	Attributes	Description
`force`	Vector2
`pos`	Vector2	<optional>

Overrides: EngineObject#applyForce
Source: plugins/box2d.js, line 447

applyTorque(torque)

Apply torque to this object

Parameters:

Name	Type	Description
`torque`	number

Source: plugins/box2d.js, line 466

beginContact(otherObject)

Called when a contact begins

Parameters:

Name	Type	Description
`otherObject`	Box2dObject

Source: plugins/box2d.js, line 119

collideWithObject(object) → {boolean}

Called to check if a object collision should be resolved

Parameters:

Name	Type	Description
`object`	EngineObject	the object to test against

Overrides: EngineObject#collideWithObject
Source: src/engineObject.js, line 373

Returns:

true if the collision should be resolved

Type:: boolean

collideWithTile(tileData, pos) → {boolean}

Called to check if a tile collision should be resolved

Parameters:

Name	Type	Description
`tileData`	number	the value of the tile at the position
`pos`	Vector2	tile where the collision occurred

Overrides: EngineObject#collideWithTile
Source: src/engineObject.js, line 367

Returns:

true if the collision should be resolved

Type:: boolean

destroy()

Destroy this object and it's physics body

Overrides: EngineObject#destroy
Source: plugins/box2d.js, line 68

drawFixtures(coloropt, lineColoropt, lineWidthopt, contextopt)

Draws all this object's fixtures

Parameters:

Name	Type	Attributes	Default
`color`	Color	<optional>
`lineColor`	Color	<optional>
`lineWidth`	number	<optional>	0.1
`context`	CanvasRenderingContext2D	<optional>

Source: plugins/box2d.js, line 108

endContact(otherObject)

Called when a contact ends

Parameters:

Name	Type	Description
`otherObject`	Box2dObject

Source: plugins/box2d.js, line 123

getAliveTime() → {number}

How long since the object was created

Overrides: EngineObject#getAliveTime
Source: src/engineObject.js, line 377

Returns:

Type:: number

getAngularVelocity() → {Vector2}

Gets the angular velocity

Source: plugins/box2d.js, line 313

Returns:

Type:: Vector2

getBodyType() → {number}

Gets the physics body type

Source: plugins/box2d.js, line 329

Returns:

Type:: number

getCenterOfMass() → {Vector2}

Gets the center of mass

Source: plugins/box2d.js, line 305

Returns:

Type:: Vector2

getFixtureList() → {Array.<Object>}

Get list of fixtures for this object

Source: plugins/box2d.js, line 489

Returns:

Type:: Array.<Object>

getInertia() → {number}

Gets the rotational inertia

Source: plugins/box2d.js, line 321

Returns:

Type:: number

getIsAwake() → {boolean}

Check if this object is awake

Source: plugins/box2d.js, line 325

Returns:

Type:: boolean

getJointList() → {Array.<Object>}

Get list of joints for this object

Source: plugins/box2d.js, line 506

Returns:

Type:: Array.<Object>

getLinearVelocity() → {Vector2}

Gets the linear velocity

Source: plugins/box2d.js, line 309

Returns:

Type:: Vector2

getMass() → {number}

Gets the mass

Source: plugins/box2d.js, line 317

Returns:

Type:: number

getMirrorSign() → {number}

Get the direction of the mirror

Overrides: EngineObject#getMirrorSign
Source: src/engineObject.js, line 396

Returns:

-1 if this.mirror is true, or 1 if not mirrored

Type:: number

hasFixtures() → {boolean}

Check if this object has any fixtures

Source: plugins/box2d.js, line 485

Returns:

Type:: boolean

hasJoints() → {boolean}

Check if this object has any joints

Source: plugins/box2d.js, line 502

Returns:

Type:: boolean

localToWorld(pos)

Convert from local space to world space

Parameters:

Name	Type	Description
`pos`	Vector2	local space point

Overrides: EngineObject#localToWorld
Source: src/engineObject.js, line 349

localToWorldVector(vec)

Convert from local space to world space for a vector (rotation only)

Parameters:

Name	Type	Description
`vec`	Vector2	local space vector

Overrides: EngineObject#localToWorldVector
Source: src/engineObject.js, line 357

removeChild(child)

Removes a child from this one

Parameters:

Name	Type	Description
`child`	EngineObject

Overrides: EngineObject#removeChild
Source: src/engineObject.js, line 413

render()

Render the object, uses box2d drawing if no tile info exists

Overrides: EngineObject#render
Source: plugins/box2d.js, line 85

renderDebugInfo()

Render debug info

Overrides: EngineObject#renderDebugInfo
Source: plugins/box2d.js, line 95

resetMassData()

Reset the mass, center of mass, and moment

Source: plugins/box2d.js, line 405

setAngle(angle)

Sets the angle

Parameters:

Name	Type	Description
`angle`	number

Source: plugins/box2d.js, line 350

setAngularDamping(damping)

Sets the angular damping

Parameters:

Name	Type	Description
`damping`	number

Source: plugins/box2d.js, line 366

setAngularVelocity(angularVelocity)

Sets the angular velocity

Parameters:

Name	Type	Description
`angularVelocity`	number

Source: plugins/box2d.js, line 358

setAwake(isAwakeopt)

Set the sleep state of the body

Parameters:

Name	Type	Attributes	Default	Description
`isAwake`	boolean	<optional>	true

Source: plugins/box2d.js, line 378

setBodyType(type)

Set the physics body type

Parameters:

Name	Type	Description
`type`	number

Source: plugins/box2d.js, line 382

setBullet(isBulletopt)

Should this body be treated like a bullet for continuous collision detection?

Parameters:

Name	Type	Attributes	Default	Description
`isBullet`	boolean	<optional>	true

Source: plugins/box2d.js, line 374

setCenterOfMass(center)

Set the center of mass of the body

Parameters:

Name	Type	Description
`center`	Vector2

Source: plugins/box2d.js, line 394

setCollision(collideSolidObjectsopt, isSolidopt, collideTilesopt, collideRaycastopt)

Set how this object collides

Parameters:

Name	Type	Attributes	Default	Description
`collideSolidObjects`	boolean	<optional>	true	Does it collide with solid objects?
`isSolid`	boolean	<optional>	true	Does it collide with and block other objects? (expensive in large numbers)
`collideTiles`	boolean	<optional>	true	Does it collide with the tile collision?
`collideRaycast`	boolean	<optional>	true	Does it collide with raycasts?

Overrides: EngineObject#setCollision
Source: src/engineObject.js, line 425

setFilterData(categoryBitsopt, ignoreCategoryBitsopt, groupIndexopt)

Set the collision filter data for this body

Parameters:

Name	Type	Attributes
`categoryBits`	number	<optional>
`ignoreCategoryBits`	number	<optional>
`groupIndex`	number	<optional>

Source: plugins/box2d.js, line 425

setFixedRotation(isFixedopt)

Set whether the body can rotate

Parameters:

Name	Type	Attributes	Default	Description
`isFixed`	boolean	<optional>	true

Source: plugins/box2d.js, line 390

setGravityScale(scaleopt)

Sets the gravity scale

Parameters:

Name	Type	Attributes	Default	Description
`scale`	number	<optional>	1

Source: plugins/box2d.js, line 370

setLinearDamping(damping)

Sets the linear damping

Parameters:

Name	Type	Description
`damping`	number

Source: plugins/box2d.js, line 362

setLinearVelocity(velocity)

Sets the linear velocity

Parameters:

Name	Type	Description
`velocity`	Vector2

Source: plugins/box2d.js, line 354

setMass(mass)

Set the mass of the body

Parameters:

Name	Type	Description
`mass`	number

Source: plugins/box2d.js, line 398

setMassData(localCenteropt, massopt, momentOfInertiaopt)

Set the mass data of the body

Parameters:

Name	Type	Attributes
`localCenter`	Vector2	<optional>
`mass`	number	<optional>
`momentOfInertia`	number	<optional>

Source: plugins/box2d.js, line 411

setMomentOfInertia(momentOfInertia)

Set the moment of inertia of the body

Parameters:

Name	Type	Description
`momentOfInertia`	number

Source: plugins/box2d.js, line 402

setPosition(pos)

Sets the position

Parameters:

Name	Type	Description
`pos`	Vector2

Source: plugins/box2d.js, line 346

setSensor(isSensoropt)

Set if this body is a sensor

Parameters:

Name	Type	Attributes	Default	Description
`isSensor`	boolean	<optional>	true

Source: plugins/box2d.js, line 438

setSleepingAllowed(isAllowedopt)

Set whether the body is allowed to sleep

Parameters:

Name	Type	Attributes	Default	Description
`isAllowed`	boolean	<optional>	true

Source: plugins/box2d.js, line 386

setTransform(pos, angle)

Sets the position and angle

Parameters:

Name	Type	Description
`pos`	Vector2
`angle`	number

Source: plugins/box2d.js, line 337

toString() → {string}

Returns string containing info about this object for debugging

Overrides: EngineObject#toString
Source: src/engineObject.js, line 437

Returns:

Type:: string

update()

Copy box2d update sim data

Overrides: EngineObject#update
Source: plugins/box2d.js, line 77

updateTransforms()

Update the object transform, called automatically by engine even when paused

Overrides: EngineObject#updateTransforms
Source: src/engineObject.js, line 120

worldToLocal(pos)

Convert from world space to local space

Parameters:

Name	Type	Description
`pos`	Vector2	world space point

Overrides: EngineObject#worldToLocal
Source: src/engineObject.js, line 353

worldToLocalVector(vec)

Convert from world space to local space for a vector (rotation only)

Parameters:

Name	Type	Description
`vec`	Vector2	world space vector

Overrides: EngineObject#worldToLocalVector
Source: src/engineObject.js, line 361