Epok Engine

EPOK RUNTIME

epok::TextComponent

Class

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.

Class

Class declared by the object-model module for the object model module.

Namespace
epok
Header
object_model.hpp
Include
#include "object_model.hpp"
Module
object-model
Source
runtime/object_model.hpp:917
Inherits from
UIComponent

Basic usage

This generated sketch illustrates syntax for reaching the type; adapt it to the actual API contract. Open a member below for an operation-specific example.

C++ example
#include "object_model.hpp"

epok::TextComponent& value = /* obtain a valid instance from your game */;

Fields and constants

Public methods

alignPerforms `align` as part of the object model module.Methodclass_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.Methodfont_indexPerforms `font index` as part of the object model module.Methodset_align0 Left, 1 Center, 2 Right; anything else leaves the lines left-aligned.Methodset_colorSets color as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_font_indexThe cooked font this label draws from, in export order; -1 is the built-in 8x16 atlas.Methodset_numberSets number as part of the object model module.Methodset_text_keyShows string table entry `key` (its number in the Localization editor) in the current language, and keeps following it when the language changes.Methodset_text_wordSets text word as part of the object model module.Methodset_unsignedSets unsigned as part of the object model module.Methodset_visible_glyphsSets visible glyphs as part of the object model module.Methodset_wrapSets wrap as part of the object model module.Methodshow_all_textPerforms `show all text` as part of the object model module.Methodtext_keyPerforms `text key` as part of the object model module.Methodtext_wordPerforms `text word` as part of the object model module.Methodvisible_glyphsPerforms `visible glyphs` as part of the object model module.Method