Epok Engine

EPOK RUNTIME

epok::ParticleEmitterComponent::state

Method · 1 overload

Method

Performs `state` as part of the object model module.

Belongs to
epok::ParticleEmitterComponent
Header
object_model.hpp
Overloads
1

Declaration

const
Declaration
ParticleEmitterState state() const

Performs `state` as part of the object model module.

This overload takes no parameters.

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

Example

C++ example
#include "object_model.hpp"

epok::ParticleEmitterComponent& object = /* obtain a valid instance */;

auto result = object.state();

Why use it

The method is `const`, so it does not mutate the object through this API surface.

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/object_model.hpp:833

Related members

burstPerforms `burst` as part of the object model module.Methodclass_idPerforms `class id` as part of the object model module.Methodentity_slotPerforms `entity slot` as part of the object model module.MethodplayStarts play as part of the object model module.Methodset_enabledSets enabled as part of the object model module.Methodset_lifetimeSets lifetime as part of the object model module.Methodset_max_particlesSets max particles as part of the object model module.Methodset_rateSets rate as part of the object model module.MethodstopStops stop as part of the object model module.Method