Skip to content

Class: DewQuest ​

csharp
public abstract class DewQuest : GameEffect, ILogicUpdate, ICleanup, ICustomDestroyRoutine

Fields ​

NameDeclarationDescription
ClientQuestEvent_OnQuestUpdatedpublic SafeAction ClientQuestEvent_OnQuestUpdated
DefaultSteppublic const string DefaultStep = "Default"
type`[BoxGroup("Quest Settings", true, false, 0)]
public QuestType type`

Properties ​

NameDeclarationDescription
currentProgresspublic string currentProgress { get; set; }
failReasonpublic FailReason failReason { get; set; }
progressTypepublic QuestProgressType progressType { get; set; }
questDetailedDescriptionRawpublic string questDetailedDescriptionRaw { get; set; }
questShortDescriptionRawpublic string questShortDescriptionRaw { get; set; }
questTitleRawpublic string questTitleRaw { get; set; }
statepublic QuestState state { get; set; }
step`[SaveVar(SaveVarFlags.ApplyAfterCreation)]
public string step { get; set; }`

Methods ​

AddStepGoal_ReachNode(NextGoalSettings) ​

csharp
public void AddStepGoal_ReachNode(NextGoalSettings settings)

Parameters:

NameTypeDescription
settingsNextGoalSettings

CompleteQuest() ​

csharp
public void CompleteQuest()

EndStep(string) ​

csharp
public void EndStep(string nextStep = null)

Parameters:

NameTypeDescription
nextStepstring

FailQuest(FailReason) ​

csharp
public void FailQuest(FailReason reason)

Parameters:

NameTypeDescription
reasonFailReason

GetInitialStep() ​

Called on server.

csharp
public virtual string GetInitialStep()

Returns: string

IsVisibleLocally() ​

Is this quest visible locally? This is checked everywhere when this quest is added.

csharp
public virtual bool IsVisibleLocally()

Returns: bool

OnCreate() ​

csharp
protected override void OnCreate()

OnDestroyActor() ​

csharp
protected override void OnDestroyActor()

OnStepEnded(string) ​

Called everywhere when a step of this quest has ended.

csharp
protected virtual void OnStepEnded(string formerStep)

Parameters:

NameTypeDescription
formerStepstring

OnStepStarted(bool) ​

Called everywhere when a new step starts.

csharp
protected virtual void OnStepStarted(bool isLoadedFromSave)

Parameters:

NameTypeDescription
isLoadedFromSavebool

RpcInvokeQuestUpdated() ​

Invoke UI update across clients. You usually don't need to call this yourself.

csharp
public void RpcInvokeQuestUpdated()

SetLocalizedDescription(string) ​

Provide null for default desc.

csharp
public void SetLocalizedDescription(string key)

Parameters:

NameTypeDescription
keystring

SetLocalizedTitle(string) ​

Provide null for default title.

csharp
public void SetLocalizedTitle(string key)

Parameters:

NameTypeDescription
keystring

Maintained by the Shape of Dreams Modding Community