Skip to content

Commit

Permalink
CHANGE: Updated package version from 1.0.2 to 2.0.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
VulpesSoftware committed Jan 27, 2023
1 parent 76c2128 commit 9f5e38d
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 5 deletions.
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,35 @@ All notable changes to this package will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [2.0.0] - 2023-01-27
### Changed
- Simplified a lot of interfaces by removing redundant methods and properties.
- Most classes now have the 'DisallowMultipleComponent' attribute.
- Cleaned up some of the code to make things more concise.
- For 'MenuScreens' the 'TransitionIn' and 'TransitionOut' now take a 'MenuScreenTransitionContext' as an argument instead of a boolean value.
- The 'MenuHandler' no longer requires a 'CanvasGroup' component and instead requires a 'Canvas' component.
- On the 'MenuHandler', the 'Visible' property now directly toggles the 'Canvas' component on and off rather than awkwardly setting the alpha value of the 'CanvasGroup'.
- Removed 'MenuTooltip' logic from 'MenuHandler', that logic is now included in an optional 'MenuTooltipHandler' component which should be added to the same object as the 'MenuHandler' if you are using the 'MenuTooltip' as part of your menus.
- 'MenuHandler' no longer manages 'EventSystem' selections.
- Moved 'Raycast' method from 'MenuHandler' to new optional component 'MenuRaycaster'.
- Separated screen stack logic from 'IMenuHandler' into new 'IMenuStack' interface.
- Renamed 'MenuTooltipDetails' to 'MenuTooltipContent'.
- Updated Transitions Package dependency from 1.0.2 to 1.0.3.

### Fixed
- 'MenuModal' and 'MenuLoading' can no longer be assigned as the MenuHandler's initial screen.
- Fixed issue where 'null' could incorrectly be pushed to the screen stack, potentially causing a Null Reference Exception, attempting to push 'null' will now return a rejected Promise.

### Added
- Added 'MenuScreenTransitionContext' struct.
- Added 'MenuWidget_Toggle' class.
- Added 'MenuRaycaster' class.
- Added 'MenuTooltipHandler' class.
- Added 'IMenuStack' interface.
- Added 'IMenuTooltipProvider' interface.
- Added new Menu Sample assets.
- Added Documentation.

## [1.0.2] - 2023-01-22
### Changed
- Changed Unity Version from 2021.3.6f1 to 2021.3.0f1.
Expand Down
11 changes: 6 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"name": "com.vulpes.menus",
"displayName": "Vulpes Menu Framework",
"version": "1.0.2",
"version": "2.0.0",
"unity": "2021.3",
"description": "A Promise driven game menu framework for Unity.",
"description": "The Vulpes Menu Framework is a Promise driven menu system that serves as a companion to Unity’s built-in UI system.",
"keywords": [
"vulpes",
"menus"
Expand All @@ -17,8 +17,8 @@
"dependencies": {
"com.unity.ugui": "1.0.0",
"com.unity.textmeshpro": "3.0.6",
"com.unity.inputsystem": "1.0.2",
"com.vulpes.transitions": "1.0.2",
"com.unity.inputsystem": "1.3.0",
"com.vulpes.transitions": "1.0.3",
"com.vulpes.promises": "2.1.1"
},
"samples": [
Expand All @@ -28,5 +28,6 @@
"path": "Samples~/Menu Samples"
}
],
"unityRelease": "0f1"
"unityRelease": "0f1",
"documentationUrl": "https://github.com/VulpesSoftware/com.vulpes.menus/blob/master/Documentation~/index.md"
}

0 comments on commit 9f5e38d

Please sign in to comment.