DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
DirectOutput.FX.TimmedFX.MinDurationEffect Class Reference

This effect enforces a minimum duration on the effect calls.
Calls which are setting a effect to active (having a trigger value which is not equal 0 or null) are forwarded directly to the TargetEffect.
Calls setting the effect to inactive (having a trigger value of 0) are only forwarded to the TargetEffect after the specified minimum duration has expired.
More...

Inheritance diagram for DirectOutput.FX.TimmedFX.MinDurationEffect:
Collaboration diagram for DirectOutput.FX.TimmedFX.MinDurationEffect:

Public Member Functions

override void Trigger (TableElementData TableElementData)
 Triggers the MinDurationEffect with the given TableElementData.
The minimal duration is started, if the value portion of the TableElementData parameter is !=0. 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...
 

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 MinDurationMs [get, set]
 Gets or sets the minimal duration for the effect in milliseconds. More...
 
bool Active [get, set]
 Gets a value indicating whether this MinDurationEffect is currently holding back trigger calls on the TargetEffect having a value of 0. 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< NameChangeEventArgsAfterNameChanged
 Event is fired after the value of the property Name has changed. More...
 
EventHandler< NameChangeEventArgsBeforeNameChange
 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

This effect enforces a minimum duration on the effect calls.
Calls which are setting a effect to active (having a trigger value which is not equal 0 or null) are forwarded directly to the TargetEffect.
Calls setting the effect to inactive (having a trigger value of 0) are only forwarded to the TargetEffect after the specified minimum duration has expired.

FX_MinDuration.png
MinDuration effect

Member Function Documentation

override void DirectOutput.FX.TimmedFX.MinDurationEffect.Finish ( )
virtual

Finishes the DurationEffect.

Reimplemented from DirectOutput.FX.EffectEffectBase.

override void DirectOutput.FX.TimmedFX.MinDurationEffect.Trigger ( TableElementData  TableElementData)
virtual

Triggers the MinDurationEffect with the given TableElementData.
The minimal duration is started, if the value portion of the TableElementData parameter is !=0.

Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.

Implements DirectOutput.FX.EffectBase.

Property Documentation

bool DirectOutput.FX.TimmedFX.MinDurationEffect.Active
getset

Gets a value indicating whether this MinDurationEffect is currently holding back trigger calls on the TargetEffect having a value of 0.

true if active; otherwise false.

int DirectOutput.FX.TimmedFX.MinDurationEffect.MinDurationMs
getset

Gets or sets the minimal duration for the effect in milliseconds.

The minimal effect duration in milliseconds.

RetriggerBehaviourEnum DirectOutput.FX.TimmedFX.MinDurationEffect.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 minimal duration) or Ignore (keeps the org duration).


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