Maintains a list of quests on a GameObject. More...

Inheritance diagram for PixelCrushers.QuestMachine.QuestListContainer:

[legend]

Collaboration diagram for PixelCrushers.QuestMachine.QuestListContainer:

[legend]

Classes
class	SaveData

Public Member Functions
override void	Reset ()

override void	Awake ()

override void	Start ()

override void	OnDestroy ()

void	DestroyQuestInstances ()

virtual void	ResetToOriginalState ()
	Resets the quest list container to its original list.

virtual void	AddQuests (List< Quest > listToAdd)
	Adds a list of quests to the quest giver's quest list and runs their runtime startup.

virtual void	AddQuests (List< Quest > listToAdd, bool delayStartup)
	Adds a list of quests to the quest giver's quest list and runs their runtime startup.

virtual Quest	AddQuest (Quest quest)
	Adds a quest to the quest giver's quest list and runs its runtime startup.

virtual Quest	AddQuest (Quest quest, bool delayStartup)
	Adds a quest to the quest giver's quest list and optionally runs its runtime startup immediately or waits until the end of frame to allow other quests to be added to their respective quest lists in case a quest's offer conditions reference the state of another quest.

virtual Quest	FindQuest (string questID)

virtual Quest	FindQuest (StringField questID)

virtual bool	ContainsQuest (string questID)

virtual bool	ContainsQuest (StringField questID)

virtual void	DeleteQuest (StringField questID)

virtual void	DeleteQuest (Quest quest)

virtual void	RegisterForQuestEvents (Quest quest)

virtual void	UnregisterForQuestEvents (Quest quest)

virtual void	OnMessage (MessageArgs messageArgs)
	Handles a message that the message handler is listening for.

virtual void	OnQuestBecameOfferable (Quest quest)

virtual void	OnQuestStateChanged (Quest quest)

virtual void	OnQuestNodeStateChanged (QuestNode questNode)

override string	RecordData ()

override void	ApplyData (string data)

override void	OnRestartGame ()
	The Save System will call this method when restarting the game.

Public Member Functions inherited from PixelCrushers.Saver
virtual void	OnEnable ()

virtual void	OnDisable ()

string	RecordData ()
	This method should return a string that represents the data you want to save.

void	ApplyData (string s)
	This method should process the string representation of saved data and apply it to the current state of the game.

virtual void	ApplyDataImmediate ()
	If the Saver needs to pull data from the Save System immediately after loading a scene, instead of waiting for ApplyData to be called at it its normal time, it can implement this method.

virtual void	OnBeforeSceneChange ()
	The Save System will call this method before scene changes.

Protected Member Functions
void	InstantiateQuestAssets ()
	Instantiates copies of quest assets into the runtime quest list and enables their autostart and offer condition checking.

IEnumerator	RuntimeStartupAtEndOfFrame ()

IEnumerator	SetIsLoadingGameFalseAfter2Frames ()

Protected Attributes
Coroutine	m_delayedStartupCoroutine = null
	This coroutine runs when delaying quest runtime startup until the end of frame.

List< Quest >	m_runtimeStartupQueue = new List<Quest>()
	The delayed startup coroutine should do runtime startup for quests in this list.

Protected Attributes inherited from PixelCrushers.Saver
string	m_runtimeKey = null

Properties
bool	forwardEventsToListeners `[get, set]`
	Forward quest state events to listeners that have registered to events such as questBecameOfferable, questStateChanged, and questNodeStateChanged.

bool	includeInSavedGameData `[get, set]`
	Include in saved game data, which is used for saved games and scene persistence.

bool	addNewQuestsSinceSavedGame `[get, set]`
	If quests were added after game was saved, add them to quest list when loading saved game.

List< Quest >	questList `[get, protected set]`
	Quest assets.

List< string >	deletedStaticQuests `[get, protected set]`
	IDs of static quests that have been deleted and shouldn't be instantiated.

List< Quest >	originalQuestList `[get, set]`
	The original design-time quest list.

Properties inherited from PixelCrushers.Saver
bool	appendSaverTypeToKey `[get, set]`
	Append the name of this saver type to the key.

virtual string	key `[get, set]`
	Save data under this key.

string	_internalKeyValue `[get, set]`
	Accesses the internal key value.

virtual bool	saveAcrossSceneChanges `[get, set]`
	Save when changing scenes to be able to restore saved state when returning to scene.

virtual bool	restoreStateOnStart `[get, set]`

Events
QuestParameterDelegate	questAdded = delegate { }
	Raised when a quest is added to the list.

QuestParameterDelegate	questRemoved = delegate { }
	Raised when a quest is removed from the list.

QuestParameterDelegate	questBecameOfferable = delegate { }
	Raised when a quest in the list becomes offerable.

QuestParameterDelegate	questStateChanged = delegate { }
	Raised when the state of a quest in the list changes.

QuestNodeParameterDelegate	questNodeStateChanged = delegate { }
	Raised when the state of a quest node in a quest in the list changes.

Detailed Description

Maintains a list of quests on a GameObject.

Member Function Documentation

◆ AddQuest() [1/2]

virtual Quest PixelCrushers.QuestMachine.QuestListContainer.AddQuest ( Quest quest )

inlinevirtual

Adds a quest to the quest giver's quest list and runs its runtime startup.

Parameters

quest

Reimplemented in PixelCrushers.QuestMachine.QuestGiver, and PixelCrushers.QuestMachine.QuestJournal.

◆ AddQuest() [2/2]

virtual Quest PixelCrushers.QuestMachine.QuestListContainer.AddQuest	(	Quest	quest,
		bool	delayStartup
	)

inlinevirtual

Adds a quest to the quest giver's quest list and optionally runs its runtime startup immediately or waits until the end of frame to allow other quests to be added to their respective quest lists in case a quest's offer conditions reference the state of another quest.

Parameters

delayStartup If true, delay runtime startup until end of frame; otherwise run runtime startup immediately.

◆ AddQuests() [1/2]

virtual void PixelCrushers.QuestMachine.QuestListContainer.AddQuests ( List< Quest > listToAdd )

inlinevirtual

Adds a list of quests to the quest giver's quest list and runs their runtime startup.

◆ AddQuests() [2/2]

virtual void PixelCrushers.QuestMachine.QuestListContainer.AddQuests	(	List< Quest >	listToAdd,
		bool	delayStartup
	)

inlinevirtual

Adds a list of quests to the quest giver's quest list and runs their runtime startup.

◆ ApplyData()

override void PixelCrushers.QuestMachine.QuestListContainer.ApplyData ( string data )

inline

◆ Awake()

override void PixelCrushers.QuestMachine.QuestListContainer.Awake ( )

inlinevirtual

Reimplemented from PixelCrushers.Saver.

◆ ContainsQuest() [1/2]

virtual bool PixelCrushers.QuestMachine.QuestListContainer.ContainsQuest ( string questID )

inlinevirtual

◆ ContainsQuest() [2/2]

virtual bool PixelCrushers.QuestMachine.QuestListContainer.ContainsQuest ( StringField questID )

inlinevirtual

◆ DeleteQuest() [1/2]

virtual void PixelCrushers.QuestMachine.QuestListContainer.DeleteQuest ( Quest quest )

inlinevirtual

◆ DeleteQuest() [2/2]

virtual void PixelCrushers.QuestMachine.QuestListContainer.DeleteQuest ( StringField questID )

inlinevirtual

Reimplemented in PixelCrushers.QuestMachine.QuestGiver.

◆ DestroyQuestInstances()

void PixelCrushers.QuestMachine.QuestListContainer.DestroyQuestInstances ( )

inline

◆ FindQuest() [1/2]

virtual Quest PixelCrushers.QuestMachine.QuestListContainer.FindQuest ( string questID )

inlinevirtual

◆ FindQuest() [2/2]

virtual Quest PixelCrushers.QuestMachine.QuestListContainer.FindQuest ( StringField questID )

inlinevirtual

◆ InstantiateQuestAssets()

void PixelCrushers.QuestMachine.QuestListContainer.InstantiateQuestAssets ( )

inlineprotected

Instantiates copies of quest assets into the runtime quest list and enables their autostart and offer condition checking.

◆ OnDestroy()

override void PixelCrushers.QuestMachine.QuestListContainer.OnDestroy ( )

inlinevirtual

Reimplemented from PixelCrushers.Saver.

Reimplemented in PixelCrushers.QuestMachine.ORKSupport.QuestListContainerForORK.

◆ OnMessage()

virtual void PixelCrushers.QuestMachine.QuestListContainer.OnMessage ( MessageArgs messageArgs )

inlinevirtual

Handles a message that the message handler is listening for.

Parameters

messageArgs The message that was sent to the MessageSystem.

Implements PixelCrushers.IMessageHandler.

Reimplemented in PixelCrushers.QuestMachine.EmeraldAISupport.EmeraldAIQuestGiver, PixelCrushers.QuestMachine.uSurvivalSupport.uSurvivalQuestJournal, and PixelCrushers.QuestMachine.QuestJournal.

◆ OnQuestBecameOfferable()

virtual void PixelCrushers.QuestMachine.QuestListContainer.OnQuestBecameOfferable ( Quest quest )

inlinevirtual

◆ OnQuestNodeStateChanged()

virtual void PixelCrushers.QuestMachine.QuestListContainer.OnQuestNodeStateChanged ( QuestNode questNode )

inlinevirtual

◆ OnQuestStateChanged()

virtual void PixelCrushers.QuestMachine.QuestListContainer.OnQuestStateChanged ( Quest quest )

inlinevirtual

◆ OnRestartGame()

override void PixelCrushers.QuestMachine.QuestListContainer.OnRestartGame ( )

inlinevirtual

The Save System will call this method when restarting the game.

Your saver can reset data to a fresh state if necessary.

Reimplemented from PixelCrushers.Saver.

◆ RecordData()

override string PixelCrushers.QuestMachine.QuestListContainer.RecordData ( )

inline

◆ RegisterForQuestEvents()

virtual void PixelCrushers.QuestMachine.QuestListContainer.RegisterForQuestEvents ( Quest quest )

inlinevirtual

◆ Reset()

override void PixelCrushers.QuestMachine.QuestListContainer.Reset ( )

inlinevirtual

Reimplemented from PixelCrushers.Saver.

◆ ResetToOriginalState()

virtual void PixelCrushers.QuestMachine.QuestListContainer.ResetToOriginalState ( )

inlinevirtual

Resets the quest list container to its original list.

Reimplemented in PixelCrushers.QuestMachine.QuestGiver.

◆ RuntimeStartupAtEndOfFrame()

IEnumerator PixelCrushers.QuestMachine.QuestListContainer.RuntimeStartupAtEndOfFrame ( )

inlineprotected

◆ SetIsLoadingGameFalseAfter2Frames()

IEnumerator PixelCrushers.QuestMachine.QuestListContainer.SetIsLoadingGameFalseAfter2Frames ( )

inlineprotected

◆ Start()

override void PixelCrushers.QuestMachine.QuestListContainer.Start ( )

inlinevirtual

Reimplemented from PixelCrushers.Saver.

Reimplemented in PixelCrushers.QuestMachine.uSurvivalSupport.uSurvivalQuestJournal.

◆ UnregisterForQuestEvents()

virtual void PixelCrushers.QuestMachine.QuestListContainer.UnregisterForQuestEvents ( Quest quest )

inlinevirtual

Member Data Documentation

◆ m_delayedStartupCoroutine

Coroutine PixelCrushers.QuestMachine.QuestListContainer.m_delayedStartupCoroutine = null

protected

This coroutine runs when delaying quest runtime startup until the end of frame.

◆ m_runtimeStartupQueue

List<Quest> PixelCrushers.QuestMachine.QuestListContainer.m_runtimeStartupQueue = new List<Quest>()

protected

The delayed startup coroutine should do runtime startup for quests in this list.

Property Documentation

◆ addNewQuestsSinceSavedGame

bool PixelCrushers.QuestMachine.QuestListContainer.addNewQuestsSinceSavedGame

getset

If quests were added after game was saved, add them to quest list when loading saved game.

◆ deletedStaticQuests

List<string> PixelCrushers.QuestMachine.QuestListContainer.deletedStaticQuests

getprotected set

IDs of static quests that have been deleted and shouldn't be instantiated.

◆ forwardEventsToListeners

bool PixelCrushers.QuestMachine.QuestListContainer.forwardEventsToListeners

getset

Forward quest state events to listeners that have registered to events such as questBecameOfferable, questStateChanged, and questNodeStateChanged.

◆ includeInSavedGameData

bool PixelCrushers.QuestMachine.QuestListContainer.includeInSavedGameData

getset

Include in saved game data, which is used for saved games and scene persistence.

◆ originalQuestList

List<Quest> PixelCrushers.QuestMachine.QuestListContainer.originalQuestList

getsetprotected

The original design-time quest list.

◆ questList

List<Quest> PixelCrushers.QuestMachine.QuestListContainer.questList

getprotected set

Quest assets.

Event Documentation

◆ questAdded

QuestParameterDelegate PixelCrushers.QuestMachine.QuestListContainer.questAdded = delegate { }

Raised when a quest is added to the list.

◆ questBecameOfferable

QuestParameterDelegate PixelCrushers.QuestMachine.QuestListContainer.questBecameOfferable = delegate { }

Raised when a quest in the list becomes offerable.

◆ questNodeStateChanged

QuestNodeParameterDelegate PixelCrushers.QuestMachine.QuestListContainer.questNodeStateChanged = delegate { }

Raised when the state of a quest node in a quest in the list changes.

◆ questRemoved

QuestParameterDelegate PixelCrushers.QuestMachine.QuestListContainer.questRemoved = delegate { }

Raised when a quest is removed from the list.

◆ questStateChanged

QuestParameterDelegate PixelCrushers.QuestMachine.QuestListContainer.questStateChanged = delegate { }

Raised when the state of a quest in the list changes.

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

C:/Dev/Quest Machine/Dev/Source/Assets/Plugins/Pixel Crushers/Quest Machine/Scripts/Quest MonoBehaviours/Quest List/QuestListContainer.cs

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ AddQuest() [1/2]

◆ AddQuest() [2/2]

◆ AddQuests() [1/2]

◆ AddQuests() [2/2]

◆ ApplyData()

◆ Awake()

◆ ContainsQuest() [1/2]

◆ ContainsQuest() [2/2]

◆ DeleteQuest() [1/2]

◆ DeleteQuest() [2/2]

◆ DestroyQuestInstances()

◆ FindQuest() [1/2]

◆ FindQuest() [2/2]

◆ InstantiateQuestAssets()

◆ OnDestroy()

◆ OnMessage()

◆ OnQuestBecameOfferable()

◆ OnQuestNodeStateChanged()

◆ OnQuestStateChanged()

◆ OnRestartGame()

◆ RecordData()

◆ RegisterForQuestEvents()

◆ Reset()

◆ ResetToOriginalState()

◆ RuntimeStartupAtEndOfFrame()

◆ SetIsLoadingGameFalseAfter2Frames()

◆ Start()

◆ UnregisterForQuestEvents()

Member Data Documentation

◆ m_delayedStartupCoroutine

◆ m_runtimeStartupQueue

Property Documentation

◆ addNewQuestsSinceSavedGame

◆ deletedStaticQuests

◆ forwardEventsToListeners

◆ includeInSavedGameData

◆ originalQuestList

◆ questList

Event Documentation

◆ questAdded

◆ questBecameOfferable

◆ questNodeStateChanged

◆ questRemoved

◆ questStateChanged