Swarm::IEffect class

An instance of an effect in the game.

Contents

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

Public types

enum IntParams { kParamModelOverride = 0, kParamTextureOverride = 1, kParamSelectFrame = 2, kParamSelectState = 3, kParamDistID = 4, kParamDistUpdate = 5, kParamIntUser1 = 6, kParamIntUser2 = 7, kParamIntUser3 = 8, kParamIntUser4 = 9 }
enum FloatParams { kParamEmitStrength = 0, kParamParticleSizeScale = 1, kParamParticleLifeScale = 2, kParamEmitScale = 3, kParamTransparency = 4, kParamColor = 5, kParamColorList = 6, kParamTargetPoint = 7, kParamExplosionLocation = 8, kParamAttractorLocation = 9, kParamAttractorIntensity = 10, kParamViewRay = 11, kParamEmissionVolume = 12, kParamPath = 13, kParamShaderParams = 14, kParamVolume = 15, kParamHeightRange = 16, kParamSubdivWindow = 17, kParamMapForceScale = 18, kParamLodDistanceScale = 19, kParamDistributeSizeScale = 20, kParamFloatUser1 = 21, kParamFloatUser2 = 22, kParamFloatUser3 = 23, kParamFloatUser4 = 24 }
enum ObjectParams { }

Public functions

auto AddRef() -> int pure virtual
auto Release() -> int pure virtual
void Start(int hardStart = 1) pure virtual
auto Stop(int hardStop = 1) -> int pure virtual
auto IsRunning() -> int pure virtual
void func14h(const Transform&) pure virtual
void SetTransform(const Transform& transform) pure virtual
auto func1Ch() const -> Transform pure virtual
auto GetTransform() const -> Transform pure virtual
void func24h(int, int) pure virtual
auto func28h(int) -> int pure virtual
void SetPaused(bool paused) pure virtual
If true, pauses the effect; if false, it unpauses it.
void SetHidden(bool hidden) pure virtual
auto IsPaused() -> bool pure virtual
auto IsHidden() -> bool pure virtual
void SetSeed(int32_t seed) pure virtual
auto SetVectorParams(FloatParams param, const 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 SetObjectParam(ObjectParams param, Object* data) -> bool pure virtual
auto GetVectorParams(FloatParams param, int* dstCount = nullptr) -> const 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 GetObjectParam(ObjectParams params) -> Object* pure virtual
auto GetName() -> ResourceID pure virtual
void func64h(int, int) pure virtual

Enum documentation

enum Swarm::IEffect::IntParams

Enumerators
kParamModelOverride

Set an override model. This requires two parameters: int overrideSet and uint32_t name

kParamTextureOverride

Set an override texture. This requires two parameters: int overrideSet and uint32_t name

kParamSelectFrame

Select the given particle texture frame.

kParamSelectState

Select the given effect state (Swarm::SwarmState)

kParamDistID

Used in Distribute effects, expects a ResourceID*.

kParamDistUpdate

kParamIntUser1

kParamIntUser2

kParamIntUser3

kParamIntUser4

Function documentation

void Swarm::IEffect::SetPaused(bool paused) pure virtual

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

Parameters
paused