Epok Engine

EPOK RUNTIME

epok::bp::api::pause_sequence

Function · 1 overload

Function

Pauses sequence as part of compiled Blueprint execution and object interaction.

Belongs to
epok::bp::api
Header
blueprint_api.hpp
Overloads
1

Declaration

Declaration
bool pause_sequence(timeline::Handle)

Pauses sequence as part of compiled Blueprint execution and object interaction.

ParameterTypeMeaning
arg1timeline::HandleValue supplied for arg1. Keep referenced or pointed-to data valid for the complete call.

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

Example

C++ example
#include "blueprint_api.hpp"

// Assume these named values have been initialized with valid data:
// timeline::Handle arg1

auto result = epok::bp::api::pause_sequence(arg1);

Why use it

The boolean result makes success, availability or state explicit without exceptions.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations.

Declared in runtime/blueprint_api.hpp:11

Related members