Epok Engine

EPOK RUNTIME

epok::gameplay_vector

Function · 2 overloads

Function

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

Belongs to
epok
Header
gameplay_api.hpp
Overloads
2

Declaration 1 of 2

Declaration
inline GameplayVector3 gameplay_vector(const Fixed* value)

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

ParameterTypeMeaning
valueconst Fixed *Value supplied for value. Keep referenced or pointed-to data valid for the complete call.

Returns: GameplayVector3. 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:
// const Fixed * value

auto result = epok::gameplay_vector(value);

Why use it

It provides direct, allocation-conscious access to the gameplay api module. No exception-based error path is implied by the signature.

Trade-offs and warnings

Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/gameplay_api.hpp:118

Declaration 2 of 2

Declaration
inline void gameplay_vector(GameplayVector3 value,Fixed* output)

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

ParameterTypeMeaning
valueGameplayVector3Value supplied for value. Keep referenced or pointed-to data valid for the complete call.
outputFixed *Value supplied for output. Keep referenced or pointed-to data valid for the complete call.

Returns: Nothing (void).

Example

C++ example
#include "gameplay_api.hpp"

// Assume these named values have been initialized with valid data:
// GameplayVector3 value
// Fixed * output

epok::gameplay_vector(value, output);

Why use it

It provides direct, allocation-conscious access to the gameplay api module. No exception-based error path is implied by the signature.

Trade-offs and warnings

Pointer/reference arguments are borrowed unless the source contract says otherwise; keep them valid for the complete operation and never assume null is accepted.

Declared in runtime/gameplay_api.hpp:119

Related members