Epok Engine

EPOK RUNTIME

Object Model

object_model.hpp · the object model module

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.

Module

the object model module.

Header
object_model.hpp
Include
#include "object_model.hpp"
Stability
Epok runtime API

Include this module

C++ include
#include "object_model.hpp"

Types

ActivationCallbacksClass template declared by the object-model module for the object model module.Class templateActorClass declared by the object-model module for the object model module.ClassActor2DClass declared by the object-model module for the object model module.ClassActor3DClass declared by the object-model module for the object model module.ClassActorCallbacksClass template declared by the object-model module for the object model module.Class templateActorComponentClass declared by the object-model module for the object model module.ClassActorPrepareFn---- spawning ------------------------------------------------------------------ Preparation hook, run once per reserved actor after its defaults, root, owner and registration are in place and *before* any `begin_play` of this batch (design.md section 6, between steps 2 and 5).Type aliasActorSpawnRequestOne spawn request.StructAudioComponentShared audio without a transform.ClassBlobShadowComponentClass declared by the object-model module for the object model module.ClassCamera3DComponentClass declared by the object-model module for the object model module.ClassCanvasComponentClass declared by the object-model module for the object model module.ClassClassDescriptorCooked class table.StructCollider3DComponentClass declared by the object-model module for the object model module.ClassComponentCallbacksAccess-restricted or overloaded user hooks must remain callable through the virtual base interface.Class templateEndPlayReasonEnum declared by the object-model module for the object model module.EnumFocusableComponentClass declared by the object-model module for the object model module.ClassImageComponentClass declared by the object-model module for the object model module.ClassLayoutContainerComponentClass declared by the object-model module for the object model module.ClassLayoutElementComponentClass declared by the object-model module for the object model module.ClassLevelClass declared by the object-model module for the object model module.ClassLevelPendingOpOne queued spawn/destroy request, executed when the current batch finishes.StructLight3DComponentClass declared by the object-model module for the object model module.ClassMesh3DComponentNative components register their ownership with the Actor lifecycle.ClassNativeComponentDefaultStruct declared by the object-model module for the object model module.StructObjectClass declared by the object-model module for the object model module.ClassObjectBatch8Struct declared by the object-model module for the object model module.StructObjectClassFlagsClass descriptor flags.EnumObjectDispatchScopeStorage of a destroyed object stays quarantined until every nested callback returns.StructObjectDomainEnum declared by the object-model module for the object model module.EnumObjectFamilyEnum declared by the object-model module for the object model module.EnumObjectIdCompact runtime identity.StructObjectPoolFixed typed storage for one concrete class.Class templateObjectRegistrySlot table over a fixed capacity.StructObjectRegistryStorageDefault capacity for a cooked build; tests instantiate a small table.Class templateObjectSlotStruct declared by the object-model module for the object model module.StructObjectStateEnum declared by the object-model module for the object model module.EnumObjectStatsStruct declared by the object-model module for the object model module.StructPaletteAnimatorComponentClass declared by the object-model module for the object model module.ClassParticleEffectComponentClass declared by the object-model module for the object model module.ClassParticleEmitterComponentClass declared by the object-model module for the object model module.ClassProgressBarComponentClass declared by the object-model module for the object model module.ClassRectTransformComponentClass declared by the object-model module for the object model module.ClassSceneComponent2DClass declared by the object-model module for the object model module.ClassSceneComponent3DClass declared by the object-model module for the object model module.ClassSceneScriptActorOne per loaded Level.ClassSharedObjectPoolCooked class factories share payload storage while retaining their individual admission bounds.Class templateSprite3DComponentClass declared by the object-model module for the object model module.ClassTextComponentClass declared by the object-model module for the object model module.ClassTickGroupSimulation stages are independent of actor placement and component order.EnumTickGroupOfClass template declared by the object-model module for the object model module.Class templateTimelineComponentClass declared by the object-model module for the object model module.ClassTransform2D2D world transform: XY position in Q12 pixels (Y points down, as on screen), rotation in degrees about the view axis, per-axis scale and a z-index draw order.StructUIActorClass declared by the object-model module for the object model module.ClassUIComponentClass declared by the object-model module for the object model module.ClassWorldClass declared by the object-model module for the object model module.Class

Functions and methods

~ObjectReleases the resources owned by `epok::Object`.destructor~ObjectDispatchScopeReleases the resources owned by `epok::ObjectDispatchScope`.destructoracquirePerforms `acquire` as part of the object model module.MethodacquirePool-backed construction of a concrete class.MethodacquirePerforms `acquire` as part of the object model module.MethodactiveSelf flag only; Level::actor_active() folds the logical parent chain.Methodactor_active---- activation ----------------------------------------------------------------Methodactor_atPerforms `actor at` as part of the object model module.Methodactor_countPerforms `actor count` as part of the object model module.Methodadd_component---- components ----------------------------------------------------------------Function templateadoptAdopt storage owned by somebody else (an actor's embedded default component, the Level itself).MethodalignPerforms `align` as part of the object model module.Methodattach_componentSpatial attachment between components of the same domain.Functionattach_slotPerforms `attach slot` as part of the object model module.Methodattach_slotPerforms `attach slot` as part of the object model module.Methodattach_slotPerforms `attach slot` as part of the object model module.Methodattach_slotPerforms `attach slot` as part of the object model module.Methodattach_toPerforms `attach to` as part of the object model module.Methodattach_toPerforms `attach to` as part of the object model module.Methodbegin_playBegins play as part of the object model module.Methodbegin_playBegins play as part of the object model module.Methodbegin_playplay_on_start policy.MethodbindBinds the slot table and registers the Level itself.MethodbindPerforms `bind` as part of the object model module.Methodbind_dataPerforms `bind data` as part of the object model module.Methodbind_localPerforms `bind local` as part of the object model module.Methodbind_localPerforms `bind local` as part of the object model module.Methodbind_localNo legacy slot: the component owns the transform.Methodbind_slotBind to the legacy slot's AudioSource, or to component-owned storage.Methodbind_slotPerforms `bind slot` as part of the object model module.Methodbind_slotCanonical storage: the legacy entity slot owns the transform and everything that already reads it (collision, rendering, motion interpolation) keeps working.Methodblueprint_observePerforms `blueprint observe` as part of the object model module.Methodblueprint_observePerforms `blueprint observe` as part of the object model module.Methodbone_countPerforms `bone count` as part of the object model module.MethodburstPerforms `burst` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idRuntime-owned identity hooks; not an authoring API.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodclass_ofPerforms `class of` as part of the object model module.Methodclear_textClears text as part of the object model module.MethodclipPerforms `clip` as part of the object model module.Methodclip_countPerforms `clip count` as part of the object model module.Methodclip_framesPerforms `clip frames` as part of the object model module.Methodclip_loop_ticksOne loop of a clip, measured in the animator's own two-per-frame ticks.Methodcollect_quarantinedRetry the quarantined slots.MethodcolumnsPerforms `columns` as part of the object model module.Methodcompact_class_idSingle-block SHA-256: enough for a 36 character UUID (message + padding <= 64 bytes).Functioncomponent_countPerforms `component count` as part of the object model module.Methodcomponent_idPerforms `component id` as part of the object model module.MethodconfigurePerforms `configure` as part of the object model module.MethodconfigurePerforms `configure` as part of the object model module.Methodcreate_scene_scriptThe scene script is created by the loader; it is never part of the actor table.MethoddataLegacy adapter: the canonical slot behind the root scene component, or nullptr.Methoddefault_rootRuntime hook, not reflected: the declarative root component embedded in the actor.Methoddefault_rootPerforms `default root` as part of the object model module.Methoddefault_rootPerforms `default root` as part of the object model module.Methoddefault_rootPerforms `default root` as part of the object model module.MethoddestroyDestroys destroy as part of the object model module.Methoddestroy_actor---- destruction --------------------------------------------------------------- A request made inside a callback marks the actor immediately (it receives no further events) and runs the teardown when the current batch finishes.Methoddispatch_triggerCollision is owned by the spatial services, not by the Level: they resolve the legacy slot to its actor and call this, which fans the event out to the owner's components in registration order.FunctionenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.MethodenabledPerforms `enabled` as part of the object model module.Methodend_playEnds play as part of the object model module.Methodend_playEnds play as part of the object model module.Methodend_playEnds play as part of the object model module.Methodend_play_allExit order: scene script first while the actors are still alive, then every actor.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.Methodfield_of_viewPerforms `field of view` as part of the object model module.Methodfind_object_classFinds object class as part of the object model module.Functionfinish_releaseCalled when the last dispatch scope unwinds: no callback can still be on the stack of a destroyed object, so its typed storage returns to the pool.MethodfocusedThe focused element, as an actor index into the scene's objects array, or -1.Methodfont_indexPerforms `font index` as part of the object model module.Methodframe_updatePerforms `frame update` as part of the object model module.Methodframe_updatePerforms `frame update` as part of the object model module.Methodframe_updateOnce per rendered frame, even while paused (legacy Behaviour parity).Methodgeometry_statePerforms `geometry state` as part of the object model module.MethodgetReturns get as part of the object model module.MethodgetReturns get as part of the object model module.Methodget_componentReturns component as part of the object model module.Function templateget_componentsReturns components as part of the object model module.Function templateget_ownerReturns owner as part of the object model module.Methodhorizontal_flagsPerforms `horizontal flags` as part of the object model module.MethodidPerforms `id` as part of the object model module.MethodintensityPerforms `intensity` as part of the object model module.Methodinvalidate_actor_activationPerforms `invalidate actor activation` as part of the object model module.Functionis_aReports whether a 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_playingReports whether playing as part of the object model module.Methodis_toggleReports whether toggle as part of the object model module.MethodkindPerforms `kind` as part of the object model module.MethodlayerPerforms `layer` as part of the object model module.Methodlevel_attachedRuntime hook, not reflected: the Level just bound this component to its owner.Methodlevel_idReflected identity/hierarchy readers.Methodlighting_enabledPerforms `lighting enabled` as part of the object model module.MethodlivePerforms `live` as part of the object model module.MethodlivePerforms `live` as part of the object model module.MethodlivePerforms `live` as part of the object model module.Methodlocal_transformPerforms `local transform` as part of the object model module.Methodlogical_parentPerforms `logical parent` as part of the object model module.Methodmake_activePerforms `make active` as part of the object model module.MethodmaskPerforms `mask` as part of the object model module.Methodmaterial_statePerforms `material state` as part of the object model module.Methodminimum_heightPerforms `minimum height` as part of the object model module.Methodminimum_widthPerforms `minimum width` as part of the object model module.MethodnamePerforms `name` as part of the object model module.MethodnamePerforms `name` 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.Methodnext_generationPerforms `next generation` as part of the object model module.Methodobject_class_is_aAncestry walk bounded by the table size; the cook rejects cycles before emitting.Functionobject_constructPlacement-new into caller storage; destroy runs the virtual destructor of the concrete type, so a base pointer never slices.Function templateobject_destructPerforms `object destruct` as part of the object model module.Functionobject_domain_bitOwner domain masks for components.Functionobject_storage_quarantinedDefined after AudioComponent; `false` for every object that owns no retained storage.FunctionObjectDispatchScopeConstructs `epok::ObjectDispatchScope` for the object model module.constructorObjectRegistryConstructs `epok::ObjectRegistry` for the object model module.constructorObjectRegistryStorage<Capacity>Constructs `epok::ObjectRegistryStorage` for the object model module.constructoron_disablePerforms `on disable` as part of the object model module.Methodon_disablePerforms `on disable` as part of the object model module.Methodon_disableDeactivation and teardown stop both kinds: lifecycle.hpp::set_active stops a legacy slot's audio through the slot table, and stopping an already stopped source is a no-op, so the two paths are idempotent rather than conflicting.Methodon_enablePerforms `on enable` as part of the object model module.Methodon_enablePerforms `on enable` as part of the object model module.Methodon_framePerforms `on frame` as part of the object model module.Methodon_framePerforms `on frame` as part of the object model module.Methodon_triggerPerforms `on trigger` as part of the object model module.Methodoperator!=Performs `operator !=` as part of the object model module.Methodoperator=Performs `operator =` as part of the object model module.Methodoperator=Performs `operator =` as part of the object model module.Methodoperator==Performs `operator ==` as part of the object model module.MethodorderPerforms `order` as part of the object model module.Methodoutline_enabledPerforms `outline enabled` as part of the object model module.Methodoverlap_2dWorld2D: a trigger Collider2D of this actor overlaps another actor's collider (or the reverse).Methodowner_idPerforms `owner id` as part of the object model module.Methodowns_sourceTrue only for component-owned storage.Methodpadding_bottomPerforms `padding bottom` as part of the object model module.Methodpadding_leftPerforms `padding left` as part of the object model module.Methodpadding_rightPerforms `padding right` as part of the object model module.Methodpadding_topPerforms `padding top` as part of the object model module.Methodpause_animationPauses animation as part of the object model module.Methodpause_animationPauses animation as part of the object model module.Methodpending_destructionPerforms `pending destruction` as part of the object model module.MethodpitchPerforms `pitch` as part of the object model module.MethodplayStarts play as part of the object model module.MethodplayStarts play as part of the object model module.Methodplay_clipStarts clip as part of the object model module.Methodplay_clipStarts clip as part of the object model module.Methodplay_on_startStarts on start as part of the object model module.Methodplayback_stateStarts back state as part of the object model module.Methodplayback_stateStarts back state as part of the object model module.Methodpoll_eventPolls event as part of the object model module.Methodposition_xPerforms `position x` as part of the object model module.Methodposition_yPerforms `position y` as part of the object model module.MethodpriorityPerforms `priority` as part of the object model module.Methodquad_countPerforms `quad count` as part of the object model module.MethodregistryPerforms `registry` as part of the object model module.MethodreleasableFalse while a service still holds this component's storage; the registry then keeps the (already dead) slot quarantined instead of returning it to the pool.MethodreleasableComponent-owned storage stays quarantined while an asynchronous consumer (the XA music service) still points at it, mirroring allocate_actor_data's legacy-slot rule.MethodreleasePerforms `release` as part of the object model module.MethodreleaseInvalidates the handle immediately; storage is quarantined while callbacks run.MethodreleasePerforms `release` as part of the object model module.Methodremove_componentRemoves component as part of the object model module.Methodrequest_geometryRequests geometry as part of the object model module.MethodresetResets reset as part of the object model module.MethodresolveGeneration and class checked; the runtime class must derive from T's static class.Function templateresume_animationResumes animation as part of the object model module.Methodresume_animationResumes animation as part of the object model module.Methodroot_idPerforms `root id` as part of the object model module.MethodrotationPerforms `rotation` as part of the object model module.MethodrotationPerforms `rotation` as part of the object model module.Methodsample_bonePerforms `sample bone` as part of the object model module.Methodsample_geometry_vertexPerforms `sample geometry vertex` as part of the object model module.Methodsample_vertexPerforms `sample vertex` as part of the object model module.Methodsample_verticesPerforms `sample vertices` as part of the object model module.Methodscene_scriptPerforms `scene script` as part of the object model module.Methodscreen_overlayPerforms `screen overlay` as part of the object model module.Methodset_activeFolded activation with the on_enable/on_disable fan-out, and deferred destruction inside a dispatch scope: the same Level paths the legacy Blueprint nodes take.Methodset_activeSets active as part of the object model module.Methodset_align0 Left, 1 Center, 2 Right; anything else leaves the lines left-aligned.Methodset_anchorsSets anchors as part of the object model module.Methodset_animation_positionManual playback position, in the same ticks.Methodset_bordersNine-slice borders in source pixels: left, top, right, bottom.Methodset_centerSets center as part of the object model module.Methodset_checkedSets checked as part of the object model module.Methodset_clipSets clip as part of the object model module.Methodset_colorSets color as part of the object model module.Methodset_colorSets color as part of the object model module.Methodset_colorSets color as part of the object model module.Methodset_colorSets color as part of the object model module.Methodset_colorsSets colors as part of the object model module.Methodset_columnsSets columns as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_field_of_viewSets field of view as part of the object model module.Methodset_flipSets flip as part of the object model module.Methodset_focusedSets focused 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_half_extentsSets half extents as part of the object model module.Methodset_highlightSets highlight as part of the object model module.Methodset_horizontal_flagsSets horizontal flags as part of the object model module.Methodset_intensitySets intensity as part of the object model module.Methodset_kindSets kind as part of the object model module.Methodset_layerSets layer as part of the object model module.Methodset_lifetimeSets lifetime as part of the object model module.Methodset_lighting_enabledSets lighting enabled as part of the object model module.Methodset_local_positionSets local position as part of the object model module.Methodset_local_rotationSets local rotation as part of the object model module.Methodset_local_scaleSets local scale as part of the object model module.Methodset_local_transformSets local transform as part of the object model module.Methodset_logical_parentSets logical parent as part of the object model module.Methodset_maskSets mask as part of the object model module.Methodset_material_blendSets material blend as part of the object model module.Methodset_material_colorSets material color as part of the object model module.Methodset_material_depth_biasSets material depth bias as part of the object model module.Methodset_material_textureSets material texture as part of the object model module.Methodset_material_unlitSets material unlit as part of the object model module.Methodset_max_particlesSets max particles as part of the object model module.Methodset_minimumSets minimum as part of the object model module.Methodset_modeSets mode as part of the object model module.Methodset_nameSets name as part of the object model module.Methodset_nameSets name as part of the object model module.Methodset_neighborSets neighbor as part of the object model module.Methodset_numberSets number 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_paddingSets padding as part of the object model module.Methodset_pitchSets pitch as part of the object model module.Methodset_pivotSets pivot as part of the object model module.Methodset_play_on_startSets play on start as part of the object model module.Methodset_positionSets position as part of the object model module.Methodset_positionSets position as part of the object model module.Methodset_prioritySets priority as part of the object model module.Methodset_rangeSets range as part of the object model module.Methodset_rateSets rate as part of the object model module.Methodset_regionSets region as part of the object model module.Methodset_rotationDegrees about the pivot.Methodset_rotationSets rotation as part of the object model module.Methodset_scaleSets scale as part of the object model module.Methodset_screen_overlaySets screen overlay as part of the object model module.Methodset_sizeSets size as part of the object model module.Methodset_sizeSets size as part of the object model module.Methodset_spacingSets spacing as part of the object model module.Methodset_stepSets step as part of the object model module.Methodset_stretchSets stretch 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_textureSets texture as part of the object model module.Methodset_textureSets texture as part of the object model module.Methodset_tiling0 None, 1 Tile, 2 TileFit; anything else leaves the image stretched.Methodset_toggleSets toggle as part of the object model module.Methodset_triggerSets trigger as part of the object model module.Methodset_typeSets type as part of the object model module.Methodset_unsignedSets unsigned as part of the object model module.Methodset_uv_scrollSets uv scroll as part of the object model module.Methodset_valueSets value as part of the object model module.Methodset_vertical_flagsSets vertical flags as part of the object model module.Methodset_visible_glyphsSets visible glyphs as part of the object model module.Methodset_volumeSets volume as part of the object model module.Methodset_wants_tickSets wants tick as part of the object model module.Methodset_wrapSets wrap as part of the object model module.Methodsha256_rotrPerforms `sha256 rotr` as part of the object model module.Functionshow_all_textPerforms `show all text` as part of the object model module.MethodslotPerforms `slot` as part of the object model module.Methodspacing_xPerforms `spacing x` as part of the object model module.Methodspacing_yPerforms `spacing y` as part of the object model module.Methodspawn_actorPerforms `spawn actor` as part of the object model module.Methodspawn_batchAll or nothing.MethodstatePerforms `state` as part of the object model module.MethodstatePerforms `state` as part of the object model module.MethodstatePerforms `state` as part of the object model module.MethodstatsPerforms `stats` as part of the object model module.MethodstepA step above zero makes the bar a slider: Left/Right on the focused bar move it.MethodstopStops stop as part of the object model module.MethodstopStops stop as part of the object model module.Methodstop_animationStops animation as part of the object model module.MethodstreamedPerforms `streamed` as part of the object model module.MethodstretchPerforms `stretch` 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_completionPerforms `take completion` as part of the object model module.Methodtake_pressedTrue once after Cross was pressed while this element had the focus: a button.MethodteleportPerforms `teleport` 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.MethodtickPerforms `tick` as part of the object model module.MethodtickPerforms `tick` as part of the object model module.Methodtick---- ticking -------------------------------------------------------------------Methodtick_group_callbackPerforms `tick group callback` as part of the object model module.FunctiontilingPerforms `tiling` as part of the object model module.Methodtimeline_syncRuntime hooks, not reflected.Methodtimeline_syncPerforms `timeline sync` as part of the object model module.MethodtriggerPerforms `trigger` as part of the object model module.Methodtrigger_eventForward-only collision hook.MethodvalidPerforms `valid` as part of the object model module.MethodvaluePerforms `value` as part of the object model module.Methodvertex_countPerforms `vertex count` as part of the object model module.Methodvertical_flagsPerforms `vertical flags` as part of the object model module.Methodvisible_glyphsPerforms `visible glyphs` as part of the object model module.MethodvolumePerforms `volume` as part of the object model module.Methodwants_tickPerforms `wants tick` as part of the object model module.Methodworld_affinePerforms `world affine` as part of the object model module.Method

Fields, variables and values

acquireExposes `acquire` on `epok::ClassDescriptor` for the object model module.FieldactiveExposes `active` on `epok::ActorSpawnRequest` for the object model module.Fieldactive_object_registryRegistry bound by the active Level.VariableactorExposes `actor` on `epok::LevelPendingOp` for the object model module.FieldActorNamed value `Actor` in `epok::ObjectFamily`.Enum valueactor_activation_revisionActor activation is private state, changed only through Level.Variableactor_component_capacityExposes `actor_component_capacity` on the `epok` namespace for the object model module.VariablealignExposes `align` on `epok::ClassDescriptor` for the object model module.FieldaliveExposes `alive` on `epok::ObjectStats` for the object model module.Fieldattach_parentExposes `attach_parent` on `epok::NativeComponentDefault` for the object model module.Fieldattach_parentExposes `attach_parent` on `epok::RectTransformComponent` for the object model module.Fieldattach_parentExposes `attach_parent` on `epok::SceneComponent2D` for the object model module.Fieldattach_parentExposes `attach_parent` on `epok::SceneComponent3D` for the object model module.Fieldaudio_source_retained---- service quarantine ------------------------------------------------------------ Some services retain the address of a component's storage across asynchronous callbacks.VariablecallbacksExposes `callbacks` on `epok::ObjectSlot` for the object model module.FieldcapacityExposes `capacity` on `epok::ObjectPool` for the object model module.VariablecapacityExposes `capacity` on `epok::ObjectRegistry` for the object model module.FieldcapacityExposes `capacity` on `epok::SharedObjectPool` for the object model module.Variableclass_idExposes `class_id` on `epok::NativeComponentDefault` for the object model module.FieldcomponentExposes `component` on `epok::NativeComponentDefault` for the object model module.FieldComponentNamed value `Component` in `epok::ObjectFamily`.Enum valuecomponent_activationLegacy hand-written tables remain conservative.Fieldcomponent_frameLegacy hand-written tables remain conservative.Fieldcomponent_tickLegacy hand-written tables remain conservative.FieldcountExposes `count` on `epok::ObjectBatch8` for the object model module.FieldcreateExposes `create` on `epok::ClassDescriptor` for the object model module.Fielddefault_componentExposes `default_component` on `epok::ClassDescriptor` for the object model module.Fielddefault_component_countExposes `default_component_count` on `epok::ClassDescriptor` for the object model module.FielddeferredExposes `deferred` on `epok::ObjectStats` for the object model module.FielddestroyExposes `destroy` on `epok::ClassDescriptor` for the object model module.FielddestroyExposes `destroy` on `epok::LevelPendingOp` for the object model module.FieldDestroyedNamed value `Destroyed` in `epok::EndPlayReason`.Enum valueDestroyedNamed value `Destroyed` in `epok::ObjectState`.Enum valuedispatchExposes `dispatch` on `epok::ObjectRegistry` for the object model module.FielddomainExposes `domain` on `epok::ClassDescriptor` for the object model module.Fielddraw_orderExposes `draw_order` on `epok::Transform2D` for the object model module.FieldEndingPlayNamed value `EndingPlay` in `epok::ObjectState`.Enum valuefamilyExposes `family` on `epok::ClassDescriptor` for the object model module.FieldflagsExposes `flags` on `epok::ClassDescriptor` for the object model module.FieldframeExposes `frame` on `epok::ActorCallbacks` for the object model module.VariableframeExposes `frame` on `epok::ComponentCallbacks` for the object model module.VariableGameplayNamed value `Gameplay` in `epok::TickGroup`.Enum valuegenerationExposes `generation` on `epok::ObjectId` for the object model module.FieldgenerationExposes `generation` on `epok::ObjectSlot` for the object model module.FieldhandlesExposes `handles` on `epok::ObjectPool` for the object model module.VariablehandlesExposes `handles` on `epok::SharedObjectPool` for the object model module.VariableidExposes `id` on `epok::ClassDescriptor` for the object model module.FieldindexExposes `index` on `epok::ObjectId` for the object model module.FieldInitializedNamed value `Initialized` in `epok::ObjectState`.Enum valueInputNamed value `Input` in `epok::TickGroup`.Enum valueinstanceExposes `instance` on `epok::ObjectSlot` for the object model module.Fielditem0Exposes `item0` on `epok::ObjectBatch8` for the object model module.Fielditem1Exposes `item1` on `epok::ObjectBatch8` for the object model module.Fielditem2Exposes `item2` on `epok::ObjectBatch8` for the object model module.Fielditem3Exposes `item3` on `epok::ObjectBatch8` for the object model module.Fielditem4Exposes `item4` on `epok::ObjectBatch8` for the object model module.Fielditem5Exposes `item5` on `epok::ObjectBatch8` for the object model module.Fielditem6Exposes `item6` on `epok::ObjectBatch8` for the object model module.Fielditem7Exposes `item7` on `epok::ObjectBatch8` for the object model module.FieldlevelService context.FieldLevelNamed value `Level` in `epok::ObjectFamily`.Enum valuelevel_actor_capacityExposes `level_actor_capacity` on the `epok` namespace for the object model module.Variablelevel_pending_capacityExposes `level_pending_capacity` on the `epok` namespace for the object model module.VariableLevelUnloadedNamed value `LevelUnloaded` in `epok::EndPlayReason`.Enum valuelocalExposes `local` on `epok::AudioComponent` for the object model module.FieldlocalExposes `local` on `epok::RectTransformComponent` for the object model module.FieldlocalExposes `local` on `epok::SceneComponent3D` for the object model module.Fieldlogical_parentExposes `logical_parent` on `epok::ActorSpawnRequest` for the object model module.FieldnameExposes `name` on `epok::ActorSpawnRequest` for the object model module.FieldnameExposes `name` on `epok::NativeComponentDefault` for the object model module.FieldNoneNamed value `None` in `epok::ObjectDomain`.Enum valueObjectNamed value `Object` in `epok::ObjectFamily`.Enum valueobject_class_countExposes `object_class_count` on the `epok` namespace for the object model module.Variableobject_classesEmitted by the Rust cook next to the scene banks.Variableobject_hierarchy_depthExposes `object_hierarchy_depth` on the `epok` namespace for the object model module.VariableObjectClassAbstractNamed value `ObjectClassAbstract` in `epok::ObjectClassFlags`.Enum valueObjectClassMultipleNamed value `ObjectClassMultiple` in `epok::ObjectClassFlags`.Enum valueObjectClassPlaceableNamed value `ObjectClassPlaceable` in `epok::ObjectClassFlags`.Enum valueObjectClassRootNamed value `ObjectClassRoot` in `epok::ObjectClassFlags`.Enum valueObjectClassSceneManagedNamed value `ObjectClassSceneManaged` in `epok::ObjectClassFlags`.Enum valueObjectClassSpawnableNamed value `ObjectClassSpawnable` in `epok::ObjectClassFlags`.Enum valueowners_maskExposes `owners_mask` on `epok::ClassDescriptor` for the object model module.Fieldowns_storageExposes `owns_storage` on `epok::ObjectSlot` for the object model module.FieldparentExposes `parent` on `epok::ClassDescriptor` for the object model module.FieldpeakExposes `peak` on `epok::ObjectStats` for the object model module.Fieldpending_releasesExposes `pending_releases` on `epok::ObjectRegistry` for the object model module.FieldPhysicsNamed value `Physics` in `epok::TickGroup`.Enum valuePlayingNamed value `Playing` in `epok::ObjectState`.Enum valuepositionExposes `position` on `epok::Transform2D` for the object model module.FieldPostPhysicsNamed value `PostPhysics` in `epok::TickGroup`.Enum valuequarantinedExposes `quarantined` on `epok::ObjectStats` for the object model module.FieldQuitNamed value `Quit` in `epok::EndPlayReason`.Enum valuereasonExposes `reason` on `epok::LevelPendingOp` for the object model module.FieldrectExposes `rect` on `epok::RectTransformComponent` for the object model module.FieldregistryExposes `registry` on `epok::ObjectDispatchScope` for the object model module.FieldregistryExposes `registry` on `epok::World` for the object model module.FieldrejectedExposes `rejected` on `epok::ObjectStats` for the object model module.FieldreleaseExposes `release` on `epok::ClassDescriptor` for the object model module.FieldreleasingExposes `releasing` on `epok::ObjectSlot` for the object model module.FieldrequestExposes `request` on `epok::LevelPendingOp` for the object model module.FieldReservedNamed value `Reserved` in `epok::ObjectState`.Enum valuerootExposes `root` on `epok::Actor2D` for the object model module.FieldrootExposes `root` on `epok::Actor3D` for the object model module.FieldrootExposes `root` on `epok::NativeComponentDefault` for the object model module.FieldrootExposes `root` on `epok::UIActor` for the object model module.FieldrotationExposes `rotation` on `epok::Transform2D` for the object model module.FieldscaleExposes `scale` on `epok::Transform2D` for the object model module.Fieldsha256_kExposes `sha256_k` on the `epok::detail` namespace for the object model module.VariablesizeExposes `size` on `epok::ClassDescriptor` for the object model module.FieldslotsExposes `slots` on `epok::ObjectRegistry` for the object model module.FieldsourceExposes `source` on `epok::AudioComponent` for the object model module.FieldspawnedExposes `spawned` on `epok::ObjectStats` for the object model module.FieldstateExposes `state` on `epok::ObjectSlot` for the object model module.Fieldstatic_class_idExposes `static_class_id` on `epok::Actor` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::Actor2D` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::Actor3D` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::ActorComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::AudioComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::BlobShadowComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::Camera3DComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::CanvasComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::Collider3DComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::FocusableComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::ImageComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::LayoutContainerComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::LayoutElementComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::Level` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::Light3DComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::Mesh3DComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::Object` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::PaletteAnimatorComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::ParticleEffectComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::ParticleEmitterComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::ProgressBarComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::RectTransformComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::SceneComponent2D` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::SceneComponent3D` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::SceneScriptActor` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::Sprite3DComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::TextComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::TimelineComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::UIActor` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::UIComponent` for the object model module.Variablestatic_class_idExposes `static_class_id` on `epok::World` for the object model module.VariablestatsExposes `stats` on `epok::ObjectRegistry` for the object model module.FieldstorageExposes `storage` on `epok::SharedObjectPool` for the object model module.Variablestorage_bytesExposes `storage_bytes` on `epok::ObjectPool` for the object model module.Variablestorage_bytesExposes `storage_bytes` on `epok::SharedObjectPool` for the object model module.VariabletableExposes `table` on `epok::ObjectRegistryStorage` for the object model module.FieldtickExposes `tick` on `epok::ActorCallbacks` for the object model module.VariabletickExposes `tick` on `epok::ComponentCallbacks` for the object model module.Variabletick_groupExposes `tick_group` on `epok::ClassDescriptor` for the object model module.FieldtotalExposes `total` on `epok::ObjectBatch8` for the object model module.Fieldtransform2D actors own their transform: no legacy slot carries a Transform2D, and no fictitious 3D transform is created for them.FieldtransformView over the canonical slot transform when the owner is backed by a legacy entity.FieldtypeExposes `type` on `epok::ActorSpawnRequest` for the object model module.FieldtypeExposes `type` on `epok::ObjectSlot` for the object model module.FieldUINamed value `UI` in `epok::ObjectDomain`.Enum valueUnusedNamed value `Unused` in `epok::ObjectState`.Enum valueusedExposes `used` on `epok::ObjectPool` for the object model module.VariableusedExposes `used` on `epok::ObjectSlot` for the object model module.FieldusedExposes `used` on `epok::SharedObjectPool` for the object model module.VariablevalueExposes `value` on `epok::ActivationCallbacks` for the object model module.VariablevalueExposes `value` on `epok::TickGroupOf` for the object model module.Variablevalue_bytesExposes `value_bytes` on `epok::SharedObjectPool` for the object model module.VariablevaluesExposes `values` on `epok::ObjectPool` for the object model module.VariableWorldNamed value `World` in `epok::ObjectFamily`.Enum valueWorld2DNamed value `World2D` in `epok::ObjectDomain`.Enum valueWorld3DNamed value `World3D` in `epok::ObjectDomain`.Enum value