abstractCollider

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
  • CircleCollider
  • EdgeCollider
  • PolygonCollider

Implements

• Clonable<Collider>

Index

Constructors

• constructor

Properties

• composite
• events
• id
• offset
• owner

Accessors

• axes
• bounds
• center
• localBounds
• worldPos

Methods

• clone
• collide
• contains
• debug
• getClosestLineBetween
• getFurthestPoint
• getInertia
• project
• rayCast
• touching
• update

Constructors

constructor

• new Collider(): Collider

• Returns Collider

Properties

publiccomposite

composite: CompositeCollider = null

Composite collider if any this collider is attached to

WARNING do not tamper with this property

publicevents

events: EventEmitter<any> = ...

publicreadonlyid

id: Id<collider> = ...

offset

offset: Vector = Vector.Zero

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>

Accessors

abstractaxes

• get axes(): Vector[]

• Return the axes of this particular collider

  ---

  Returns Vector[]

abstractbounds

• get bounds(): BoundingBox

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

  ---

  Returns BoundingBox

abstractcenter

• get center(): Vector

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

  ---

  Returns Vector

abstractlocalBounds

• get localBounds(): BoundingBox

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

  ---

  Returns BoundingBox

abstractworldPos

• get worldPos(): Vector

• Position of the collision collider in world coordinates

  ---

  Returns Vector

Methods

abstractclone

• clone(): Collider

• Implementation of Clonable.clone

  Returns Collider

abstractcollide

• collide(collider: Collider): CollisionContact[]

• Parameters

  • collider: Collider

  Returns CollisionContact[]

abstractcontains

• contains(point: Vector): boolean

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

  ---

  Parameters

  • point: Vector

  Returns boolean

abstractdebug

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

• Parameters

  • ex: ExcaliburGraphicsContext

  • color: Color

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

  Returns void

abstractgetClosestLineBetween

• getClosestLineBetween(collider: Collider): LineSegment

• Returns the closest line between the surfaces this collider and another

  ---

  Parameters

  • collider: Collider

  Returns LineSegment

abstractgetFurthestPoint

• getFurthestPoint(direction: Vector): Vector

• Find the furthest point on the convex hull of this particular collider in a certain direction.

  ---

  Parameters

  • direction: Vector

  Returns Vector

abstractgetInertia

• getInertia(mass: number): number

• Parameters

  • mass: number

  Returns number

abstractproject

• project(axis: Vector): Projection

• Create a projection of this collider along an axis. Think of this as casting a "shadow" along an axis

  ---

  Parameters

  • axis: Vector

  Returns Projection

abstractrayCast

• rayCast(ray: Ray, max?: number): RayCastHit

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

  ---

  Parameters

  • ray: Ray

  • optionalmax: number

  Returns RayCastHit

publictouching

• touching(other: Collider): boolean

• 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

abstractupdate

• update(transform: Transform): void

• Updates collider world space geometry

  ---

  Parameters

  • transform: Transform

  Returns void