Epok Engine

EPOK RUNTIME

epok::detail::prepare_character_command

Function template · 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.

Function template

Performs `prepare character command` as part of extensible command producers and point/target movement policies for shared character motors.

Belongs to
epok::detail
Header
character_commands.hpp
Overloads
1

Declaration

template
Declaration
template<class Source,class Motor,class Result> Result prepare_character_command(Source& source,CharacterCommandLease<Motor>& lease,Fixed dt,ObjectRegistry* registry)

Performs `prepare character command` as part of extensible command producers and point/target movement policies for shared character motors.

ParameterTypeMeaning
sourceSource &Not documented; consult the linked header.
leaseCharacterCommandLease<Motor> &Not documented; consult the linked header.
dtFixedNot documented; consult the linked header.
registryObjectRegistry *Not documented; consult the linked header.

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

Example sketch

C++ example
#include "character_commands.hpp"

// Replace these template arguments with types or values accepted by the declaration:
// Source, Motor, Result

// Assume these named values have been initialized with valid data:
// Source & source
// CharacterCommandLease<Motor> & lease
// Fixed dt
// ObjectRegistry * registry

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

auto result = object.prepare_character_command<Source, Motor, Result>(source, lease, dt, registry);

Trade-offs and warnings

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

Declared in runtime/character_commands.hpp:49

Related members