@quenty/humanoidutils 2.0.0 → 2.0.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.
- package/CHANGELOG.md +8 -0
- package/LICENSE.md +1 -1
- package/README.md +6 -14
- package/package.json +2 -2
- package/src/Shared/HumanoidUtils.lua +15 -7
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,14 @@
|
|
|
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
|
+
## [2.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/humanoidutils@2.0.0...@quenty/humanoidutils@2.0.1) (2021-12-30)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @quenty/humanoidutils
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
# [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/humanoidutils@1.2.0...@quenty/humanoidutils@2.0.0) (2021-09-05)
|
|
7
15
|
|
|
8
16
|
|
package/LICENSE.md
CHANGED
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
## HumanoidUtils
|
|
2
2
|
<div align="center">
|
|
3
|
-
<a href="http://quenty.github.io/
|
|
4
|
-
<img src="https://
|
|
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/
|
|
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,17 +13,9 @@
|
|
|
13
13
|
|
|
14
14
|
General humanoid utility code.
|
|
15
15
|
|
|
16
|
+
<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/HumanoidUtils">View docs →</a></div>
|
|
17
|
+
|
|
16
18
|
## Installation
|
|
17
19
|
```
|
|
18
20
|
npm install @quenty/humanoidutils --save
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Usage
|
|
22
|
-
Usage is designed to be simple.
|
|
23
|
-
|
|
24
|
-
### `HumanoidUtils.getHumanoid(descendant)`
|
|
25
|
-
Retrieves a humanoid from a descendant (Players only).
|
|
26
|
-
|
|
27
|
-
### `HumanoidUtils.forceUnseatHumanoid(humanoid)`
|
|
28
|
-
Forcefully unseats the humanoid. Useful when teleporting humanoid
|
|
29
|
-
|
|
21
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quenty/humanoidutils",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "General humanoid utility code.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Roblox",
|
|
@@ -27,5 +27,5 @@
|
|
|
27
27
|
"publishConfig": {
|
|
28
28
|
"access": "public"
|
|
29
29
|
},
|
|
30
|
-
"gitHead": "
|
|
30
|
+
"gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
|
|
31
31
|
}
|
|
@@ -1,12 +1,15 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
--[=[
|
|
2
|
+
General humanoid utility code.
|
|
3
|
+
@class HumanoidUtils
|
|
4
|
+
]=]
|
|
4
5
|
|
|
5
6
|
local HumanoidUtils = {}
|
|
6
7
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
--
|
|
8
|
+
--[=[
|
|
9
|
+
Retrieves a humanoid from a descendant.
|
|
10
|
+
@param descendant Instance -- Child of a humanoid model, like a limb
|
|
11
|
+
@return Humanoid?
|
|
12
|
+
]=]
|
|
10
13
|
function HumanoidUtils.getHumanoid(descendant)
|
|
11
14
|
local character = descendant
|
|
12
15
|
while character do
|
|
@@ -20,7 +23,12 @@ function HumanoidUtils.getHumanoid(descendant)
|
|
|
20
23
|
return nil
|
|
21
24
|
end
|
|
22
25
|
|
|
23
|
-
|
|
26
|
+
--[=[
|
|
27
|
+
Forcefully unseats the humanoid. Useful when teleporting humanoid.
|
|
28
|
+
Definitely a non-intuitive operation to do safely.
|
|
29
|
+
|
|
30
|
+
@param humanoid Humanoid
|
|
31
|
+
]=]
|
|
24
32
|
function HumanoidUtils.forceUnseatHumanoid(humanoid)
|
|
25
33
|
if humanoid.SeatPart then
|
|
26
34
|
local weld = humanoid.SeatPart:FindFirstChild("SeatWeld")
|