EPOK RUNTIME

epok::PlaybackLibrary::stop_sequence

Method · 1 overload

Method

Stops sequence as part of the gameplay api module.

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

Declaration

static

Declaration

static bool stop_sequence(timeline::Handle handle)

Stops sequence as part of the gameplay api module.

Parameter	Type	Meaning
`handle`	`timeline::Handle`	Value supplied for handle. 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 "gameplay_api.hpp"

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

auto result = epok::PlaybackLibrary::stop_sequence(handle);

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/gameplay_api.hpp:311

Related members