Epok Engine

EPOK RUNTIME

epok::Level::destroy_actor

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

---- 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.

Belongs to
epok::Level
Header
object_model.hpp
Overloads
1

Declaration

Declaration
bool destroy_actor(ObjectId actor, EndPlayReason reason = EndPlayReason::Destroyed)

---- 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.

ParameterTypeMeaning
actorObjectIdNot documented; consult the linked header.
reasonEndPlayReasonNot documented; consult the linked header.

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

Example sketch

C++ example
#include "object_model.hpp"

// Assume these named values have been initialized with valid data:
// ObjectId actor
// EndPlayReason reason

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

auto result = object.destroy_actor(actor, reason);

Trade-offs and warnings

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

Declared in runtime/object_model.hpp:1263

Related members