IGroundEffect

C++
struct IGroundEffect {
  enum EGroundEffectFlags {
    eGEF_AlignToGround = (1<<0),
    eGEF_AlignToOcean = (1<<1),
    eGEF_PrimeEffect = (1<<2),
    eGEF_StickOnGround = (1<<3)
  };
};
File

IEffectSystem.h

IGroundEffect::EGroundEffectFlags Enumeration
C++
enum EGroundEffectFlags {
  eGEF_AlignToGround = (1<<0),
  eGEF_AlignToOcean = (1<<1),
  eGEF_PrimeEffect = (1<<2),
  eGEF_StickOnGround = (1<<3)
};
File

IEffectSystem.h

Members
Members
Description
eGEF_AlignToOcean = (1<<1)
takes higher precedence than AlignToGround
IGroundEffect::~IGroundEffect Destructor
C++
virtual ~IGroundEffect();
IGroundEffect::GetFlags Method
C++
virtual int GetFlags() const = 0;
IGroundEffect::SetBaseScale Method
C++
virtual void SetBaseScale(float sizeScale, float countScale, float speedScale = 1.f) = 0;
Description

set additional scale parameters, if user control is needed these are always multiplied by height scale parameters

IGroundEffect::SetFlags Method
C++
virtual void SetFlags(int flags) = 0;
IGroundEffect::SetHeight Method
C++
virtual void SetHeight(float height) = 0;
Description

set maximum height

IGroundEffect::SetHeightScale Method
C++
virtual void SetHeightScale(float sizeScale, float countScale) = 0;
Description

use if effect should be scaled dependending on height ratio. scale(zero height) = 1,1 scale(max height) = sizeScale,countScale use e.g. sizeScale=0,countScale=0 to fade it out completely at max height

IGroundEffect::SetInteraction Method
C++
virtual void SetInteraction(const char* name) = 0;
Description

if an interaction name is set, the particle effect is looked up in MaterialEffects. if not, one can still call SetParticleEffect by herself

IGroundEffect::SetInterpolation Method
C++
virtual void SetInterpolation(float speed) = 0;
Description

set interpolation speed for size scale speed 0 means no interpolation

IGroundEffect::SetParticleEffect Method
C++
virtual bool SetParticleEffect(const char* name) = 0;
IGroundEffect::Stop Method
C++
virtual void Stop(bool stop) = 0;
Description

stop == true will keep the effect on hold until a stop == false is set.

IGroundEffect::Update Method
C++
virtual void Update() = 0;
Description

must be called by user