@quenty/coreguiutils 3.2.1-canary.8533eea.0 → 3.3.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 +5 -3
- package/package.json +4 -4
- package/src/Client/CoreGuiUtils.lua +20 -3
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.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/coreguiutils@3.3.0...@quenty/coreguiutils@3.3.1) (2021-12-30)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @quenty/coreguiutils
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/coreguiutils@3.2.0...@quenty/coreguiutils@3.3.0) (2021-12-18)
|
|
7
15
|
|
|
8
16
|
**Note:** Version bump only for package @quenty/coreguiutils
|
|
9
17
|
|
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
## CoreGuiUtils
|
|
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,6 +13,8 @@
|
|
|
13
13
|
|
|
14
14
|
Utility functions to work with the CoreGui
|
|
15
15
|
|
|
16
|
+
<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/CoreGuiUtils">View docs →</a></div>
|
|
17
|
+
|
|
16
18
|
## Installation
|
|
17
19
|
```
|
|
18
20
|
npm install @quenty/coreguiutils --save
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quenty/coreguiutils",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.3.1",
|
|
4
4
|
"description": "Utility functions to work with the CoreGui",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Roblox",
|
|
@@ -25,11 +25,11 @@
|
|
|
25
25
|
"Quenty"
|
|
26
26
|
],
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@quenty/loader": "3.1.
|
|
29
|
-
"@quenty/promise": "3.
|
|
28
|
+
"@quenty/loader": "^3.1.2",
|
|
29
|
+
"@quenty/promise": "^3.3.1"
|
|
30
30
|
},
|
|
31
31
|
"publishConfig": {
|
|
32
32
|
"access": "public"
|
|
33
33
|
},
|
|
34
|
-
"gitHead": "
|
|
34
|
+
"gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
|
|
35
35
|
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
--[=[
|
|
2
|
+
Utility functions to work with the CoreGui
|
|
3
|
+
@class CoreGuiUtils
|
|
4
|
+
]=]
|
|
4
5
|
|
|
5
6
|
local require = require(script.Parent.loader).load(script)
|
|
6
7
|
|
|
@@ -10,6 +11,15 @@ local Promise = require("Promise")
|
|
|
10
11
|
|
|
11
12
|
local CoreGuiUtils = {}
|
|
12
13
|
|
|
14
|
+
--[=[
|
|
15
|
+
Retries setting the the core. This is required because sometimes the Core
|
|
16
|
+
scripts are not initialized by the time that client code executes.
|
|
17
|
+
|
|
18
|
+
@param tries number
|
|
19
|
+
@param initialWaitTime number
|
|
20
|
+
@param ... any -- parameters to set core with
|
|
21
|
+
@return Promise<()>
|
|
22
|
+
]=]
|
|
13
23
|
function CoreGuiUtils.promiseRetrySetCore(tries, initialWaitTime, ...)
|
|
14
24
|
assert(type(tries) == "number", "Bad tries")
|
|
15
25
|
assert(type(initialWaitTime) == "number", "Bad initialWaitTime")
|
|
@@ -38,6 +48,13 @@ function CoreGuiUtils.promiseRetrySetCore(tries, initialWaitTime, ...)
|
|
|
38
48
|
end)
|
|
39
49
|
end
|
|
40
50
|
|
|
51
|
+
--[=[
|
|
52
|
+
Tries to invoke `StarterGui:SetCore` with the arguments specified
|
|
53
|
+
|
|
54
|
+
@param ... any -- Args to try to call SetCore with
|
|
55
|
+
@return boolean -- false if failed
|
|
56
|
+
@return string? -- error, if there was one
|
|
57
|
+
]=]
|
|
41
58
|
function CoreGuiUtils.tryToSetCore(...)
|
|
42
59
|
local args = {...}
|
|
43
60
|
local n = select("#", ...)
|