Epok Engine

EPOK RUNTIME

epok::PlaybackLibrary::play_effect

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

Starts effect as part of the gameplay api module.

Belongs to
epok::PlaybackLibrary
Header
gameplay_api.hpp
Overloads
1

Declaration

static
Declaration
static effects::Handle play_effect(ObjectId component)

Starts effect as part of the gameplay api module.

ParameterTypeMeaning
componentObjectIdNot documented; consult the linked header.

Returns: effects::Handle. Consult the linked header for its meaning.

Example sketch

C++ example
#include "gameplay_api.hpp"

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

auto result = epok::PlaybackLibrary::play_effect(component);

Trade-offs and warnings

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

Declared in runtime/gameplay_api.hpp:505

Related members