Epok Engine

EPOK RUNTIME

epok::query_ground

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

Performs `query ground` as part of the epok module.

Belongs to
epok
Header
epok.hpp
Overloads
1

Declaration

Declaration
SpatialHit query_ground(const ActorData& entity,Fixed distance,uint32_t mask=0xffffffffu)

Performs `query ground` as part of the epok module.

ParameterTypeMeaning
entityconst ActorData &Not documented; consult the linked header.
distanceFixedNot documented; consult the linked header.
maskuint32_tNot documented; consult the linked header.

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

Example sketch

C++ example
#include "epok.hpp"

// Assume these named values have been initialized with valid data:
// const ActorData & entity
// Fixed distance
// uint32_t mask

auto result = epok::query_ground(entity, distance, mask);

Trade-offs and warnings

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

Declared in runtime/epok.hpp:364

Related members