Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.ParticleEffectMapping Class Reference

Maps animation states to particle effects. More...

Public Attributes

AnimationState state
 The animation state. More...
 
ParticleSystem particleSystem
 The particles. More...
 
float repeatInterval
 How often we should repeat this effect or 0 for a one shot. More...
 
LayerMask groundLayer
 Only play this effect if the ground layer is in the layer mask. Note that NOTHING means always match. More...
 
AnimationState previousState
 The required previous state. Use NONE to ignore previous state. More...
 
bool isStop
 If true instead of starting the referenced system we stop it. More...
 
bool clearSystem
 If true should we also call clear when we stop the particle system. More...
 
ParticleEffectType effectType
 How does this effect work. More...
 
Vector3 offset
 The offset from character position (used for detaached and instantiated particle effects). More...
 
bool rotateToFacingDirection
 If true the effects game object will be set to Euler 0,0,180 degrees if facing left and 0,0,0 degrees if facing right. For instantiated objects the game object will rotated by 180 degrees in Z when facing left. More...
 

Detailed Description

Maps animation states to particle effects.

Member Data Documentation

◆ clearSystem

bool PlatformerPro.ParticleEffectMapping.clearSystem

If true should we also call clear when we stop the particle system.

◆ effectType

ParticleEffectType PlatformerPro.ParticleEffectMapping.effectType

How does this effect work.

◆ groundLayer

LayerMask PlatformerPro.ParticleEffectMapping.groundLayer

Only play this effect if the ground layer is in the layer mask. Note that NOTHING means always match.

◆ isStop

bool PlatformerPro.ParticleEffectMapping.isStop

If true instead of starting the referenced system we stop it.

◆ offset

Vector3 PlatformerPro.ParticleEffectMapping.offset

The offset from character position (used for detaached and instantiated particle effects).

◆ particleSystem

ParticleSystem PlatformerPro.ParticleEffectMapping.particleSystem

The particles.

◆ previousState

AnimationState PlatformerPro.ParticleEffectMapping.previousState

The required previous state. Use NONE to ignore previous state.

◆ repeatInterval

float PlatformerPro.ParticleEffectMapping.repeatInterval

How often we should repeat this effect or 0 for a one shot.

◆ rotateToFacingDirection

bool PlatformerPro.ParticleEffectMapping.rotateToFacingDirection

If true the effects game object will be set to Euler 0,0,180 degrees if facing left and 0,0,0 degrees if facing right. For instantiated objects the game object will rotated by 180 degrees in Z when facing left.

◆ state

AnimationState PlatformerPro.ParticleEffectMapping.state

The animation state.


The documentation for this class was generated from the following file: