Duration effect which triggers a specified target effect for a specified duration.
When this effect is triggered it triggers the target effect immediately with the same data it has received. After the specified duration it calls trigger on the target effect again with data for the same table elmenet, but with the value changed to 0.
More...

Inheritance diagram for DirectOutput.FX.TimmedFX.DurationEffect:

Public Member Functions
override void	Trigger (Table.TableElementData TableElementData)
	Triggers the DurationEffect with the given TableElementData. The duration is started, if the value portion of the TableElementData parameter is !=0. Trigger calls with a TableElement value=0 have no effect. More...

override void	Finish ()
	Finishes the DurationEffect. More...

Public Member Functions inherited from DirectOutput.FX.EffectEffectBase
override void	Init (Table.Table Table)
	Initializes the EffectEffect. Resolves the name of the TargetEffect. More...

Public Member Functions inherited from DirectOutput.FX.EffectBase
abstract void	Trigger (TableElementData TableElementData)
	Triggers the effect with the given TableElementData. More...

Properties
RetriggerBehaviourEnum	RetriggerBehaviour `[get, set]`
	Gets or sets the retrigger behaviour. The setting defines the behaviour of the effect if it is retriggered while it is still active. This settings is only relevant, if the effect can be called from more than one table element. More...

int	DurationMs `[get, set]`
	Gets or sets the duration for the effect in milliseconds. More...

bool	Active `[get]`
	Gets a value indicating whether this DurationEffect is currently 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]`
	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]`
	Gets the table object which is hosting the effect. More...

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. More...

Properties inherited from DirectOutput.General.Generic.INamedItem
string	Name `[get, set]`
	Gets or sets the name of the item. Must fire the BeforeNameChange and AfterNameChange events when the value of the property is changed. More...

Properties inherited from DirectOutput.FX.IEffect
new string	Name `[get, set]`
	Name of 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...

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)

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 >	BeforeNameChanged
	Event is fired before the value of the property Name is changed. More...

PropertyChangedEventHandler	PropertyChanged

PropertyChangingEventHandler	PropertyChanging

Events inherited from DirectOutput.General.Generic.INamedItem
EventHandler< NameChangeEventArgs >	BeforeNameChanged
	Occurs before the name of the item changes. More...

EventHandler< NameChangeEventArgs >	AfterNameChanged
	Occurs when after the name of the item has 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 >	BeforeNameChanged
	This event must be fired before the Name property of a IEffect object is changed. More...

Detailed Description

Duration effect which triggers a specified target effect for a specified duration.
When this effect is triggered it triggers the target effect immediately with the same data it has received. After the specified duration it calls trigger on the target effect again with data for the same table elmenet, but with the value changed to 0.

Duration effect

Definition at line 14 of file DurationEffect.cs.

Member Function Documentation

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

virtual

Finishes the DurationEffect.

Reimplemented from DirectOutput.FX.EffectEffectBase.

Definition at line 90 of file DurationEffect.cs.

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

Triggers the DurationEffect with the given TableElementData.
The duration is started, if the value portion of the TableElementData parameter is !=0. Trigger calls with a TableElement value=0 have no effect.

Parameters

TableElementData TableElementData for the TableElement which has triggered the effect.

Definition at line 62 of file DurationEffect.cs.

Property Documentation

bool DirectOutput.FX.TimmedFX.DurationEffect.Active

get

Gets a value indicating whether this DurationEffect is currently active.

true if active; otherwise false.

Definition at line 54 of file DurationEffect.cs.

int DirectOutput.FX.TimmedFX.DurationEffect.DurationMs

getset

Gets or sets the duration for the effect in milliseconds.

The effect duration in milliseconds.

Definition at line 41 of file DurationEffect.cs.

RetriggerBehaviourEnum DirectOutput.FX.TimmedFX.DurationEffect.RetriggerBehaviour

getset

Gets or sets the retrigger behaviour.
The setting defines the behaviour of the effect if it is retriggered while it is still active.
This settings is only relevant, if the effect can be called from more than one table element.

Valid values are Restart (Restarts the duration) or Ignore (keeps the org duration).

Definition at line 27 of file DurationEffect.cs.

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

C:/Users/tom/Documents/Github/DirectOutput/DirectOutput/FX/TimmedFX/DurationEffect.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation