CompositeCollider

A collision collider specifies the geometry that can detect when other collision colliders intersect for the purposes of colliding 2 objects in excalibur.

Hierarchy

• Collider
  • CompositeCollider

Index

Constructors

• constructor

Properties

• composite
• events
• id
• offset
• owner

Accessors

• axes
• bounds
• center
• compositeStrategy
• localBounds
• worldPos

Methods

• addCollider
• clearColliders
• clone
• collide
• contains
• debug
• getClosestLineBetween
• getColliders
• getFurthestPoint
• getInertia
• project
• rayCast
• removeCollider
• touching
• update

Constructors

constructor

• new CompositeCollider(colliders: Collider[]): CompositeCollider

• Overrides Collider.constructor

  Parameters

  • colliders: Collider[]

  Returns CompositeCollider

Properties

publiccomposite

composite: CompositeCollider = null

Inherited from Collider.composite

Composite collider if any this collider is attached to

WARNING do not tamper with this property

publicevents

events: EventEmitter<any> = ...

Inherited from Collider.events

publicreadonlyid

id: Id<collider> = ...

Inherited from Collider.id

offset

offset: Vector = Vector.Zero

Inherited from Collider.offset

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

publicowner

owner: Entity<any>

Inherited from Collider.owner

Accessors

axes

• get axes(): Vector[]

• Overrides Collider.axes

  Return the axes of this particular collider

  ---

  Returns Vector[]

bounds

• get bounds(): BoundingBox

• Overrides Collider.bounds

  Return the axis-aligned bounding box of the collision collider in world coordinates

  ---

  Returns BoundingBox

center

• get center(): Vector

• Overrides Collider.center

  The center point of the collision collider, for example if the collider is a circle it would be the center.

  ---

  Returns Vector

publiccompositeStrategy

• get compositeStrategy(): separate | together
• set compositeStrategy(value: separate | together): void

• Returns separate | together

• Treat composite collider's member colliders as either separate colliders for the purposes of onCollisionStart/onCollision or as a single collider together.

  This property can be overridden on individual [[CompositeColliders]].

  For composites without gaps or small groups of colliders, you probably want 'together'

  For composites with deliberate gaps, like a platforming level layout, you probably want 'separate'

  Default is 'together' if unset

  ---

  Parameters

  • value: separate | together

  Returns void

localBounds

• get localBounds(): BoundingBox

• Overrides Collider.localBounds

  Return the axis-aligned bounding box of the collision collider in local coordinates

  ---

  Returns BoundingBox

worldPos

• get worldPos(): Vector

• Overrides Collider.worldPos

  Position of the collision collider in world coordinates

  ---

  Returns Vector

Methods

addCollider

• addCollider(collider: Collider): void

• Parameters

  • collider: Collider

  Returns void

clearColliders

• clearColliders(): void

• Returns void

clone

• clone(): Collider

• Overrides Collider.clone

  Returns Collider

collide

• collide(other: Collider): CollisionContact[]

• Overrides Collider.collide

  Parameters

  • other: Collider

  Returns CollisionContact[]

contains

• contains(point: Vector): boolean

• Overrides Collider.contains

  Return wether the collider contains a point inclusive to it's border

  ---

  Parameters

  • point: Vector

  Returns boolean

publicdebug

• debug(ex: ExcaliburGraphicsContext, color: Color, options?: { lineWidth: number; pointSize: number }): void

• Overrides Collider.debug

  Parameters

  • ex: ExcaliburGraphicsContext

  • color: Color

  • optionaloptions: { lineWidth: number; pointSize: number }

  Returns void

getClosestLineBetween

• getClosestLineBetween(other: Collider): LineSegment

• Overrides Collider.getClosestLineBetween

  Returns the closest line between the surfaces this collider and another

  ---

  Parameters

  • other: Collider

  Returns LineSegment

getColliders

• getColliders(): Collider[]

• Returns Collider[]

getFurthestPoint

• getFurthestPoint(direction: Vector): Vector

• Overrides Collider.getFurthestPoint

  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

  Parameters

  • mass: number

  Returns number

project

• project(axis: Vector): Projection

• Overrides Collider.project

  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): RayCastHit

• Overrides Collider.rayCast

  Return the point on the border of the collision collider that intersects with a ray (if any).

  ---

  Parameters

  • ray: Ray

  • optionalmax: number

  Returns RayCastHit

removeCollider

• removeCollider(collider: Collider): void

• Parameters

  • collider: Collider

  Returns void

publictouching

• touching(other: Collider): boolean

• Inherited from Collider.touching

  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

  Updates collider world space geometry

  ---

  Parameters

  • transform: Transform

  Returns void