Epok Engine

EPOK RUNTIME

epok::world2d::grid_path

Function · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Function

Waypoints from `from` to `to` on a grid (the start excluded), at most `capacity`.

Belongs to
epok::world2d
Header
world2d_navigation.hpp
Overloads
1

Declaration

Declaration
inline size_t grid_path(const NavGrid2D& g, const Fixed* from, const Fixed* to, Fixed (*out)[2], size_t capacity, bool& reached)

Waypoints from `from` to `to` on a grid (the start excluded), at most `capacity`.

ParameterTypeMeaning
gconst NavGrid2D &Not documented; consult the linked header.
fromconst Fixed *Not documented; consult the linked header.
toconst Fixed *Not documented; consult the linked header.
outFixed (*)[2]Not documented; consult the linked header.
capacitysize_tNot documented; consult the linked header.
reachedbool &Not documented; consult the linked header.

Returns: size_t. Consult the linked header for its meaning.

Example sketch

C++ example
#include "world2d_navigation.hpp"

// Assume these named values have been initialized with valid data:
// const NavGrid2D & g
// const Fixed * from
// const Fixed * to
// Fixed (*)[2] out
// size_t capacity
// bool & reached

auto result = epok::world2d::grid_path(g, from, to, out, capacity, reached);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/world2d_navigation.hpp:130

Related members