Impact CFX API 1.5.0
Comprehensive API documentation for Impact CFX - Collision Effects System
Loading...
Searching...
No Matches
ImpactCFX.IEffectData< TResult > Interface Template Reference

Interface for impact effect data that is suitable for jobs. More...

Inheritance diagram for ImpactCFX.IEffectData< TResult >:
ImpactCFX.IMultiPrefabEffectData< TResult > ImpactCFX.IPooledEffectData< TResult >

Public Member Functions

TResult GetResult (CollisionInputData collisionData, MaterialCompositionData materialCompositionData, ImpactVelocityData velocityData, ref Random random)
 Gets an interaction result based on the given input collision data.
 

Properties

int EffectID [get, set]
 Unique identifier for this effect.
 
ImpactTagMaskFilter IncludeTags [get, set]
 Tags that must be present for the effect to be used.
 
ImpactTagMaskFilter ExcludeTags [get, set]
 Tags that, if present, will make the effect not be used.
 

Detailed Description

Interface for impact effect data that is suitable for jobs.

Template Parameters
TResultThe type of result struct that this effect returns.
Type Constraints
TResult :struct 
TResult :IEffectResult 

Member Function Documentation

◆ GetResult()

TResult ImpactCFX.IEffectData< TResult >.GetResult ( CollisionInputData  collisionData,
MaterialCompositionData  materialCompositionData,
ImpactVelocityData  velocityData,
ref Random  random 
)

Gets an interaction result based on the given input collision data.

Parameters
collisionDataThe collision data that will be used to calculate the result.
materialCompositionDataThe material data of the object being collided with.
velocityDataThe velocity of the collision.
randomReference to a Random generator for any randomness required by the effect.
Returns
Data describing the result of the interaction.