Epok Engine

EPOK RUNTIME

Interaction

interaction.hpp · the interaction 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 interaction module.

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

Include this module

C++ include
#include "interaction.hpp"

Types

Functions and methods

~InteractableComponentReleases the resources owned by `epok::InteractableComponent`.destructor~InteractorComponentReleases the resources owned by `epok::InteractorComponent`.destructoractivation_changedPerforms `activation changed` as part of the interaction module.FunctionactorPerforms `actor` as part of the interaction module.FunctionaddAdds add as part of the interaction module.MethodavailabilityPerforms `availability` as part of the interaction module.Methodbinding_statusPerforms `binding status` as part of the interaction module.Methodbinding_statusPerforms `binding status` as part of the interaction module.Methodcan_interactPerforms `can interact` as part of the interaction module.Methodcandidate_countPerforms `candidate count` as part of the interaction module.Methodclass_idPerforms `class id` as part of the interaction module.Methodclass_idPerforms `class id` as part of the interaction module.Methodclass_idPerforms `class id` as part of the interaction module.Methodclass_idPerforms `class id` as part of the interaction module.Methodclass_idPerforms `class id` as part of the interaction module.Methodclass_idPerforms `class id` as part of the interaction module.Methodclass_idPerforms `class id` as part of the interaction module.Methodclass_idPerforms `class id` as part of the interaction module.MethodcompletePerforms `complete` as part of the interaction module.MethodconfigurePerforms `configure` as part of the interaction module.MethodconfigurePerforms `configure` as part of the interaction module.Methoddistance_squaredPerforms `distance squared` as part of the interaction module.FunctiondomainPerforms `domain` as part of the interaction module.Functionfocus_changedPerforms `focus changed` as part of the interaction module.Methodfocus_gainedPerforms `focus gained` as part of the interaction module.Methodfocus_lostPerforms `focus lost` as part of the interaction module.Methodfocused_targetPerforms `focused target` as part of the interaction module.Methodforget_sensorPerforms `forget sensor` as part of the interaction module.Functionforget_sensorPerforms `forget sensor` as part of the interaction module.Methodframe_updatePerforms `frame update` as part of the interaction module.Methodframe_updatePerforms `frame update` as part of the interaction module.Methodframe_updatePerforms `frame update` as part of the interaction module.Methodframe_updateFramework work precedes the extensible on_frame event, including in Lua/BP subclasses.Methodhold_openPerforms `hold open` as part of the interaction module.MethodinteractPerforms `interact` as part of the interaction module.Methodinteraction_finishedPerforms `interaction finished` as part of the interaction module.Methodinteraction_startedPerforms `interaction started` as part of the interaction module.Methodis_busyReports whether busy as part of the interaction module.Methodlevel_attachedPerforms `level attached` as part of the interaction module.Methodlevel_attachedPerforms `level attached` as part of the interaction module.Methodlevel_attachedPerforms `level attached` as part of the interaction module.MethodLink<T>Constructs `epok::interaction::Link` for the interaction module.constructorlivePerforms `live` as part of the interaction module.Functionoperator=Performs `operator =` as part of the interaction module.Methodoverflow_countPerforms `overflow count` as part of the interaction module.MethodpositionPerforms `position` as part of the interaction module.Functionprune_lifetimePerforms `prune lifetime` as part of the interaction module.Methodprune_lifetimePerforms `prune lifetime` as part of the interaction module.Methodradius_squaredPerforms `radius squared` as part of the interaction module.FunctionrefreshPerforms `refresh` as part of the interaction module.Methodregister_candidatePerforms `register candidate` as part of the interaction module.MethodremoveRemoves remove as part of the interaction module.MethodrequestRequests request as part of the interaction module.Methodsensor_bindingPerforms `sensor binding` as part of the interaction module.Functionsensor_eventPerforms `sensor event` as part of the interaction module.Functionset_enabledSets enabled as part of the interaction module.Methodset_monitoringSets monitoring as part of the interaction module.Methodset_monitoringSets monitoring as part of the interaction module.Methodsource_livePerforms `source live` as part of the interaction module.Functiontrigger_eventPerforms `trigger event` as part of the interaction module.Methodtrigger_eventPerforms `trigger event` as part of the interaction module.Methodunregister_candidatePerforms `unregister candidate` as part of the interaction module.Method

Fields, variables and values

AcceptedNamed value `Accepted` in `epok::InteractionResult`.Enum valueaccepted_initiatorExposes `accepted_initiator` on `epok::InteractionSensor2DComponent` for the interaction module.Fieldaccepted_initiatorExposes `accepted_initiator` on `epok::InteractionSensor3DComponent` for the interaction module.Fieldauto_inputExposes `auto_input` on `epok::InteractorComponent` for the interaction module.FieldBusyNamed value `Busy` in `epok::InteractionResult`.Enum valuedepthExposes `depth` on `epok::InteractionSensor3DComponent` for the interaction module.FieldDomainMismatchNamed value `DomainMismatch` in `epok::InteractionResult`.Enum valueenabledExposes `enabled` on `epok::InteractableComponent` for the interaction module.FieldenabledExposes `enabled` on `epok::InteractorComponent` for the interaction module.FieldheadExposes `head` on `epok::interaction::List` for the interaction module.FieldheightExposes `height` on `epok::InteractionSensor2DComponent` for the interaction module.FieldheightExposes `height` on `epok::InteractionSensor3DComponent` for the interaction module.Fieldinput_portExposes `input_port` on `epok::InteractionPromptComponent` for the interaction module.Fieldinput_portExposes `input_port` on `epok::InteractorComponent` for the interaction module.Fieldinteraction_linkExposes `interaction_link` on `epok::InteractableComponent` for the interaction module.Fieldinteraction_linkExposes `interaction_link` on `epok::InteractorComponent` for the interaction module.FieldinteractorExposes `interactor` on `epok::InteractionPromptComponent` for the interaction module.FieldinteractorsExposes `interactors` on the `epok::interaction` namespace for the interaction module.VariableInvalidOwnerNamed value `InvalidOwner` in `epok::InteractionResult`.Enum valueMissingBindingNamed value `MissingBinding` in `epok::InteractionResult`.Enum valuemonitoringExposes `monitoring` on `epok::InteractionSensor2DComponent` for the interaction module.FieldmonitoringExposes `monitoring` on `epok::InteractionSensor3DComponent` for the interaction module.FieldnextExposes `next` on `epok::interaction::Link` for the interaction module.FieldOutOfRangeNamed value `OutOfRange` in `epok::InteractionResult`.Enum valuepresenterExposes `presenter` on `epok::InteractionPrompt` for the interaction module.FieldpreviousExposes `previous` on `epok::interaction::Link` for the interaction module.FieldpriorityExposes `priority` on `epok::InteractableComponent` for the interaction module.Fieldprompt_keyExposes `prompt_key` on `epok::InteractableComponent` for the interaction module.FieldproximityExposes `proximity` on `epok::InteractorComponent` for the interaction module.Fieldrange_2dExposes `range_2d` on `epok::InteractableComponent` for the interaction module.Fieldrange_2dExposes `range_2d` on `epok::InteractorComponent` for the interaction module.Fieldrange_3dExposes `range_3d` on `epok::InteractableComponent` for the interaction module.Fieldrange_3dExposes `range_3d` on `epok::InteractorComponent` for the interaction module.FieldregistryExposes `registry` on `epok::interaction::Link` for the interaction module.Fieldselection_orderThe cook assigns the rank of the persistent component UUID unless overridden.FieldsensorExposes `sensor` on `epok::TriggerArea2D` for the interaction module.FieldsensorExposes `sensor` on `epok::TriggerBox3D` for the interaction module.Fieldstatic_class_idExposes `static_class_id` on `epok::InteractableComponent` for the interaction module.Variablestatic_class_idExposes `static_class_id` on `epok::InteractionPrompt` for the interaction module.Variablestatic_class_idExposes `static_class_id` on `epok::InteractionPromptComponent` for the interaction module.Variablestatic_class_idExposes `static_class_id` on `epok::InteractionSensor2DComponent` for the interaction module.Variablestatic_class_idExposes `static_class_id` on `epok::InteractionSensor3DComponent` for the interaction module.Variablestatic_class_idExposes `static_class_id` on `epok::InteractorComponent` for the interaction module.Variablestatic_class_idExposes `static_class_id` on `epok::TriggerArea2D` for the interaction module.Variablestatic_class_idExposes `static_class_id` on `epok::TriggerBox3D` for the interaction module.VariabletargetExposes `target` on `epok::InteractionSensor2DComponent` for the interaction module.FieldtargetExposes `target` on `epok::InteractionSensor3DComponent` for the interaction module.FieldtargetsExposes `targets` on the `epok::interaction` namespace for the interaction module.VariabletextExposes `text` on `epok::InteractionPrompt` for the interaction module.FieldUnavailableNamed value `Unavailable` in `epok::InteractionResult`.Enum valuewidthExposes `width` on `epok::InteractionSensor2DComponent` for the interaction module.FieldwidthExposes `width` on `epok::InteractionSensor3DComponent` for the interaction module.Field