@quenty/colorsequenceutils 2.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [2.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/colorsequenceutils@2.0.0...@quenty/colorsequenceutils@2.0.1) (2021-12-30)
7
+
8
+ **Note:** Version bump only for package @quenty/colorsequenceutils
9
+
10
+
11
+
12
+
13
+
6
14
  # [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/colorsequenceutils@1.2.0...@quenty/colorsequenceutils@2.0.0) (2021-09-05)
7
15
 
8
16
 
package/LICENSE.md CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2014 Quenty
3
+ Copyright (c) 2014-2021 Quenty
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  ## ColorSequenceUtils
2
2
  <div align="center">
3
- <a href="http://quenty.github.io/api/">
4
- <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
3
+ <a href="http://quenty.github.io/NevermoreEngine/">
4
+ <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
5
5
  </a>
6
6
  <a href="https://discord.gg/mhtGUS8">
7
- <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
7
+ <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
8
8
  </a>
9
9
  <a href="https://github.com/Quenty/NevermoreEngine/actions">
10
10
  <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,13 +13,10 @@
13
13
 
14
14
  Utility functions for Color sequences in Roblox.
15
15
 
16
+ <div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ColorSequenceUtils">View docs →</a></div>
17
+
16
18
  ## Installation
17
19
  ```
18
20
  npm install @quenty/colorsequenceutils --save
19
21
  ```
20
22
 
21
- ## Usage
22
- Usage is designed to be simple.
23
-
24
- ### `ColorSequenceUtils.stripe(stripes, backgroundColor3, stripeColor3, percentStripeThickness, percentOffset)`
25
-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/colorsequenceutils",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "description": "Utility functions for Color sequences in Roblox.",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -27,5 +27,5 @@
27
27
  "publishConfig": {
28
28
  "access": "public"
29
29
  },
30
- "gitHead": "c06170ec47b0d4520c587ce2e6404d14b5dbb851"
30
+ "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
31
31
  }
@@ -1,10 +1,22 @@
1
- --- Utility functions for Color sequences in Roblox.
2
- -- @module ColorSequenceUtils
1
+ --[=[
2
+ Utility functions for Color sequences in Roblox.
3
+ @class ColorSequenceUtils
4
+ ]=]
3
5
 
4
6
  local ColorSequenceUtils = {}
5
7
 
6
8
  local EPSILON = 1e-3
7
9
 
10
+ --[=[
11
+ Makes stripes for color sequences.
12
+
13
+ @param stripes number
14
+ @param backgroundColor3 Color3
15
+ @param stripeColor3 Color3
16
+ @param percentStripeThickness number
17
+ @param percentOffset number
18
+ @return ColorSequence
19
+ ]=]
8
20
  function ColorSequenceUtils.stripe(stripes, backgroundColor3, stripeColor3, percentStripeThickness, percentOffset)
9
21
  percentOffset = percentOffset or 0
10
22
  percentStripeThickness = math.clamp(percentStripeThickness or 0.5, 0, 1)