WIP
DirectOutput framework for virtual pinball cabinets WIP
Go to:
Overview 
DirectOutput.FX.ConditionFX.TableElementConditionEffect Class Reference

This effect evaluates the condition specified in the Condition property. More...

Inheritance diagram for DirectOutput.FX.ConditionFX.TableElementConditionEffect:
DirectOutput.FX.EffectEffectBase DirectOutput.FX.EffectBase DirectOutput.General.Generic.NamedItemBase DirectOutput.FX.IEffect DirectOutput.General.Generic.INamedItem DirectOutput.General.Generic.INamedItem

Public Member Functions

List< string > GetVariables ()
 Gets a list of all variables in the condition. More...
 
override void Trigger (TableElementData TableElementData)
 Triggers the effect with the given TableElementData. More...
 
override void Init (Table.Table Table)
 Initializes the Effect.
Resolves the name of the TargetEffect and initializes the condition context. More...
 
override void Finish ()
 Finishes the Effect.
Releases the references to the target effect, the table object and the expression context. 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...
 

Properties

string Condition [get, set]
 Gets or sets the condition. 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< 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 evaluates the condition specified in the Condition property.

Definition at line 14 of file TableElementConditionEffect.cs.

Member Function Documentation

override void DirectOutput.FX.ConditionFX.TableElementConditionEffect.Finish ( )
virtual

Finishes the Effect.
Releases the references to the target effect, the table object and the expression context.

Reimplemented from DirectOutput.FX.EffectBase.

Definition at line 217 of file TableElementConditionEffect.cs.

List<string> DirectOutput.FX.ConditionFX.TableElementConditionEffect.GetVariables ( )

Gets a list of all variables in the condition.

Returns

Definition at line 84 of file TableElementConditionEffect.cs.

override void DirectOutput.FX.ConditionFX.TableElementConditionEffect.Init ( Table.Table  Table)
virtual

Initializes the Effect.
Resolves the name of the TargetEffect and initializes the condition context.

Parameters
TableTable object containing the effect.

Implements DirectOutput.FX.EffectBase.

Definition at line 206 of file TableElementConditionEffect.cs.

override void DirectOutput.FX.ConditionFX.TableElementConditionEffect.Trigger ( TableElementData  TableElementData)
virtual

Triggers the effect with the given TableElementData.

Parameters
TableElementDataTableElementData for the TableElement which has triggered the effect.

Implements DirectOutput.FX.EffectBase.

Definition at line 171 of file TableElementConditionEffect.cs.

Property Documentation

string DirectOutput.FX.ConditionFX.TableElementConditionEffect.Condition
getset

Gets or sets the condition.

The condition.

Definition at line 25 of file TableElementConditionEffect.cs.


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