Impact CFX API 1.5.0
Comprehensive API documentation for Impact CFX - Collision Effects System
Loading...
Searching...
No Matches
ImpactCFX.IEffectResult Interface Reference

General interface for results of effects that is suitable for jobs. More...

Inheritance diagram for ImpactCFX.IEffectResult:
ImpactCFX.Audio.AudioEffectResult ImpactCFX.IMultiPrefabEffectResult ImpactCFX.Decals.DecalEffectResult ImpactCFX.Particles.ParticleEffectResult

Properties

bool IsEffectValid [get, set]
 Results can be marked by an effect as invalid to save processing.
 
int CollisionIndex [get, set]
 The index of the original collision data that created this result.
 
int MaterialCompositionIndex [get, set]
 The index of the original material composition data that created this result.
 

Detailed Description

General interface for results of effects that is suitable for jobs.

Property Documentation

◆ CollisionIndex

int ImpactCFX.IEffectResult.CollisionIndex
getset

The index of the original collision data that created this result.

Implemented in ImpactCFX.Audio.AudioEffectResult, ImpactCFX.Decals.DecalEffectResult, and ImpactCFX.Particles.ParticleEffectResult.

◆ IsEffectValid

bool ImpactCFX.IEffectResult.IsEffectValid
getset

Results can be marked by an effect as invalid to save processing.

Implemented in ImpactCFX.Audio.AudioEffectResult, ImpactCFX.Decals.DecalEffectResult, and ImpactCFX.Particles.ParticleEffectResult.

◆ MaterialCompositionIndex

int ImpactCFX.IEffectResult.MaterialCompositionIndex
getset

The index of the original material composition data that created this result.

Implemented in ImpactCFX.Audio.AudioEffectResult, ImpactCFX.Decals.DecalEffectResult, and ImpactCFX.Particles.ParticleEffectResult.