Skip to content

Commit 1b29bdc

Browse files
committed
Update readme & changelog
1 parent ea8ca23 commit 1b29bdc

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

CHANGELOG.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,32 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## [2.1.0] - 2022-xx-xx
7+
## [2.1.0] - 2022-02-05
88
Quality of life improvements.
99

1010
### Added
11-
- Utility window to help in creation of Scriptable Events. It can be found under _Right Click > Create > Scriptable Event > Custom Scriptable Event_ (at the very bottom).
11+
- Utility window to help in creation of Scriptable Events. It can be found via _Right Click > Create > Scriptable Event > Custom Scriptable Event_ (at the very bottom).
1212
- `ScriptableEventConstants` class which can be used to order custom events more neatly.
1313
- `BaseScriptableEvent` class (without `TArg`) which is inherited by all events and is used internally to draw inspector GUIs.
14-
- `DefaultScriptableEventEditor` which targets `BaseScriptableEvent`. This addresses some issues when Odin Inspector is used in the project.
14+
- `DefaultScriptableEventEditor` which targets `BaseScriptableEvent`. This addresses some issues when Odin Inspector is present in the project.
1515
- `BaseScriptableEventListener` (without `TArg`) which is now inherited by all listeners.
16-
- `BaseScriptableEventListenerEditor` which targets `BaseScriptableEventListener`. This addresses some issues when Odin Inspector is used in the project and will be used to add additional functionality to listener components in the future.
16+
- `BaseScriptableEventListenerEditor` which targets `BaseScriptableEventListener`. This addresses some issues when Odin Inspector is present in the project and will be used to add additional functionality to listener components in the future.
1717
- Support for `Action<TArg>` listeners. This means that regular methods can now be used as listeners without the need of implementing `IScriptableEventListener<TArg>`.
1818
- _Raise_ button which is shown next to each added listener. Using this button listeners can be raised individually through the inspector. This is useful for debugging purposes.
1919
- Icons for events and listeners - this will require asset re-import.
2020
- Odin Inspector support via the use of `#if ODIN_INSPECTOR`.
2121

2222
### Changed
2323
- Renamed Scriptable Event creation menu from _Scriptable **Events**_ to _Scriptable **Event**_.
24-
- Moved Scriptable Event creation menu under _Folder_ and _Script_ creation menus so the package is less intrusive.
24+
- Moved Scriptable Event menus below _Folder_ and _Script_ creation menu items so the package is less intrusive.
2525
- All existing events now use `ScriptableEventConstants` to define their menu order.
2626
- `lockDescription` is no longer serialized as its only useful during edit mode.
2727
- All `bool` properties now have an `is` prefix.
28-
- Improved `isDebug` messages to be more consistent. Additionally, a listener `Object` will be used as a context when possible to improve the _ping_ functionality when clicking on a debug message in the Editor.
29-
- Events can now be raised in Edit mode via the _Raise_ button in if any listeners are added.
28+
- Improved `isDebug` messages to be more consistent. Additionally, a listener `Object` will be used as a context when possible to improve the [ping](https://docs.unity3d.com/ScriptReference/EditorGUIUtility.PingObject.html) functionality when clicking on a debug message in the Editor.
29+
- Events can now be raised in Edit mode via the _Raise_ button in if any listeners are present in the event.
3030
- Improved how event `description` is being drawn.
31+
- Reworked all samples to be more consistent.
32+
- Updated usage documentation to follow new samples and showcase event creation.
3133

3234
## [2.0.0] - 2021-07-07
3335
This release contains major breaking changes and migrates from 2019 (LTS) to 2020 (LTS) in order to utilise generics.

0 commit comments

Comments
 (0)