Navigation:navigate_to

Begins moving towards a specific location.

Usage

navigation:navigate_to(x, y, acceptance_radius, repath_delay)

Arguments

Name Type Description
x number X coordinate to move towards.
y number Y coordinate to move towards.
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 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:navigate_to(100, 120); -- Begins moving towards (100, 120)

This site uses Just the Docs, a documentation theme for Jekyll.