Epok Engine

EPOK RUNTIME

epok::FocusableComponent

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:999
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::FocusableComponent& value = /* obtain a valid instance from your game */;

Fields and constants

Public methods

class_idPerforms `class id` 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.Methodis_checkedA Toggle's state; pressing Cross on a focused Toggle flips it.Methodis_focusedTrue while the canvas above this element points at it.Methodis_toggleReports whether toggle as part of the object model module.MethodneighborDirection 0 left, 1 right, 2 up, 3 down; the value is an actor index into the scene's objects array, or -1 for no neighbour that way.MethodorderPerforms `order` as part of the object model module.Methodoutline_enabledPerforms `outline enabled` as part of the object model module.Methodset_checkedSets checked as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_highlightSets highlight as part of the object model module.Methodset_neighborSets neighbor as part of the object model module.Methodset_orderSets order as part of the object model module.Methodset_outlineSets outline as part of the object model module.Methodset_toggleSets toggle as part of the object model module.MethodtakePerforms `take` as part of the object model module.Methodtake_cancelledTrue once after Circle was pressed while this element had the focus: back.Methodtake_changedTrue once after a Toggle flipped or a slider moved through the D-pad.Methodtake_pressedTrue once after Cross was pressed while this element had the focus: a button.Method