Epok Engine

EPOK RUNTIME

epok::SpatialQueryContextComponent::raycast_segment

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 `raycast segment` as part of the gameplay api module.

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

Declaration

Declaration
CollisionHitSample raycast_segment(GameplayVector3 origin,GameplayVector3 displacement,uint32_t mask,ObjectId ignore,bool triggers)

Performs `raycast segment` as part of the gameplay api module.

ParameterTypeMeaning
originGameplayVector3Not documented; consult the linked header.
displacementGameplayVector3Not documented; consult the linked header.
maskuint32_tNot documented; consult the linked header.
ignoreObjectIdNot documented; consult the linked header.
triggersboolNot 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:
// GameplayVector3 origin
// GameplayVector3 displacement
// uint32_t mask
// ObjectId ignore
// bool triggers

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

auto result = object.raycast_segment(origin, displacement, mask, ignore, triggers);

Trade-offs and warnings

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

Declared in runtime/gameplay_api.hpp:418

Related members