Epok Engine

EPOK RUNTIME

epok::HealthLibrary::damage

Method · 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.

Method

Performs `damage` as part of the health module.

Belongs to
epok::HealthLibrary
Header
health.hpp
Overloads
1

Declaration

static
Declaration
static HealthChange damage(HealthState state,int32_t amount)

Performs `damage` as part of the health module.

ParameterTypeMeaning
stateHealthStateNot documented; consult the linked header.
amountint32_tNot documented; consult the linked header.

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

Example sketch

C++ example
#include "health.hpp"

// Assume these named values have been initialized with valid data:
// HealthState state
// int32_t amount

auto result = epok::HealthLibrary::damage(state, amount);

Trade-offs and warnings

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

Declared in runtime/health.hpp:22

Related members