@quenty/equippedtracker 3.4.1-canary.8533eea.0 → 3.5.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 +9 -1
- package/README.md +6 -17
- package/package.json +6 -6
- package/src/Shared/EquippedTracker.lua +18 -4
package/CHANGELOG.md
CHANGED
|
@@ -3,7 +3,15 @@
|
|
|
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.
|
|
6
|
+
## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/equippedtracker@3.5.0...@quenty/equippedtracker@3.5.1) (2021-12-30)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @quenty/equippedtracker
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/equippedtracker@3.4.0...@quenty/equippedtracker@3.5.0) (2021-12-18)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @quenty/equippedtracker
|
|
9
17
|
|
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
## EquippedTracker
|
|
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,20 +13,9 @@
|
|
|
13
13
|
|
|
14
14
|
Tracks the equipped player of a tool
|
|
15
15
|
|
|
16
|
+
<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/EquippedTracker">View docs →</a></div>
|
|
17
|
+
|
|
16
18
|
## Installation
|
|
17
19
|
```
|
|
18
20
|
npm install @quenty/equippedtracker --save
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Usage
|
|
22
|
-
Usage is designed to be simple.
|
|
23
|
-
|
|
24
|
-
### `EquippedTracker.new(tool)`
|
|
25
|
-
|
|
26
|
-
### `EquippedTracker:Destroy()`
|
|
27
|
-
|
|
28
|
-
### `EquippedTracker.Player.Changed`
|
|
29
|
-
Signal that fires when the player changes
|
|
30
|
-
|
|
31
|
-
### `EquippedTracker.Player.Value`
|
|
32
|
-
Current equipped player value
|
|
21
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quenty/equippedtracker",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.5.1",
|
|
4
4
|
"description": "Tracks the equipped player of a tool",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Roblox",
|
|
@@ -26,13 +26,13 @@
|
|
|
26
26
|
"Quenty"
|
|
27
27
|
],
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@quenty/characterutils": "3.
|
|
30
|
-
"@quenty/loader": "3.1.
|
|
31
|
-
"@quenty/maid": "2.0.
|
|
32
|
-
"@quenty/valueobject": "3.
|
|
29
|
+
"@quenty/characterutils": "^3.3.1",
|
|
30
|
+
"@quenty/loader": "^3.1.2",
|
|
31
|
+
"@quenty/maid": "^2.0.2",
|
|
32
|
+
"@quenty/valueobject": "^3.5.1"
|
|
33
33
|
},
|
|
34
34
|
"publishConfig": {
|
|
35
35
|
"access": "public"
|
|
36
36
|
},
|
|
37
|
-
"gitHead": "
|
|
37
|
+
"gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
|
|
38
38
|
}
|
|
@@ -1,16 +1,23 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
--[=[
|
|
2
|
+
Tracks the equipped player of a tool
|
|
3
|
+
@class EquippedTracker
|
|
4
|
+
]=]
|
|
3
5
|
|
|
4
6
|
local require = require(script.Parent.loader).load(script)
|
|
5
7
|
|
|
6
|
-
local Maid = require("Maid")
|
|
7
8
|
local CharacterUtils = require("CharacterUtils")
|
|
9
|
+
local Maid = require("Maid")
|
|
8
10
|
local ValueObject = require("ValueObject")
|
|
9
11
|
|
|
10
12
|
local EquippedTracker = {}
|
|
11
13
|
EquippedTracker.ClassName = "EquippedTracker"
|
|
12
14
|
EquippedTracker.__index = EquippedTracker
|
|
13
15
|
|
|
16
|
+
--[=[
|
|
17
|
+
Tracks the state of a tool being equipped
|
|
18
|
+
@param tool Tool
|
|
19
|
+
@return EquippedTracker
|
|
20
|
+
]=]
|
|
14
21
|
function EquippedTracker.new(tool)
|
|
15
22
|
local self = setmetatable({}, EquippedTracker)
|
|
16
23
|
|
|
@@ -19,7 +26,11 @@ function EquippedTracker.new(tool)
|
|
|
19
26
|
|
|
20
27
|
self._maid = Maid.new()
|
|
21
28
|
|
|
22
|
-
|
|
29
|
+
--[=[
|
|
30
|
+
Tracks current equipped player who has an alive humanoid
|
|
31
|
+
@prop Player ValueObject<Player>
|
|
32
|
+
@within EquippedTracker
|
|
33
|
+
]=]
|
|
23
34
|
self.Player = ValueObject.new()
|
|
24
35
|
self._maid:GiveTask(self.Player)
|
|
25
36
|
|
|
@@ -55,6 +66,9 @@ function EquippedTracker:_update()
|
|
|
55
66
|
end)
|
|
56
67
|
end
|
|
57
68
|
|
|
69
|
+
--[=[
|
|
70
|
+
Cleans up the EquippedTracker
|
|
71
|
+
]=]
|
|
58
72
|
function EquippedTracker:Destroy()
|
|
59
73
|
self._maid:DoCleaning()
|
|
60
74
|
setmetatable(self, nil)
|