Why use it
The boolean result makes success, availability or state explicit without exceptions.
EPOK RUNTIME
epok::TextComponent::set_text_word
Method · 1 overload
Method
Sets text word as part of the object model module.
Declaration
Declaration
bool set_text_word(uint32_t index,uint32_t packed)Sets text word as part of the object model module.
| Parameter | Type | Meaning |
|---|---|---|
index | uint32_t | Value supplied for index. Keep referenced or pointed-to data valid for the complete call. |
packed | uint32_t | Value supplied for packed. Keep referenced or pointed-to data valid for the complete call. |
Returns: bool. 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
// uint32_t packed
epok::TextComponent& object = /* obtain a valid instance */;
auto result = object.set_text_word(index, packed);Trade-offs and warnings
Check the return value; `false` is part of normal control flow for many PSX resource operations.
Declared in runtime/object_model.hpp:812
Related members
class_idPerforms `class id` as part of the object model module.Methodclear_textClears text as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodset_colorSets color as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_numberSets number as part of the object model module.Methodset_unsignedSets unsigned as part of the object model module.Methodset_wrapSets wrap as part of the object model module.Methodtext_wordPerforms `text word` as part of the object model module.Method