Epok Engine

EPOK RUNTIME

epok::move_and_slide

Function · 1 overload

Function

Performs `move and slide` as part of the epok module.

Belongs to
epok
Header
epok.hpp
Overloads
1

Declaration

Declaration
MoveResult move_and_slide(ActorData& entity,const Fixed* world_displacement,uint32_t mask=0xffffffffu)

Performs `move and slide` as part of the epok module.

ParameterTypeMeaning
entityActorData &Value supplied for entity. Keep referenced or pointed-to data valid for the complete call.
world_displacementconst Fixed *Value supplied for world_displacement. Keep referenced or pointed-to data valid for the complete call.
maskuint32_tValue supplied for mask. Keep referenced or pointed-to data valid for the complete call.

Returns: MoveResult. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "epok.hpp"

// Assume these named values have been initialized with valid data:
// ActorData & entity
// const Fixed * world_displacement
// uint32_t mask

auto result = epok::move_and_slide(entity, world_displacement, mask);

Why use it

It provides direct, allocation-conscious access to the epok 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/epok.hpp:209

Related members