Why use it
It provides direct, allocation-conscious access to the gameplay api module. No exception-based error path is implied by the signature.
EPOK RUNTIME
epok::CollisionLibrary::ground
Method · 1 overload
Method
Performs `ground` as part of the gameplay api module.
Declaration
staticDeclaration
static CollisionHitSample ground(ObjectId actor,Fixed distance,uint32_t mask)Performs `ground` as part of the gameplay api module.
| Parameter | Type | Meaning |
|---|---|---|
actor | ObjectId | Value supplied for actor. Keep referenced or pointed-to data valid for the complete call. |
distance | Fixed | Value supplied for distance. Keep referenced or pointed-to data valid for the complete call. |
mask | uint32_t | Value supplied for mask. Keep referenced or pointed-to data valid for the complete call. |
Returns: CollisionHitSample. Check the value before continuing when it represents success, availability or a resource handle.
Example
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
Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.
Declared in runtime/gameplay_api.hpp:252