Class QuestEntry

Namespace

S1API.Quests

Assembly

S1API.dll

Represents a quest entry on a quest. These are the individual tasks on a quest.

public class QuestEntry

Inheritance

object

QuestEntry

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Properties

POIPosition

The point-of-interest world position. Returns Vector3.zero if no location is set. Setting a position will create/update the PoILocation transform if it doesn't exist.

public Vector3 POIPosition { get; set; }

Property Value

Vector3

State

The current state of this quest entry.

public QuestState State { get; }

Property Value

QuestState

Title

The title displayed for the quest entry.

public string Title { get; set; }

Property Value

string

Methods

Begin()

Marks the quest entry as started and transitions its State to the in-progress state in-game.

public void Begin()

ClearPOI()

Clears any active POI from this quest entry and hides the compass marker.

public void ClearPOI()

Complete()

Marks the quest entry as completed.

public void Complete()

SetPOIToNPC(NPC)

Sets the POI location to follow an NPC instance. The POI marker will automatically update when the NPC moves. If the POI hasn't been created yet, it will be created automatically.

public bool SetPOIToNPC(NPC npc)

Parameters

npc NPC

The NPC instance to follow.

Returns

bool

True if the NPC was valid and POI location was set, false otherwise.

SetPOIToNPC<T>()

Sets the POI location to follow an NPC by type. The POI marker will automatically update when the NPC moves.

public bool SetPOIToNPC<T>() where T : NPC

Returns

bool

True if the NPC was found and POI location was set, false otherwise.

Type Parameters

T

The NPC type to follow.

SetPOIToSpraySurface(SpraySurface)

Sets the POI location to a spray surface's position.

public bool SetPOIToSpraySurface(SpraySurface spraySurface)

Parameters

spraySurface SpraySurface

The spray surface to set POI to.

Returns

bool

True if the spray surface was valid and POI location was set, false otherwise.

SetState(QuestState)

Manually sets the state of the quest entry.

public void SetState(QuestState questState)

Parameters

questState QuestState

The state you want the entry to be.

Events

OnComplete

An action called once a quest has been completed.

public event Action OnComplete

Event Type

Action