@quenty/getpercentexposedutils 3.1.2-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.2-canary.c50dead.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/getpercentexposedutils@3.1.1...@quenty/getpercentexposedutils@3.1.2-canary.c50dead.0) (2021-11-20)
+## [3.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/getpercentexposedutils@3.2.0...@quenty/getpercentexposedutils@3.2.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/getpercentexposedutils
+
+
+
+
+
+# [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/getpercentexposedutils@3.1.1...@quenty/getpercentexposedutils@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 @@
 ## GetPercentExposedUtils
 <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,14 +13,9 @@
 
 Identify parts that are potentially exposed to an explosion using a random vector raycasting
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/GetPercentExposedUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/getpercentexposedutils --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-### `GetPercentExposed.search(point, radius, raycaster)`
-Searches for percent exposure of all parts given
-
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/getpercentexposedutils",
-  "version": "3.1.2-canary.c50dead.0",
+  "version": "3.2.1",
   "description": "Identify parts that are potentially exposed to an explosion using a random vector raycasting",
   "keywords": [
     "Roblox",
@@ -26,11 +26,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "3.1.1",
-    "@quenty/vector3utils": "3.1.2-canary.c50dead.0"
+    "@quenty/loader": "^3.1.2",
+    "@quenty/vector3utils": "^3.2.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c50deadbe5ebe479aded04e1619441a08ff0e9a8"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/GetPercentExposedUtils.lua

@@ -1,5 +1,7 @@
---- Identify parts that are potentially exposed to an explosion using a random vector raycasting
--- @module GetPercentExposed
+--[=[
+	Identify parts that are potentially exposed to an explosion using a random vector raycasting
+	@class GetPercentExposedUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -7,18 +9,29 @@ local Workspace = game:GetService("Workspace")
 
 local RandomVector3Utils = require("RandomVector3Utils")
 
-local GetPercentExposed = {}
-GetPercentExposed.RAY_COUNT = 314
-
---- Searches for percent exposure of all parts given
--- @tparam Vector3 point point to search
--- @tparam number Radius
--- @return A table mapping parts to to percent exposure
-function GetPercentExposed.search(point, radius, raycaster)
+local GetPercentExposedUtils = {}
+
+--[=[
+	Number of rays to use when searching
+	@readonly
+	@prop RAY_COUNT number
+	@within GetPercentExposedUtils
+]=]
+GetPercentExposedUtils.RAY_COUNT = 314
+
+--[=[
+	Searches for percent exposure of all parts given.
+
+	@param point Vector3 -- Point to search
+	@param radius number
+	@param raycaster Raycaster?
+	@return { [BasePart]: number } -- A table mapping parts to to percent exposure
+]=]
+function GetPercentExposedUtils.search(point, radius, raycaster)
 	local hits = {}
 	local totalHits = 0
 
-	for _=1, GetPercentExposed.RAY_COUNT do
+	for _=1, GetPercentExposedUtils.RAY_COUNT do
 		local ray = Ray.new(point, RandomVector3Utils.getRandomUnitVector() * radius)
 		if raycaster then
 			local hitData = raycaster:FindPartOnRay(ray)
@@ -40,11 +53,10 @@ function GetPercentExposed.search(point, radius, raycaster)
 	end
 
 	for part, count in pairs(hits) do
-		hits[part] = count / GetPercentExposed.RAY_COUNT
+		hits[part] = count / GetPercentExposedUtils.RAY_COUNT
 	end
 
 	return hits
 end
 
-
-return GetPercentExposed
+return GetPercentExposedUtils