Class ColliderComponent

Components are containers for state in Excalibur, the are meant to convey capabilities that an Entity possesses

Implementations of Component must have a zero-arg constructor to support dependencies

class MyComponent extends ex.Component<'my'> {
  public readonly type = 'my';
  // zero arg support required if you want to use component dependencies
  constructor(public optionalPos?: ex.Vector) {}
}

Hierarchy

Component<"ex.collider">
- ColliderComponent

Index

Constructors

constructor

new ColliderComponent(collider?: Collider): ColliderComponent
Parameters
- Optional collider: Collider
Returns ColliderComponent
Overrides Component.constructor
- Defined in Collision/ColliderComponent.ts:31

Properties

$colliderAdded

$colliderAdded: Util.Observable<Collider> = ...

Observable that notifies when a collider is added to the body

$colliderRemoved

$colliderRemoved: Util.Observable<Collider> = ...

Observable that notifies when a collider is removed from the body

`Optional` `Readonly` dependencies

dependencies?: ComponentCtor<Component<string>>[]

Optionally list any component types this component depends on If the owner entity does not have these components, new components will be added to the entity

Only components with zero-arg constructors are supported as automatic component dependencies

events

events: EventDispatcher<any> = ...

`Optional` `Readonly` optional

optional?: ComponentCtor<Component<string>>[]

`Optional` owner

owner?: Entity = null

Current owning Entity, if any, of this component. Null if not added to any Entity

`Readonly` type

type: "ex.collider" = 'ex.collider'

Type of this component, must be a unique type among component types in you game.

Accessors

bounds

get bounds(): BoundingBox
Return world space bounds

Returns BoundingBox
- Defined in Collision/ColliderComponent.ts:76

localBounds

get localBounds(): BoundingBox
Return local space bounds

Returns BoundingBox
- Defined in Collision/ColliderComponent.ts:83

Methods

clear

clear(): void
Remove collider geometry from collider component

Returns void
- Defined in Collision/ColliderComponent.ts:64

clone

clone(): ColliderComponent
Clones any properties on this component, if that property value has a clone() method it will be called

Returns ColliderComponent
Inherited from Component.clone
- Defined in EntityComponentSystem/Component.ts:61

collide

collide(other: ColliderComponent): CollisionContact[]
Collide component with another
Parameters
- other: ColliderComponent
Returns CollisionContact[]
- Defined in Collision/ColliderComponent.ts:104

get

get(): Collider
Get the current collider geometry

Returns Collider
- Defined in Collision/ColliderComponent.ts:40

onAdd

onAdd(entity: Entity): void
Optional callback called when a component is added to an entity
Parameters
- entity: Entity
Returns void
Overrides Component.onAdd
- Defined in Collision/ColliderComponent.ts:139

onRemove

onRemove(): void
Optional callback called when a component is added to an entity

Returns void
Overrides Component.onRemove
- Defined in Collision/ColliderComponent.ts:168

set

set<T>(collider: T): T
Set the collider geometry

Returns
the collider you set
Type Parameters
- T extends Collider<T>
Parameters
- collider: T
Returns T
- Defined in Collision/ColliderComponent.ts:49

update

update(): void
Update the collider's transformed geometry

Returns void
- Defined in Collision/ColliderComponent.ts:90

useBoxCollider

useBoxCollider(width: number, height: number, anchor?: Vector, center?: Vector): PolygonCollider
Sets up a box geometry based on the current bounds of the associated actor of this physics body.

If no width/height are specified the body will attempt to use the associated actor's width/height.

By default, the box is center is at (0, 0) which means it is centered around the actors anchor.
Parameters
- width: number
- height: number
- anchor: Vector = Vector.Half
- center: Vector = Vector.Zero
Returns PolygonCollider
- Defined in Collision/ColliderComponent.ts:180

useCircleCollider

useCircleCollider(radius: number, center?: Vector): CircleCollider
Sets up a circle collision geometry as the only collider with a specified radius in pixels.

By default, the box is center is at (0, 0) which means it is centered around the actors anchor.
Parameters
- radius: number
- center: Vector = Vector.Zero
Returns CircleCollider
- Defined in Collision/ColliderComponent.ts:204

useCompositeCollider

useCompositeCollider(colliders: Collider[]): CompositeCollider
Setups up a CompositeCollider which can define any arbitrary set of excalibur colliders
Parameters
- colliders: Collider[]
Returns CompositeCollider
- Defined in Collision/ColliderComponent.ts:224

useEdgeCollider

useEdgeCollider(begin: Vector, end: Vector): EdgeCollider
Sets up an Edge|edge collision geometry with a start point and an end point relative to the anchor of the associated actor of this physics body.

By default, the box is center is at (0, 0) which means it is centered around the actors anchor.
Parameters
- begin: Vector
- end: Vector
Returns EdgeCollider
- Defined in Collision/ColliderComponent.ts:215

usePolygonCollider

usePolygonCollider(points: Vector[], center?: Vector): PolygonCollider
Sets up a polygon collision geometry based on a list of of points relative to the anchor of the associated actor of this physics body.

Only convex polygon definitions are supported.

By default, the box is center is at (0, 0) which means it is centered around the actors anchor.
Parameters
- points: Vector[]
- center: Vector = Vector.Zero
Returns PolygonCollider
- Defined in Collision/ColliderComponent.ts:194

Class ColliderComponent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional collider: Collider

Returns ColliderComponent

Properties

$colliderAdded

$colliderRemoved

Optional Readonly dependencies

events

Optional Readonly optional

Optional owner

Readonly type

Accessors

bounds

Returns BoundingBox

localBounds

Returns BoundingBox

Methods

clear

Returns void

clone

Returns ColliderComponent

collide

Parameters

other: ColliderComponent

Returns CollisionContact[]

get

Returns Collider

onAdd

Parameters

entity: Entity

Returns void

onRemove

Returns void

set

Returns

Type Parameters

T extends Collider<T>

Parameters

collider: T

Returns T

update

Returns void

useBoxCollider

Parameters

width: number

height: number

anchor: Vector = Vector.Half

center: Vector = Vector.Zero

Returns PolygonCollider

useCircleCollider

Parameters

radius: number

center: Vector = Vector.Zero

Returns CircleCollider

useCompositeCollider

Parameters

colliders: Collider[]

Returns CompositeCollider

useEdgeCollider

Parameters

begin: Vector

end: Vector

Returns EdgeCollider

usePolygonCollider

Parameters

points: Vector[]

center: Vector = Vector.Zero

Returns PolygonCollider

Settings

Member Visibility

Theme

`Optional` collider: Collider

`Optional` `Readonly` dependencies

`Optional` `Readonly` optional

`Optional` owner

`Readonly` type