GridNav

In-game navigation API

IsTraversable(pos: Vector, flag [?]: number): bool

Name	Type	Description
pos	Vector	position to check
flag [?]	number	flag to check. No idea what it is (default: 1)

Returns true if the world position is traversable.

---

BuildPath(start: Vector, end: Vector, noTreeMode [?]: boolean): table

Name	Type	Description
start	Vector	position to start
end	Vector	position to end
noTreeMode [?]	boolean	flag to ignore trees (default: false)

Build path from start to end. Returns the 1-based indexed table with builded positions.

Example

-- build_path.lua
return {
    OnUpdate = function()
        local no_tree_mode = false;
        local my_hero = Heroes.GetLocal();
        local start_pos = Entity.GetAbsOrigin(my_hero);
        local end_pos = Input.GetWorldCursorPos();

        local path = GridNav.BuildPath(start_pos, end_pos, no_tree_mode);
        local prev_x, prev_y = nil, nil;
        for i, pos in pairs(path) do
            local x, y, visible = Renderer.WorldToScreen(pos);
            if (prev_x and visible) then
                Renderer.SetDrawColor(255, 255, 255, 255);
                Renderer.DrawLine(prev_x, prev_y, x, y);
            end
            prev_x, prev_y = x, y;
        end
    end
}