@quenty/sprites 7.3.0 → 8.0.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sprites@7.3.0...@quenty/sprites@8.0.0) (2023-03-06)
+
+**Note:** Version bump only for package @quenty/sprites
+
+
+
+
+
 # [7.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sprites@7.2.0...@quenty/sprites@7.3.0) (2023-03-05)
 
 **Note:** Version bump only for package @quenty/sprites

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/sprites",
-  "version": "7.3.0",
+  "version": "8.0.0",
   "description": "Spritesheet utility for Roblox including a built-in InputImageLibrary",
   "keywords": [
     "Roblox",
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e62b5eac2e5d9084ab9083f128452dd2d98b6f1a"
+  "gitHead": "2e5e9b3fa1c8d585a9c522e627fd86b950d16502"
 }

package/src/Shared/Sprite/AnimatedSpritesheet.lua

@@ -1,82 +0,0 @@
---[=[
-	A spritesheet that is animated. See [AnimatedSpritesheetPlayer] for playback.
-	@class AnimatedSpritesheet
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local Spritesheet = require("Spritesheet")
-
-local AnimatedSpritesheet = setmetatable({}, Spritesheet)
-AnimatedSpritesheet.ClassName = "AnimatedSpritesheet"
-AnimatedSpritesheet.__index = AnimatedSpritesheet
-
---[=[
-	@interface AnimatedSpritesheetOptions
-	.texture string
-	.frames number
-	.spritesPerRow number
-	.spriteSize Vector2
-	.framesPerSecond number
-	@within AnimatedSpritesheet
-]=]
-
---[=[
-	Constructs a new AnimatedSpritesheet
-	@param options AnimatedSpritesheetOptions
-	@return AnimatedSpritesheet
-]=]
-function AnimatedSpritesheet.new(options)
-	local self = setmetatable(Spritesheet.new(options.texture), AnimatedSpritesheet)
-
-	self._options = assert(options, "Bad options")
-	assert(self._options.texture, "Bad options.texture")
-	assert(self._options.frames, "Bad options.frames")
-	assert(self._options.spritesPerRow, "Bad options.spritesPerRow")
-	assert(self._options.spriteSize, "Bad options.spriteSize")
-	assert(self._options.framesPerSecond, "Bad options.framesPerSecond")
-
-	for i=0, options.frames do
-		local x = i % options.spritesPerRow
-		local y = math.floor(i / options.spritesPerRow)
-		local position = options.spriteSize*Vector2.new(x, y)
-
-		self:AddSprite(i + 1, position, options.spriteSize)
-	end
-
-	return self
-end
-
---[=[
-	Gets the sprite size
-	@return Vector2
-]=]
-function AnimatedSpritesheet:GetSpriteSize()
-	return self._options.spriteSize
-end
-
---[=[
-	Gets the frames per a second
-	@return number
-]=]
-function AnimatedSpritesheet:GetFramesPerSecond()
-	return self._options.framesPerSecond
-end
-
---[=[
-	Gets the play time for the animated sheet
-	@return number
-]=]
-function AnimatedSpritesheet:GetPlayTime()
-	return self._options.frames/self._options.framesPerSecond
-end
-
---[=[
-	Retrieves the frames for the sprite sheet.
-	@return frames
-]=]
-function AnimatedSpritesheet:GetFrames()
-	return self._options.frames
-end
-
-return AnimatedSpritesheet

package/src/Shared/Sprite/AnimatedSpritesheet.story.lua

@@ -1,61 +0,0 @@
---[[
-	@class AnimatedSpritesheet.story
-]]
-
-local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).load(script)
-
-local AnimatedSpritesheet = require("AnimatedSpritesheet")
-local AnimatedSpritesheetPlayer = require("AnimatedSpritesheetPlayer")
-local Maid = require("Maid")
-local UICornerUtils = require("UICornerUtils")
-
-local function makeLabel(maid, sheet, target)
-	local size = sheet:GetSpriteSize()
-
-	local imageLabel = Instance.new("ImageLabel")
-	imageLabel.BackgroundTransparency = 0
-	imageLabel.BackgroundColor3 = Color3.new(0.5, 0.5, 0.5)
-	imageLabel.Size = UDim2.fromOffset(size.x, size.y)
-	imageLabel.BorderSizePixel = 0
-	maid:GiveTask(imageLabel)
-
-	UICornerUtils.fromOffset(8, imageLabel)
-
-	local player = AnimatedSpritesheetPlayer.new(imageLabel, sheet)
-	maid:GiveTask(player)
-
-	imageLabel.Parent = target
-
-	return imageLabel
-end
-
-return function(target)
-	local maid = Maid.new()
-
-	local container = Instance.new("Frame")
-	container.Size = UDim2.new(1, 0, 1, 0)
-	container.BackgroundTransparency = 0
-	container.BackgroundColor3 = Color3.new(0, 0, 0)
-	container.Parent = target
-	maid:GiveTask(container)
-
-	local uiListLayout = Instance.new("UIListLayout")
-	uiListLayout.FillDirection = Enum.FillDirection.Horizontal
-	uiListLayout.VerticalAlignment = Enum.VerticalAlignment.Center
-	uiListLayout.HorizontalAlignment = Enum.HorizontalAlignment.Center
-	uiListLayout.Padding = UDim.new(0, 10)
-	uiListLayout.SortOrder = Enum.SortOrder.LayoutOrder
-	uiListLayout.Parent = container
-
-	makeLabel(maid, AnimatedSpritesheet.new({
-		texture = "rbxassetid://5085366281";
-		frames = 34;
-		spritesPerRow = 6;
-		spriteSize = Vector2.new(85.33333, 85.33333);
-		framesPerSecond = 30;
-	}), container)
-
-	return function()
-		maid:DoCleaning()
-	end
-end

package/src/Shared/Sprite/AnimatedSpritesheetPlayer.lua

@@ -1,60 +0,0 @@
---[=[
-	Plays an [AnimatedSpritesheet] for an given image label.
-	@class AnimatedSpritesheetPlayer
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local RunService = game:GetService("RunService")
-
-local BaseObject = require("BaseObject")
-local Maid = require("Maid")
-
-local AnimatedSpritesheetPlayer = setmetatable({}, BaseObject)
-AnimatedSpritesheetPlayer.ClassName = "AnimatedSpritesheetPlayer"
-AnimatedSpritesheetPlayer.__index = AnimatedSpritesheetPlayer
-
---[=[
-	Constructs a new AnimatedSpritesheetPlayer
-	@param imageLabel ImageLabel
-	@param spritesheet AnimatedSpritesheet?
-	@return AnimatedSpritesheetPlayer
-]=]
-function AnimatedSpritesheetPlayer.new(imageLabel, spritesheet)
-	local self = setmetatable(BaseObject.new(spritesheet), AnimatedSpritesheetPlayer)
-
-	self._imageLabel = assert(imageLabel, "Bad imageLabel")
-
-	if spritesheet then
-		self:SetSheet(spritesheet)
-	end
-
-	return self
-end
-
---[=[
-	Sets the current sheet and starts play if needed
-	@param spritesheet AnimatedSpritesheet
-]=]
-function AnimatedSpritesheetPlayer:SetSheet(spritesheet)
-	assert(spritesheet, "Bad spritesheet")
-
-	self._spritesheet = spritesheet
-	self:_play()
-end
-
-function AnimatedSpritesheetPlayer:_play()
-	local maid = Maid.new()
-
-	local fps = self._spritesheet:GetFramesPerSecond()
-	local frames = self._spritesheet:GetFrames()
-
-	maid:GiveTask(RunService.RenderStepped:Connect(function()
-		local frame = (math.floor(tick()*fps)%frames)+1
-		self._spritesheet:GetSprite(frame):Style(self._imageLabel)
-	end))
-
-	self._maid._play = maid
-end
-
-return AnimatedSpritesheetPlayer