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

Inheritance diagram for DirectOutput.FX.EffectEffectBase:

[legend]

Collaboration diagram for DirectOutput.FX.EffectEffectBase:

[legend]

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

Protected Member Functions
void	TriggerTargetEffect (TableElementData TriggerData)
	Triggers the target effect. The method will deactivate the target effect if it throws a exception.
Protected Member Functions inherited from DirectOutput.General.Generic.NamedItemBase
virtual void	AfterNameChange (string OldName, string NewName)
virtual void	BeforeNameChange (string OldName, string NewName)
virtual void	OnPropertyChanged (string propertyName)
virtual void	OnPropertyChanging (string propertyName)

Properties
string	TargetEffectName `[get, set]`
	Name of the target effect. Triggers EffectNameChanged if value is changed.
IEffect	TargetEffect `[get]`
	TargetEffect for the effect (ReadOnly). The property is resolved from the TargetEffectName. If TargetEffectName is empty or unknown this property will return null.
Table.Table	Table `[get]`
	Gets the table object which is hosting the effect.
Properties inherited from DirectOutput.General.Generic.NamedItemBase
string	Name `[get, set]`
	Name of the named item. Triggers BeforeNameChange before a new Name is set. Triggers AfterNameChanged after a new name has been set.
Properties inherited from DirectOutput.FX.IEffect
new string	Name `[get, set]`
	Name of the effect.

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.
EventHandler< NameChangeEventArgs >	BeforeNameChanged
	Event is fired before the value of the property Name is changed.
PropertyChangedEventHandler	PropertyChanged
PropertyChangingEventHandler	PropertyChanging
Events inherited from DirectOutput.General.Generic.INamedItem
EventHandler< NameChangeEventArgs >	BeforeNameChanged
	Occurs before the name of the item changes.
EventHandler< NameChangeEventArgs >	AfterNameChanged
	Occurs when after the name of the item has changed.
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.
new EventHandler< NameChangeEventArgs >	BeforeNameChanged
	This event must be fired before the Name property of a IEffect object is changed.

Detailed Description

Base class for effects targeting another effect.

Member Function Documentation

◆ Finish()

override void DirectOutput.FX.EffectEffectBase.Finish ( )

virtual

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

Reimplemented from DirectOutput.FX.EffectBase.

Reimplemented in DirectOutput.FX.ConditionFX.TableElementConditionEffect, DirectOutput.FX.TimmedFX.ExtendDurationEffect, and DirectOutput.FX.TimmedFX.MinDurationEffect.

◆ Init()

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

Initializes the EffectEffect.
Resolves the name of the TargetEffect.

Parameters

Table Table object containing the effect.

Implements DirectOutput.FX.IEffect.

◆ TriggerTargetEffect()

void DirectOutput.FX.EffectEffectBase.TriggerTargetEffect ( TableElementData TriggerData )

protected

Triggers the target effect.
The method will deactivate the target effect if it throws a exception.

Parameters

TriggerData The trigger data for the target effect.

Property Documentation

◆ Table

Table.Table DirectOutput.FX.EffectEffectBase.Table

getprotected

Gets the table object which is hosting the effect.

The table object which is hosting the effect.

◆ TargetEffect

IEffect DirectOutput.FX.EffectEffectBase.TargetEffect

getprotected

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

◆ TargetEffectName

string DirectOutput.FX.EffectEffectBase.TargetEffectName

getset

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

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

D:/a/DirectOutput/DirectOutput/DirectOutput/FX/EffectEffectBase.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members