The effect fires a assigned target effect after a specified delay.
The original values supplied when the effect is triggered are forwarded to the target effect.
More...

Inheritance diagram for DirectOutput.FX.TimmedFX.DelayEffect:

[legend]

Collaboration diagram for DirectOutput.FX.TimmedFX.DelayEffect:

[legend]

Public Member Functions
override void	Trigger (TableElementData TableElementData)
	Triggers the effect. If the TargetEffect throws a exception, it will be deactivated. More...

override void	Init (Table.Table Table)
	Initializes the DelayEffect. More...

new void	Finish ()
	Finishes the DelayEffect. More...

Properties
int	DelayMs `[get, set]`
	Gets or sets the delay in milliseconds. More...

Properties inherited from DirectOutput.FX.EffectEffectBase
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...

Table.Table	Table `[get, set]`
	Gets the table object which is hosting the effect. More...

Additional Inherited Members
Protected Member Functions inherited from DirectOutput.FX.EffectEffectBase
void	TriggerTargetEffect (TableElementData TriggerData)
	Triggers the target effect. The method will deactivate the target effect if it throws a exception. More...

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

The effect fires a assigned target effect after a specified delay.
The original values supplied when the effect is triggered are forwarded to the target effect.

Delay effect

Definition at line 14 of file DelayEffect.cs.

Member Function Documentation

new void DirectOutput.FX.TimmedFX.DelayEffect.Finish ( )

inlinevirtual

Finishes the DelayEffect.

Reimplemented from DirectOutput.FX.EffectEffectBase.

Definition at line 72 of file DelayEffect.cs.

override void DirectOutput.FX.TimmedFX.DelayEffect.Init ( Table.Table Table )

inlinevirtual

Initializes the DelayEffect.

Parameters

Table The table which contains the DelayEffect.

Reimplemented from DirectOutput.FX.EffectEffectBase.

Definition at line 63 of file DelayEffect.cs.

override void DirectOutput.FX.TimmedFX.DelayEffect.Trigger ( TableElementData TableElementData )

inlinevirtual

Triggers the effect.
If the TargetEffect throws a exception, it will be deactivated.

Parameters

TableElementData The TableElementData object for the TableElement which has triggered the effect.

Implements DirectOutput.FX.EffectBase.

Definition at line 37 of file DelayEffect.cs.

Property Documentation

int DirectOutput.FX.TimmedFX.DelayEffect.DelayMs

getset

Gets or sets the delay in milliseconds.

The delay in milliseconds.

Definition at line 26 of file DelayEffect.cs.

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

C:/Users/Tom/Documents/GitHub/DirectOutput/DirectOutput/FX/TimmedFX/DelayEffect.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation