Epok Engine

EPOK RUNTIME

epok::InteractorComponent::register_candidate

Method · 1 overload

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.

Method

Performs `register candidate` as part of the interaction module.

Belongs to
epok::InteractorComponent
Header
interaction.hpp
Overloads
1

Declaration

Declaration
bool register_candidate(ObjectId value,ObjectId sensor)

Performs `register candidate` as part of the interaction module.

ParameterTypeMeaning
valueObjectIdNot documented; consult the linked header.
sensorObjectIdNot documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

C++ example
#include "interaction.hpp"

// Assume these named values have been initialized with valid data:
// ObjectId value
// ObjectId sensor

epok::InteractorComponent& object = /* obtain a valid instance */;

auto result = object.register_candidate(value, sensor);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/interaction.hpp:226

Related members