@quenty/humanoidteleportutils 3.1.2-canary.c50dead.0 → 3.2.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.
Files changed (5) hide show
  1. package/CHANGELOG.md +10 -2
  2. package/LICENSE.md +1 -1
  3. package/README.md +6 -12
  4. package/package.json +4 -4
  5. package/src/Shared/HumanoidTeleportUtils.lua +27 -3
package/CHANGELOG.md CHANGED
@@ -3,12 +3,20 @@
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.1.2-canary.c50dead.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/humanoidteleportutils@3.1.1...@quenty/humanoidteleportutils@3.1.2-canary.c50dead.0) (2021-11-20)
6
+ ## [3.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/humanoidteleportutils@3.2.0...@quenty/humanoidteleportutils@3.2.1) (2021-12-30)
7
+
8
+ **Note:** Version bump only for package @quenty/humanoidteleportutils
9
+
10
+
11
+
12
+
13
+
14
+ # [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/humanoidteleportutils@3.1.1...@quenty/humanoidteleportutils@3.2.0) (2021-11-20)
7
15
 
8
16
 
9
17
  ### Bug Fixes
10
18
 
11
- * Support MacOS syncing ([c50dead](https://github.com/Quenty/NevermoreEngine/commit/c50deadbe5ebe479aded04e1619441a08ff0e9a8))
19
+ * Support MacOS syncing ([#225](https://github.com/Quenty/NevermoreEngine/issues/225)) ([03f9183](https://github.com/Quenty/NevermoreEngine/commit/03f918392c6a5bdd33f8a17c38de371d1e06c67a))
12
20
 
13
21
 
14
22
 
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
  ## HumanoidTeleportUtils
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,15 +13,9 @@
13
13
 
14
14
  Utility for teleporting humanoids
15
15
 
16
+ <div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/HumanoidTeleportUtils">View docs →</a></div>
17
+
16
18
  ## Installation
17
19
  ```
18
20
  npm install @quenty/humanoidteleportutils --save
19
- ```
20
-
21
- ## Usage
22
- Usage is designed to be simple.
23
-
24
- ### `HumanoidTeleportUtils.identifySafePosition(position, raycaster)`
25
-
26
- ### `HumanoidTeleportUtils.teleportRootPart(humanoid, rootPart, position)`
27
-
21
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/humanoidteleportutils",
3
- "version": "3.1.2-canary.c50dead.0",
3
+ "version": "3.2.1",
4
4
  "description": "Utility for teleporting humanoids",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -25,11 +25,11 @@
25
25
  "Quenty"
26
26
  ],
27
27
  "dependencies": {
28
- "@quenty/loader": "3.1.1",
29
- "@quenty/raycaster": "2.1.0"
28
+ "@quenty/loader": "^3.1.2",
29
+ "@quenty/raycaster": "^2.1.1"
30
30
  },
31
31
  "publishConfig": {
32
32
  "access": "public"
33
33
  },
34
- "gitHead": "c50deadbe5ebe479aded04e1619441a08ff0e9a8"
34
+ "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
35
35
  }
package/src/Shared/HumanoidTeleportUtils.lua CHANGED
@@ -1,5 +1,7 @@
1
- --- Utility for teleporting humanoids
2
- -- @module HumanoidTeleportUtils
1
+ --[=[
2
+ Utility for teleporting humanoids
3
+ @class HumanoidTeleportUtils
4
+ ]=]
3
5
 
4
6
  local require = require(script.Parent.loader).load(script)
5
7
 
@@ -10,7 +12,15 @@ local HumanoidTeleportUtils = {}
10
12
  local REQUIRED_SPACE = 7
11
13
  local SEARCH_UP_TO = 40
12
14
 
13
- -- @param[opt=nil] raycaster Optional raycaster
15
+ --[=[
16
+ Finds a safe position to teleport a humanoid. This searches some amount
17
+ around the position to try to ensure a free space for the humanoid.
18
+
19
+ @param position Position
20
+ @param raycaster Raycaster? -- Optional raycaster
21
+ @return boolean -- True if safe
22
+ @return Vector3? -- Position if we can hit it
23
+ ]=]
14
24
  function HumanoidTeleportUtils.identifySafePosition(position, raycaster)
15
25
  assert(typeof(position) == "Vector3", "Bad position")
16
26
 
@@ -42,6 +52,20 @@ function HumanoidTeleportUtils.identifySafePosition(position, raycaster)
42
52
  return false, position + Vector3.new(0, SEARCH_UP_TO, 0)
43
53
  end
44
54
 
55
+ --[=[
56
+ Teleports a humanoid to a given location.
57
+
58
+ :::info
59
+ You should call this on the machine that has network ownership. For characters
60
+ owned by a player, this is generally the player who's character it is.
61
+
62
+ For NPCs, this should generally be the server.
63
+ :::
64
+
65
+ @param humanoid Humanoid
66
+ @param rootPart BasePart
67
+ @param position Vector3
68
+ ]=]
45
69
  function HumanoidTeleportUtils.teleportRootPart(humanoid, rootPart, position)
46
70
  -- Calculate additional offset for teleportation
47
71
  local offset = rootPart.Size.Y/2 + humanoid.HipHeight