Skip to content

Commit 484898c

Browse files
chore(release): 2.0.0 [skip ci]
# [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.
1 parent fb55d52 commit 484898c

File tree

6 files changed

+65
-3
lines changed

6 files changed

+65
-3
lines changed

Assets/com.fluid.quest-journal/CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
## [1.0.1](https://github.com/ashblue/unity-quest-journal/compare/v1.0.0...v1.0.1) (2021-11-28)
2+
3+
4+
### Bug Fixes
5+
6+
* **builds:** prevents a crash by removing accidentally included editor only code ([b163656](https://github.com/ashblue/unity-quest-journal/commit/b16365679b7a23c848271325e8a5e6d90a07f016))
7+
18
# 1.0.0 (2021-09-03)
29

310

Assets/com.fluid.quest-journal/README.md

+35
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ A Unity 3D package for managing quests with sub-tasks. Inspired by Skyrim and Th
1212
* Customizable drop in example prefab to easily get a quest GUI up and running in minutes
1313
* Save / load support out of the box
1414
* Heavily tested with TDD
15+
* Includes event hooks to distribute rewards, update UI, and other game logic
1516

1617
**Support**
1718

@@ -105,6 +106,34 @@ Found in `Assets/Examples/DebugQuestPrint/DebugQuestPrint.scene`. A useful scene
105106

106107
## Recipes
107108

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
117+
QuestJournalManager.Instance.Quests.EventQuestAdd.AddListener((quest) => {
118+
// Your logic here
119+
});
120+
121+
// Triggers when a quest is completed due to running out of tasks. Useful for quest completion post processing events
122+
QuestJournalManager.Instance.Quests.EventQuestComplete.AddListener((quest) => {
123+
// Your logic here
124+
});
125+
126+
// Triggered when a quest has a task change. A good place to update your UI if you are displaying quest progress
127+
QuestJournalManager.Instance.Quests.EventQuestUpdate.AddListener((quest) => {
128+
// Your logic here
129+
});
130+
131+
// Triggers whenever a task is completed with the corresponding quest and task instance. Useful to fire post processing events with completed tasks.
132+
QuestJournalManager.Instance.Quests.EventQuestTaskComplete.AddListener((quest, task) => {
133+
// Your logic here
134+
});
135+
```
136+
108137
### Save And Load
109138

110139
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
169198
.Definition as MyCustomTaskDefinition;
170199
```
171200

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+
![Hide default quest and task](docs/hide-default-quest-and-task.png)
206+
172207
## Releases
173208

174209
Archives of specific versions and release notes are available on the [releases page](https://github.com/ashblue/unity-quest-journal/releases).

Assets/com.fluid.quest-journal/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "com.fluid.quest-journal",
3-
"version": "1.0.1",
3+
"version": "2.0.0",
44
"displayName": "Unity Quest Journal",
55
"description": "A Unity 3D package for managing quests with sub-tasks. Inspired by Skyrim and The Witcher 3's task managment system.",
66
"unity": "2020.1",

CHANGELOG.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
# [2.0.0](https://github.com/ashblue/unity-quest-journal/compare/v1.0.1...v2.0.0) (2024-03-27)
2+
3+
4+
### Bug Fixes
5+
6+
* **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
19+
version if you're on 1.X.
20+
121
## [1.0.1](https://github.com/ashblue/unity-quest-journal/compare/v1.0.0...v1.0.1) (2021-11-28)
222

323

package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "com.fluid.quest-journal",
3-
"version": "1.0.1",
3+
"version": "2.0.0",
44
"unity": "2020.1",
55
"displayName": "Unity Quest Journal",
66
"description": "A Unity 3D package for managing quests with sub-tasks. Inspired by Skyrim and The Witcher 3's task managment system.",

0 commit comments

Comments
 (0)