@quenty/animationgroup 3.1.3-canary.c50dead.0 → 3.2.1

package/CHANGELOG.md

@@ -3,12 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [3.1.3-canary.c50dead.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/animationgroup@3.1.2...@quenty/animationgroup@3.1.3-canary.c50dead.0) (2021-11-20)
+## [3.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/animationgroup@3.2.0...@quenty/animationgroup@3.2.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/animationgroup
+
+
+
+
+
+# [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/animationgroup@3.1.2...@quenty/animationgroup@3.2.0) (2021-11-20)
 
 
 ### Bug Fixes
 
-* Support MacOS syncing ([c50dead](https://github.com/Quenty/NevermoreEngine/commit/c50deadbe5ebe479aded04e1619441a08ff0e9a8))
+* Support MacOS syncing ([#225](https://github.com/Quenty/NevermoreEngine/issues/225)) ([03f9183](https://github.com/Quenty/NevermoreEngine/commit/03f918392c6a5bdd33f8a17c38de371d1e06c67a))
 
 
 

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 @@
 ## AnimationGroup
 <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" />
@@ -13,17 +13,9 @@
 
 A group of weighted tracks that can be played back with weighted probability. The closest example to this is the idle animation that looks around at a 1:10 ratio when you're standing still in default Roblox animation script.
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/AnimationGroup">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/animationgroup --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-### `AnimationGroup.new(weightedTracks)`
-
-### `AnimationGroup:Play(transitionTime)`
-
-### `AnimationGroup:Stop(transitionTime)`
-
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/animationgroup",
-  "version": "3.1.3-canary.c50dead.0",
+  "version": "3.2.1",
   "description": "A group of weighted tracks that can be played back with weighted probability. The closest example to this is the idle animation that looks around at a 1:10 ratio when you're standing still in default Roblox animation script.",
   "keywords": [
     "Roblox",
@@ -26,13 +26,13 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/animationtrackutils": "2.0.0",
-    "@quenty/baseobject": "3.1.3-canary.c50dead.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/maid": "2.0.1"
+    "@quenty/animationtrackutils": "^2.0.1",
+    "@quenty/baseobject": "^3.2.1",
+    "@quenty/loader": "^3.1.2",
+    "@quenty/maid": "^2.0.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c50deadbe5ebe479aded04e1619441a08ff0e9a8"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/AnimationGroup.lua

@@ -1,7 +1,10 @@
---- A group of weighted tracks that can be played back with weighted probability.
--- The closest example to this is the idle animation that looks around at a 1:10
--- ratio when you're standing still in default Roblox animation script.
--- @classmod AnimationGroup
+--[=[
+	A group of weighted tracks that can be played back with weighted probability.
+	The closest example to this is the idle animation that looks around at a 1:10
+	ratio when you're standing still in default Roblox animation script.
+
+	@class AnimationGroup
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -13,6 +16,10 @@ local AnimationGroup = setmetatable({}, BaseObject)
 AnimationGroup.ClassName = "AnimationGroup"
 AnimationGroup.__index = AnimationGroup
 
+--[=[
+	@param weightedTracks { WeightedTrack }
+	@return AnimationGroup
+]=]
 function AnimationGroup.new(weightedTracks)
 	local self = setmetatable(BaseObject.new(), AnimationGroup)
 
@@ -29,6 +36,10 @@ function AnimationGroup.new(weightedTracks)
 	return self
 end
 
+--[=[
+	Plays the animations
+	@param transitionTime number
+]=]
 function AnimationGroup:Play(transitionTime)
 	if self._currentTrack and self._currentTrack.IsPlaying then
 		return
@@ -36,7 +47,10 @@ function AnimationGroup:Play(transitionTime)
 
 	self:_playNewTrack(transitionTime)
 end
-
+--[=[
+	Stops the animations
+	@param transitionTime number
+]=]
 function AnimationGroup:Stop(transitionTime)
 	if self._currentTrack then
 		self._currentTrack:Stop(transitionTime)

package/src/Shared/AnimationGroupUtils.lua

@@ -1,5 +1,9 @@
----
--- @module AnimationGroupUtils
+--[=[
+	An animation group is a group of animations, such as the idle animations that Roblox plays.
+	This utility functions are intended to help recreate a custom animation playback system with
+	weighted values.
+	@class AnimationGroupUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -7,6 +11,26 @@ local AnimationTrackUtils = require("AnimationTrackUtils")
 
 local AnimationGroupUtils = {}
 
+--[=[
+	@interface WeightedAnimation
+	.animationId string
+	.weight number
+	@within AnimationGroupUtils
+]=]
+
+--[=[
+	@interface WeightedTrack
+	.track Track
+	.weight number
+	@within AnimationGroupUtils
+]=]
+
+--[=[
+	Creates a new weighted track list.
+	@param humanoid Humanoid
+	@param weightedAnimationList { WeightedAnimation }
+	@return { WeightedTrack }
+]=]
 function AnimationGroupUtils.createdWeightedTracks(humanoid, weightedAnimationList)
 	assert(humanoid, "Bad humanoid")
 	assert(weightedAnimationList, "Bad weightedAnimationList")
@@ -23,6 +47,13 @@ function AnimationGroupUtils.createdWeightedTracks(humanoid, weightedAnimationLi
 	return tracks
 end
 
+--[=[
+	Creates a new weighted animation.
+
+	@param animationId string
+	@param weight number
+	@return WeightedAnimation
+]=]
 function AnimationGroupUtils.createdWeightedAnimation(animationId, weight)
 	assert(type(animationId) == "string", "Bad animationId")
 	assert(type(weight) == "number", "Bad weight")
@@ -33,6 +64,13 @@ function AnimationGroupUtils.createdWeightedAnimation(animationId, weight)
 	}
 end
 
+--[=[
+	Creates a new weighted track.
+
+	@param track Track
+	@param weight number
+	@return WeightedTrack
+]=]
 function AnimationGroupUtils.createdWeightedTrack(track, weight)
 	assert(typeof(track) == "Instance" and track:IsA("AnimationTrack"), "Bad track")
 	assert(type(weight) == "number", "Bad weight")
@@ -43,6 +81,12 @@ function AnimationGroupUtils.createdWeightedTrack(track, weight)
 	}
 end
 
+--[=[
+	Picks a weighted track for playback.
+
+	@param weightedTracks { WeightedTrack }
+	@return WeightedTrack?
+]=]
 function AnimationGroupUtils.selectFromWeightedTracks(weightedTracks)
 	assert(type(weightedTracks) == "table", "Bad weightedTracks")
 	assert(#weightedTracks > 0, "Bad weightedTracks")