Epok Engine

EPOK RUNTIME

epok::detail::character_planar_velocity

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

Performs `character planar velocity` 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

Declaration
inline bool character_planar_velocity(Fixed from_x,Fixed from_y,Fixed to_x,Fixed to_y,Fixed speed,Fixed radius,Fixed dt,GameplayVector2& velocity)

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

ParameterTypeMeaning
from_xFixedNot documented; consult the linked header.
from_yFixedNot documented; consult the linked header.
to_xFixedNot documented; consult the linked header.
to_yFixedNot documented; consult the linked header.
speedFixedNot documented; consult the linked header.
radiusFixedNot documented; consult the linked header.
dtFixedNot documented; consult the linked header.
velocityGameplayVector2 &Not documented; consult the linked header.

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

Example sketch

C++ example
#include "character_commands.hpp"

// Assume these named values have been initialized with valid data:
// Fixed from_x
// Fixed from_y
// Fixed to_x
// Fixed to_y
// Fixed speed
// Fixed radius
// Fixed dt
// GameplayVector2 & velocity

auto result = epok::detail::character_planar_velocity(from_x, from_y, to_x, to_y, speed, radius, dt, velocity);

Trade-offs and warnings

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

Declared in runtime/character_commands.hpp:76

Related members