Epok Engine

EPOK RUNTIME

epok::PocketStationService::set_value

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

Pocket Lua link: sets value `index` (1-16), read with `link.value(index)`.

Belongs to
epok::PocketStationService
Header
pocketstation.hpp
Overloads
1

Declaration

Declaration
PocketError set_value(uint8_t index, int32_t value, unsigned port = 0)

Pocket Lua link: sets value `index` (1-16), read with `link.value(index)`.

ParameterTypeMeaning
indexuint8_tNot documented; consult the linked header.
valueint32_tNot documented; consult the linked header.
portunsigned intNot documented; consult the linked header.

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

Example sketch

C++ example
#include "pocketstation.hpp"

// Assume these named values have been initialized with valid data:
// uint8_t index
// int32_t value
// unsigned int port

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

auto result = object.set_value(index, value, port);

Trade-offs and warnings

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

Declared in runtime/pocketstation.hpp:349

Related members