You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# [2.0.0](v1.0.1...v2.0.0) (2024-03-27)
### Bug Fixes
* **quest inspector:** cleaned up display bugs in the task display ([cc23082](cc23082))
### Features
* **quest database:** quests are now separate ScriptableObjects independent of the database ([9c64eb5](9c64eb5))
* **quest events:** quest collection now has event hooks ([c535109](c535109))
* **quests and tasks:** default quest and task definition can now be excluded from inspectors ([359ba7b](359ba7b))
### BREAKING CHANGES
* **quest database:** Breaks all existing quest implementations. It is recommended to not upgrade to this
version if you're on 1.X.
***builds:** prevents a crash by removing accidentally included editor only code ([b163656](https://github.com/ashblue/unity-quest-journal/commit/b16365679b7a23c848271325e8a5e6d90a07f016))
Copy file name to clipboardExpand all lines: Assets/com.fluid.quest-journal/README.md
+35
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,7 @@ A Unity 3D package for managing quests with sub-tasks. Inspired by Skyrim and Th
12
12
* Customizable drop in example prefab to easily get a quest GUI up and running in minutes
13
13
* Save / load support out of the box
14
14
* Heavily tested with TDD
15
+
* Includes event hooks to distribute rewards, update UI, and other game logic
15
16
16
17
**Support**
17
18
@@ -105,6 +106,34 @@ Found in `Assets/Examples/DebugQuestPrint/DebugQuestPrint.scene`. A useful scene
105
106
106
107
## Recipes
107
108
109
+
### Event Hooks
110
+
111
+
You can hook into quest state changes with the following hooks. This is extremely useful for granting rewards, detecting task changes, updating UI, and other game logic.
112
+
113
+
NOTE: Make sure you remove the event listener when the listening object is destroyed to prevent memory leaks.
114
+
115
+
```c#
116
+
// Triggers when a quest is added to the collection. Generally useful for UI updates
Unity Quest Journal supports save and load functionality out of the box. You can execute a save of your current quest states as so.
@@ -169,6 +198,12 @@ var taskDefinition = QuestJournalManager.Instance.Quests
169
198
.DefinitionasMyCustomTaskDefinition;
170
199
```
171
200
201
+
### Hiding Default Quest and Task
202
+
203
+
If you've written your own custom tasks you probably don't want the default ones to show up in the inspector. You can hide them by clicking the following checkboxes in your settings object.
204
+
205
+

206
+
172
207
## Releases
173
208
174
209
Archives of specific versions and release notes are available on the [releases page](https://github.com/ashblue/unity-quest-journal/releases).
***quest inspector:** cleaned up display bugs in the task display ([cc23082](https://github.com/ashblue/unity-quest-journal/commit/cc230826a167ce0b5e5d9b0c0a41baec313cbae4))
7
+
8
+
9
+
### Features
10
+
11
+
***quest database:** quests are now separate ScriptableObjects independent of the database ([9c64eb5](https://github.com/ashblue/unity-quest-journal/commit/9c64eb5f200b34cd93f132e841150c16067b16e9))
12
+
***quest events:** quest collection now has event hooks ([c535109](https://github.com/ashblue/unity-quest-journal/commit/c5351092340b6a538d170834217822185b94b141))
13
+
***quests and tasks:** default quest and task definition can now be excluded from inspectors ([359ba7b](https://github.com/ashblue/unity-quest-journal/commit/359ba7be8fa19cc44493e601c26622d3b8c1b2a1))
14
+
15
+
16
+
### BREAKING CHANGES
17
+
18
+
***quest database:** Breaks all existing quest implementations. It is recommended to not upgrade to this
0 commit comments