This subclass of QuestList provides facilities to show the list in a QuestJournalUI. More...
Public Member Functions | |
override void | Reset () |
override void | Start () |
override void | OnEnable () |
override void | OnDisable () |
override void | OnMessage (MessageArgs messageArgs) |
Handles a message that the message handler is listening for. | |
virtual void | ShowJournalUI () |
Show the quest journal. | |
virtual void | HideJournalUI () |
Hide the quest journal. | |
virtual void | ToggleJournalUI () |
Toggle visibility of the journal. | |
virtual bool | CheckTrackingToggles (string questID) |
If onlyTrackOneQuestAtATime is true and the specified quest is now being tracked, disable tracking on other quests. | |
virtual void | AbandonQuest (Quest quest) |
override Quest | AddQuest (Quest quest) |
Adds a quest to the quest giver's quest list and runs its runtime startup. | |
override void | ApplyData (string data) |
virtual void | RepaintUIs () |
Public Member Functions inherited from PixelCrushers.QuestMachine.QuestListContainer | |
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, 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 | 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 | |
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 | |
virtual void | CheckQuestState (MessageArgs messageArgs) |
If quest was completed and rememberCompletedQuests is false, remove the quest. | |
virtual void | VerifyTrueNodeChildrenAreActive () |
Protected Member Functions inherited from PixelCrushers.QuestMachine.QuestListContainer | |
void | InstantiateQuestAssets () |
Instantiates copies of quest assets into the runtime quest list and enables their autostart and offer condition checking. | |
IEnumerator | RuntimeStartupAtEndOfFrame () |
IEnumerator | SetIsLoadingGameFalseAfter2Frames () |
Properties | |
IQuestJournalUI | questJournalUI [get, set] |
The quest journal UI to use. | |
IQuestHUD | questHUD [get, set] |
The quest HUD to use. | |
bool | rememberCompletedQuests [get, set] |
Keep completed quests in the journal. | |
bool | onlyRememberHandwrittenQuests [get, set] |
Keep only handwritten completed quests in the journal, not procedurally generated quests. | |
bool | compressCompletedProcgenQuests [get, set] |
When procedurally generated quests complete, pare down saved data to only success/failure content. | |
bool | onlyTrackOneQuestAtATime [get, set] |
If tracking is enabled for a quest, disable tracking for other quests. | |
Properties inherited from PixelCrushers.QuestMachine.IdentifiableQuestListContainer | |
bool | hasInternallyAssignedID [get] |
bool | hasInternallyAssignedDisplayName [get] |
StringField | id [get, set] |
The ID that uniquely identifies this quest list container. | |
StringField | displayName [get, set] |
The name shown in UIs. | |
Sprite | image [get, set] |
The image shown in UIs. | |
QuestEntity | questEntity [get] |
Properties inherited from PixelCrushers.QuestMachine.QuestListContainer | |
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] |
Properties inherited from PixelCrushers.QuestMachine.IQuestMachineID |
Additional Inherited Members | |
Protected Attributes inherited from PixelCrushers.QuestMachine.IdentifiableQuestListContainer | |
StringField | m_id = new StringField() |
StringField | m_displayName = new StringField() |
Sprite | m_image |
Protected Attributes inherited from PixelCrushers.QuestMachine.QuestListContainer | |
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 |
Events inherited from PixelCrushers.QuestMachine.QuestListContainer | |
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. | |
This subclass of QuestList provides facilities to show the list in a QuestJournalUI.
|
inlinevirtual |
Adds a quest to the quest giver's quest list and runs its runtime startup.
quest |
Reimplemented from PixelCrushers.QuestMachine.QuestListContainer.
|
inline |
|
inlineprotectedvirtual |
If quest was completed and rememberCompletedQuests is false, remove the quest.
messageArgs |
|
inlinevirtual |
If onlyTrackOneQuestAtATime is true and the specified quest is now being tracked, disable tracking on other quests.
Returns true if any quest tracking changed.
|
inlinevirtual |
Hide the quest journal.
|
inlinevirtual |
Reimplemented from PixelCrushers.QuestMachine.IdentifiableQuestListContainer.
|
inlinevirtual |
Reimplemented from PixelCrushers.QuestMachine.IdentifiableQuestListContainer.
|
inlinevirtual |
Handles a message that the message handler is listening for.
messageArgs | The message that was sent to the MessageSystem. |
Reimplemented from PixelCrushers.QuestMachine.QuestListContainer.
Reimplemented in PixelCrushers.QuestMachine.uSurvivalSupport.uSurvivalQuestJournal.
|
inlinevirtual |
|
inlinevirtual |
Reimplemented from PixelCrushers.Saver.
|
inlinevirtual |
Show the quest journal.
|
inlinevirtual |
Reimplemented from PixelCrushers.Saver.
Reimplemented in PixelCrushers.QuestMachine.uSurvivalSupport.uSurvivalQuestJournal.
|
inlinevirtual |
Toggle visibility of the journal.
|
inlineprotectedvirtual |
|
getset |
When procedurally generated quests complete, pare down saved data to only success/failure content.
|
getset |
Keep only handwritten completed quests in the journal, not procedurally generated quests.
|
getset |
If tracking is enabled for a quest, disable tracking for other quests.
|
getset |
The quest HUD to use.
If not set, defaults to the QuestMachine's default UI.
|
getset |
The quest journal UI to use.
If not set, defaults to the QuestMachine's default UI.
|
getset |
Keep completed quests in the journal.