Class QuestObjectiveInstance

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Tracks runtime progress for a single quest objective.

public class QuestObjectiveInstance

Inheritance

object

QuestObjectiveInstance

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

QuestObjectiveInstance(QuestObjective, long)

Constructs a new objective instance from a template with an optional starting value.

public QuestObjectiveInstance(QuestObjective template, long initialValue = 0)

Parameters

template QuestObjective

The quest objective template.

initialValue long

Optional starting progress value.

Properties

CurrentValue

The current progress value for this objective.

public long CurrentValue { get; }

Property Value

long

IsComplete

Returns true when progress meets or exceeds the required value.

public bool IsComplete { get; }

Property Value

bool

Template

The quest objective template that defines this instance.

public QuestObjective Template { get; }

Property Value

QuestObjective

Methods

Increment(long)

Increments progress by the given amount, clamping to the required value.

public void Increment(long amount)

Parameters

amount long

The amount to add.

SetValue(long)

Sets the current progress to an exact value, clamping between zero and required.

public void SetValue(long value)

Parameters

value long

The value to set.