Effector Class Reference

Periodically applies some effect to all the contexts in its effect list, such as damage or healing. More...

Public Member Functions
void	AddContext (Context instigator, Context target)
	Adds a context to the effector context list.
void	RemoveContext (Context instigator, Context target)
	Removes a context from the effector context list.
void	SetInitialInterval (Context instigator, float newInterval)
	Sets the initial effect interval for the effector.
void	SetIntervalScalar (Context instigator, float newScalar)
	Sets the scalar value for the effector interval.
void	Deactivate (Context instigator)
	Deactivates the periodic effector.
void	Activate (Context instigator)
	Activates the periodic effector.

Detailed Description

Periodically applies some effect to all the contexts in its effect list, such as damage or healing.

Member Function Documentation

Activate()

void Activate

(

Context

instigator

)

Activates the periodic effector.

Parameters

instigator

The source context triggering this change

AddContext()

void AddContext	(	Context	instigator,
		Context	target )

Adds a context to the effector context list.

Parameters

instigator	The source context triggering this change
target	The context to add to the effector context list

Deactivate()

void Deactivate

(

Context

instigator

)

Deactivates the periodic effector.

Parameters

instigator

The source context triggering this change

RemoveContext()

void RemoveContext	(	Context	instigator,
		Context	target )

Removes a context from the effector context list.

Parameters

instigator	The source context triggering this change
target	The context to remove from the context list.

SetInitialInterval()

void SetInitialInterval	(	Context	instigator,
		float	newInterval )

Sets the initial effect interval for the effector.

Parameters

instigator	The source context triggering this change
newInterval	The new initial interval

SetIntervalScalar()

void SetIntervalScalar	(	Context	instigator,
		float	newScalar )

Sets the scalar value for the effector interval.

Parameters

instigator	The source context triggering this change
newScalar	The new scalar value for the effector interval