com.vulpes.menus - npm Package Compare versions

Comparing version 1.0.2 to 2.0.0

CHANGELOG.md

@@ -7,2 +7,31 @@ # Changelog
 
+## [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
@@ -9,0 +38,0 @@ ### Changed

package.json

 {
   "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": [
@@ -20,4 +20,4 @@ "vulpes",
     "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"
@@ -32,3 +32,4 @@ },
   ],
-  "unityRelease": "0f1"
+  "unityRelease": "0f1",
+  "documentationUrl": "https://github.com/VulpesSoftware/com.vulpes.menus/blob/master/Documentation~/index.md"
 }

README.md

 # Vulpes Menu Framework
 
-A Promise driven game menu framework for Unity.
+The Vulpes Menu Framework is a Promise driven menu system that serves as a companion to Unity’s built-in UI system.
 
@@ -5,0 +5,0 @@ ## Installing this package

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

838871

increased by31.97%

Number of package files

167

increased by59.05%

Dependency changes

• + Addedcom.vulpes.transitions@1.0.3(transitive)

• - Removedcom.vulpes.transitions@1.0.2(transitive)

• Updatedcom.unity.inputsystem@1.3.0

• Updatedcom.vulpes.transitions@1.0.3