EPOK RUNTIME

epok::PlaybackLibrary::play_effect

Method · 1 overload

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.

Parameter	Type	Meaning
`component`	`ObjectId`	Value supplied for component. Keep referenced or pointed-to data valid for the complete call.

Returns: effects::Handle. Check the value before continuing when it represents success, availability or a resource handle.

Example

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);

Why use it

It provides direct, allocation-conscious access to the gameplay api module. No exception-based error path is implied by the signature.

Trade-offs and warnings

Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.

Declared in runtime/gameplay_api.hpp:315

Related members