Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Properties | List of all members
PixelCrushers.QuestMachine.QuestStateInfo Class Reference

Information about a specific quest state (Inactive, Active, etc.). More...

Public Member Functions

 QuestStateInfo ()
 Constructs a new QuestStateInfo instance with empty lists for each content category.
 
void SetRuntimeReferences (Quest quest, QuestNode questNode)
 
bool HasContent (QuestContentCategory category)
 Checks if the quest state has any UI content for a specified category.
 
List< QuestContent > GetContentList (QuestContentCategory category)
 Gets the UI content for a specified category.
 
void CloneSubassetsInto (QuestStateInfo copy, Quest quest=null)
 
void DestroySubassets ()
 

Static Public Member Functions

static int GetNumQuestStates ()
 
static int GetNumQuestNodeStates ()
 
static QuestStateInfo GetStateInfo (List< QuestStateInfo > stateInfoList, QuestState questState)
 
static QuestStateInfo GetStateInfo (List< QuestStateInfo > stateInfoList, QuestNodeState questNodeState)
 
static void ValidateStateInfoListCount (List< QuestStateInfo > stateInfoList, int numStates=-1)
 
static void ValidateCategorizedContentListCount (List< QuestContentSet > categorizedContentList, int numStates=-1)
 
static void CloneSubassets (List< QuestStateInfo > original, List< QuestStateInfo > copy, Quest quest=null)
 
static void DestroyListSubassets (List< QuestStateInfo > list)
 

Static Public Attributes

static int NumContentCategories = Enum.GetNames(typeof(QuestContentCategory)).Length - 3
 

Properties

List< QuestAction > actionList [get, set]
 Run these actions when this state becomes active.
 
List< QuestContentSet > categorizedContentList [get, set]
 Contents for each UI category (dialogue, journal, etc.).
 

Detailed Description

Information about a specific quest state (Inactive, Active, etc.).

Constructor & Destructor Documentation

◆ QuestStateInfo()

PixelCrushers.QuestMachine.QuestStateInfo.QuestStateInfo ( )
inline

Constructs a new QuestStateInfo instance with empty lists for each content category.

Member Function Documentation

◆ CloneSubassets()

static void PixelCrushers.QuestMachine.QuestStateInfo.CloneSubassets ( List< QuestStateInfo >  original,
List< QuestStateInfo >  copy,
Quest  quest = null 
)
inlinestatic

◆ CloneSubassetsInto()

void PixelCrushers.QuestMachine.QuestStateInfo.CloneSubassetsInto ( QuestStateInfo  copy,
Quest  quest = null 
)
inline

◆ DestroyListSubassets()

static void PixelCrushers.QuestMachine.QuestStateInfo.DestroyListSubassets ( List< QuestStateInfo >  list)
inlinestatic

◆ DestroySubassets()

void PixelCrushers.QuestMachine.QuestStateInfo.DestroySubassets ( )
inline

◆ GetContentList()

List< QuestContent > PixelCrushers.QuestMachine.QuestStateInfo.GetContentList ( QuestContentCategory  category)
inline

Gets the UI content for a specified category.

Parameters
categoryThe content category for which to get content.
Returns
The UI content.

◆ GetNumQuestNodeStates()

static int PixelCrushers.QuestMachine.QuestStateInfo.GetNumQuestNodeStates ( )
inlinestatic

◆ GetNumQuestStates()

static int PixelCrushers.QuestMachine.QuestStateInfo.GetNumQuestStates ( )
inlinestatic

◆ GetStateInfo() [1/2]

static QuestStateInfo PixelCrushers.QuestMachine.QuestStateInfo.GetStateInfo ( List< QuestStateInfo >  stateInfoList,
QuestNodeState  questNodeState 
)
inlinestatic

◆ GetStateInfo() [2/2]

static QuestStateInfo PixelCrushers.QuestMachine.QuestStateInfo.GetStateInfo ( List< QuestStateInfo >  stateInfoList,
QuestState  questState 
)
inlinestatic

◆ HasContent()

bool PixelCrushers.QuestMachine.QuestStateInfo.HasContent ( QuestContentCategory  category)
inline

Checks if the quest state has any UI content for a specified category.

Parameters
categoryThe content category to check.
Returns
true if there is content.

◆ SetRuntimeReferences()

void PixelCrushers.QuestMachine.QuestStateInfo.SetRuntimeReferences ( Quest  quest,
QuestNode  questNode 
)
inline

◆ ValidateCategorizedContentListCount()

static void PixelCrushers.QuestMachine.QuestStateInfo.ValidateCategorizedContentListCount ( List< QuestContentSet >  categorizedContentList,
int  numStates = -1 
)
inlinestatic

◆ ValidateStateInfoListCount()

static void PixelCrushers.QuestMachine.QuestStateInfo.ValidateStateInfoListCount ( List< QuestStateInfo >  stateInfoList,
int  numStates = -1 
)
inlinestatic

Member Data Documentation

◆ NumContentCategories

int PixelCrushers.QuestMachine.QuestStateInfo.NumContentCategories = Enum.GetNames(typeof(QuestContentCategory)).Length - 3
static

Property Documentation

◆ actionList

List<QuestAction> PixelCrushers.QuestMachine.QuestStateInfo.actionList
getset

Run these actions when this state becomes active.

◆ categorizedContentList

List<QuestContentSet> PixelCrushers.QuestMachine.QuestStateInfo.categorizedContentList
getset

Contents for each UI category (dialogue, journal, etc.).

This list is indexed by the int value of the QuestContentCategory enum, such as stateInfoList[(int)QuestContentCategory.Dialogue].

The documentation for this class was generated from the following file: