EPOK RUNTIME

epok::MathLibrary::move_toward

Method · 1 overload

Method

Performs `move toward` as part of the gameplay api module.

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

Declaration

static

Declaration

static Fixed move_toward(Fixed from,Fixed to,Fixed max_step)

Performs `move toward` as part of the gameplay api module.

Parameter	Type	Meaning
`from`	`Fixed`	Value supplied for from. Keep referenced or pointed-to data valid for the complete call.
`to`	`Fixed`	Value supplied for to. Keep referenced or pointed-to data valid for the complete call.
`max_step`	`Fixed`	Value supplied for max_step. Keep referenced or pointed-to data valid for the complete call.

Returns: Fixed. 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:
// Fixed from
// Fixed to
// Fixed max_step

auto result = epok::MathLibrary::move_toward(from, to, max_step);

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

Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.

Declared in runtime/gameplay_api.hpp:190

Related members

addAdds add as part of the gameplay api module.Method clampPerforms `clamp` as part of the gameplay api module.Method cosine_degreesPerforms `cosine degrees` as part of the gameplay api module.Method delta_degreesShortest signed turn from one heading to another, in -180..180.Method heading_degreesHeading of a planar vector in degrees, measured from +y towards +x, so a stick pushed forward reads 0 and a stick pushed right reads 90.Method lengthPerforms `length` as part of the gameplay api module.Method length2Performs `length2` as part of the gameplay api module.Method lerpPerforms `lerp` as part of the gameplay api module.Method move_toward_degreesThe same approach on a circle: turns the short way and never overshoots.Method scalePerforms `scale` as part of the gameplay api module.Method sine_degreesTrigonometry, roots and angle arithmetic in the engine's own Q12 form.Method smoothstepPerforms `smoothstep` as part of the gameplay api module.Method