Class CompositeCollider

Hierarchy

Collider
- CompositeCollider

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CompositeCollider(colliders: Collider[]): CompositeCollider

Overrides Collider.constructor
- Defined in Collision/Colliders/CompositeCollider.ts:22
Parameters
- colliders: Collider[]
Returns CompositeCollider

Properties

events

events: EventDispatcher<Collider> = ...

Readonly id

id: Id<"collider"> = ...

offset

offset: Vector

Pixel offset of the collision collider relative to the collider, by default (0, 0) meaning the collider is positioned on top of the collider.

owner

owner: Entity

Accessors

axes

get axes(): Vector[]

Overrides Collider.axes
- Defined in Collision/Colliders/CompositeCollider.ts:81
Returns Vector[]

bounds

get bounds(): BoundingBox

Overrides Collider.bounds
- Defined in Collision/Colliders/CompositeCollider.ts:62
Returns BoundingBox

center

get center(): Vector

Overrides Collider.center
- Defined in Collision/Colliders/CompositeCollider.ts:58
Returns Vector

localBounds

get localBounds(): BoundingBox

Overrides Collider.localBounds
- Defined in Collision/Colliders/CompositeCollider.ts:73
Returns BoundingBox

worldPos

get worldPos(): Vector

Overrides Collider.worldPos
- Defined in Collision/Colliders/CompositeCollider.ts:53
Returns Vector

Methods

addCollider

addCollider(collider: Collider): void

- Defined in Collision/Colliders/CompositeCollider.ts:33
Parameters
- collider: Collider
Returns void

clearColliders

clearColliders(): void

- Defined in Collision/Colliders/CompositeCollider.ts:29
Returns void

clone

clone(): Collider

Overrides Collider.clone
- Defined in Collision/Colliders/CompositeCollider.ts:246
Returns Collider

collide

collide(other: Collider): CollisionContact[]

Overrides Collider.collide
- Defined in Collision/Colliders/CompositeCollider.ts:119
Parameters
- other: Collider
Returns CollisionContact[]

contains

contains(point: Vector): boolean

Overrides Collider.contains
- Defined in Collision/Colliders/CompositeCollider.ts:176
Return wether the collider contains a point inclusive to it's border

Parameters
- point: Vector
Returns boolean

debug

debug(ex: ExcaliburGraphicsContext, color: Color): void

Overrides Collider.debug
- Defined in Collision/Colliders/CompositeCollider.ts:239
Parameters
- ex: ExcaliburGraphicsContext
- color: Color
Returns void

getClosestLineBetween

getClosestLineBetween(other: Collider): LineSegment

Overrides Collider.getClosestLineBetween
- Defined in Collision/Colliders/CompositeCollider.ts:140
Returns the closest line between the surfaces this collider and another

Parameters
- other: Collider
Returns LineSegment

getColliders

getColliders(): Collider[]

- Defined in Collision/Colliders/CompositeCollider.ts:49
Returns Collider[]

getFurthestPoint

getFurthestPoint(direction: Vector): Vector

Overrides Collider.getFurthestPoint
- Defined in Collision/Colliders/CompositeCollider.ts:91
Find the furthest point on the convex hull of this particular collider in a certain direction.

Parameters
- direction: Vector
Returns Vector

getInertia

getInertia(mass: number): number

Overrides Collider.getInertia
- Defined in Collision/Colliders/CompositeCollider.ts:110
Parameters
- mass: number
Returns number

project

project(axis: Vector): Projection

Overrides Collider.project
- Defined in Collision/Colliders/CompositeCollider.ts:208
Create a projection of this collider along an axis. Think of this as casting a "shadow" along an axis

Parameters
- axis: Vector
Returns Projection

rayCast

rayCast(ray: Ray, max?: number): Vector

Overrides Collider.rayCast
- Defined in Collision/Colliders/CompositeCollider.ts:185
Return the point on the border of the collision collider that intersects with a ray (if any).

Parameters
- ray: Ray
- Optional max: number
Returns Vector

removeCollider

removeCollider(collider: Collider): void

- Defined in Collision/Colliders/CompositeCollider.ts:41
Parameters
- collider: Collider
Returns void

touching

touching(other: Collider): boolean

Inherited from Collider.touching
- Defined in Collision/Colliders/Collider.ts:34
Returns a boolean indicating whether this body collided with or was in stationary contact with the body of the other Collider

Parameters
- other: Collider
Returns boolean

update

update(transform: Transform): void

Overrides Collider.update
- Defined in Collision/Colliders/CompositeCollider.ts:229
Updates collider world space geometry

Parameters
- transform: Transform
Returns void