BaseProjectileEffect Interface Reference

Inheritance diagram for BaseProjectileEffect:

Public Member Functions
proto external bool	HasFinished ()
	Ask if the effect has finished or not.
proto external void	SetHasFinished (bool value)
	Set if the effect is finished or not.
proto external bool	IsEnabled ()
	Ask if the effect is enabled or not.
proto external void	SetIsEnabled (bool value)
	Set if the effect is finished or not.
void	OnInit (IEntity owner)
	Called during EOnInit.
void	OnEffect (IEntity pHitEntity, inout vector outMat[3], IEntity damageSource, notnull Instigator instigator, string colliderName, float speed)
	Called when the effect is being applied.
void	OnFrame (IEntity owner, float timeSlice)
	Called during EOnFrame.
bool	ShouldTick ()
	OnFrame function should be called.

Member Function Documentation

HasFinished()

proto external bool BaseProjectileEffect.HasFinished

(

)

Ask if the effect has finished or not.

Returns

Returns true when a TICKABLE projectile effect has ended

IsEnabled()

proto external bool BaseProjectileEffect.IsEnabled

(

)

Ask if the effect is enabled or not.

OnEffect()

void BaseProjectileEffect.OnEffect	(	IEntity	pHitEntity,
		inout vector	outMat[3],
		IEntity	damageSource,
		notnull Instigator	instigator,
		string	colliderName,
		float	speed
	)

Called when the effect is being applied.

Parameters

pHitEntity	Damaged entity
outMat	Hit position/direction/normal
damageSource	Projectile
Instigator	Instigator of the damage
colliderName	Collider name if exist otherwise empty
speed	Projectile velocity in m/s

OnFrame()

void BaseProjectileEffect.OnFrame	(	IEntity	owner,
		float	timeSlice
	)

Called during EOnFrame.

Parameters

owner	Entity this component is attached to.
timeSlice	Delta time since last update.

OnInit()

void BaseProjectileEffect.OnInit

(

IEntity

owner

)

Called during EOnInit.

Parameters

owner

Entity this component is attached to.

SetHasFinished()

proto external void BaseProjectileEffect.SetHasFinished

(

bool

value

)

Set if the effect is finished or not.

SetIsEnabled()

proto external void BaseProjectileEffect.SetIsEnabled

(

bool

value

)

Set if the effect is finished or not.

ShouldTick()

bool BaseProjectileEffect.ShouldTick

(

)

OnFrame function should be called.

Returns

Returns true if OnFrame function should be called.

---

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

• Game/generated/Projectile/BaseProjectileEffect.c