crystal.Collider

Component allowing an entity to collide with others. Freshly created colliders have no category and collide with nothing.

In a typical platforming game, characters, enemies and platforms would use Collider components.

Constructor

Like all other components, Collider components are created by calling Entity:add_component. The constructor expects one argument: a love.Shape. The entity must have a Body component added prior to adding any colliders.

entity:add_component(crystal.Body);
entity:add_component(crystal.Collider, love.physics.newCircleShape(4));

Methods

Name	Description
collisions	Returns all components currently colliding with this collider.
disable_collider	Prevents this collider from colliding with others.
disable_collision_with	Prevents this collider from colliding with colliders or sensors of specific categories.
disable_collision_with_everything	Prevents this collider from colliding with colliders or sensors of any category.
enable_collider	Allows this collider to collide with others.
enable_collision_with	Allows this collider to collide with colliders or sensors of specific categories.
enable_collision_with_everything	Allows this collider to collide with colliders or sensors of any category.
set_categories	Sets which physics categories describe this collider.
set_friction	Sets the friction coefficient of this collider.
set_restitution	Sets the restitution coefficient of this collider.
shape	Returns the shape of this collider.

Callbacks

Name	Description
on_collide	Called when a collider or sensor starts colliding with this collider.
on_uncollide	Called when a collider or sensor stops colliding with this collider.

Examples

local ecs = crystal.ECS:new();
ecs:add_system(crystal.PhysicsSystem);

local entity = ecs:spawn(crystal.Entity);
entity:add_component(crystal.Body);
entity:add_component(crystal.Collider, love.physics.newCircleShape(4));
entity:set_categories("characters");
entity:enable_collision_with("level", "characters");