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

This effect triggers a list of other effect when it is triggered.
More...

Inheritance diagram for DirectOutput.FX.ListFX.ListEffect:
Collaboration diagram for DirectOutput.FX.ListFX.ListEffect:

Public Member Functions

override void Trigger (Table.TableElementData TableElementData)
 Triggers all effects assigned to the ListEffect. More...
 
override void Init (Table.Table Table)
 Initializes the ListEffect. More...
 
override void Finish ()
 Fnishes the ListEffect. More...
 
- Public Member Functions inherited from DirectOutput.FX.EffectBase
abstract void Trigger (TableElementData TableElementData)
 Triggers the effect with the given TableElementData. More...
 
abstract void Init (Table.Table Table)
 Init does all necessary initialization work after the effect object has been instanciated. More...
 

Properties

AssignedEffectList AssignedEffects [get, set]
 Gets or sets the list of effects assigned to the ListEffect. More...
 

Additional Inherited Members

- 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 triggers a list of other effect when it is triggered.

Warning
Be careful not to add ListEffect objects which finnaly contain a reference to the instance you're working with. This will create a recursive loop which never exit!.

Member Function Documentation

override void DirectOutput.FX.ListFX.ListEffect.Finish ( )
virtual

Fnishes the ListEffect.

Reimplemented from DirectOutput.FX.EffectBase.

override void DirectOutput.FX.ListFX.ListEffect.Init ( Table.Table  Table)

Initializes the ListEffect.

Parameters
TableTable object containing the effect.
override void DirectOutput.FX.ListFX.ListEffect.Trigger ( Table.TableElementData  TableElementData)

Triggers all effects assigned to the ListEffect.

Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.

Property Documentation

AssignedEffectList DirectOutput.FX.ListFX.ListEffect.AssignedEffects
getset

Gets or sets the list of effects assigned to the ListEffect.

The list of effects assigned to the ListEffect.


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