From eb788c8ae1e862d0eaf685724474514952c5423a Mon Sep 17 00:00:00 2001 From: Active <56242467+doubleactii@users.noreply.github.com> Date: Tue, 28 Mar 2023 09:06:26 -0500 Subject: [PATCH] Update docs. --- docs/index.html | 139 ++++++++++++++++++++++++++++++++++++++++++++++-- docs/index.json | 2 +- 2 files changed, 137 insertions(+), 4 deletions(-) diff --git a/docs/index.html b/docs/index.html index eafb859..e82816e 100644 --- a/docs/index.html +++ b/docs/index.html @@ -35,9 +35,142 @@ -

EUtils

A small plugin full of useful things.

-

#INCLUDE SCRIPT eutils.min.js

-

🚧🚧 Docs coming soon 🚧🚧

+

EUtils

EUtils is a lightweight and versatile JavaScript utility class designed to provide commonly used functions for web development. It is a collection of various helper functions that can be used in a variety of projects.

+

Usage

To use EUtils in your project, simply import it as follows:

+
import { EUtils } from './eutils.min.mjs';
+
+

You can then call any of the functions available in the EUtils class.

+

API

decimalRand(pNum1, pNum2, pPlaces)

+
    +
  • Generates a random decimal number between pNum1 and pNum2 with pPlaces decimal places.
    • +
+

rand(pNum1, pNum2)

+
    +
  • Generates a random integer between pNum1 and pNum2.
    • +
+

getPercentage(pValue, pTotalValue)

+
    +
  • Calculates the percentage of pValue in relation to pTotalValue.
    • +
+

clamp(pNumber, pMin, pMax)

+
    +
  • Clamps pNumber between pMin and pMax.
    • +
+

lerp(pStart, pEnd, pAmount)

+
    +
  • Linearly interpolates between pStart and pEnd by pAmount.
    • +
+

flooredLerp(pStart, pEnd, pAmount)

+
    +
  • Linearly interpolates between pStart and pEnd by pAmount, then floors the result.
    • +
+

round(pNumber, pPlace)

+
    +
  • Rounds pNumber to pPlace decimal places.
    • +
+

normalize(pVal, pMin, pMax)

+
    +
  • Normalizes pVal between pMin and pMax.
    • +
+

within(pVal, pMin, pMax)

+
    +
  • Checks if pVal is within the range of pMin and pMax.
    • +
+

formatIntegerWithCommas(pNum)

+
    +
  • Formats pNum as a string with commas between every three digits.
    • +
+

degreesToRadians(pDegrees)

+
    +
  • Converts degrees to radians.
    • +
+

radiansToDegrees(pRadians)

+
    +
  • Converts radians to degrees.
    • +
+

pick(pArray)

+
    +
  • Returns a random element from pArray.
    • +
+

removeProperties(pObject, pExclude)

+
    +
  • Removes all properties from pObject, excluding those in pExclude.
    • +
+

prob(pChance)

+
    +
  • Returns true with a probability of pChance, and false with a probability of 100 - pChance.
    • +
+

getInverseDir(pDir)

+
    +
  • Returns the opposite direction of pDir.
    • +
+

getAngleFromDir(pDir)

+
    +
  • Returns the angle in radians corresponding to pDir.
    • +
+

generateID(pIDLength)

+
    +
  • Generates a random unique ID string of length pIDLength.
    • +
+

decimalToHex(pDecimal, pChars)

+
    +
  • Converts a decimal number to a hexadecimal color string with pChars characters. pChars can either be 3 or 6.
    • +
+

addIntensity(pColor, pPercent)

+
    +
  • Increases the intensity of pColor by pPercent percent.
    • +
+

rgbToHex(pR, pG, pB)

+
    +
  • Converts an RGB color to a hexadecimal color string.
    • +
+

hexToRgb(pHex)

+
    +
  • Converts a hexadecimal color string to an RGB color.
    • +
+

rgbToDecimal(pR, pG, pB)

+
    +
  • Converts an RGB color to a decimal number.
    • +
+

hexToDecimal(pHex)

+
    +
  • Converts a hexadecimal color string to a decimal number.
    • +
+

grabColor(pSwitch, pG, pB)

+
    +
  • Returns a color object with a hexadecimal color string, tagless hexadecimal color string, RGB string, RGB color array, RGB normalized array, RGB object, and decimal color number. If pSwitch is a number, pG and pB must also be numbers and represent the green and blue components of the color respectively. If pSwitch is a string, it can either be a hexadecimal color string or a decimal color.
    • +
+

getRandomColor()

+
    +
  • Gets a random color in the hex format.
    • +
+

getRandomColorBetween(pColor1, pColor2, pAmount = 0.5)

+
    +
  • Gets a random color between pColor1 and pColor2 in the decimal format. pAmount can be used to change how close the returned color is to either pColor1 or pColor2.
    • +
+

transitionColor(pInstance, pStartColor='#000', pEndColor='#fff', pDuration=1000, pIterativeCallback, pEndCallback)

+
    +
  • Transition pStartColor to pEndColor in pDuration time with callbacks to track the animation. Where pIterativeCallback is called each frame and pEndCallback is called at the end of the animation. This API returns the ID of the transition. So that if you want to cancel it, you can use cancelTransitionColor(ID).
    • +
+

cancelTransitionColor(pID)

+
    +
  • Cancels an ongoing transition with the ID of pID.
    • +
+

getPointRotated(pRect, pTheta, pPoint)v

+
    +
  • Calculates the position of a point after rotating it around a center point by a given angle.
    • +
  • @param {object} pRect - The rectangle object to rotate the point around. pRect.anchor.x and pRecent.anchor.y is used to control the "center" of the rectangle.
    • +
  • @param {number} pTheta - The angle (in radians) to rotate the point by.
    • +
  • @param {object} pPoint - The point object to rotate around the center of the rectangle.
    • +
  • @param {number} pPoint.x - The x-coordinate of the point to rotate.
    • +
  • @param {number} pPoint.y - The y-coordinate of the point to rotate.
    • +
  • @returns {object} An object with the rotated point's new x and y coordinates.
    • +
+

getPointsOfRotatedRect(pRect, pTheta)

+
    +
  • @param {object} pRect - The rectangle object to rotate the point around. pRect.anchor.x and pRecent.anchor.y is used to control the "center" of the rectangle.
    • +
  • @param {number} pTheta - The angle (in radians) to rotate the point by.
    • +
diff --git a/docs/index.json b/docs/index.json index b7da8a4..3623cff 100644 --- a/docs/index.json +++ b/docs/index.json @@ -2229,7 +2229,7 @@ }, { "kind": "index", - "content": "# EUtils\r\nA small plugin full of useful things.\r\n\r\n#INCLUDE SCRIPT eutils.min.js\r\n\r\n**🚧🚧 Docs coming soon 🚧🚧**\r\n", + "content": "# EUtils\r\n\r\nEUtils is a lightweight and versatile JavaScript utility class designed to provide commonly used functions for web development. It is a collection of various helper functions that can be used in a variety of projects.\r\n\r\n# Usage\r\nTo use EUtils in your project, simply import it as follows:\r\n\r\n```js\r\nimport { EUtils } from './eutils.min.mjs';\r\n```\r\n\r\nYou can then call any of the functions available in the EUtils class.\r\n\r\n# API\r\ndecimalRand(pNum1, pNum2, pPlaces)\r\n- Generates a random decimal number between **`pNum1`** and **`pNum2`** with **`pPlaces`** decimal places.\r\n\r\nrand(pNum1, pNum2)\r\n- Generates a random integer between **`pNum1`** and **`pNum2`**.\r\n\r\ngetPercentage(pValue, pTotalValue)\r\n- Calculates the percentage of **`pValue`** in relation to **`pTotalValue`**.\r\n\r\nclamp(pNumber, pMin, pMax)\r\n- Clamps **`pNumber`** between **`pMin`** and **`pMax`**.\r\n\r\nlerp(pStart, pEnd, pAmount)\r\n- Linearly interpolates between **`pStart`** and **`pEnd`** by **`pAmount`**.\r\n\r\nflooredLerp(pStart, pEnd, pAmount)\r\n- Linearly interpolates between **`pStart`** and **`pEnd`** by **`pAmount`**, then floors the result.\r\n\r\nround(pNumber, pPlace)\r\n- Rounds pNumber to **`pPlace`** decimal places.\r\n\r\nnormalize(pVal, pMin, pMax)\r\n- Normalizes pVal between **`pMin`** and **`pMax`**.\r\n\r\nwithin(pVal, pMin, pMax)\r\n- Checks if **`pVal`** is within the range of **`pMin`** and **`pMax`**.\r\n\r\nformatIntegerWithCommas(pNum)\r\n- Formats **`pNum`** as a string with commas between every three digits.\r\n\r\ndegreesToRadians(pDegrees)\r\n- Converts degrees to radians.\r\n\r\nradiansToDegrees(pRadians)\r\n- Converts radians to degrees.\r\n\r\npick(pArray)\r\n- Returns a random element from **`pArray`**.\r\n\r\nremoveProperties(pObject, pExclude)\r\n- Removes all properties from **`pObject`**, excluding those in **`pExclude`**.\r\n\r\nprob(pChance)\r\n- Returns true with a probability of **`pChance`**, and false with a probability of **`100 - pChance`**.\r\n\r\ngetInverseDir(pDir)\r\n- Returns the opposite direction of **`pDir`**.\r\n\r\ngetAngleFromDir(pDir)\r\n- Returns the angle in radians corresponding to **`pDir`**.\r\n\r\ngenerateID(pIDLength)\r\n- Generates a random unique ID string of length **`pIDLength`**.\r\n\r\ndecimalToHex(pDecimal, pChars)\r\n- Converts a decimal number to a hexadecimal color string with pChars characters. **`pChars`** can either be **`3`** or **`6`**.\r\n\r\naddIntensity(pColor, pPercent)\r\n- Increases the intensity of pColor by **`pPercent`** **`percent`**.\r\n\r\nrgbToHex(pR, pG, pB)\r\n- Converts an RGB color to a hexadecimal color string.\r\n\r\nhexToRgb(pHex)\r\n- Converts a hexadecimal color string to an RGB color.\r\n\r\nrgbToDecimal(pR, pG, pB)\r\n- Converts an RGB color to a decimal number.\r\n\r\nhexToDecimal(pHex)\r\n- Converts a hexadecimal color string to a decimal number.\r\n\r\ngrabColor(pSwitch, pG, pB)\r\n- Returns a color object with a hexadecimal color string, tagless hexadecimal color string, RGB string, RGB color array, RGB normalized array, RGB object, and decimal color number. If **`pSwitch`** is a number, **`pG`** and **`pB`** must also be numbers and represent the green and blue components of the color respectively. If **`pSwitch`** is a string, it can either be a hexadecimal color string or a decimal color.\r\n\r\ngetRandomColor()\r\n- Gets a random color in the hex format.\r\n\r\ngetRandomColorBetween(pColor1, pColor2, pAmount = 0.5)\r\n- Gets a random color between **`pColor1`** and **`pColor2`** in the decimal format. **`pAmount`** can be used to change how close the returned color is to either **`pColor1`** or **`pColor2`**.\r\n\r\ntransitionColor(pInstance, pStartColor='#000', pEndColor='#fff', pDuration=1000, pIterativeCallback, pEndCallback)\r\n- Transition **`pStartColor`** to **`pEndColor`** in **`pDuration`** time with callbacks to track the animation. Where **`pIterativeCallback`** is called each frame and **`pEndCallback`** is called at the end of the animation. This API returns the **`ID`** of the transition. So that if you want to cancel it, you can use **`cancelTransitionColor(ID)`**.\r\n\r\ncancelTransitionColor(pID)\r\n- Cancels an ongoing transition with the **`ID`** of **`pID`**.\r\n\r\ngetPointRotated(pRect, pTheta, pPoint)v\r\n- Calculates the position of a point after rotating it around a center point by a given angle.\r\n- @param {object} pRect - The rectangle object to rotate the point around. pRect.anchor.x and pRecent.anchor.y is used to control the \"center\" of the rectangle.\r\n- @param {number} pTheta - The angle (in radians) to rotate the point by.\r\n- @param {object} pPoint - The point object to rotate around the center of the rectangle.\r\n- @param {number} pPoint.x - The x-coordinate of the point to rotate.\r\n- @param {number} pPoint.y - The y-coordinate of the point to rotate.\r\n- @returns {object} An object with the rotated point's new x and y coordinates.\r\n\r\ngetPointsOfRotatedRect(pRect, pTheta)\r\n- @param {object} pRect - The rectangle object to rotate the point around. **`pRect.anchor.x`** and **`pRecent.anchor.y`** is used to control the \"center\" of the rectangle.\r\n- @param {number} pTheta - The angle (in radians) to rotate the point by.", "longname": "Z:\\Business\\Evitca Studio\\Github\\EUtils\\README.md", "name": "./README.md", "static": true,