EPOK RUNTIME

epok::bp::api::pause_effect

Function · 1 overload

Function

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

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

Declaration

bool pause_effect(effects::Handle)

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

Parameter	Type	Meaning
`arg1`	`effects::Handle`	Value 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:
// effects::Handle arg1

auto result = epok::bp::api::pause_effect(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:16

Related members

aabb_may_touchPerforms `aabb may touch` as part of bounded AABB collision queries and movement.Function template aabb_overlapPerforms `aabb overlap` as part of bounded AABB collision queries and movement.Function template aabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Function aabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Function aabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Function aabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Function activate_texture_bankPerforms `activate texture bank` as part of the epok module.Function active_cameraPerforms `active camera` as part of the epok module.Function actor_for_slotPerforms `actor for slot` as part of the actor tables module.Function allocate_actor_dataPerforms `allocate actor data` as part of the epok module.Function attach_componentSpatial attachment between components of the same domain.Function audio_initializePerforms `audio initialize` as part of SPU sound playback and voice ownership.Function