@quenty/badgeutils 3.3.0 → 3.4.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 +16 -0
- package/README.md +5 -9
- package/package.json +4 -4
- package/src/Server/BadgeUtils.lua +11 -3
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.4.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/badgeutils@3.3.1...@quenty/badgeutils@3.4.0-canary.241.a4e8214.0) (2022-01-03)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @quenty/badgeutils
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/badgeutils@3.3.0...@quenty/badgeutils@3.3.1) (2021-12-30)
|
|
15
|
+
|
|
16
|
+
**Note:** Version bump only for package @quenty/badgeutils
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
6
22
|
# [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/badgeutils@3.2.0...@quenty/badgeutils@3.3.0) (2021-12-18)
|
|
7
23
|
|
|
8
24
|
**Note:** Version bump only for package @quenty/badgeutils
|
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
## BadgeUtils
|
|
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,13 +13,9 @@
|
|
|
13
13
|
|
|
14
14
|
Utility functions involving badges on Roblox
|
|
15
15
|
|
|
16
|
+
<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/BadgeUtils">View docs →</a></div>
|
|
17
|
+
|
|
16
18
|
## Installation
|
|
17
19
|
```
|
|
18
20
|
npm install @quenty/badgeutils --save
|
|
19
21
|
```
|
|
20
|
-
|
|
21
|
-
## Usage
|
|
22
|
-
Usage is designed to be simple.
|
|
23
|
-
|
|
24
|
-
### `BadgeUtils.promiseAwardBadge(player, badgeId)`
|
|
25
|
-
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quenty/badgeutils",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.4.0-canary.241.a4e8214.0",
|
|
4
4
|
"description": "Utility functions involving badges on Roblox",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Roblox",
|
|
@@ -25,11 +25,11 @@
|
|
|
25
25
|
"Quenty"
|
|
26
26
|
],
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@quenty/loader": "
|
|
29
|
-
"@quenty/promise": "
|
|
28
|
+
"@quenty/loader": "3.2.0-canary.241.a4e8214.0",
|
|
29
|
+
"@quenty/promise": "3.4.0-canary.241.a4e8214.0"
|
|
30
30
|
},
|
|
31
31
|
"publishConfig": {
|
|
32
32
|
"access": "public"
|
|
33
33
|
},
|
|
34
|
-
"gitHead": "
|
|
34
|
+
"gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
|
|
35
35
|
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
--[=[
|
|
2
|
+
Utility functions involving badges on Roblox
|
|
3
|
+
@class BadgeUtils
|
|
4
|
+
]=]
|
|
4
5
|
|
|
5
6
|
local BadgeService = game:GetService("BadgeService")
|
|
6
7
|
|
|
@@ -10,6 +11,13 @@ local Promise = require("Promise")
|
|
|
10
11
|
|
|
11
12
|
local BadgeUtils = {}
|
|
12
13
|
|
|
14
|
+
--[=[
|
|
15
|
+
Tries to reward a player to a badge inside of a promise.
|
|
16
|
+
|
|
17
|
+
@param player Player
|
|
18
|
+
@param badgeId number
|
|
19
|
+
@return Promise
|
|
20
|
+
]=]
|
|
13
21
|
function BadgeUtils.promiseAwardBadge(player, badgeId)
|
|
14
22
|
assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
|
|
15
23
|
assert(type(badgeId) == "number", "Bad badgeId")
|