WIP
DirectOutput framework for virtual pinball cabinets WIP
Go to:
Overview 
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:
DirectOutput.FX.EffectBase DirectOutput.General.Generic.NamedItemBase DirectOutput.FX.IEffect DirectOutput.General.Generic.INamedItem DirectOutput.General.Generic.INamedItem

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...
 
- 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.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< NameChangeEventArgsAfterNameChanged
 Event is fired after the value of the property Name has changed. More...
 
EventHandler< NameChangeEventArgsBeforeNameChanged
 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< NameChangeEventArgsBeforeNameChanged
 Occurs before the name of the item changes. More...
 
EventHandler< NameChangeEventArgsAfterNameChanged
 Occurs when after the name of the item has changed. More...
 
- Events inherited from DirectOutput.FX.IEffect
new EventHandler< NameChangeEventArgsAfterNameChanged
 This event must be fired after the Name property of a IEffect object has changed. More...
 
new EventHandler< NameChangeEventArgsBeforeNameChanged
 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!.

Definition at line 14 of file ListEffect.cs.

Member Function Documentation

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

Fnishes the ListEffect.

Reimplemented from DirectOutput.FX.EffectBase.

Definition at line 56 of file ListEffect.cs.

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

Initializes the ListEffect.

Parameters
TableTable object containing the effect.

Definition at line 47 of file ListEffect.cs.

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.

Definition at line 37 of file ListEffect.cs.

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.

Definition at line 27 of file ListEffect.cs.


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