@quenty/getgroundplane 3.1.1 → 3.2.0-canary.241.a4e8214.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.2.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/getgroundplane@3.1.2...@quenty/getgroundplane@3.2.0-canary.241.a4e8214.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/getgroundplane
+
+
+
+
+
+## [3.1.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/getgroundplane@3.1.1...@quenty/getgroundplane@3.1.2) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/getgroundplane
+
+
+
+
+
 ## [3.1.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/getgroundplane@3.1.0...@quenty/getgroundplane@3.1.1) (2021-10-30)
 
 **Note:** Version bump only for package @quenty/getgroundplane

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 @@
 ## getGroundPlane
 <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,6 +13,8 @@
 
 Function that uses raycasting to determine the groundplane in Roblox
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/getGroundPlane">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/getgroundplane --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/getgroundplane",
-  "version": "3.1.1",
+  "version": "3.2.0-canary.241.a4e8214.0",
   "description": "Function that uses raycasting to determine the groundplane in Roblox",
   "keywords": [
     "Roblox",
@@ -25,7 +25,7 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.1.1"
+    "@quenty/loader": "3.2.0-canary.241.a4e8214.0"
   },
   "devDependencies": {
     "@quenty/loader": "file:../loader"
@@ -33,5 +33,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e9cd4223c7fda7c852db9743ef844baa19cacb13"
+  "gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
 }

package/src/Shared/batchRaycast.lua

@@ -1,5 +1,8 @@
---- Batch raycast utility function
--- @function batchRaycast
+--[=[
+	Batch raycast utility function
+	@private
+	@class batchRaycast
+]=]
 
 local function batchRaycast(
 	originList, directionList,

package/src/Shared/getGroundPlane.lua

@@ -1,5 +1,7 @@
---- Function that uses raycasting to determine the groundplane in Roblox
--- @function getGroundPlane
+--[=[
+	Function that uses raycasting to determine the groundplane in Roblox.
+	@class getGroundPlane
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -69,8 +71,26 @@ end
 
 local goldenAngle = (3 - 5^0.5)*math.pi
 
--- uses -y as the direction
--- ignoreFunc REALLY SHOULD NOT YIELD
+--[=[
+	Uses -y as the direction
+
+	Searchs for a groundPlane given a basis. Useful for planting a object
+	in 3D space on terrain.
+
+	:::warning
+	ignoreFunc REALLY SHOULD NOT YIELD
+	:::
+
+	@function getGroundPlane
+	@param basis Vector3
+	@param radius number
+	@param length number
+	@param sampleCount number
+	@param ignoreFunc (Instance) -> boolean
+	@return Vector3 -- position
+	@return Vector3 -- normal
+	@within getGroundPlane
+]=]
 local function getGroundPlane(
 	basis, radius, length, sampleCount,
 	ignoreList, ignoreFunc