Epok Engine

EPOK RUNTIME

epok::CollisionLibrary::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 the gameplay api module.

Belongs to
epok::CollisionLibrary
Header
gameplay_api.hpp
Overloads
1

Declaration

static
Declaration
static CollisionHitSample ground(ObjectId actor,Fixed distance,uint32_t mask)

Performs `ground` as part of the gameplay api module.

ParameterTypeMeaning
actorObjectIdNot documented; consult the linked header.
distanceFixedNot documented; consult the linked header.
maskuint32_tNot documented; consult the linked header.

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

Example sketch

C++ example
#include "gameplay_api.hpp"

// Assume these named values have been initialized with valid data:
// ObjectId actor
// Fixed distance
// uint32_t mask

auto result = epok::CollisionLibrary::ground(actor, distance, mask);

Trade-offs and warnings

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

Declared in runtime/gameplay_api.hpp:356

Related members