Class: Entity
entity.Entity
Represents a generic entity in 3D space.
Hierarchy
Constructors
constructor
• new Entity(position, collider, pieces?, mass?, name?)
Creates a new Entity instance with a position, bounding box and body pieces.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
position | vec2 | undefined | The entity's position in world space |
collider | Collider | undefined | The entity's bounding box |
pieces | Shape[] | [] | The entity's body pieces for rendering |
mass? | number | undefined | The entity's mass in kg (0 for infinite mass) |
name | string | "" | A name which can be used to identify the entity |
Overrides
Defined in
src/entity.ts:26
Properties
airFriction
• airFriction: number = 0
The damping applied to the object's linear velocity every physics update.
Inherited from
Defined in
src/physics/object.ts:68
angularDamping
• angularDamping: number = 0
The damping applied to the object's angular velocity every physics update.
Inherited from
Defined in
src/physics/object.ts:97
angularVelocity
• angularVelocity: number = 0
The object's angular velocity in radians per second.
Inherited from
Defined in
src/physics/object.ts:80
collider
• collider: Collider
The object's collider.
Inherited from
Defined in
src/physics/collisionObject.ts:23
dynamicFriction
• dynamicFriction: number = 0.1
Coefficient of dynamic/kinetic friction.
This value should be between 0 and 1 for best results.
see Static And Kinetic Friction
Inherited from
Defined in
src/physics/object.ts:51
filter
• filter: CollisionFilter
The object's collision filter.
Inherited from
Defined in
src/physics/collisionObject.ts:18
force
• force: vec2
The net force applied to the object in newtons.
Inherited from
Defined in
src/physics/object.ts:58
gravity
• gravity: vec2
The gravitational froce applied to the object.
Inherited from
Defined in
src/physics/object.ts:12
isDynamic
• isDynamic: boolean = true
Wether the body has dynamics or not.
Inherited from
Defined in
src/physics/rigidbody.ts:15
isStatic
• isStatic: boolean = false
Wether or not the object is static, static objects do not move during collisions.
Inherited from
Defined in
src/physics/collisionObject.ts:38
isTrigger
• isTrigger: boolean = false
Wether or not the collision object should be a trigger.
When true the object will detect but not respond to collisions.
Inherited from
Defined in
src/physics/collisionObject.ts:45
listeners
• Protected listeners: Object = {}
Index signature
▪ [index: string]: Listener[]
Inherited from
Defined in
src/object2d.ts:32
lockRotation
• lockRotation: boolean = false
Wether or not the object can rotate.
When true the object's rotation will not be affected by collisions or dynamics.
Inherited from
Defined in
src/physics/object.ts:125
lockXAxis
• lockXAxis: boolean = false
Wether or not the object's x position is locked.
When true the object's x position will not be affected by collisions or dynamics.
Inherited from
Defined in
src/physics/object.ts:111
lockYAxis
• lockYAxis: boolean = false
Wether or not the object's y position is locked.
When true the object's y position will not be affected by collisions or dynamics.
Inherited from
Defined in
src/physics/object.ts:118
name
• name: string = ""
Defined in
src/entity.ts:12
pieces
• Private pieces: Shape[]
Defined in
src/entity.ts:14
restitution
• restitution: number = 0
Elasticity/bounciness
This value should be between 0 and 1 for best results.
Inherited from
Defined in
src/physics/object.ts:33
staticFriction
• staticFriction: number = 0.1
Coefficient of static friction.
This value should be between 0 and 1 for best results.
see Static And Kinetic Friction
Inherited from
Defined in
src/physics/object.ts:42
stickyCollider
• stickyCollider: boolean = true
Wether or not to clone the object's position and rotation to it's collider.
Inherited from
Defined in
src/physics/collisionObject.ts:33
takesGravity
• takesGravity: boolean = true
Wether or not the object should take gravity from the physics world.
Inherited from
Defined in
src/physics/object.ts:104
torque
• torque: number = 0
The object's torque in newtons, can be thought of as rotational force.
Inherited from
Defined in
src/physics/object.ts:75
totalContacts
• totalContacts: number = 0
The number of contact points the object is colliding at.
Inherited from
Defined in
src/physics/collisionObject.ts:28
velocity
• velocity: vec2
The object's velocity in world space units (metres).
Inherited from
Defined in
src/physics/object.ts:63
zIndex
• Private zIndex: number = 0
Defined in
src/entity.ts:15
Methods
addEventListener
▸ addEventListener(event, listener): boolean
Executes a function when an event is fired.
Parameters
| Name | Type | Description |
|---|---|---|
event | string | The event to listen for |
listener | Listener | The function to execute when the event fired |
Returns
boolean
Wether or not the listener was added
Inherited from
Defined in
src/object2d.ts:209
addPiece
▸ addPiece(piece): void
Adds a body piece to the entity.
Parameters
| Name | Type | Description |
|---|---|---|
piece | Shape | The piece to add to the entity |
Returns
void
Defined in
src/entity.ts:98
applyForce
▸ applyForce(force, contact?): void
Adds a force to the object's current total force vector.
If no contact point is provided then the force will be applied at the object's centre, generating 0 torque.
Parameters
| Name | Type | Description |
|---|---|---|
force | vec2 | The force vector to apply |
contact? | vec2 | The local position on the body to apply the force at |
Returns
void
Inherited from
Defined in
src/physics/object.ts:156
applyForceAtAngle
▸ applyForceAtAngle(force, angle, contact?): void
Applies a force to the object at an angle.
The direction vector is calculated from the unit y+ vector.
If no contact point is provided then the force will be applied at the object's centre, generating 0 torque.
Parameters
| Name | Type | Description |
|---|---|---|
force | number | The force to apply in newtons |
angle | number | The angle at which to apply the force in radians (world space) |
contact? | vec2 | The local position on the body to apply the force at |
Returns
void
Inherited from
Defined in
src/physics/object.ts:178
applyImpulse
▸ applyImpulse(impulse, contactVector): void
Applies an impulse to the physics object.
This will apply an instantaneous change to the object's angular and linear velocity.
Parameters
| Name | Type | Description |
|---|---|---|
impulse | vec2 | The impulse to apply |
contactVector | vec2 | A vector from the object's center to the contact point |
Returns
void
Inherited from
Defined in
src/physics/object.ts:199
fireEvent
▸ fireEvent(event, ...e): void
Executes all listeners attached to a given event.
Parameters
| Name | Type | Description |
|---|---|---|
event | string | The event to fire |
...e | any | The data to pass to each event listener |
Returns
void
Inherited from
Defined in
src/object2d.ts:185
fixedUpdate
▸ fixedUpdate(delta): void
Fires the "fixedUpdate" event.
Parameters
| Name | Type | Description |
|---|---|---|
delta | number | The time since the last fixed update |
Returns
void
Defined in
src/entity.ts:62
getEventListeners
▸ getEventListeners(event): Listener[]
Gets the listeners attached to an event.
Parameters
| Name | Type |
|---|---|
event | string |
Returns
Listener[]
An array of listeners attached to the given event
Inherited from
Defined in
src/object2d.ts:198
getEvents
▸ getEvents(): string[]
Gets the events that can be listened to on the object.
Returns
string[]
The events the object supports
Inherited from
Defined in
src/object2d.ts:175
getInertia
▸ getInertia(): number
Gets the moment of inertia of the object.
Returns
number
The inertia of the object
Inherited from
Defined in
src/physics/object.ts:257
getInverseInertia
▸ getInverseInertia(): number
Gets the inverse moment of inertia of the object (1 / inertia).
Returns
number
The inverse inertia of the object
Inherited from
Defined in
src/physics/object.ts:266
getInverseMass
▸ getInverseMass(): number
Gets the inverse mass of the object (1 / mass).
Returns
number
The inverse mass of the object
Inherited from
Defined in
src/physics/object.ts:234
getMass
▸ getMass(): number
Gets the mass of the object.
Returns
number
The mass of the object
Inherited from
Defined in
src/physics/object.ts:225
getPieces
▸ getPieces(): Shape[]
Gets the entity's body pieces.
Returns
Shape[]
The entity's pieces
Defined in
src/entity.ts:89
getPosition
▸ getPosition(): vec2
Gets the object's position.
Returns
vec2
The object's position as a vec2
Inherited from
Defined in
src/object2d.ts:82
getRotation
▸ getRotation(): number
Gets the object's rotation as a number in radians relative to y+.
Returns
number
The object's rotation
Inherited from
Defined in
src/object2d.ts:139
getZIndex
▸ getZIndex(): number
Gets the entities z index.
Returns
number
The entities z index
Defined in
src/entity.ts:135
moveRight
▸ moveRight(dist): void
Moves the object's position right (x+) relative to it's rotation.
Parameters
| Name | Type | Description |
|---|---|---|
dist | number | The distance to move right, can be + or - |
Returns
void
Inherited from
Defined in
src/object2d.ts:100
moveUp
▸ moveUp(dist): void
Moves the object's position up (y+) relative to it's rotation.
Parameters
| Name | Type | Description |
|---|---|---|
dist | number | The distance to move up, can be + or - |
Returns
void
Inherited from
Defined in
src/object2d.ts:114
removeEventListener
▸ removeEventListener(event, listener): boolean
Removes a listener from an event.
Parameters
| Name | Type | Description |
|---|---|---|
event | string | The event the listener is attached to |
listener | Listener | The listener to remove |
Returns
boolean
Wether or not the listener was removed
Inherited from
Defined in
src/object2d.ts:223
removePiece
▸ removePiece(piece): boolean
Removes a body piece from the entity.
Parameters
| Name | Type | Description |
|---|---|---|
piece | Shape | The piece to remove from the entity |
Returns
boolean
Wether or not the piece was removed
Defined in
src/entity.ts:108
render
▸ render(): void
Renders the entity's pieces.
Returns
void
Defined in
src/entity.ts:69
rotate
▸ rotate(angle): void
Increments the object's rotation by an angle in radians.
Parameters
| Name | Type | Description |
|---|---|---|
angle | number | The angle to rotate by in radians |
Returns
void
Inherited from
Defined in
src/object2d.ts:148
setInertia
▸ setInertia(inertia): void
Sets the moment of inertia of the object.
Also computes the inverse inertia.
NOTE: Setting the inertia to 0 will act as infinite inertia.
Parameters
| Name | Type | Description |
|---|---|---|
inertia | number | The objects new inertia |
Returns
void
Inherited from
Defined in
src/physics/object.ts:247
setMass
▸ setMass(mass): void
Sets the mass of the object in kg.
Also computes the inverse mass.
NOTE: Setting the mass to 0 will act as infinite mass.
Parameters
| Name | Type | Description |
|---|---|---|
mass | number | The objects new mass |
Returns
void
Inherited from
Defined in
src/physics/object.ts:213
setPieces
▸ setPieces(pieces): void
Sets the entity's body pieces.
Parameters
| Name | Type | Description |
|---|---|---|
pieces | Shape[] | The entity's new pieces |
Returns
void
Defined in
src/entity.ts:80
setPosition
▸ setPosition(pos): void
Sets the object's position.
Also sets this.collider's position, if this.stickyCollider is true.
Parameters
| Name | Type | Description |
|---|---|---|
pos | vec2 | The object's new position |
Returns
void
Inherited from
Defined in
src/physics/collisionObject.ts:121
setPositionX
▸ setPositionX(x): void
Sets the x component of the object's position.
Parameters
| Name | Type | Description |
|---|---|---|
x | number | The object's new x coordinate |
Returns
void
Inherited from
Defined in
src/object2d.ts:56
setPositionY
▸ setPositionY(y): void
Sets the y component of the object's position.
Parameters
| Name | Type | Description |
|---|---|---|
y | number | The object's new y coordinate |
Returns
void
Inherited from
Defined in
src/object2d.ts:69
setRotation
▸ setRotation(angle): void
Sets the object's rotation, in radians.
Also sets this.collider's rotation, if this.stickyCollider is true.
Parameters
| Name | Type | Description |
|---|---|---|
angle | number | The object's new rotation angle (in radians) |
Returns
void
Inherited from
Defined in
src/physics/collisionObject.ts:133
setZIndex
▸ setZIndex(zIndex): void
Sets the entites z index.
throws When validateZIndex returns a string.
Parameters
| Name | Type | Description |
|---|---|---|
zIndex | number | The entites new zIndex |
Returns
void
Defined in
src/entity.ts:123
setupEvents
▸ Protected setupEvents(): void
Sets the events that can be attached to in listeners.
Returns
void
Overrides
Defined in
src/entity.ts:39
testCollision
▸ testCollision(B): CollisionResult
Checks if this object's collider is colliding with another object's collider.
Parameters
| Name | Type | Description |
|---|---|---|
B | CollisionObject | CollisionObject to test collisions against |
Returns
CollisionResult with the results of the test
Inherited from
Defined in
src/physics/collisionObject.ts:75
translate
▸ translate(v): void
Translates the object by the provided vector.
Parameters
| Name | Type | Description |
|---|---|---|
v | vec2 | The vector to translate by |
Returns
void
Inherited from
Defined in
src/object2d.ts:91
update
▸ update(delta): void
Updates the entity.
Also fires the "update" event.
Parameters
| Name | Type | Description |
|---|---|---|
delta | number | The time since the last update |
Returns
void
Defined in
src/entity.ts:53