Class Quest

Contains live state of quests in play. Quests are instantiated from text source and executed inside quest machine. Each quest is assigned a unique id (UID) as its possible for same question to be instantiated multiple times, such as a basic fetch quest to two different dungeons. The name of quest cannot not be used for unique identification. Child resources generally will not care about quest UID, but this is used by quest machine.

Inheritance

Object

Quest

Implements

IMacroContextProvider

Namespace: DaggerfallWorkshop.Game.Questing

Assembly: Assembly-CSharp.dll

Syntax

public class Quest : IDisposable, IMacroContextProvider

Constructors

Quest()

Default constructor.

Declaration

public Quest()

Fields

QuestFailureRep

Declaration

public const int QuestFailureRep = -2

Field Value

Type	Description
Int32

QuestSuccessRep

Declaration

public const int QuestSuccessRep = 5

Field Value

Type	Description
Int32

Properties

CurrentLogMessageId

Current log message ID, used only for expanding %qdt macro properly.

Declaration

public int CurrentLogMessageId { set; }

Property Value

Type	Description
Int32

DisplayName

Optional display name for future quest journal. e.g. "Lady Brisienna's Letter"

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
String

ExternalMCP

External non-quest context provider.

Declaration

public IMacroContextProvider ExternalMCP { get; set; }

Property Value

Type	Description
IMacroContextProvider

FactionId

Faction ID the quest will affect reputation of.

Declaration

public int FactionId { get; set; }

Property Value

Type	Description
Int32

LastPlaceReferenced

Gets or sets last Place resource encountered during macro expand. This will be used to resolve di, etc. Can return null so caller should have a fail-over plan.

Declaration

public Place LastPlaceReferenced { get; set; }

Property Value

Type	Description
Place

LastResourceReferenced

Gets or sets last QuestResource for Person/Foe encountered during macro expand. This will be used to resolve pronoun, god, oath, etc. Can return null so caller should have a fail-over plan.

Declaration

public QuestResource LastResourceReferenced { get; set; }

Property Value

Type	Description
QuestResource

OneTime

Whether this is a one time quest

Declaration

public bool OneTime { get; set; }

Property Value

Type	Description
Boolean

QuestBreak

Allows other classes working on this quest to break execution. This allows for "say" messages and other popups to happen in correct order. Flag will be lowered automatically.

Declaration

public bool QuestBreak { get; set; }

Property Value

Type	Description
Boolean

QuestComplete

True when quest has completed and will be tombstoned by quest machine.

Declaration

public bool QuestComplete { get; }

Property Value

Type	Description
Boolean

QuestName

Short quest name read from source. e.g. "_BRISIEN"

Declaration

public string QuestName { get; set; }

Property Value

Type	Description
String

QuestStartTime

Gets world time of quest when started.

Declaration

public DaggerfallDateTime QuestStartTime { get; }

Property Value

Type	Description
DaggerfallDateTime

QuestSuccess

True when quest executes a "give pc" action, which indicates quest success. If quest ends without this being set, quest can be considered failed.

Declaration

public bool QuestSuccess { get; set; }

Property Value

Type	Description
Boolean

QuestTombstoned

True when quest has been tombstoned by QuestMachine. Quest will persist a while after completion for post-quest rumours, failure text, etc.

Declaration

public bool QuestTombstoned { get; }

Property Value

Type	Description
Boolean

QuestTombstoneTime

The time quest was tombstoned. Not valid if quest has not yet been tombstoned.

Declaration

public DaggerfallDateTime QuestTombstoneTime { get; }

Property Value

Type	Description
DaggerfallDateTime

SmallerDungeonsState

State of smaller dungeons setting at time quest started. Persists through quest lifetime to inform smaller dungeon usage for dungeon sitelinks related to this quest.

Declaration

public QuestSmallerDungeonsState SmallerDungeonsState { get; }

Property Value

Type	Description
QuestSmallerDungeonsState

UID

Gets quest UID assigned at create time.

Declaration

public ulong UID { get; }

Property Value

Type	Description
UInt64

Methods

AddLogStep(Int32, Int32)

Adds quest log message for quest at step position. Quests can only have 0-9 steps and cannot log the same step more than once at a time.

Declaration

public void AddLogStep(int stepID, int messageID)

Parameters

Type	Name	Description
Int32	stepID	StepID to key this message.
Int32	messageID	MessageID to display for this step.

AddMessage(Int32, Message)

Declaration

public void AddMessage(int messageID, Message message)

Parameters

Type	Name	Description
Int32	messageID
Message	message

AddQuestor(Symbol)

Start tracking a new questor.

Declaration

public void AddQuestor(Symbol personSymbol)

Parameters

Type	Name	Description
Symbol	personSymbol	Symbol of new questor.

AddResource(QuestResource)

Declaration

public void AddResource(QuestResource resource)

Parameters

Type	Name	Description
QuestResource	resource

AddTask(Task)

Declaration

public void AddTask(Task task)

Parameters

Type	Name	Description
Task	task

ClearTask(Symbol)

Declaration

public void ClearTask(Symbol symbol)

Parameters

Type	Name	Description
Symbol	symbol

Dispose()

Declaration

public void Dispose()

DropQuestor(Symbol)

Stop tracking an existing questor.

Declaration

public void DropQuestor(Symbol personSymbol)

Parameters

Type	Name	Description
Symbol	personSymbol	Symbol of questor to drop.

EndQuest()

Declaration

public void EndQuest()

GetAllResources()

Declaration

public QuestResource[] GetAllResources()

Returns

Type	Description
QuestResource[]

GetAllResources(Type)

Declaration

public QuestResource[] GetAllResources(Type resourceType)

Parameters

Type	Name	Description
Type	resourceType

Returns

Type	Description
QuestResource[]

GetClock(Symbol)

Declaration

public Clock GetClock(Symbol symbol)

Parameters

Type	Name	Description
Symbol	symbol

Returns

Type	Description
Clock

GetCurrentLogMessageTime()

Get the current log entry date time when opening the active quests log.

Declaration

public DaggerfallDateTime GetCurrentLogMessageTime()

Returns

Type	Description
DaggerfallDateTime	Return the current log entry time if any, otherwise the quest start time.

GetFoe(Symbol)

Declaration

public Foe GetFoe(Symbol symbol)

Parameters

Type	Name	Description
Symbol	symbol

Returns

Type	Description
Foe

GetItem(Symbol)

Declaration

public Item GetItem(Symbol symbol)

Parameters

Type	Name	Description
Symbol	symbol

Returns

Type	Description
Item

GetLogMessages()

Gets the active log messages associated with this quest. Usually only one log step is active at a time. This allows log messages to be displayed however desired (as list, verbose, sorted, etc.).

Declaration

public Quest.LogEntry[] GetLogMessages()

Returns

Type	Description
Quest.LogEntry[]	LogEntry array, or null if quest completed.

GetMacroDataSource()

Declaration

public MacroDataSource GetMacroDataSource()

Returns

Type	Description
MacroDataSource

GetMessage(Int32)

Declaration

public Message GetMessage(int messageID)

Parameters

Type	Name	Description
Int32	messageID

Returns

Type	Description
Message

GetPerson(Symbol)

Declaration

public Person GetPerson(Symbol symbol)

Parameters

Type	Name	Description
Symbol	symbol

Returns

Type	Description
Person

GetPlace(Symbol)

Declaration

public Place GetPlace(Symbol symbol)

Parameters

Type	Name	Description
Symbol	symbol

Returns

Type	Description
Place

GetQuestors()

Declaration

public Symbol[] GetQuestors()

Returns

Type	Description
Symbol[]

GetResource(Symbol)

Declaration

public QuestResource GetResource(Symbol symbol)

Parameters

Type	Name	Description
Symbol	symbol

Returns

Type	Description
QuestResource

GetResource(String)

Declaration

public QuestResource GetResource(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
QuestResource

GetSaveData()

Declaration

public Quest.QuestSaveData_v1 GetSaveData()

Returns

Type	Description
Quest.QuestSaveData_v1

GetTask(Symbol)

Declaration

public Task GetTask(Symbol symbol)

Parameters

Type	Name	Description
Symbol	symbol

Returns

Type	Description
Task

GetTaskStates()

Declaration

public Quest.TaskState[] GetTaskStates()

Returns

Type	Description
Quest.TaskState[]

ReassignLegacyQuestMarkers()

Declaration

public void ReassignLegacyQuestMarkers()

RemoveLogStep(Int32)

Removes quest log message for step position.

Declaration

public void RemoveLogStep(int stepID)

Parameters

Type	Name	Description
Int32	stepID	StepID to remove from quest log.

RestoreSaveData(Quest.QuestSaveData_v1)

Declaration

public void RestoreSaveData(Quest.QuestSaveData_v1 data)

Parameters

Type	Name	Description
Quest.QuestSaveData_v1	data

ScheduleClickRearm(QuestResource)

Schedule a quest resource to rearm player click immediately after task execution.

Declaration

public void ScheduleClickRearm(QuestResource resource)

Parameters

Type	Name	Description
QuestResource	resource

ShowMessagePopup(Int32, Boolean)

Schedule a quest message popup at end of task execution. Message may be split into multiple chunks to display on screen.

Declaration

public DaggerfallMessageBox ShowMessagePopup(int id, bool immediate = false)

Parameters

Type	Name	Description
Int32	id	ID of message,
Boolean	immediate	Break quest execution at point of popup to display it immediately.

Returns

Type	Description
DaggerfallMessageBox	MessageBox. Will be top of display stack for chunked messages. Always null after using immediate flag.

Start()

Start the quest.

Declaration

public void Start()

StartTask(Symbol)

Declaration

public void StartTask(Symbol symbol)

Parameters

Type	Name	Description
Symbol	symbol

TombstoneQuest()

Marks quest as tombstoned and schedules for eventual deletion.

Declaration

public void TombstoneQuest()

Update()

Update quest.

Declaration

public void Update()

Implements

IMacroContextProvider