@quenty/pathfindingutils 3.4.0 → 3.5.0-canary.241.a4e8214.0

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,22 @@
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
+ # [3.5.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/pathfindingutils@3.4.1...@quenty/pathfindingutils@3.5.0-canary.241.a4e8214.0) (2022-01-03)
7
+
8
+ **Note:** Version bump only for package @quenty/pathfindingutils
9
+
10
+
11
+
12
+
13
+
14
+ ## [3.4.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/pathfindingutils@3.4.0...@quenty/pathfindingutils@3.4.1) (2021-12-30)
15
+
16
+ **Note:** Version bump only for package @quenty/pathfindingutils
17
+
18
+
19
+
20
+
21
+
6
22
  # [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/pathfindingutils@3.3.0...@quenty/pathfindingutils@3.4.0) (2021-12-18)
7
23
 
8
24
  **Note:** Version bump only for package @quenty/pathfindingutils
package/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  ## PathfindingUtils
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,6 +13,8 @@
13
13
 
14
14
  Utilities involving pathfinding in Roblox
15
15
 
16
+ <div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/PathfindingUtils">View docs →</a></div>
17
+
16
18
  ## Installation
17
19
  ```
18
20
  npm install @quenty/pathfindingutils --save
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/pathfindingutils",
3
- "version": "3.4.0",
3
+ "version": "3.5.0-canary.241.a4e8214.0",
4
4
  "description": "Utilities involving pathfinding in Roblox",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -26,13 +26,13 @@
26
26
  "Quenty"
27
27
  ],
28
28
  "dependencies": {
29
- "@quenty/draw": "^2.2.0",
30
- "@quenty/loader": "^3.1.1",
31
- "@quenty/maid": "^2.0.1",
32
- "@quenty/promise": "^3.3.0"
29
+ "@quenty/draw": "2.2.1",
30
+ "@quenty/loader": "3.2.0-canary.241.a4e8214.0",
31
+ "@quenty/maid": "2.0.2",
32
+ "@quenty/promise": "3.4.0-canary.241.a4e8214.0"
33
33
  },
34
34
  "publishConfig": {
35
35
  "access": "public"
36
36
  },
37
- "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
37
+ "gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
38
38
  }
@@ -1,5 +1,7 @@
1
- --- Utilities involving pathfinding in Roblox
2
- -- @module PathfindingUtils
1
+ --[=[
2
+ Utilities involving pathfinding in Roblox
3
+ @class PathfindingUtils
4
+ ]=]
3
5
 
4
6
  local require = require(script.Parent.loader).load(script)
5
7
 
@@ -9,6 +11,14 @@ local Maid = require("Maid")
9
11
 
10
12
  local PathfindingUtils = {}
11
13
 
14
+ --[=[
15
+ Computes a path wrapped in a promise.
16
+
17
+ @param path Path
18
+ @param start Vector3
19
+ @param finish Vector3
20
+ @return Promise<Path>
21
+ ]=]
12
22
  function PathfindingUtils.promiseComputeAsync(path, start, finish)
13
23
  assert(path, "Bad path")
14
24
  assert(start, "Bad start")
@@ -20,13 +30,26 @@ function PathfindingUtils.promiseComputeAsync(path, start, finish)
20
30
  end)
21
31
  end
22
32
 
33
+ --[=[
34
+ Checks occlusion wrapped in a promise
35
+
36
+ @param path Path
37
+ @param startIndex number
38
+ @return Promise<number>
39
+ ]=]
23
40
  function PathfindingUtils.promiseCheckOcclusion(path, startIndex)
24
41
  return Promise.spawn(function(resolve, _)
25
42
  resolve(path:CheckOcclusionAsync(startIndex))
26
43
  end)
27
-
28
44
  end
29
45
 
46
+ --[=[
47
+ Visualizes the current waypoints in the path. Will put the visualization in
48
+ Draw libraries default parent.
49
+
50
+ @param path Path
51
+ @return MaidTask
52
+ ]=]
30
53
  function PathfindingUtils.visualizePath(path)
31
54
  local maid = Maid.new()
32
55