Epok Engine

EPOK RUNTIME

epok::hud_core::NodeCache::begin

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

Begins begin as part of native HUD layout, drawing and focus navigation.

Belongs to
epok::hud_core::NodeCache
Header
hud_core.hpp
Overloads
1

Declaration

Declaration
bool begin(size_t owner,uint32_t key,Counts& counts,HudStats& stats)

Begins begin as part of native HUD layout, drawing and focus navigation.

ParameterTypeMeaning
ownersize_tNot documented; consult the linked header.
keyuint32_tNot documented; consult the linked header.
countsCounts &Not documented; consult the linked header.
statsHudStats &Not documented; consult the linked header.

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

Example sketch

C++ example
#include "hud_core.hpp"

// Assume these named values have been initialized with valid data:
// size_t owner
// uint32_t key
// Counts & counts
// HudStats & stats

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

auto result = object.begin(owner, key, counts, stats);

Trade-offs and warnings

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

Declared in runtime/hud_core.hpp:121

Related members