ImpactCFX.Pooling.IObjectPoolRequest Interface Reference

Interface for data that requests an object from an object pool. More...

Inheritance diagram for ImpactCFX.Pooling.IObjectPoolRequest:

Properties
bool	IsObjectPoolRequestValid [get, set]
	Is the request valid? If not, it will be skipped.
int	TemplateID [get, set]
	The ID of the template object this request is being made for.
float	Priority [get, set]
	The priority of the request.
long	ContactPointID [get, set]
	The contact point ID of the request.
bool	CheckContactPointID [get, set]
	Should the contact point ID be checked? This is required for sliding and rolling effects, but can be false for other effects to save processing.
int	ObjectIndex [get, set]
	The index of an object that can be retrieved. Will be -1 if no object was found.
bool	IsUpdate [get, set]
	Whether or not the result is a new object or an update to an already active object. Used for sliding and rolling effects.

Detailed Description

Interface for data that requests an object from an object pool.

Property Documentation

CheckContactPointID

bool ImpactCFX.Pooling.IObjectPoolRequest.CheckContactPointID

getset

Should the contact point ID be checked? This is required for sliding and rolling effects, but can be false for other effects to save processing.

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

ContactPointID

long ImpactCFX.Pooling.IObjectPoolRequest.ContactPointID

getset

The contact point ID of the request.

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

IsObjectPoolRequestValid

bool ImpactCFX.Pooling.IObjectPoolRequest.IsObjectPoolRequestValid

getset

Is the request valid? If not, it will be skipped.

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

IsUpdate

bool ImpactCFX.Pooling.IObjectPoolRequest.IsUpdate

getset

Whether or not the result is a new object or an update to an already active object. Used for sliding and rolling effects.

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

ObjectIndex

int ImpactCFX.Pooling.IObjectPoolRequest.ObjectIndex

getset

The index of an object that can be retrieved. Will be -1 if no object was found.

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

Priority

float ImpactCFX.Pooling.IObjectPoolRequest.Priority

getset

The priority of the request.

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

TemplateID

int ImpactCFX.Pooling.IObjectPoolRequest.TemplateID

getset

The ID of the template object this request is being made for.

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