DirectOutput.FX.EffectEffectBase Class Reference

Base class for effects targeting another effect. More...

Inheritance diagram for DirectOutput.FX.EffectEffectBase:

Collaboration diagram for DirectOutput.FX.EffectEffectBase:

Public Member Functions
override void	Init (Table.Table Table)
	Initializes the EffectEffect. Resolves the name of the TargetEffect. More...
override void	Finish ()
	Finishes the EffectEffect. Releases the references to the target effect and to the table object. More...
Public Member Functions inherited from DirectOutput.FX.EffectBase
abstract void	Trigger (TableElementData TableElementData)
	Triggers the effect with the given TableElementData. More...
abstract void	Init (Table.Table Table)
	Init does all necessary initialization work after the effect object has been instanciated. More...

Protected Attributes
Table.Table	Table

Properties
string	TargetEffectName [get, set]
	Name of the target effect. Triggers EffectNameChanged if value is changed. More...
IEffect	TargetEffect [get, set]
	TargetEffect for the effect (ReadOnly). The property is resolved from the TargetEffectName. If TargetEffectName is empty or unknown this property will return null. More...

Additional Inherited Members
Events inherited from DirectOutput.General.Generic.NamedItemBase
EventHandler< NameChangeEventArgs >	AfterNameChanged
	Event is fired after the value of the property Name has changed. More...
EventHandler< NameChangeEventArgs >	BeforeNameChange
	Event is fired before the value of the property Name is changed. More...
Events inherited from DirectOutput.FX.IEffect
new EventHandler < NameChangeEventArgs >	AfterNameChanged
	This event must be fired after the Name property of a IEffect object has changed. More...
new EventHandler < NameChangeEventArgs >	BeforeNameChange
	This event must be fired before the Name property of a IEffect object is changed. More...

Detailed Description

Base class for effects targeting another effect.

Definition at line 8 of file EffectEffectBase.cs.

Member Function Documentation

override void DirectOutput.FX.EffectEffectBase.Finish ( )

inlinevirtual

Finishes the EffectEffect.
Releases the references to the target effect and to the table object.

Reimplemented from DirectOutput.FX.EffectBase.

Reimplemented in DirectOutput.FX.TimmedFX.BlinkEffect, DirectOutput.FX.TimmedFX.MinDurationEffect, DirectOutput.FX.TimmedFX.DurationEffect, DirectOutput.FX.TimmedFX.ExtendDurationEffect, and DirectOutput.FX.TimmedFX.DelayEffect.

Definition at line 84 of file EffectEffectBase.cs.

override void DirectOutput.FX.EffectEffectBase.Init ( Table.Table  Table )

inline

Initializes the EffectEffect.
Resolves the name of the TargetEffect.

Parameters

Table

Table object containing the effect.

Definition at line 74 of file EffectEffectBase.cs.

Member Data Documentation

Table.Table DirectOutput.FX.EffectEffectBase.Table

protected

Definition at line 67 of file EffectEffectBase.cs.

Property Documentation

IEffect DirectOutput.FX.EffectEffectBase.TargetEffect

getset

TargetEffect for the effect (ReadOnly).
The property is resolved from the TargetEffectName. If TargetEffectName is empty or unknown this property will return null.

Definition at line 45 of file EffectEffectBase.cs.

string DirectOutput.FX.EffectEffectBase.TargetEffectName

getset

Name of the target effect.
Triggers EffectNameChanged if value is changed.

Definition at line 17 of file EffectEffectBase.cs.

---

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

• C:/Users/Tom/Documents/GitHub/DirectOutput/DirectOutput/FX/EffectEffectBase.cs