@quenty/flipbook 3.0.0-canary.367.e9fdcbc.0 → 3.0.0

package/CHANGELOG.md

@@ -3,7 +3,98 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [3.0.0-canary.367.e9fdcbc.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.8.0...@quenty/flipbook@3.0.0-canary.367.e9fdcbc.0) (2023-06-05)
+# [3.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.19.0...@quenty/flipbook@3.0.0) (2023-10-11)
+
+**Note:** Version bump only for package @quenty/flipbook
+
+
+
+
+
+# [2.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.18.0...@quenty/flipbook@2.19.0) (2023-09-21)
+
+**Note:** Version bump only for package @quenty/flipbook
+
+
+
+
+
+# [2.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.17.0...@quenty/flipbook@2.18.0) (2023-09-04)
+
+**Note:** Version bump only for package @quenty/flipbook
+
+
+
+
+
+# [2.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.16.0...@quenty/flipbook@2.17.0) (2023-08-23)
+
+**Note:** Version bump only for package @quenty/flipbook
+
+
+
+
+
+# [2.16.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.15.0...@quenty/flipbook@2.16.0) (2023-08-01)
+
+**Note:** Version bump only for package @quenty/flipbook
+
+
+
+
+
+# [2.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.14.0...@quenty/flipbook@2.15.0) (2023-07-28)
+
+**Note:** Version bump only for package @quenty/flipbook
+
+
+
+
+
+# [2.14.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.13.0...@quenty/flipbook@2.14.0) (2023-07-25)
+
+
+### Features
+
+* Add restFrame support to Flipbooks to control the frame the flipbooks rest on ([cbf5f4f](https://github.com/Quenty/NevermoreEngine/commit/cbf5f4f4211156144e150dd960d9e2225cf9c5f5))
+
+
+
+
+
+# [2.13.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.12.0...@quenty/flipbook@2.13.0) (2023-07-23)
+
+**Note:** Version bump only for package @quenty/flipbook
+
+
+
+
+
+# [2.12.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.11.0...@quenty/flipbook@2.12.0) (2023-07-15)
+
+**Note:** Version bump only for package @quenty/flipbook
+
+
+
+
+
+# [2.11.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.10.0...@quenty/flipbook@2.11.0) (2023-07-10)
+
+**Note:** Version bump only for package @quenty/flipbook
+
+
+
+
+
+# [2.10.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.9.0...@quenty/flipbook@2.10.0) (2023-06-17)
+
+**Note:** Version bump only for package @quenty/flipbook
+
+
+
+
+
+# [2.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/flipbook@2.8.0...@quenty/flipbook@2.9.0) (2023-06-05)
 
 **Note:** Version bump only for package @quenty/flipbook
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/flipbook",
-  "version": "3.0.0-canary.367.e9fdcbc.0",
+  "version": "3.0.0",
   "description": "Handles playing back animated spritesheets",
   "keywords": [
     "Roblox",
@@ -25,18 +25,18 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "6.2.1",
-    "@quenty/instanceutils": "7.14.0",
-    "@quenty/loader": "6.2.1",
-    "@quenty/maid": "2.5.0",
-    "@quenty/promise": "6.5.0",
-    "@quenty/rx": "7.11.0",
-    "@quenty/sprites": "8.2.0",
-    "@quenty/uiobjectutils": "3.4.0",
-    "@quenty/valueobject": "8.0.0-canary.367.e9fdcbc.0"
+    "@quenty/baseobject": "^7.0.0",
+    "@quenty/instanceutils": "^8.0.0",
+    "@quenty/loader": "^7.0.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/promise": "^7.0.0",
+    "@quenty/rx": "^8.0.0",
+    "@quenty/sprites": "^9.0.0",
+    "@quenty/uiobjectutils": "^3.4.0",
+    "@quenty/valueobject": "^8.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9fdcbc6ea1d46e068bf42a08b833099e9005259"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Client/Flipbook.lua

@@ -9,12 +9,13 @@ local Sprite = require("Sprite")
 
 --[=[
 	@interface FlipbookData
-	.imageId string
+	.image string
 	.frameCount number
 	.rows number
 	.columns number
 	.imageRectSize Vector2
 	.frameRate number
+	.restFrame number | nil -- Optional reset frame
 	@within Flipbook
 ]=]
 
@@ -32,6 +33,9 @@ function Flipbook.new(data)
 
 	self._frameSprites = {}
 	self._frameRate = 60
+	self._restFrame = data.restFrame
+
+	assert(type(data.restFrame) == "number" or data.restFrame == nil, "Bad data.restFrame")
 
 	if data.frameCount then
 		self:SetFrameCount(data.frameCount)
@@ -84,6 +88,10 @@ function Flipbook:_loadFrames(image, columns, imageRectSize)
 	end
 end
 
+function Flipbook:GetRestFrame()
+	return self._restFrame
+end
+
 function Flipbook:SetSpriteAtIndex(index, sprite)
 	assert(type(index) == "number", "Bad index")
 	assert(type(sprite) == "table", "Bad sprite")

package/src/Client/Player/FlipbookPlayer.lua

@@ -56,7 +56,15 @@ function FlipbookPlayer.new(imageLabel)
 			else
 				self._isPlaying.Value = false
 				self._maid._playing = nil
-				self:_updateToFrame(state.flipbook, 1)
+
+				local restFrame = state.flipbook:GetRestFrame()
+				if restFrame then
+					self:_updateToFrame(state.flipbook, restFrame)
+				else
+					self._obj.Image = self._originalImage
+					self._obj.ImageRectOffset = self._originalRectOffset
+					self._obj.ImageRectSize = self._originalRectSize
+				end
 			end
 		else
 			self._isPlaying.Value = false
@@ -201,18 +209,20 @@ function FlipbookPlayer:_execPlay(flipbook, playData)
 	return maid
 end
 
+function FlipbookPlayer:_computeFrameCount(originalFrameCount, isBoomarang)
+	if isBoomarang then
+		return 2*originalFrameCount - 2
+	else
+		return originalFrameCount
+	end
+end
+
 function FlipbookPlayer:_update(flipbook, currentTime, playData)
 	local isBoomarang = self._isBoomarang.Value
 	local fps = flipbook:GetFrameRate()
 	local originalFrameCount = flipbook:GetFrameCount()
 
-	local frameCount
-	if isBoomarang then
-		frameCount = 2*originalFrameCount - 2
-	else
-		frameCount = originalFrameCount
-	end
-
+	local frameCount = self:_computeFrameCount(originalFrameCount, isBoomarang)
 	local frame = (math.floor((currentTime - playData.startTime)*fps)%frameCount) + 1
 
 	if isBoomarang then
@@ -237,7 +247,7 @@ function FlipbookPlayer:_update(flipbook, currentTime, playData)
 	end
 
 	if isOver then
-		self:_updateToFrame(flipbook, 1)
+		self:_updateToFrame(flipbook, frameCount)
 		self._playData.Value = nil
 	else
 		self:_updateToFrame(flipbook, frame)

package/src/Client/Player/FlipbookPlayer.story.lua

@@ -90,6 +90,7 @@ return function(target)
 		frameCount = 34;
 		imageRectSize = Vector2.new(85.33333, 85.33333);
 		frameRate = 20;
+		restFrame = 1;
 	}), container, false)
 
 	makeLabel(maid, Flipbook.new({
@@ -99,6 +100,7 @@ return function(target)
 		frameCount = 34;
 		imageRectSize = Vector2.new(85.33333, 85.33333);
 		frameRate = 20;
+		restFrame = 1;
 	}), container, true)
 
 	makeLabel(maid, Flipbook.new({
@@ -107,6 +109,7 @@ return function(target)
 		columns = 6;
 		imageRectSize = Vector2.new(170, 170);
 		frameRate = 50;
+		restFrame = 1;
 	}), container, false)
 
 	makeLabel(maid, Flipbook.new({
@@ -116,6 +119,7 @@ return function(target)
 		frameCount = 92;
 		imageRectSize = Vector2.new(102, 102);
 		frameRate = 50;
+		restFrame = 1;
 	}), container, false)
 
 	makeButton(maid, Flipbook.new({
@@ -125,6 +129,7 @@ return function(target)
 		frameCount = 92;
 		imageRectSize = Vector2.new(102, 102);
 		frameRate = 60;
+		restFrame = 1;
 	}), container, false)
 
 	makeButton(maid, Flipbook.new({
@@ -134,6 +139,7 @@ return function(target)
 		frameCount = 34;
 		imageRectSize = Vector2.new(85.33333, 85.33333);
 		frameRate = 20;
+		restFrame = 1;
 	}), container, true)
 
 	makeLabel(maid, Flipbook.new({
@@ -143,6 +149,7 @@ return function(target)
 		frameCount = 92;
 		imageRectSize = Vector2.new(102, 102);
 		frameRate = 50;
+		restFrame = 1;
 	}), container, false)
 
 	makeLabel(maid, Flipbook.new({
@@ -152,6 +159,7 @@ return function(target)
 		frameCount = 45;
 		imageRectSize = Vector2.new(146, 146);
 		frameRate = 30;
+		restFrame = 1;
 	}), container, false)
 
 	makeLabel(maid, Flipbook.new({
@@ -161,6 +169,7 @@ return function(target)
 		frameCount = 66;
 		imageRectSize = Vector2.new(113, 113);
 		frameRate = 60;
+		restFrame = 1;
 	}), container, false)
 
 	return function()