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

Limits the max duration of the effect to the specified number of milliseconds. More...

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

Public Member Functions

override void Trigger (Table.TableElementData TableElementData)
 Triggers the effect with the given TableElementData. 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...
 
override void Finish ()
 Finishes the EffectEffect.
Releases the references to the target effect and to the table object. 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 MaxDurationMs [get, set]
 Gets or sets the max 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

Limits the max duration of the effect to the specified number of milliseconds.

Member Function Documentation

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

Triggers the effect with the given TableElementData.

Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.

Property Documentation

bool DirectOutput.FX.TimmedFX.MaxDurationEffect.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.MaxDurationEffect.MaxDurationMs
getset

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

The max effect duration in milliseconds.

RetriggerBehaviourEnum DirectOutput.FX.TimmedFX.MaxDurationEffect.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: