Swarm::IVisualEffect class
#include <Spore ModAPI/Spore/Swarm/IVisualEffect.h>

An instance of an effect in the game.

The effect can receive transformations. Use Start() to activate the instance and Stop() to destroy the effect.

Derived classes

class cVisualEffect

Public functions

auto AddRef() -> int pure virtual
auto Release() -> int pure virtual
auto Start(int hardStart = 1) -> void pure virtual
auto Stop(int hardStop = 1) -> int pure virtual
auto IsRunning() -> int pure virtual
auto SetRigidTransform(const Transform&) -> void pure virtual
auto SetSourceTransform(const Transform& transform) -> void pure virtual
auto GetRigidTransform() const -> Transform pure virtual
auto GetSourceTransform() const -> Transform pure virtual
auto SetBone(void* pBone, int boneType) -> void pure virtual
auto GetBone(int boneType) -> void* pure virtual
auto SetIsPaused(bool paused) -> void pure virtual
If true, pauses the effect; if false, it unpauses it.
auto SetIsHidden(bool hidden) -> void pure virtual
auto GetIsPaused() -> bool pure virtual
auto GetIsHidden() -> bool pure virtual
auto SetSeed(int32_t seed) -> void pure virtual
auto SetVectorParams(FloatParams param, const Math::Vector3* data, int count) -> bool pure virtual
auto SetFloatParams(FloatParams param, const float* data, int count) -> bool pure virtual
auto SetIntParams(IntParams param, const int* data, int count) -> bool pure virtual
auto SetUnknownParam(ObjectParams param, Object* data) -> bool pure virtual
auto GetVectorParams(FloatParams param, int* dstCount = nullptr) -> const Math::Vector3& pure virtual
auto GetFloatParams(FloatParams params, int* dstCount = nullptr) -> const float* pure virtual
auto GetIntParams(IntParams param, int* dstCount = nullptr) -> const int* pure virtual
auto GetUnknownParam(ObjectParams params) -> Object* pure virtual
auto GetEffectID() -> ResourceID pure virtual
auto SetNotifyMessage(int, int) -> void pure virtual

Function documentation

void Swarm::IVisualEffect::SetIsPaused(bool paused) pure virtual

If true, pauses the effect; if false, it unpauses it.

Parameters
paused