@quenty/genericscreenguiprovider 13.20.0 → 13.20.1-canary.545.2374fb2.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 +11 -0
- package/package.json +10 -10
- package/src/Client/GenericScreenGuiProvider.lua +27 -32
- package/src/Client/ScreenGuiService.lua +5 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,17 @@
|
|
|
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
|
+
## [13.20.1-canary.545.2374fb2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/genericscreenguiprovider@13.20.0...@quenty/genericscreenguiprovider@13.20.1-canary.545.2374fb2.0) (2025-04-05)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
# [13.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/genericscreenguiprovider@13.19.2...@quenty/genericscreenguiprovider@13.20.0) (2025-04-02)
|
|
7
18
|
|
|
8
19
|
**Note:** Version bump only for package @quenty/genericscreenguiprovider
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quenty/genericscreenguiprovider",
|
|
3
|
-
"version": "13.20.0",
|
|
3
|
+
"version": "13.20.1-canary.545.2374fb2.0",
|
|
4
4
|
"description": "Providers screenGuis with a given display order for easy use",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"Roblox",
|
|
@@ -24,17 +24,17 @@
|
|
|
24
24
|
"Quenty"
|
|
25
25
|
],
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@quenty/blend": "
|
|
28
|
-
"@quenty/loader": "
|
|
29
|
-
"@quenty/maid": "
|
|
30
|
-
"@quenty/rx": "
|
|
31
|
-
"@quenty/servicebag": "
|
|
32
|
-
"@quenty/string": "
|
|
33
|
-
"@quenty/uiobjectutils": "
|
|
34
|
-
"@quenty/valueobject": "
|
|
27
|
+
"@quenty/blend": "12.18.1-canary.545.2374fb2.0",
|
|
28
|
+
"@quenty/loader": "10.8.1-canary.545.2374fb2.0",
|
|
29
|
+
"@quenty/maid": "3.4.1-canary.545.2374fb2.0",
|
|
30
|
+
"@quenty/rx": "13.17.1-canary.545.2374fb2.0",
|
|
31
|
+
"@quenty/servicebag": "11.11.2-canary.545.2374fb2.0",
|
|
32
|
+
"@quenty/string": "3.3.2-canary.545.2374fb2.0",
|
|
33
|
+
"@quenty/uiobjectutils": "6.16.1-canary.545.2374fb2.0",
|
|
34
|
+
"@quenty/valueobject": "13.17.1-canary.545.2374fb2.0"
|
|
35
35
|
},
|
|
36
36
|
"publishConfig": {
|
|
37
37
|
"access": "public"
|
|
38
38
|
},
|
|
39
|
-
"gitHead": "
|
|
39
|
+
"gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
|
|
40
40
|
}
|
|
@@ -33,6 +33,7 @@ local ScreenGuiService = require("ScreenGuiService")
|
|
|
33
33
|
local ServiceBag = require("ServiceBag")
|
|
34
34
|
local String = require("String")
|
|
35
35
|
local ValueObject = require("ValueObject")
|
|
36
|
+
local _Observable = require("Observable")
|
|
36
37
|
|
|
37
38
|
local GenericScreenGuiProvider = {}
|
|
38
39
|
GenericScreenGuiProvider.ClassName = "GenericScreenGuiProvider"
|
|
@@ -43,17 +44,17 @@ GenericScreenGuiProvider.ServiceName = "GenericScreenGuiProvider"
|
|
|
43
44
|
@param orders { [string]: number }
|
|
44
45
|
@return GenericScreenGuiProvider
|
|
45
46
|
]=]
|
|
46
|
-
function GenericScreenGuiProvider.new(orders)
|
|
47
|
+
function GenericScreenGuiProvider.new(orders: { [string]: number })
|
|
47
48
|
assert(type(orders) == "table", "Bad orders")
|
|
48
49
|
|
|
49
50
|
local self = setmetatable({
|
|
50
|
-
_defaultOrders = orders
|
|
51
|
+
_defaultOrders = orders,
|
|
51
52
|
}, GenericScreenGuiProvider)
|
|
52
53
|
|
|
53
54
|
return self
|
|
54
55
|
end
|
|
55
56
|
|
|
56
|
-
function GenericScreenGuiProvider:Init(serviceBag)
|
|
57
|
+
function GenericScreenGuiProvider:Init(serviceBag: ServiceBag.ServiceBag)
|
|
57
58
|
self._serviceBag = assert(serviceBag, "No serviceBag")
|
|
58
59
|
self._maid = Maid.new()
|
|
59
60
|
|
|
@@ -65,16 +66,12 @@ function GenericScreenGuiProvider:Init(serviceBag)
|
|
|
65
66
|
end
|
|
66
67
|
end
|
|
67
68
|
|
|
68
|
-
function GenericScreenGuiProvider:Start()
|
|
69
|
-
|
|
70
|
-
end
|
|
69
|
+
function GenericScreenGuiProvider:Start() end
|
|
71
70
|
|
|
72
71
|
function GenericScreenGuiProvider:__index(index)
|
|
73
72
|
if GenericScreenGuiProvider[index] then
|
|
74
73
|
return GenericScreenGuiProvider[index]
|
|
75
|
-
elseif index == "_screenGuiService"
|
|
76
|
-
or index == "_serviceBag"
|
|
77
|
-
or index == "_maid" then
|
|
74
|
+
elseif index == "_screenGuiService" or index == "_serviceBag" or index == "_maid" then
|
|
78
75
|
return rawget(self, index)
|
|
79
76
|
else
|
|
80
77
|
error(string.format("Bad index %q", tostring(index)), 2)
|
|
@@ -82,9 +79,7 @@ function GenericScreenGuiProvider:__index(index)
|
|
|
82
79
|
end
|
|
83
80
|
|
|
84
81
|
function GenericScreenGuiProvider:__newindex(index, value)
|
|
85
|
-
if index == "_screenGuiService"
|
|
86
|
-
or index == "_serviceBag"
|
|
87
|
-
or index == "_maid" then
|
|
82
|
+
if index == "_screenGuiService" or index == "_serviceBag" or index == "_maid" then
|
|
88
83
|
rawset(self, index, value)
|
|
89
84
|
else
|
|
90
85
|
error(string.format("Bad index %q", tostring(index)), 2)
|
|
@@ -96,27 +91,27 @@ end
|
|
|
96
91
|
@param orderName string
|
|
97
92
|
@return Observable<Instance>
|
|
98
93
|
]=]
|
|
99
|
-
function GenericScreenGuiProvider:ObserveScreenGui(orderName)
|
|
94
|
+
function GenericScreenGuiProvider:ObserveScreenGui(orderName: string): _Observable.Observable<Instance>
|
|
100
95
|
assert(type(orderName) == "string", "Bad orderName")
|
|
101
96
|
|
|
102
97
|
if not RunService:IsRunning() then
|
|
103
|
-
return Blend.New
|
|
104
|
-
Name = String.toCamelCase(orderName)
|
|
105
|
-
Archivable = false
|
|
106
|
-
Size = UDim2.fromScale(1, 1)
|
|
107
|
-
BackgroundTransparency = 1
|
|
108
|
-
Parent = self:_getScreenGuiService():ObservePlayerGui()
|
|
109
|
-
}
|
|
98
|
+
return Blend.New("Frame")({
|
|
99
|
+
Name = String.toCamelCase(orderName),
|
|
100
|
+
Archivable = false,
|
|
101
|
+
Size = UDim2.fromScale(1, 1),
|
|
102
|
+
BackgroundTransparency = 1,
|
|
103
|
+
Parent = self:_getScreenGuiService():ObservePlayerGui(),
|
|
104
|
+
})
|
|
110
105
|
end
|
|
111
106
|
|
|
112
|
-
return Blend.New
|
|
113
|
-
Name = String.toCamelCase(orderName)
|
|
114
|
-
ResetOnSpawn = false
|
|
115
|
-
AutoLocalize = false
|
|
116
|
-
DisplayOrder = self:ObserveDisplayOrder(orderName)
|
|
117
|
-
Parent = self:_getScreenGuiService():ObservePlayerGui()
|
|
118
|
-
ZIndexBehavior = Enum.ZIndexBehavior.Sibling
|
|
119
|
-
}
|
|
107
|
+
return Blend.New("ScreenGui")({
|
|
108
|
+
Name = String.toCamelCase(orderName),
|
|
109
|
+
ResetOnSpawn = false,
|
|
110
|
+
AutoLocalize = false,
|
|
111
|
+
DisplayOrder = self:ObserveDisplayOrder(orderName),
|
|
112
|
+
Parent = self:_getScreenGuiService():ObservePlayerGui(),
|
|
113
|
+
ZIndexBehavior = Enum.ZIndexBehavior.Sibling,
|
|
114
|
+
})
|
|
120
115
|
end
|
|
121
116
|
|
|
122
117
|
function GenericScreenGuiProvider:SetDisplayOrder(orderName, order)
|
|
@@ -131,7 +126,7 @@ end
|
|
|
131
126
|
@param orderName string -- Order name of display order
|
|
132
127
|
@return ScreenGui
|
|
133
128
|
]=]
|
|
134
|
-
function GenericScreenGuiProvider:Get(orderName)
|
|
129
|
+
function GenericScreenGuiProvider:Get(orderName: string): ScreenGui
|
|
135
130
|
assert(type(orderName) == "string", "Bad orderName")
|
|
136
131
|
self:_assertOrderExists(orderName)
|
|
137
132
|
|
|
@@ -164,7 +159,7 @@ end
|
|
|
164
159
|
@param orderName string -- Order name of display order
|
|
165
160
|
@return number
|
|
166
161
|
]=]
|
|
167
|
-
function GenericScreenGuiProvider:GetDisplayOrder(orderName)
|
|
162
|
+
function GenericScreenGuiProvider:GetDisplayOrder(orderName: string): number
|
|
168
163
|
assert(type(orderName) == "string", "Bad orderName")
|
|
169
164
|
self:_assertOrderExists(orderName)
|
|
170
165
|
|
|
@@ -176,14 +171,14 @@ end
|
|
|
176
171
|
@param orderName string -- Order name of display order
|
|
177
172
|
@return Observable<number>
|
|
178
173
|
]=]
|
|
179
|
-
function GenericScreenGuiProvider:ObserveDisplayOrder(orderName)
|
|
174
|
+
function GenericScreenGuiProvider:ObserveDisplayOrder(orderName: string): _Observable.Observable<number>
|
|
180
175
|
assert(type(orderName) == "string", "Bad orderName")
|
|
181
176
|
self:_assertOrderExists(orderName)
|
|
182
177
|
|
|
183
178
|
return self._orderValues[orderName]:Observe()
|
|
184
179
|
end
|
|
185
180
|
|
|
186
|
-
function GenericScreenGuiProvider:_assertOrderExists(orderName)
|
|
181
|
+
function GenericScreenGuiProvider:_assertOrderExists(orderName: string): ()
|
|
187
182
|
assert(type(orderName) == "string", "Bad orderName")
|
|
188
183
|
|
|
189
184
|
if not self._defaultOrders[orderName] then
|
|
@@ -12,16 +12,19 @@ local RunService = game:GetService("RunService")
|
|
|
12
12
|
local Maid = require("Maid")
|
|
13
13
|
local ValueObject = require("ValueObject")
|
|
14
14
|
local PlayerGuiUtils = require("PlayerGuiUtils")
|
|
15
|
+
local _Observable = require("Observable")
|
|
16
|
+
local _ServiceBag = require("ServiceBag")
|
|
15
17
|
|
|
16
18
|
local ScreenGuiService = {}
|
|
17
19
|
ScreenGuiService.ServiceName = "ScreenGuiService"
|
|
20
|
+
ScreenGuiService._hackPlayerGui = nil :: any?
|
|
18
21
|
|
|
19
22
|
--[=[
|
|
20
23
|
Initializes the ScreenGuiService
|
|
21
24
|
|
|
22
25
|
@param serviceBag ServiceBag
|
|
23
26
|
]=]
|
|
24
|
-
function ScreenGuiService:Init(serviceBag)
|
|
27
|
+
function ScreenGuiService:Init(serviceBag: _ServiceBag.ServiceBag)
|
|
25
28
|
assert(not self._serviceBag, "Already initialized")
|
|
26
29
|
self._serviceBag = assert(serviceBag, "No serviceBag")
|
|
27
30
|
|
|
@@ -62,7 +65,7 @@ end
|
|
|
62
65
|
|
|
63
66
|
return Observable<ScreenGui?>
|
|
64
67
|
]=]
|
|
65
|
-
function ScreenGuiService:ObservePlayerGui()
|
|
68
|
+
function ScreenGuiService:ObservePlayerGui(): _Observable.Observable<ScreenGui?>
|
|
66
69
|
self:_ensureInit()
|
|
67
70
|
|
|
68
71
|
return self._guiParent:Observe()
|