@quenty/collectionserviceutils 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 -12
- package/package.json +2 -2
- package/src/Shared/CollectionServiceUtils.lua +14 -2
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/collectionserviceutils@2.0.0...@quenty/collectionserviceutils@2.0.1) (2021-12-30)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @quenty/collectionserviceutils
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
6
14
|
# [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/collectionserviceutils@1.2.0...@quenty/collectionserviceutils@2.0.0) (2021-09-05)
|
|
7
15
|
|
|
8
16
|
|
package/LICENSE.md
CHANGED
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
## CollectionServiceUtils
|
|
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,15 +13,9 @@
|
|
|
13
13
|
|
|
14
14
|
Utility functions for use with collection service tags
|
|
15
15
|
|
|
16
|
+
<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/CollectionServiceUtils">View docs →</a></div>
|
|
17
|
+
|
|
16
18
|
## Installation
|
|
17
19
|
```
|
|
18
20
|
npm install @quenty/collectionserviceutils --save
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Usage
|
|
22
|
-
Usage is designed to be simple.
|
|
23
|
-
|
|
24
|
-
### `CollectionServiceUtils.findFirstAncestor(tagName, child)`
|
|
25
|
-
|
|
26
|
-
### `CollectionServiceUtils.removeAllTags(instance)`
|
|
27
|
-
|
|
21
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quenty/collectionserviceutils",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "Utility functions for use with collection service tags",
|
|
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,10 +1,18 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
--[=[
|
|
2
|
+
Utility functions for use with collection service tags
|
|
3
|
+
@class CollectionServiceUtils
|
|
4
|
+
]=]
|
|
3
5
|
|
|
4
6
|
local CollectionService = game:GetService("CollectionService")
|
|
5
7
|
|
|
6
8
|
local CollectionServiceUtils = {}
|
|
7
9
|
|
|
10
|
+
--[=[
|
|
11
|
+
Finds the first ancestor with the given tagName.
|
|
12
|
+
@param tagName string
|
|
13
|
+
@param child Instance
|
|
14
|
+
@return Instance?
|
|
15
|
+
]=]
|
|
8
16
|
function CollectionServiceUtils.findFirstAncestor(tagName, child)
|
|
9
17
|
assert(type(tagName) == "string", "Bad tagName")
|
|
10
18
|
assert(typeof(child) == "Instance", "Bad child")
|
|
@@ -19,6 +27,10 @@ function CollectionServiceUtils.findFirstAncestor(tagName, child)
|
|
|
19
27
|
return nil
|
|
20
28
|
end
|
|
21
29
|
|
|
30
|
+
--[=[
|
|
31
|
+
Removes all tags from an instance.
|
|
32
|
+
@param instance Instance
|
|
33
|
+
]=]
|
|
22
34
|
function CollectionServiceUtils.removeAllTags(instance)
|
|
23
35
|
assert(typeof(instance) == "Instance", "Bad instance")
|
|
24
36
|
|