Interface IQuestSceneEvents

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

The events of one scene or of every scene of a quest.

public interface IQuestSceneEvents

Properties

OnActionEnd

Raised on the game's thread as an action of a scene ends: once the game reports it complete, which is read every quarter second of unpaused time, or as the phase it ends in ends, whichever is first.

IGameEvent<QuestSceneActionEndEventArgs> OnActionEnd { get; }

Property Value

IGameEvent<QuestSceneActionEndEventArgs>

Remarks

A scene that ends with Completed raises it for each action still running, before OnPhaseEnd. A scene that ends otherwise raises it for none of them.

OnBegin

Raised on the game's thread in the first frame a scene plays, before OnPhaseBegin is raised for its first phase.

IGameEvent<QuestSceneBeginEventArgs> OnBegin { get; }

Property Value

IGameEvent<QuestSceneBeginEventArgs>

Remarks

It is raised for each repeat of a scene whose Repeats is true and for a scene resumed after a load. A scene that ends before it plays raises OnEnd alone.

OnEnd

Raised on the game's thread once a scene ends.

IGameEvent<QuestSceneEndEventArgs> OnEnd { get; }

Property Value

IGameEvent<QuestSceneEndEventArgs>

OnLineBegin

Raised on the game's thread as an actor begins to say a SceneLine of a scene.

IGameEvent<QuestSceneLineEventArgs> OnLineBegin { get; }

Property Value

IGameEvent<QuestSceneLineEventArgs>

Remarks

It is raised once for a line, however many responses the line has. A line whose Condition is false raises neither it nor OnLineEnd.

OnLineEnd

Raised on the game's thread as an actor finishes saying a SceneLine of a scene.

IGameEvent<QuestSceneLineEventArgs> OnLineEnd { get; }

Property Value

IGameEvent<QuestSceneLineEventArgs>

Remarks

A line still being said when its scene ends raises none.

OnPhaseBegin

Raised on the game's thread as each phase of a scene begins.

IGameEvent<QuestScenePhaseEventArgs> OnPhaseBegin { get; }

Property Value

IGameEvent<QuestScenePhaseEventArgs>

Remarks

A scene resumed after a load raises it for the phase at which it resumes.

OnPhaseEnd

Raised on the game's thread as each phase OnPhaseBegin was raised for ends.

IGameEvent<QuestScenePhaseEventArgs> OnPhaseEnd { get; }

Property Value

IGameEvent<QuestScenePhaseEventArgs>

Remarks

A scene that ends other than with Completed raises it for none of the phases it had not finished.