Epok Engine

EPOK RUNTIME

epok::TextComponent::text_word

Method · 1 overload

Method

Performs `text word` as part of the object model module.

Belongs to
epok::TextComponent
Header
object_model.hpp
Overloads
1

Declaration

const
Declaration
uint32_t text_word(uint32_t index) const

Performs `text word` as part of the object model module.

ParameterTypeMeaning
indexuint32_tValue supplied for index. Keep referenced or pointed-to data valid for the complete call.

Returns: uint32_t. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "object_model.hpp"

// Assume these named values have been initialized with valid data:
// uint32_t index

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

auto result = object.text_word(index);

Why use it

The method is `const`, so it does not mutate the object through this API surface.

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/object_model.hpp:813

Related members