@quenty/sprites 3.4.0 → 3.4.1-canary.238.2c4d310.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.
 
+## [3.4.1-canary.238.2c4d310.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sprites@3.4.0...@quenty/sprites@3.4.1-canary.238.2c4d310.0) (2021-12-29)
+
+**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,10 +1,10 @@
 ## Sprites
 <div align="center">
-  <a href="http://quenty.github.io/api/">
+  <a href="http://quenty.github.io/NevermoreEngine/">
     <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
   </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" />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/sprites",
-  "version": "3.4.0",
+  "version": "3.4.1-canary.238.2c4d310.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.2.1-canary.238.2c4d310.0",
+    "@quenty/loader": "3.1.2-canary.238.2c4d310.0",
+    "@quenty/maid": "2.0.2-canary.238.2c4d310.0",
+    "@quenty/uiobjectutils": "2.0.1-canary.238.2c4d310.0"
   },
   "devDependencies": {
-    "@quenty/string": "^2.2.0"
+    "@quenty/string": "2.2.1-canary.238.2c4d310.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "87ab1435a59a05e7dd745db1dfcec26116d1d71d"
+  "gitHead": "2c4d310b84afd0570d89667dc5d4aa69a0ef304a"
 }

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

@@ -1,6 +1,6 @@
----
--- @module DialogSlider.story
--- @author Quenty
+--[=[
+	@class DialogSlider.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,7 @@
---- Input image library
--- @module InputImageLibrary
+--[=[
+	Input image library
+	@class InputImageLibrary
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -18,6 +20,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 +46,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,6 @@
----
--- @classmod AnimatedSpritesheet
--- @author Quenty
+--[=[
+	@class AnimatedSpritesheet
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

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

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

package/src/Shared/Sprite/AnimatedSpritesheetPlayer.lua

@@ -1,6 +1,6 @@
----
--- @classmod AnimatedSpritesheetPlayer
--- @author Quenty
+--[=[
+	@class AnimatedSpritesheetPlayer
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Shared/Sprite/Sprite.lua

@@ -1,5 +1,6 @@
----
--- @classmod Sprite
+--[=[
+	@class Sprite
+]=]
 
 local Sprite = {}
 Sprite.ClassName = "Sprite"

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)