Epok Engine

EPOK RUNTIME

epok::character3d::WorldQueries::ground

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

Performs `ground` as part of shared world-unit character commands, collision locomotion and motion samples.

Belongs to
epok::character3d::WorldQueries
Header
character3d.hpp
Overloads
1

Declaration

Declaration
SpatialHit ground(const ActorData& body,Fixed distance,uint32_t mask)

Performs `ground` as part of shared world-unit character commands, collision locomotion and motion samples.

ParameterTypeMeaning
bodyconst 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 "character3d.hpp"

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

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

auto result = object.ground(body, distance, mask);

Trade-offs and warnings

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

Declared in runtime/character3d.hpp:47

Related members