DirectOutput.FX.AssignedEffect Class Reference

Handles the assignemt of a effect to a AssignedEffectList. More...

Public Member Functions
void	Trigger (TableElementData TableElementData)
	Triggers the assigned Effect. More...
void	Init (Table.Table Table)
	Initializes the AssignedEffect. More...
void	Finish ()
	Finishes this instance of the AssignedEffect object. More...
	AssignedEffect ()
	Initializes a new instance of the AssignedEffect class. More...
	AssignedEffect (string EffectName)
	Initializes a new instance of the AssignedEffect class for the specified EffectName . More...

Protected Member Functions
void	TableElementEffect_EffectNameChanged (object sender, EventArgs e)
	Handles the EffectNameChanged event of the TableElementEffect control. More...

Properties
string	EffectName [get, set]
	Name of the AssignedEffect. Triggers EffectNameChanged if value is changed. More...
IEffect	Effect [get]
	Effect for the AssignedEffect (ReadOnly). The property is resolved from the EffectName. If EffectName is empty or unknown this property will return null. More...

Events
EventHandler< EventArgs >	EffectNameChanged
	Event is fired if the value of the property EffectName is changed. More...

Detailed Description

Handles the assignemt of a effect to a AssignedEffectList.

Todo:

Add conditions (expressions that evluate to true or false) for assigned effects. CSScript makes this easy, but unlopading of changed effects will not be possible without restarting the framework.

Definition at line 15 of file AssignedEffect.cs.

Constructor & Destructor Documentation

DirectOutput.FX.AssignedEffect.AssignedEffect

(

)

Initializes a new instance of the AssignedEffect class.

Definition at line 140 of file AssignedEffect.cs.

DirectOutput.FX.AssignedEffect.AssignedEffect

(

string

EffectName

)

Initializes a new instance of the AssignedEffect class for the specified EffectName .

Parameters

EffectName

Name of the effect.

Definition at line 149 of file AssignedEffect.cs.

Member Function Documentation

void DirectOutput.FX.AssignedEffect.Finish

(

)

Finishes this instance of the AssignedEffect object.

Definition at line 130 of file AssignedEffect.cs.

void DirectOutput.FX.AssignedEffect.Init

(

Table.Table

Table

)

Initializes the AssignedEffect.

Parameters

Table

The table which contains the AssignedEffect.

Definition at line 121 of file AssignedEffect.cs.

void DirectOutput.FX.AssignedEffect.TableElementEffect_EffectNameChanged ( object  sender, EventArgs  e  )

protected

Handles the EffectNameChanged event of the TableElementEffect control.

Parameters

sender	The source of the event.
e	The EventArgs instance containing the event data.

Definition at line 54 of file AssignedEffect.cs.

void DirectOutput.FX.AssignedEffect.Trigger

(

TableElementData

TableElementData

)

Triggers the assigned Effect.

Remarks

If the assigned effect throws a exception the effect will be deactivated.

Parameters

TableElementData

The table element data.

Definition at line 99 of file AssignedEffect.cs.

Property Documentation

IEffect DirectOutput.FX.AssignedEffect.Effect

get

Effect for the AssignedEffect (ReadOnly).
The property is resolved from the EffectName. If EffectName is empty or unknown this property will return null.

Definition at line 70 of file AssignedEffect.cs.

string DirectOutput.FX.AssignedEffect.EffectName

getset

Name of the AssignedEffect.
Triggers EffectNameChanged if value is changed.

The name of the assigned effect.

Definition at line 29 of file AssignedEffect.cs.

Event Documentation

EventHandler<EventArgs> DirectOutput.FX.AssignedEffect.EffectNameChanged

Event is fired if the value of the property EffectName is changed.

Definition at line 47 of file AssignedEffect.cs.

---

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

• C:/Users/tom/Documents/Github/DirectOutput/DirectOutput/FX/AssignedEffect.cs