The extend duration effect triggers another effect for a duration which is extebnded by the number of milliseconds specified in DurationMs.
This is done by forwarding triggers calls which are seting the effect to active directly to the target effect and delaying the forwarding of calls which set the effect to inactive by the number of milliseconds specified in DurationMs.
More...

Inheritance diagram for DirectOutput.FX.TimmedFX.ExtendDurationEffect:

[legend]

Collaboration diagram for DirectOutput.FX.TimmedFX.ExtendDurationEffect:

[legend]

Public Member Functions
override void	Trigger (Table.TableElementData TableElementData)
	Triggers the effect with the given TableElementData. Trigger calls of a TableElemenData value which is not equal 0, are forwarded directly to the target effect. Calls with a TableElementData Value of 0, are delayed by the Duration specifed in DurationMs before they are forwarded to the target effect. More...

override void	Init (Table.Table Table)
	Inititializes the ExtendDurationEffect. More...

override void	Finish ()
	Finishes the ExtendDurationEffect. Clears all pending/delayed calls. More...

Properties
int	DurationMs `[get, set]`
	Gets or sets the duration in milliseconds which will is added to the duration during which the effect is triggered/active. 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 extend duration effect triggers another effect for a duration which is extebnded by the number of milliseconds specified in DurationMs.
This is done by forwarding triggers calls which are seting the effect to active directly to the target effect and delaying the forwarding of calls which set the effect to inactive by the number of milliseconds specified in DurationMs.

ExtendDuration effect

Definition at line 11 of file ExtendDurationEffect.cs.

Member Function Documentation

override void DirectOutput.FX.TimmedFX.ExtendDurationEffect.Finish ( )

inlinevirtual

Finishes the ExtendDurationEffect.
Clears all pending/delayed calls.

Reimplemented from DirectOutput.FX.EffectEffectBase.

Definition at line 79 of file ExtendDurationEffect.cs.

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

inlinevirtual

Inititializes the ExtendDurationEffect.

Parameters

Table The table which uses the effect.

Reimplemented from DirectOutput.FX.EffectEffectBase.

Definition at line 70 of file ExtendDurationEffect.cs.

override void DirectOutput.FX.TimmedFX.ExtendDurationEffect.Trigger ( Table.TableElementData TableElementData )

inline

Triggers the effect with the given TableElementData.
Trigger calls of a TableElemenData value which is not equal 0, are forwarded directly to the target effect.
Calls with a TableElementData Value of 0, are delayed by the Duration specifed in DurationMs before they are forwarded to the target effect.

Parameters

TableElementData TableElementData for the TableElement which has triggered the effect.

Todo:: implement proper retrigger behaviour

Definition at line 36 of file ExtendDurationEffect.cs.

Property Documentation

int DirectOutput.FX.TimmedFX.ExtendDurationEffect.DurationMs

getset

Gets or sets the duration in milliseconds which will is added to the duration during which the effect is triggered/active.

The extended duration in milliseconds.

Definition at line 22 of file ExtendDurationEffect.cs.

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

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

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation