Navigation:align_with_entity

Begins moving to align itself vertically or horizontally with another entity, whichever is closest.

Usage

navigation:align_with_entity(entity, acceptance_radius, repath_delay)

Arguments

Name	Type	Description
entity	Entity	Entity to align with. Must have a Body component.
acceptance_radius	number	How close from the destination this entity must be to consider the navigation complete. Defaults to component-wide value if unspecified.
repath_delay	number	How often a new path will be computed while navigation is in progress. Defaults to component-wide value if unspecified.

Returns

Name	Type	Description
thread	Thread	A thread which will terminate when the entity reaches its destination.

Examples

local target = ecs:spawn(crystal.Entity);
target:add_component(crystal.Body);
target:set_position(100, 100);

local entity = ecs:spawn(crystal.Entity);
entity:add_component(crystal.Body);
entity:add_component(crystal.Movement);
entity:add_component(crystal.Navigation);
entity:set_position(80, 60);
entity:align_with_entity(target); -- Begins moving towards (100, 60)