Interface IRuntimeQuest

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

A quest created by IRuntimeQuestFactory.

public interface IRuntimeQuest

Remarks

Call members on the game's thread with a game loaded, which reading Scenes to subscribe to its events does not need.

Properties

Description

The paragraph the journal shows under the quest's name in the loaded game.

string Description { get; set; }

Property Value

string

Remarks

Alias tokens in an assigned text are replaced as it is assigned, as QuestObjective describes.

Exceptions

ArgumentNullException

The assigned text is null.

IsActive

Whether the quest is the journal's active quest, whose markers the compass and the map show.

bool IsActive { get; set; }

Property Value

bool

Remarks

A quest that has displayed no objective, or is completed or failed, is not active, and setting it active leaves it as it is.

IsCompleted

Whether the quest is completed in the loaded game.

bool IsCompleted { get; }

Property Value

bool

IsFailed

Whether the quest is failed in the loaded game.

bool IsFailed { get; }

Property Value

bool

IsStarted

Whether the quest has displayed an objective in the loaded game.

bool IsStarted { get; }

Property Value

bool

Name

The name the journal shows.

string Name { get; }

Property Value

string

Objectives

The quest's objectives.

IQuestObjectives Objectives { get; }

Property Value

IQuestObjectives

Scenes

The quest's scenes.

IQuestScenes Scenes { get; }

Property Value

IQuestScenes

Stages

The quest's stages.

IQuestStages Stages { get; }

Property Value

IQuestStages

Methods

Complete(bool)

Moves the quest to the journal's completed quests, replacing a failure, and clears its active-quest mark.

void Complete(bool completeObjectives = false)

Parameters

completeObjectives bool

Whether every objective neither completed nor failed is marked completed as well.

Remarks

A playing scene of the quest plays on.

Exceptions

InvalidOperationException

The quest has displayed no objective.

Fail(bool)

Marks the quest failed, replacing a completion. It finishes the quest as Complete(bool) does.

void Fail(bool failObjectives = false)

Parameters

failObjectives bool

Whether every objective neither completed nor failed is marked failed as well.

Exceptions

InvalidOperationException

The quest has displayed no objective.

RemoveFromJournalAndReset()

Removes the quest from the journal in the loaded game, resets its objectives, stages, and aliases, and clears its record of which scene line variants have been said.

void RemoveFromJournalAndReset()

Remarks

Each playing scene of the quest is stopped.