Class: Particle

Constructor

new Particle(position, tileIndexopt, tileSizeopt, angleopt)

Create a particle with the given settings

Parameters:

Name	Type	Attributes	Default	Description
`position`	Vector2			World space position of the particle
`tileIndex`	Number	<optional>	-1	Tile to use to render, untextured if -1
`tileSize`	Vector2	<optional>	tileSizeDefault	Size of tile in source pixels
`angle`	Number	<optional>	0	Angle to rotate the particle

Source: engineParticles.js, line 245

Extends

EngineObject

Members

additiveColor

Properties

Type	Description
Color	Additive color to apply when rendered

Overrides: EngineObject#additiveColor
Source: engineObject.js, line 63

angle

Properties

Type	Description
Number	Angle to rotate the object

Overrides: EngineObject#angle
Source: engineObject.js, line 59

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: engineObject.js, line 71

angleVelocity

Properties

Name	Type	Attributes	Default	Description
`angleVelocity`	Number	<optional>	0	Angular velocity of the object

Overrides: EngineObject#angleVelocity
Source: engineObject.js, line 83

color

Properties

Type	Description
Color	Color to apply when rendered

Overrides: EngineObject#color
Source: engineObject.js, line 61

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: engineObject.js, line 69

drawSize

Properties

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

Overrides: EngineObject#drawSize
Source: engineObject.js, line 53

elasticity

Properties

Name	Type	Attributes	Default	Description
`elasticity`	Number	<optional>	objectDefaultElasticity	How bouncy the object is when colliding (0-1)

Overrides: EngineObject#elasticity
Source: engineObject.js, line 73

friction

Properties

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

Overrides: EngineObject#friction
Source: engineObject.js, line 75

gravityScale

Properties

Name	Type	Attributes	Default	Description
`gravityScale`	Number	<optional>	1	How much to scale gravity by for this object

Overrides: EngineObject#gravityScale
Source: engineObject.js, line 77

mass

Properties

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

Overrides: EngineObject#mass
Source: engineObject.js, line 67

pos

Properties

Type	Description
Vector2	World space position of the object

Overrides: EngineObject#pos
Source: engineObject.js, line 49

renderOrder

Properties

Name	Type	Attributes	Default	Description
`renderOrder`	Number	<optional>	0	Objects are sorted by render order

Overrides: EngineObject#renderOrder
Source: engineObject.js, line 79

size

Properties

Type	Description
Vector2	World space width and height of the object

Overrides: EngineObject#size
Source: engineObject.js, line 51

tileIndex

Properties

Type	Description
Number	Tile to use to render object (-1 is untextured)

Overrides: EngineObject#tileIndex
Source: engineObject.js, line 55

tileSize

Properties

Type	Description
Vector2	Size of tile in source pixels

Overrides: EngineObject#tileSize
Source: engineObject.js, line 57

velocity

Properties

Name	Type	Attributes	Default	Description
`velocity`	Vector2	<optional>	Vector2()	Velocity of the object

Overrides: EngineObject#velocity
Source: engineObject.js, line 81

Methods

addChild(child, localPosopt, localAngleopt)

Attaches a child to this with a given local transform

Parameters:

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

Overrides: EngineObject#addChild
Source: engineObject.js, line 325

applyAcceleration(acceleration)

Apply acceleration to this object (adjust velocity, not affected by mass)

Parameters:

Name	Type	Description
`acceleration`	Vector2

Overrides: EngineObject#applyAcceleration
Source: engineObject.js, line 311

applyForce(force)

Apply force to this object (adjust velocity, affected by mass)

Parameters:

Name	Type	Description
`force`	Vector2

Overrides: EngineObject#applyForce
Source: engineObject.js, line 315

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: engineObject.js, line 303

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 occured

Overrides: EngineObject#collideWithTile
Source: engineObject.js, line 291

Returns:

true if the collision should be resolved

Type:: Boolean

collideWithTileRaycast(tileData, pos) → {Boolean}

Called to check if a tile raycast hit

Parameters:

Name	Type	Description
`tileData`	Number	the value of the tile at the position
`pos`	Vector2	tile where the raycast is

Overrides: EngineObject#collideWithTileRaycast
Source: engineObject.js, line 297

Returns:

true if the raycast should hit

Type:: Boolean

destroy()

Destroy this object, destroy it's children, detach it's parent, and mark it for removal

Overrides: EngineObject#destroy
Source: engineObject.js, line 275

getAliveTime() → {Number}

How long since the object was created

Overrides: EngineObject#getAliveTime
Source: engineObject.js, line 307

Returns:

Type:: Number

getMirrorSign() → {Number}

Get the direction of the mirror

Overrides: EngineObject#getMirrorSign
Source: engineObject.js, line 319

Returns:

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

Type:: Number

removeChild(child)

Removes a child from this one

Parameters:

Name	Type	Description
`child`	EngineObject

Overrides: EngineObject#removeChild
Source: engineObject.js, line 336

render()

Render the particle, automatically called each frame, sorted by renderOrder

Overrides: EngineObject#render
Source: engineParticles.js, line 258

setCollision(collideSolidObjectsopt, isSolidopt, collideTilesopt)

Set how this object collides

Parameters:

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

Overrides: EngineObject#setCollision
Source: engineObject.js, line 347

toString() → {String}

Returns string containg info about this object for debugging

Overrides: EngineObject#toString
Source: engineObject.js, line 358

Returns:

Type:: String

update()

Update the object transform and physics, called automatically by engine once each frame

Overrides: EngineObject#update
Source: engineObject.js, line 95