@quenty/sprites 3.4.0 → 3.5.0-canary.241.a4e8214.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.5.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sprites@3.4.1...@quenty/sprites@3.5.0-canary.241.a4e8214.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/sprites
+
+
+
+
+
+## [3.4.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sprites@3.4.0...@quenty/sprites@3.4.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/sprites
+
+
+
+
+
 # [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sprites@3.3.0...@quenty/sprites@3.4.0) (2021-11-20)
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,17 +1,20 @@
 ## Sprites
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
   </a>
 </div>
+
 Spritesheet utility for Roblox including a built-in InputImageLibrary
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/InputImageLibrary">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/sprites --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/sprites",
-  "version": "3.4.0",
+  "version": "3.5.0-canary.241.a4e8214.0",
   "description": "Spritesheet utility for Roblox including a built-in InputImageLibrary",
   "keywords": [
     "Roblox",
@@ -26,16 +26,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^3.2.0",
-    "@quenty/loader": "^3.1.1",
-    "@quenty/maid": "^2.0.1",
-    "@quenty/uiobjectutils": "^2.0.0"
+    "@quenty/baseobject": "3.3.0-canary.241.a4e8214.0",
+    "@quenty/loader": "3.2.0-canary.241.a4e8214.0",
+    "@quenty/maid": "2.0.2",
+    "@quenty/uiobjectutils": "2.0.1"
   },
   "devDependencies": {
-    "@quenty/string": "^2.2.0"
+    "@quenty/string": "2.2.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "87ab1435a59a05e7dd745db1dfcec26116d1d71d"
+  "gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
 }

package/src/Shared/InputImageLibrary/InputImageLibrary.story.lua

@@ -1,6 +1,6 @@
----
--- @module DialogSlider.story
--- @author Quenty
+--[[
+	@class InputImageLibrary.story
+]]
 
 local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).load(script)
 

package/src/Shared/InputImageLibrary/Spritesheets/Guestures/All.lua

@@ -1,4 +1,7 @@
---- Generated Gestures with Python
+--[[
+	Generated Gestures with Python
+	@class Gestures
+]]
 
 local parent = script:FindFirstAncestorWhichIsA("ModuleScript")
 local require = require(parent.Parent.loader).load(parent)

package/src/Shared/InputImageLibrary/Spritesheets/Keyboard/Dark.lua

@@ -1,4 +1,7 @@
---- Generated KeyboardDark with Python
+--[[
+	Generated KeyboardDark with Python
+	@class KeyboardDark
+]]
 
 local parent = script:FindFirstAncestorWhichIsA("ModuleScript")
 local require = require(parent.Parent.loader).load(parent)

package/src/Shared/InputImageLibrary/Spritesheets/Keyboard/Light.lua

@@ -1,4 +1,7 @@
---- Generated KeyboardLight with Python
+--[[
+	Generated KeyboardLight with Python
+	@class KeyboardLight
+]]
 
 local parent = script:FindFirstAncestorWhichIsA("ModuleScript")
 local require = require(parent.Parent.loader).load(parent)

package/src/Shared/InputImageLibrary/Spritesheets/XboxOne/Dark.lua

@@ -1,4 +1,7 @@
---- Generated XboxOneDark with Python
+--[[
+	Generated XboxOneDark with Python
+	@class XboxOneDark
+]]
 
 local parent = script:FindFirstAncestorWhichIsA("ModuleScript")
 local require = require(parent.Parent.loader).load(parent)

package/src/Shared/InputImageLibrary/Spritesheets/XboxOne/Light.lua

@@ -1,5 +1,7 @@
---- Generated XboxOneLight with Python
--- @author Quenty
+--[[
+	Generated XboxOneLight with Python
+	@class XboxOneLight
+]]
 
 local parent = script:FindFirstAncestorWhichIsA("ModuleScript")
 local require = require(parent.Parent.loader).load(parent)

package/src/Shared/InputImageLibrary/init.lua

@@ -1,5 +1,9 @@
---- Input image library
--- @module InputImageLibrary
+--[=[
+	InputImageLibrary with a variety of dark and light themed icons for inputs on keyboard, xbox, touched events,
+	mouse, and more.
+
+	@class InputImageLibrary
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -18,6 +22,11 @@ function InputImageLibrary.new(parentFolder)
 	return self
 end
 
+--[=[
+	Retrieves all the asset ids to preload
+
+	@return { string }
+]=]
 function InputImageLibrary:GetPreloadAssetIds()
 	local assets = {}
 	for _, platformSheets in pairs(self._spritesheets) do
@@ -39,8 +48,14 @@ function InputImageLibrary:_loadSpriteSheets(parentFolder)
 	end
 end
 
----
--- @treturn Sprite
+--[=[
+	Retrieves a sprite from the library
+
+	@param index number -- The sprite index to get
+	@param preferredStyle string -- The preferred style type to retrieve this in
+	@param preferredPlatform string -- The preferred platform to get the sprite for
+	@return Sprite
+]=]
 function InputImageLibrary:GetSprite(index, preferredStyle, preferredPlatform)
 	local sheet = self:_pickSheet(index, preferredStyle, preferredPlatform)
 	if sheet then

package/src/Shared/Sprite/AnimatedSpritesheet.lua

@@ -1,6 +1,7 @@
----
--- @classmod AnimatedSpritesheet
--- @author Quenty
+--[=[
+	A spritesheet that is animated. See [AnimatedSpritesheetPlayer] for playback.
+	@class AnimatedSpritesheet
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -10,6 +11,21 @@ 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)
 
@@ -31,19 +47,34 @@ function AnimatedSpritesheet.new(options)
 	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
 
-function AnimatedSpritesheet:GetPlayTime(framesPerSecond)
-	return self._options.frames/framesPerSecond
+--[=[
+	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

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

@@ -1,6 +1,6 @@
----
--- @module DialogSlider.story
--- @author Quenty
+--[[
+	@class AnimatedSpritesheet.story
+]]
 
 local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).load(script)
 

package/src/Shared/Sprite/AnimatedSpritesheetPlayer.lua

@@ -1,6 +1,7 @@
----
--- @classmod AnimatedSpritesheetPlayer
--- @author Quenty
+--[=[
+	Plays an [AnimatedSpritesheet] for an given image label.
+	@class AnimatedSpritesheetPlayer
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -13,6 +14,12 @@ 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)
 
@@ -25,6 +32,10 @@ function AnimatedSpritesheetPlayer.new(imageLabel, spritesheet)
 	return self
 end
 
+--[=[
+	Sets the current sheet and starts play if needed
+	@param spritesheet AnimatedSpritesheet
+]=]
 function AnimatedSpritesheetPlayer:SetSheet(spritesheet)
 	assert(spritesheet, "Bad spritesheet")
 

package/src/Shared/Sprite/Sprite.lua

@@ -1,10 +1,27 @@
----
--- @classmod Sprite
+--[=[
+	A single image on a spritesheet.
+	@class Sprite
+]=]
 
 local Sprite = {}
 Sprite.ClassName = "Sprite"
 Sprite.__index = Sprite
 
+--[=[
+	Data used to construct a sprite.
+	@interface SpriteData
+	.Texture string
+	.Size Vector2
+	.Position Vector2
+	.Name string
+	@within Sprite
+]=]
+
+--[=[
+	Constructs a new sprite
+	@param data SpriteData
+	@return Sprite
+]=]
 function Sprite.new(data)
 	assert(data.Texture, "Bad data")
 	assert(data.Size, "Bad data")
@@ -16,6 +33,11 @@ function Sprite.new(data)
 	return self
 end
 
+--[=[
+	Applies the styling to the gui
+	@param gui ImageLabel | ImageButton
+	@return Instance
+]=]
 function Sprite:Style(gui)
 	gui.Image = self.Texture
 	gui.ImageRectOffset = self.Position
@@ -24,6 +46,11 @@ function Sprite:Style(gui)
 	return gui
 end
 
+--[=[
+	Returns a new sprite with the specified `instanceType`
+	@param instanceType "ImageLabel" | "ImageButton"
+	@return ImageLabel | ImageButton
+]=]
 function Sprite:Get(instanceType)
 	local gui = Instance.new(instanceType)
 	gui.Size = UDim2.new(0, self.Size.X, 0, self.Size.Y)

package/src/Shared/Sprite/Spritesheet.lua

@@ -1,5 +1,7 @@
---- Data model for sprite sheets
--- @classmod Spritesheet
+--[=[
+	Data model for sprite sheets
+	@class Spritesheet
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -9,6 +11,11 @@ local Spritesheet = {}
 Spritesheet.ClassName = "Spritesheet"
 Spritesheet.__index = Spritesheet
 
+--[=[
+	Constructs a new Spritesheet
+	@param texture string
+	@return Spritesheet
+]=]
 function Spritesheet.new(texture)
 	local self = setmetatable({}, Spritesheet)
 
@@ -18,10 +25,21 @@ function Spritesheet.new(texture)
 	return self
 end
 
+--[=[
+	Retrieves the preload asset ids to use
+	@return string
+]=]
 function Spritesheet:GetPreloadAssetId()
 	return self._texture
 end
 
+--[=[
+	@param index any
+	@param position Vector2
+	@param size Vector2
+
+	Adds a named sprite at the given index
+]=]
 function Spritesheet:AddSprite(index, position, size)
 	assert(not self._sprites[index], "Already exists")
 
@@ -35,6 +53,11 @@ function Spritesheet:AddSprite(index, position, size)
 	self._sprites[index] = sprite
 end
 
+--[=[
+	Retrieves the sprite for the given index
+	@param index any | EnumItem
+	@return Sprite?
+]=]
 function Spritesheet:GetSprite(index)
 	if not index then
 		warn("[Spritesheet.GetSprite] - Image name cannot be nil")
@@ -53,6 +76,11 @@ function Spritesheet:GetSprite(index)
 	return sprite
 end
 
+--[=[
+	Returns true if the sprite exists
+	@param index any | EnumItem
+	@return boolean
+]=]
 function Spritesheet:HasSprite(index)
 	return self:GetSprite(index) ~= nil
 end