Interface IHasPerformanceEvents

Namespace

CSF.Screenplay.Performances

Assembly

CSF.Screenplay.Abstractions.dll

An object which has events which are significant to the progress of a Screenplay.

public interface IHasPerformanceEvents

Remarks

This object is used as an event publisher, such that events which originate from many separate objects may be aggregated to a single point of contact. This way, consumers of those events have only a single object to which they need subscribe. There should only be a single instance of an object which implements this interface, for the lifetime of a Screenplay.

This type is closely related to IRelaysPerformanceEvents. This is the event publisher and IRelaysPerformanceEvents is event sink which collects them. Despite this, their APIs are not symmetrical, as many of the events published by this type are derived by subscribing to an Actor instance from the event sink.

Events

ActorCreated

Occurs when a new Actor is created and added to the IPerformance.

event EventHandler<ActorEventArgs> ActorCreated

Event Type

EventHandler<ActorEventArgs>

ActorSpotlit

Occurs when an Actor is placed into the Spotlight of an IStage.

event EventHandler<ActorEventArgs> ActorSpotlit

Event Type

EventHandler<ActorEventArgs>

BeginPerformable

Occurs when an Actor begins the execution of a performable object.

event EventHandler<PerformableEventArgs> BeginPerformable

Event Type

EventHandler<PerformableEventArgs>

EndPerformable

Occurs when an Actor ends the execution of a performable object.

event EventHandler<PerformableEventArgs> EndPerformable

Event Type

EventHandler<PerformableEventArgs>

GainedAbility

Occurs when an Actor gains a new ability.

event EventHandler<GainAbilityEventArgs> GainedAbility

Event Type

EventHandler<GainAbilityEventArgs>

PerformableFailed

Occurs when a performable object fails with an exception.

event EventHandler<PerformableFailureEventArgs> PerformableFailed

Event Type

EventHandler<PerformableFailureEventArgs>

PerformableResult

Occurs when an Actor receives a result from a perfperformable objectrmance.

event EventHandler<PerformableResultEventArgs> PerformableResult

Event Type

EventHandler<PerformableResultEventArgs>

PerformanceBegun

Occurs when a IPerformance begins executing.

event EventHandler<PerformanceEventArgs> PerformanceBegun

Event Type

EventHandler<PerformanceEventArgs>

PerformanceFinished

Occurs when a IPerformance has finished executing.

event EventHandler<PerformanceFinishedEventArgs> PerformanceFinished

Event Type

EventHandler<PerformanceFinishedEventArgs>

RecordAsset

Occurs when an actor records the presence of a new file asset.

event EventHandler<PerformableAssetEventArgs> RecordAsset

Event Type

EventHandler<PerformableAssetEventArgs>

ScreenplayEnded

Occurs when a Screenplay has ended.

event EventHandler ScreenplayEnded

Event Type

EventHandler

ScreenplayStarted

Occurs when a Screenplay starts.

event EventHandler ScreenplayStarted

Event Type

EventHandler

SpotlightTurnedOff

Occurs when the Spotlight of an IStage is 'turned off'; the Actor who is currently spotlit is removed without being replaced.

event EventHandler<PerformanceScopeEventArgs> SpotlightTurnedOff

Event Type

EventHandler<PerformanceScopeEventArgs>

See Also

IRelaysPerformanceEvents