Epok Engine

EPOK RUNTIME

epok::NavigationRegion2DComponent::find_path

Method · 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.

Method

Finds path as part of the world2d navigation module.

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

Declaration

const
Declaration
size_t find_path(const Fixed* from, const Fixed* to, Fixed (*out)[2], size_t capacity, bool& reached) const

Finds path as part of the world2d navigation module.

ParameterTypeMeaning
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 Fixed * from
// const Fixed * to
// Fixed (*)[2] out
// size_t capacity
// bool & reached

epok::NavigationRegion2DComponent& object = /* obtain a valid instance */;

auto result = object.find_path(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:458

Related members