roblox-opencode 1.0.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/README.md +122 -0
- package/commands/setup-game.md +108 -0
- package/commands/sync-check.md +53 -0
- package/core/roblox-core.md +93 -0
- package/dist/server.js +167 -0
- package/package.json +35 -0
- package/skills/roblox-analytics/SKILL.md +277 -0
- package/skills/roblox-analytics/references/event-batcher.luau +75 -0
- package/skills/roblox-animation-vfx/SKILL.md +1325 -0
- package/skills/roblox-architecture/SKILL.md +863 -0
- package/skills/roblox-architecture/references/combat-systems.md +1381 -0
- package/skills/roblox-code-review/SKILL.md +687 -0
- package/skills/roblox-data/SKILL.md +889 -0
- package/skills/roblox-data/references/inventory-systems.md +1729 -0
- package/skills/roblox-debug/SKILL.md +99 -0
- package/skills/roblox-gui/SKILL.md +1103 -0
- package/skills/roblox-gui-fusion/SKILL.md +150 -0
- package/skills/roblox-gui-fusion/references/inventory.luau +427 -0
- package/skills/roblox-gui-fusion/references/settings-menu.luau +579 -0
- package/skills/roblox-gui-fusion/references/shop.luau +411 -0
- package/skills/roblox-luau-mastery/SKILL.md +1519 -0
- package/skills/roblox-monetization/SKILL.md +1084 -0
- package/skills/roblox-monetization/references/process-receipt.luau +131 -0
- package/skills/roblox-networking/SKILL.md +669 -0
- package/skills/roblox-networking/references/remote-validator.luau +193 -0
- package/skills/roblox-publish-checklist/SKILL.md +128 -0
- package/skills/roblox-runtime/SKILL.md +753 -0
- package/skills/roblox-sharp-edges/SKILL.md +295 -0
- package/skills/roblox-sync/SKILL.md +126 -0
- package/skills/roblox-testing/SKILL.md +943 -0
- package/skills/roblox-tooling/SKILL.md +150 -0
- package/vendor/LICENSES/ProfileStore-LICENSE +201 -0
- package/vendor/LICENSES/RbxUtil-LICENSE +7 -0
- package/vendor/LICENSES/promise-LICENSE +21 -0
- package/vendor/LICENSES/t-LICENSE +21 -0
- package/vendor/LICENSES/testez-LICENSE +201 -0
- package/vendor/README.md +84 -0
- package/vendor/fusion/Animation/ExternalTime.luau +84 -0
- package/vendor/fusion/Animation/Spring.luau +322 -0
- package/vendor/fusion/Animation/Stopwatch.luau +128 -0
- package/vendor/fusion/Animation/Tween.luau +187 -0
- package/vendor/fusion/Animation/getTweenDuration.luau +27 -0
- package/vendor/fusion/Animation/getTweenRatio.luau +47 -0
- package/vendor/fusion/Animation/lerpType.luau +164 -0
- package/vendor/fusion/Animation/packType.luau +100 -0
- package/vendor/fusion/Animation/springCoefficients.luau +80 -0
- package/vendor/fusion/Animation/unpackType.luau +103 -0
- package/vendor/fusion/Colour/Oklab.luau +70 -0
- package/vendor/fusion/Colour/sRGB.luau +55 -0
- package/vendor/fusion/External.luau +168 -0
- package/vendor/fusion/ExternalDebug.luau +70 -0
- package/vendor/fusion/Graph/Observer.luau +114 -0
- package/vendor/fusion/Graph/castToGraph.luau +29 -0
- package/vendor/fusion/Graph/change.luau +81 -0
- package/vendor/fusion/Graph/depend.luau +33 -0
- package/vendor/fusion/Graph/evaluate.luau +56 -0
- package/vendor/fusion/Instances/Attribute.luau +58 -0
- package/vendor/fusion/Instances/AttributeChange.luau +47 -0
- package/vendor/fusion/Instances/AttributeOut.luau +63 -0
- package/vendor/fusion/Instances/Child.luau +21 -0
- package/vendor/fusion/Instances/Children.luau +148 -0
- package/vendor/fusion/Instances/Hydrate.luau +33 -0
- package/vendor/fusion/Instances/New.luau +53 -0
- package/vendor/fusion/Instances/OnChange.luau +50 -0
- package/vendor/fusion/Instances/OnEvent.luau +54 -0
- package/vendor/fusion/Instances/Out.luau +69 -0
- package/vendor/fusion/Instances/applyInstanceProps.luau +149 -0
- package/vendor/fusion/Instances/defaultProps.luau +194 -0
- package/vendor/fusion/LICENSE +21 -0
- package/vendor/fusion/Logging/formatError.luau +49 -0
- package/vendor/fusion/Logging/messages.luau +52 -0
- package/vendor/fusion/Logging/parseError.luau +25 -0
- package/vendor/fusion/Memory/checkLifetime.luau +134 -0
- package/vendor/fusion/Memory/deriveScope.luau +24 -0
- package/vendor/fusion/Memory/deriveScopeImpl.luau +45 -0
- package/vendor/fusion/Memory/doCleanup.luau +79 -0
- package/vendor/fusion/Memory/innerScope.luau +34 -0
- package/vendor/fusion/Memory/legacyCleanup.luau +18 -0
- package/vendor/fusion/Memory/needsDestruction.luau +17 -0
- package/vendor/fusion/Memory/poisonScope.luau +34 -0
- package/vendor/fusion/Memory/scopePool.luau +55 -0
- package/vendor/fusion/Memory/scoped.luau +27 -0
- package/vendor/fusion/Memory/whichLivesLonger.luau +75 -0
- package/vendor/fusion/RobloxExternal.luau +98 -0
- package/vendor/fusion/State/Computed.luau +139 -0
- package/vendor/fusion/State/For/Disassembly.luau +211 -0
- package/vendor/fusion/State/For/ForTypes.luau +30 -0
- package/vendor/fusion/State/For/init.luau +110 -0
- package/vendor/fusion/State/ForKeys.luau +94 -0
- package/vendor/fusion/State/ForPairs.luau +97 -0
- package/vendor/fusion/State/ForValues.luau +94 -0
- package/vendor/fusion/State/Value.luau +88 -0
- package/vendor/fusion/State/castToState.luau +26 -0
- package/vendor/fusion/State/peek.luau +31 -0
- package/vendor/fusion/State/updateAll.luau +1 -0
- package/vendor/fusion/Types.luau +314 -0
- package/vendor/fusion/Utility/Contextual.luau +91 -0
- package/vendor/fusion/Utility/Safe.luau +23 -0
- package/vendor/fusion/Utility/isSimilar.luau +29 -0
- package/vendor/fusion/Utility/merge.luau +35 -0
- package/vendor/fusion/Utility/nameOf.luau +35 -0
- package/vendor/fusion/Utility/never.luau +14 -0
- package/vendor/fusion/Utility/nicknames.luau +11 -0
- package/vendor/fusion/Utility/xtypeof.luau +27 -0
- package/vendor/fusion/init.luau +82 -0
- package/vendor/profilestore/init.luau +2243 -0
- package/vendor/promise/init.luau +1982 -0
- package/vendor/rbxutil/buffer-util/Buffer.test.luau +25 -0
- package/vendor/rbxutil/buffer-util/BufferReader.luau +228 -0
- package/vendor/rbxutil/buffer-util/BufferWriter.luau +269 -0
- package/vendor/rbxutil/buffer-util/DataTypeBuffer.luau +223 -0
- package/vendor/rbxutil/buffer-util/Types.luau +60 -0
- package/vendor/rbxutil/buffer-util/index.d.ts +153 -0
- package/vendor/rbxutil/buffer-util/init.luau +41 -0
- package/vendor/rbxutil/buffer-util/package.json +16 -0
- package/vendor/rbxutil/buffer-util/wally.toml +9 -0
- package/vendor/rbxutil/comm/Client/ClientComm.luau +232 -0
- package/vendor/rbxutil/comm/Client/ClientRemoteProperty.luau +156 -0
- package/vendor/rbxutil/comm/Client/ClientRemoteSignal.luau +109 -0
- package/vendor/rbxutil/comm/Client/init.luau +135 -0
- package/vendor/rbxutil/comm/Server/RemoteProperty.luau +295 -0
- package/vendor/rbxutil/comm/Server/RemoteSignal.luau +211 -0
- package/vendor/rbxutil/comm/Server/ServerComm.luau +211 -0
- package/vendor/rbxutil/comm/Server/init.luau +140 -0
- package/vendor/rbxutil/comm/Types.luau +18 -0
- package/vendor/rbxutil/comm/Util.luau +27 -0
- package/vendor/rbxutil/comm/init.luau +35 -0
- package/vendor/rbxutil/comm/wally.toml +13 -0
- package/vendor/rbxutil/component/init.luau +759 -0
- package/vendor/rbxutil/component/init.test.luau +311 -0
- package/vendor/rbxutil/component/wally.toml +14 -0
- package/vendor/rbxutil/concur/init.luau +542 -0
- package/vendor/rbxutil/concur/init.test.luau +364 -0
- package/vendor/rbxutil/concur/wally.toml +8 -0
- package/vendor/rbxutil/enum-list/init.luau +101 -0
- package/vendor/rbxutil/enum-list/init.test.luau +91 -0
- package/vendor/rbxutil/enum-list/wally.toml +8 -0
- package/vendor/rbxutil/find/index.d.ts +20 -0
- package/vendor/rbxutil/find/init.luau +44 -0
- package/vendor/rbxutil/find/package.json +17 -0
- package/vendor/rbxutil/find/wally.toml +8 -0
- package/vendor/rbxutil/input/Gamepad.luau +559 -0
- package/vendor/rbxutil/input/Keyboard.luau +124 -0
- package/vendor/rbxutil/input/Mouse.luau +278 -0
- package/vendor/rbxutil/input/PreferredInput.luau +91 -0
- package/vendor/rbxutil/input/Touch.luau +120 -0
- package/vendor/rbxutil/input/init.luau +33 -0
- package/vendor/rbxutil/input/wally.toml +12 -0
- package/vendor/rbxutil/loader/index.d.ts +15 -0
- package/vendor/rbxutil/loader/init.luau +137 -0
- package/vendor/rbxutil/loader/wally.toml +8 -0
- package/vendor/rbxutil/log/index.d.ts +38 -0
- package/vendor/rbxutil/log/init.luau +746 -0
- package/vendor/rbxutil/log/wally.toml +8 -0
- package/vendor/rbxutil/net/init.luau +190 -0
- package/vendor/rbxutil/net/wally.toml +8 -0
- package/vendor/rbxutil/option/index.d.ts +44 -0
- package/vendor/rbxutil/option/init.luau +489 -0
- package/vendor/rbxutil/option/init.test.luau +342 -0
- package/vendor/rbxutil/option/wally.toml +8 -0
- package/vendor/rbxutil/pid/index.d.ts +53 -0
- package/vendor/rbxutil/pid/init.luau +195 -0
- package/vendor/rbxutil/pid/package.json +16 -0
- package/vendor/rbxutil/pid/wally.toml +9 -0
- package/vendor/rbxutil/quaternion/index.d.ts +117 -0
- package/vendor/rbxutil/quaternion/init.luau +570 -0
- package/vendor/rbxutil/quaternion/package.json +16 -0
- package/vendor/rbxutil/quaternion/wally.toml +9 -0
- package/vendor/rbxutil/query/index.d.ts +43 -0
- package/vendor/rbxutil/query/init.luau +117 -0
- package/vendor/rbxutil/query/package.json +18 -0
- package/vendor/rbxutil/query/wally.toml +9 -0
- package/vendor/rbxutil/sequent/index.d.ts +28 -0
- package/vendor/rbxutil/sequent/init.luau +340 -0
- package/vendor/rbxutil/sequent/package.json +16 -0
- package/vendor/rbxutil/sequent/wally.toml +9 -0
- package/vendor/rbxutil/ser/init.luau +175 -0
- package/vendor/rbxutil/ser/init.test.luau +50 -0
- package/vendor/rbxutil/ser/wally.toml +11 -0
- package/vendor/rbxutil/shake/index.d.ts +36 -0
- package/vendor/rbxutil/shake/init.luau +532 -0
- package/vendor/rbxutil/shake/init.test.luau +267 -0
- package/vendor/rbxutil/shake/package.json +16 -0
- package/vendor/rbxutil/shake/wally.toml +9 -0
- package/vendor/rbxutil/signal/index.d.ts +100 -0
- package/vendor/rbxutil/signal/init.luau +432 -0
- package/vendor/rbxutil/signal/init.test.luau +190 -0
- package/vendor/rbxutil/signal/package.json +17 -0
- package/vendor/rbxutil/signal/wally.toml +9 -0
- package/vendor/rbxutil/silo/TableWatcher.luau +65 -0
- package/vendor/rbxutil/silo/Util.luau +55 -0
- package/vendor/rbxutil/silo/init.luau +338 -0
- package/vendor/rbxutil/silo/init.test.luau +215 -0
- package/vendor/rbxutil/silo/wally.toml +8 -0
- package/vendor/rbxutil/spring/index.d.ts +40 -0
- package/vendor/rbxutil/spring/init.luau +97 -0
- package/vendor/rbxutil/spring/package.json +17 -0
- package/vendor/rbxutil/spring/wally.toml +8 -0
- package/vendor/rbxutil/stream/index.d.ts +88 -0
- package/vendor/rbxutil/stream/init.luau +597 -0
- package/vendor/rbxutil/stream/package.json +18 -0
- package/vendor/rbxutil/stream/wally.toml +9 -0
- package/vendor/rbxutil/streamable/Streamable.luau +202 -0
- package/vendor/rbxutil/streamable/StreamableUtil.luau +80 -0
- package/vendor/rbxutil/streamable/init.luau +8 -0
- package/vendor/rbxutil/streamable/wally.toml +12 -0
- package/vendor/rbxutil/symbol/init.luau +56 -0
- package/vendor/rbxutil/symbol/init.test.luau +37 -0
- package/vendor/rbxutil/symbol/wally.toml +8 -0
- package/vendor/rbxutil/table-util/init.luau +938 -0
- package/vendor/rbxutil/table-util/init.test.luau +439 -0
- package/vendor/rbxutil/table-util/wally.toml +8 -0
- package/vendor/rbxutil/task-queue/index.d.ts +27 -0
- package/vendor/rbxutil/task-queue/init.luau +97 -0
- package/vendor/rbxutil/task-queue/wally.toml +8 -0
- package/vendor/rbxutil/timer/index.d.ts +81 -0
- package/vendor/rbxutil/timer/init.luau +249 -0
- package/vendor/rbxutil/timer/init.test.luau +73 -0
- package/vendor/rbxutil/timer/wally.toml +11 -0
- package/vendor/rbxutil/tree/index.d.ts +15 -0
- package/vendor/rbxutil/tree/init.luau +137 -0
- package/vendor/rbxutil/tree/wally.toml +8 -0
- package/vendor/rbxutil/trove/index.d.ts +46 -0
- package/vendor/rbxutil/trove/init.luau +787 -0
- package/vendor/rbxutil/trove/init.test.luau +203 -0
- package/vendor/rbxutil/trove/wally.toml +8 -0
- package/vendor/rbxutil/typed-remote/init.luau +196 -0
- package/vendor/rbxutil/typed-remote/wally.toml +8 -0
- package/vendor/rbxutil/wait-for/index.d.ts +17 -0
- package/vendor/rbxutil/wait-for/init.luau +257 -0
- package/vendor/rbxutil/wait-for/init.test.luau +182 -0
- package/vendor/rbxutil/wait-for/wally.toml +11 -0
- package/vendor/t/t.lua +1350 -0
- package/vendor/testez/Context.lua +26 -0
- package/vendor/testez/Expectation.lua +311 -0
- package/vendor/testez/ExpectationContext.lua +38 -0
- package/vendor/testez/LifecycleHooks.lua +89 -0
- package/vendor/testez/Reporters/TeamCityReporter.lua +102 -0
- package/vendor/testez/Reporters/TextReporter.lua +106 -0
- package/vendor/testez/Reporters/TextReporterQuiet.lua +97 -0
- package/vendor/testez/TestBootstrap.lua +147 -0
- package/vendor/testez/TestEnum.lua +28 -0
- package/vendor/testez/TestPlan.lua +304 -0
- package/vendor/testez/TestPlanner.lua +40 -0
- package/vendor/testez/TestResults.lua +112 -0
- package/vendor/testez/TestRunner.lua +188 -0
- package/vendor/testez/TestSession.lua +243 -0
- package/vendor/testez/init.lua +40 -0
|
@@ -0,0 +1,342 @@
|
|
|
1
|
+
local ServerScriptService = game:GetService("ServerScriptService")
|
|
2
|
+
|
|
3
|
+
local Test = require(ServerScriptService.TestRunner.Test)
|
|
4
|
+
|
|
5
|
+
return function(ctx: Test.TestContext)
|
|
6
|
+
local Option = require(script.Parent)
|
|
7
|
+
|
|
8
|
+
ctx:Describe("Some", function()
|
|
9
|
+
ctx:Test("should create some option", function()
|
|
10
|
+
local opt = Option.Some(true)
|
|
11
|
+
ctx:Expect(opt:IsSome()):ToBe(true)
|
|
12
|
+
end)
|
|
13
|
+
|
|
14
|
+
ctx:Test("should fail to create some option with nil", function()
|
|
15
|
+
ctx:Expect(function()
|
|
16
|
+
Option.Some(nil)
|
|
17
|
+
end):ToThrow()
|
|
18
|
+
end)
|
|
19
|
+
|
|
20
|
+
ctx:Test("should not be none", function()
|
|
21
|
+
local opt = Option.Some(10)
|
|
22
|
+
ctx:Expect(opt:IsNone()):ToBe(false)
|
|
23
|
+
end)
|
|
24
|
+
end)
|
|
25
|
+
|
|
26
|
+
ctx:Describe("None", function()
|
|
27
|
+
ctx:Test("should be able to reference none", function()
|
|
28
|
+
ctx:Expect(function()
|
|
29
|
+
local _none = Option.None
|
|
30
|
+
end)
|
|
31
|
+
:Not()
|
|
32
|
+
:ToThrow()
|
|
33
|
+
end)
|
|
34
|
+
|
|
35
|
+
ctx:Test("should be able to check if none", function()
|
|
36
|
+
local none = Option.None
|
|
37
|
+
ctx:Expect(none:IsNone()):ToBe(true)
|
|
38
|
+
end)
|
|
39
|
+
|
|
40
|
+
ctx:Test("should be able to check if not some", function()
|
|
41
|
+
local none = Option.None
|
|
42
|
+
ctx:Expect(none:IsSome()):ToBe(false)
|
|
43
|
+
end)
|
|
44
|
+
end)
|
|
45
|
+
|
|
46
|
+
ctx:Describe("Equality", function()
|
|
47
|
+
ctx:Test("should equal the same some from same options", function()
|
|
48
|
+
local opt = Option.Some(32)
|
|
49
|
+
ctx:Expect(opt):ToBe(opt)
|
|
50
|
+
end)
|
|
51
|
+
|
|
52
|
+
ctx:Test("should equal the same some from different options", function()
|
|
53
|
+
local opt1 = Option.Some(32)
|
|
54
|
+
local opt2 = Option.Some(32)
|
|
55
|
+
ctx:Expect(opt1):ToBe(opt2)
|
|
56
|
+
end)
|
|
57
|
+
end)
|
|
58
|
+
|
|
59
|
+
ctx:Describe("Assert", function()
|
|
60
|
+
ctx:Test("should assert that a some option is an option", function()
|
|
61
|
+
ctx:Expect(Option.Is(Option.Some(10))):ToBe(true)
|
|
62
|
+
end)
|
|
63
|
+
|
|
64
|
+
ctx:Test("should assert that a none option is an option", function()
|
|
65
|
+
ctx:Expect(Option.Is(Option.None)):ToBe(true)
|
|
66
|
+
end)
|
|
67
|
+
|
|
68
|
+
ctx:Test("should assert that a non-option is not an option", function()
|
|
69
|
+
ctx:Expect(Option.Is(10)):ToBe(false)
|
|
70
|
+
ctx:Expect(Option.Is(true)):ToBe(false)
|
|
71
|
+
ctx:Expect(Option.Is(false)):ToBe(false)
|
|
72
|
+
ctx:Expect(Option.Is("Test")):ToBe(false)
|
|
73
|
+
ctx:Expect(Option.Is({})):ToBe(false)
|
|
74
|
+
ctx:Expect(Option.Is(function() end)):ToBe(false)
|
|
75
|
+
ctx:Expect(Option.Is(coroutine.create(function() end))):ToBe(false)
|
|
76
|
+
ctx:Expect(Option.Is(Option)):ToBe(false)
|
|
77
|
+
end)
|
|
78
|
+
end)
|
|
79
|
+
|
|
80
|
+
ctx:Describe("Unwrap", function()
|
|
81
|
+
ctx:Test("should unwrap a some option", function()
|
|
82
|
+
local opt = Option.Some(10)
|
|
83
|
+
ctx:Expect(function()
|
|
84
|
+
opt:Unwrap()
|
|
85
|
+
end)
|
|
86
|
+
:Not()
|
|
87
|
+
:ToThrow()
|
|
88
|
+
ctx:Expect(opt:Unwrap()):ToBe(10)
|
|
89
|
+
end)
|
|
90
|
+
|
|
91
|
+
ctx:Test("should fail to unwrap a none option", function()
|
|
92
|
+
local opt = Option.None
|
|
93
|
+
ctx:Expect(function()
|
|
94
|
+
opt:Unwrap()
|
|
95
|
+
end):ToThrow()
|
|
96
|
+
end)
|
|
97
|
+
end)
|
|
98
|
+
|
|
99
|
+
ctx:Describe("Expect", function()
|
|
100
|
+
ctx:Test("should expect a some option", function()
|
|
101
|
+
local opt = Option.Some(10)
|
|
102
|
+
ctx:Expect(function()
|
|
103
|
+
opt:Expect("Expecting some value")
|
|
104
|
+
end)
|
|
105
|
+
:Not()
|
|
106
|
+
:ToThrow()
|
|
107
|
+
ctx:Expect(opt:Unwrap()):ToBe(10)
|
|
108
|
+
end)
|
|
109
|
+
|
|
110
|
+
ctx:Test("should fail when expecting on a none option", function()
|
|
111
|
+
local opt = Option.None
|
|
112
|
+
ctx:Expect(function()
|
|
113
|
+
opt:Expect("Expecting some value")
|
|
114
|
+
end):ToThrow()
|
|
115
|
+
end)
|
|
116
|
+
end)
|
|
117
|
+
|
|
118
|
+
ctx:Describe("ExpectNone", function()
|
|
119
|
+
ctx:Test("should fail to expect a none option", function()
|
|
120
|
+
local opt = Option.Some(10)
|
|
121
|
+
ctx:Expect(function()
|
|
122
|
+
opt:ExpectNone("Expecting some value")
|
|
123
|
+
end):ToThrow()
|
|
124
|
+
end)
|
|
125
|
+
|
|
126
|
+
ctx:Test("should expect a none option", function()
|
|
127
|
+
local opt = Option.None
|
|
128
|
+
ctx:Expect(function()
|
|
129
|
+
opt:ExpectNone("Expecting some value")
|
|
130
|
+
end)
|
|
131
|
+
:Not()
|
|
132
|
+
:ToThrow()
|
|
133
|
+
end)
|
|
134
|
+
end)
|
|
135
|
+
|
|
136
|
+
ctx:Describe("UnwrapOr", function()
|
|
137
|
+
ctx:Test("should unwrap a some option", function()
|
|
138
|
+
local opt = Option.Some(10)
|
|
139
|
+
ctx:Expect(opt:UnwrapOr(20)):ToBe(10)
|
|
140
|
+
end)
|
|
141
|
+
|
|
142
|
+
ctx:Test("should unwrap a none option", function()
|
|
143
|
+
local opt = Option.None
|
|
144
|
+
ctx:Expect(opt:UnwrapOr(20)):ToBe(20)
|
|
145
|
+
end)
|
|
146
|
+
end)
|
|
147
|
+
|
|
148
|
+
ctx:Describe("UnwrapOrElse", function()
|
|
149
|
+
ctx:Test("should unwrap a some option", function()
|
|
150
|
+
local opt = Option.Some(10)
|
|
151
|
+
local result = opt:UnwrapOrElse(function()
|
|
152
|
+
return 30
|
|
153
|
+
end)
|
|
154
|
+
ctx:Expect(result):ToBe(10)
|
|
155
|
+
end)
|
|
156
|
+
|
|
157
|
+
ctx:Test("should unwrap a none option", function()
|
|
158
|
+
local opt = Option.None
|
|
159
|
+
local result = opt:UnwrapOrElse(function()
|
|
160
|
+
return 30
|
|
161
|
+
end)
|
|
162
|
+
ctx:Expect(result):ToBe(30)
|
|
163
|
+
end)
|
|
164
|
+
end)
|
|
165
|
+
|
|
166
|
+
ctx:Describe("And", function()
|
|
167
|
+
ctx:Test("should return the second option with and when both are some", function()
|
|
168
|
+
local opt1 = Option.Some(1)
|
|
169
|
+
local opt2 = Option.Some(2)
|
|
170
|
+
ctx:Expect(opt1:And(opt2)):ToBe(opt2)
|
|
171
|
+
end)
|
|
172
|
+
|
|
173
|
+
ctx:Test("should return none when first option is some and second option is none", function()
|
|
174
|
+
local opt1 = Option.Some(1)
|
|
175
|
+
local opt2 = Option.None
|
|
176
|
+
ctx:Expect(opt1:And(opt2):IsNone()):ToBe(true)
|
|
177
|
+
end)
|
|
178
|
+
|
|
179
|
+
ctx:Test("should return none when first option is none and second option is some", function()
|
|
180
|
+
local opt1 = Option.None
|
|
181
|
+
local opt2 = Option.Some(2)
|
|
182
|
+
ctx:Expect(opt1:And(opt2):IsNone()):ToBe(true)
|
|
183
|
+
end)
|
|
184
|
+
|
|
185
|
+
ctx:Test("should return none when both options are none", function()
|
|
186
|
+
local opt1 = Option.None
|
|
187
|
+
local opt2 = Option.None
|
|
188
|
+
ctx:Expect(opt1:And(opt2):IsNone()):ToBe(true)
|
|
189
|
+
end)
|
|
190
|
+
end)
|
|
191
|
+
|
|
192
|
+
ctx:Describe("AndThen", function()
|
|
193
|
+
ctx:Test("should pass the some value to the predicate", function()
|
|
194
|
+
local opt = Option.Some(32)
|
|
195
|
+
opt:AndThen(function(value)
|
|
196
|
+
ctx:Expect(value):ToBe(32)
|
|
197
|
+
return Option.None
|
|
198
|
+
end)
|
|
199
|
+
end)
|
|
200
|
+
|
|
201
|
+
ctx:Test("should throw if an option is not returned from predicate", function()
|
|
202
|
+
local opt = Option.Some(32)
|
|
203
|
+
ctx:Expect(function()
|
|
204
|
+
opt:AndThen(function() end)
|
|
205
|
+
end):ToThrow()
|
|
206
|
+
end)
|
|
207
|
+
|
|
208
|
+
ctx:Test("should return none if the option is none", function()
|
|
209
|
+
local opt = Option.None
|
|
210
|
+
ctx:Expect(opt:AndThen(function()
|
|
211
|
+
return Option.Some(10)
|
|
212
|
+
end):IsNone()):ToBe(true)
|
|
213
|
+
end)
|
|
214
|
+
|
|
215
|
+
ctx:Test("should return option of predicate if option is some", function()
|
|
216
|
+
local opt = Option.Some(32)
|
|
217
|
+
local result = opt:AndThen(function()
|
|
218
|
+
return Option.Some(10)
|
|
219
|
+
end)
|
|
220
|
+
ctx:Expect(result:IsSome()):ToBe(true)
|
|
221
|
+
ctx:Expect(result:Unwrap()):ToBe(10)
|
|
222
|
+
end)
|
|
223
|
+
end)
|
|
224
|
+
|
|
225
|
+
ctx:Describe("Or", function()
|
|
226
|
+
ctx:Test("should return the first option if it is some", function()
|
|
227
|
+
local opt1 = Option.Some(10)
|
|
228
|
+
local opt2 = Option.Some(20)
|
|
229
|
+
ctx:Expect(opt1:Or(opt2)):ToBe(opt1)
|
|
230
|
+
end)
|
|
231
|
+
|
|
232
|
+
ctx:Test("should return the second option if the first one is none", function()
|
|
233
|
+
local opt1 = Option.None
|
|
234
|
+
local opt2 = Option.Some(20)
|
|
235
|
+
ctx:Expect(opt1:Or(opt2)):ToBe(opt2)
|
|
236
|
+
end)
|
|
237
|
+
end)
|
|
238
|
+
|
|
239
|
+
ctx:Describe("OrElse", function()
|
|
240
|
+
ctx:Test("should return the first option if it is some", function()
|
|
241
|
+
local opt1 = Option.Some(10)
|
|
242
|
+
local opt2 = Option.Some(20)
|
|
243
|
+
ctx:Expect(opt1:OrElse(function()
|
|
244
|
+
return opt2
|
|
245
|
+
end)):ToBe(opt1)
|
|
246
|
+
end)
|
|
247
|
+
|
|
248
|
+
ctx:Test("should return the second option if the first one is none", function()
|
|
249
|
+
local opt1 = Option.None
|
|
250
|
+
local opt2 = Option.Some(20)
|
|
251
|
+
ctx:Expect(opt1:OrElse(function()
|
|
252
|
+
return opt2
|
|
253
|
+
end)):ToBe(opt2)
|
|
254
|
+
end)
|
|
255
|
+
|
|
256
|
+
ctx:Test("should throw if the predicate does not return an option", function()
|
|
257
|
+
local opt1 = Option.None
|
|
258
|
+
ctx:Expect(function()
|
|
259
|
+
opt1:OrElse(function() end)
|
|
260
|
+
end):ToThrow()
|
|
261
|
+
end)
|
|
262
|
+
end)
|
|
263
|
+
|
|
264
|
+
ctx:Describe("XOr", function()
|
|
265
|
+
ctx:Test("should return first option if first option is some and second option is none", function()
|
|
266
|
+
local opt1 = Option.Some(1)
|
|
267
|
+
local opt2 = Option.None
|
|
268
|
+
ctx:Expect(opt1:XOr(opt2)):ToBe(opt1)
|
|
269
|
+
end)
|
|
270
|
+
|
|
271
|
+
ctx:Test("should return second option if first option is none and second option is some", function()
|
|
272
|
+
local opt1 = Option.None
|
|
273
|
+
local opt2 = Option.Some(2)
|
|
274
|
+
ctx:Expect(opt1:XOr(opt2)):ToBe(opt2)
|
|
275
|
+
end)
|
|
276
|
+
|
|
277
|
+
ctx:Test("should return none if first and second option are some", function()
|
|
278
|
+
local opt1 = Option.Some(1)
|
|
279
|
+
local opt2 = Option.Some(2)
|
|
280
|
+
ctx:Expect(opt1:XOr(opt2)):ToBe(Option.None)
|
|
281
|
+
end)
|
|
282
|
+
|
|
283
|
+
ctx:Test("should return none if first and second option are none", function()
|
|
284
|
+
local opt1 = Option.None
|
|
285
|
+
local opt2 = Option.None
|
|
286
|
+
ctx:Expect(opt1:XOr(opt2)):ToBe(Option.None)
|
|
287
|
+
end)
|
|
288
|
+
end)
|
|
289
|
+
|
|
290
|
+
ctx:Describe("Filter", function()
|
|
291
|
+
ctx:Test("should return none if option is none", function()
|
|
292
|
+
local opt = Option.None
|
|
293
|
+
ctx:Expect(opt:Filter(function() end)):ToBe(Option.None)
|
|
294
|
+
end)
|
|
295
|
+
|
|
296
|
+
ctx:Test("should return none if option is some but fails predicate", function()
|
|
297
|
+
local opt = Option.Some(10)
|
|
298
|
+
ctx:Expect(opt:Filter(function(_v)
|
|
299
|
+
return false
|
|
300
|
+
end)):ToBe(Option.None)
|
|
301
|
+
end)
|
|
302
|
+
|
|
303
|
+
ctx:Test("should return self if option is some and passes predicate", function()
|
|
304
|
+
local opt = Option.Some(10)
|
|
305
|
+
ctx:Expect(opt:Filter(function(_v)
|
|
306
|
+
return true
|
|
307
|
+
end)):ToBe(opt)
|
|
308
|
+
end)
|
|
309
|
+
end)
|
|
310
|
+
|
|
311
|
+
ctx:Describe("Contains", function()
|
|
312
|
+
ctx:Test("should return true if some option contains the given value", function()
|
|
313
|
+
local opt = Option.Some(32)
|
|
314
|
+
ctx:Expect(opt:Contains(32)):ToBe(true)
|
|
315
|
+
end)
|
|
316
|
+
|
|
317
|
+
ctx:Test("should return false if some option does not contain the given value", function()
|
|
318
|
+
local opt = Option.Some(32)
|
|
319
|
+
ctx:Expect(opt:Contains(64)):ToBe(false)
|
|
320
|
+
end)
|
|
321
|
+
|
|
322
|
+
ctx:Test("should return false if option is none", function()
|
|
323
|
+
local opt = Option.None
|
|
324
|
+
ctx:Expect(opt:Contains(64)):ToBe(false)
|
|
325
|
+
end)
|
|
326
|
+
end)
|
|
327
|
+
|
|
328
|
+
ctx:Describe("ToString", function()
|
|
329
|
+
ctx:Test("should return string of none option", function()
|
|
330
|
+
local opt = Option.None
|
|
331
|
+
ctx:Expect(tostring(opt)):ToBe("Option<None>")
|
|
332
|
+
end)
|
|
333
|
+
|
|
334
|
+
ctx:Test("should return string of some option with type", function()
|
|
335
|
+
local values = { 10, true, false, "test", {}, function() end, coroutine.create(function() end), workspace }
|
|
336
|
+
for _, value in ipairs(values) do
|
|
337
|
+
local expectedString = ("Option<%s>"):format(typeof(value))
|
|
338
|
+
ctx:Expect(tostring(Option.Some(value))):ToBe(expectedString)
|
|
339
|
+
end
|
|
340
|
+
end)
|
|
341
|
+
end)
|
|
342
|
+
end
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
declare namespace PID {
|
|
2
|
+
interface Constructor {
|
|
3
|
+
/**
|
|
4
|
+
* Constructs a new PID.
|
|
5
|
+
*
|
|
6
|
+
* @param min Minimum output.
|
|
7
|
+
* @param max Maximum output.
|
|
8
|
+
* @param kp Proportional gain coefficient.
|
|
9
|
+
* @param ki Integral gain coefficient.
|
|
10
|
+
* @param kd Derivative gain coefficient.
|
|
11
|
+
*/
|
|
12
|
+
new (min: number, max: number, kp: number, ki: number, kd: number): PID;
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
interface PID {
|
|
17
|
+
/**
|
|
18
|
+
* Calculates the new output based on the setpoint and input.
|
|
19
|
+
*
|
|
20
|
+
* @param setpoint The goal for the PID.
|
|
21
|
+
* @param processVariable The measured value of the system to compare against the setpoint.
|
|
22
|
+
* @param deltaTime Delta time.
|
|
23
|
+
* @returns The updated output.
|
|
24
|
+
*/
|
|
25
|
+
Calculate(setpoint: number, processVariable: number, deltaTime: number): number;
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Resets the PID.
|
|
29
|
+
*/
|
|
30
|
+
Reset(): void;
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Creates a debug instance that can be used to tune the PID.
|
|
34
|
+
* This only works in Studio. This does nothing outside of Studio.
|
|
35
|
+
*
|
|
36
|
+
* @param name The name of the debug folder instance.
|
|
37
|
+
* @param parent The parent for the debug folder (defaults to Workspace).
|
|
38
|
+
*/
|
|
39
|
+
Debug(name: string, parent?: Instance): void;
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Destroys any debug instance created. `Destroy()` only needs
|
|
43
|
+
* to be called if `Debug()` was called.
|
|
44
|
+
*/
|
|
45
|
+
Destroy(): void;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* The PID class simulates a [PID controller](https://en.wikipedia.org/wiki/PID_controller).
|
|
50
|
+
*/
|
|
51
|
+
declare const PID: PID.Constructor;
|
|
52
|
+
|
|
53
|
+
export = PID;
|
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
--!native
|
|
2
|
+
|
|
3
|
+
export type PID = {
|
|
4
|
+
Reset: (self: PID) -> (),
|
|
5
|
+
Calculate: (self: PID, setpoint: number, input: number, deltaTime: number) -> number,
|
|
6
|
+
Debug: (self: PID, name: string, parent: Instance?) -> (),
|
|
7
|
+
Destroy: (self: PID) -> (),
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
--[=[
|
|
11
|
+
@class PID
|
|
12
|
+
The PID class simulates a [PID controller](https://en.wikipedia.org/wiki/PID_controller). PID is an acronym
|
|
13
|
+
for _proportional, integral, derivative_. PIDs are input feedback loops that try to reach a specific
|
|
14
|
+
goal by measuring the difference between the input and the desired value, and then returning a new
|
|
15
|
+
desired input.
|
|
16
|
+
|
|
17
|
+
A common example is a car's cruise control, which would give a PID the current speed
|
|
18
|
+
and the desired speed, and the PID controller would return the desired throttle input to reach the
|
|
19
|
+
desired speed.
|
|
20
|
+
]=]
|
|
21
|
+
local PID = {}
|
|
22
|
+
PID.__index = PID
|
|
23
|
+
|
|
24
|
+
--[=[
|
|
25
|
+
@param min number -- Minimum value the PID can output
|
|
26
|
+
@param max number -- Maximum value the PID can output
|
|
27
|
+
@param kp number -- Proportional gain coefficient (P)
|
|
28
|
+
@param ki number -- Integral gain coefficient (I)
|
|
29
|
+
@param kd number -- Derivative gain coefficient (D)
|
|
30
|
+
@return PID
|
|
31
|
+
|
|
32
|
+
Constructs a new PID.
|
|
33
|
+
|
|
34
|
+
```lua
|
|
35
|
+
local pid = PID.new(0, 1, 0.1, 0, 0)
|
|
36
|
+
```
|
|
37
|
+
]=]
|
|
38
|
+
function PID.new(min: number, max: number, kp: number, ki: number, kd: number): PID
|
|
39
|
+
local self = setmetatable({}, PID)
|
|
40
|
+
self._min = min
|
|
41
|
+
self._max = max
|
|
42
|
+
self._kp = kp
|
|
43
|
+
self._ki = ki
|
|
44
|
+
self._kd = kd
|
|
45
|
+
self._lastError = 0 -- Store the last error for derivative calculation
|
|
46
|
+
self._integralSum = 0 -- Store the sum of errors for integral calculation
|
|
47
|
+
return self
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
--[=[
|
|
51
|
+
Resets the PID to a zero start state.
|
|
52
|
+
]=]
|
|
53
|
+
function PID:Reset()
|
|
54
|
+
self._lastError = 0
|
|
55
|
+
self._integralSum = 0
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
--[=[
|
|
59
|
+
@param setpoint number -- The desired point to reach
|
|
60
|
+
@param processVariable number -- The measured value of the system to compare against the setpoint
|
|
61
|
+
@param deltaTime number -- Delta time. This is the time between each PID calculation
|
|
62
|
+
@return output: number
|
|
63
|
+
|
|
64
|
+
Calculates the new output based on the setpoint and input. For example,
|
|
65
|
+
if the PID was being used for a car's throttle control where the throttle
|
|
66
|
+
can be in the range of [0, 1], then the PID calculation might look like
|
|
67
|
+
the following:
|
|
68
|
+
```lua
|
|
69
|
+
local cruisePID = PID.new(0, 1, ...)
|
|
70
|
+
local desiredSpeed = 50
|
|
71
|
+
|
|
72
|
+
RunService.Heartbeat:Connect(function(dt)
|
|
73
|
+
local throttle = cruisePID:Calculate(desiredSpeed, car.CurrentSpeed, dt)
|
|
74
|
+
car:SetThrottle(throttle)
|
|
75
|
+
end)
|
|
76
|
+
```
|
|
77
|
+
]=]
|
|
78
|
+
function PID:Calculate(setpoint: number, processVariable: number, deltaTime: number): number
|
|
79
|
+
-- Calculate the error e(t) = SP - PV(t)
|
|
80
|
+
local err = setpoint - processVariable
|
|
81
|
+
|
|
82
|
+
-- Proportional term
|
|
83
|
+
local pOut = self._kp * err
|
|
84
|
+
|
|
85
|
+
-- Integral term
|
|
86
|
+
self._integralSum = self._integralSum + err * deltaTime
|
|
87
|
+
local iOut = self._ki * self._integralSum
|
|
88
|
+
|
|
89
|
+
-- Derivative term
|
|
90
|
+
local derivative = (err - self._lastError) / deltaTime
|
|
91
|
+
local dOut = self._kd * derivative
|
|
92
|
+
|
|
93
|
+
-- Combine terms
|
|
94
|
+
local output = pOut + iOut + dOut
|
|
95
|
+
|
|
96
|
+
-- Clamp output to min/max
|
|
97
|
+
output = math.clamp(output, self._min, self._max)
|
|
98
|
+
|
|
99
|
+
-- Save the current error for the next derivative calculation
|
|
100
|
+
self._lastError = err
|
|
101
|
+
|
|
102
|
+
return output
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
--[=[
|
|
106
|
+
@param name string -- Folder name
|
|
107
|
+
@param parent Instance? -- Folder parent
|
|
108
|
+
|
|
109
|
+
Creates a folder that contains attributes that can be used to
|
|
110
|
+
tune the PID during runtime within the explorer.
|
|
111
|
+
|
|
112
|
+
:::info Studio Only
|
|
113
|
+
This will only create the folder in Studio. In a real game server,
|
|
114
|
+
this function will do nothing.
|
|
115
|
+
:::
|
|
116
|
+
]=]
|
|
117
|
+
function PID:Debug(name: string, parent: Instance?)
|
|
118
|
+
if not game:GetService("RunService"):IsStudio() then
|
|
119
|
+
return
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
if self._debug then
|
|
123
|
+
return
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
local folder = Instance.new("Folder")
|
|
127
|
+
folder.Name = name
|
|
128
|
+
folder:AddTag("PIDDebug")
|
|
129
|
+
|
|
130
|
+
local function Bind(attrName, propName)
|
|
131
|
+
folder:SetAttribute(attrName, self[propName])
|
|
132
|
+
folder:GetAttributeChangedSignal(attrName):Connect(function()
|
|
133
|
+
self[propName] = folder:GetAttribute(attrName)
|
|
134
|
+
self:Reset()
|
|
135
|
+
end)
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
folder:SetAttribute("MinMax", NumberRange.new(self._min, self._max))
|
|
139
|
+
folder:GetAttributeChangedSignal("MinMax"):Connect(function()
|
|
140
|
+
local minMax = folder:GetAttribute("MinMax") :: NumberRange
|
|
141
|
+
self._min = minMax.Min
|
|
142
|
+
self._max = minMax.Max
|
|
143
|
+
self:Reset()
|
|
144
|
+
end)
|
|
145
|
+
|
|
146
|
+
Bind("kP", "_kp")
|
|
147
|
+
Bind("kI", "_ki")
|
|
148
|
+
Bind("kD", "_kd")
|
|
149
|
+
|
|
150
|
+
folder:SetAttribute("Output", self._min)
|
|
151
|
+
|
|
152
|
+
local lastOutput = 0
|
|
153
|
+
self.Calculate = function(s, sp, pv, ...)
|
|
154
|
+
lastOutput = PID.Calculate(s, sp, pv, ...)
|
|
155
|
+
folder:SetAttribute("Output", lastOutput)
|
|
156
|
+
return lastOutput
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
local delayThread: thread? = nil
|
|
160
|
+
folder:SetAttribute("ShowDebugger", false)
|
|
161
|
+
folder:GetAttributeChangedSignal("ShowDebugger"):Connect(function()
|
|
162
|
+
if delayThread then
|
|
163
|
+
task.cancel(delayThread)
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
local showDebugger = folder:GetAttribute("ShowDebugger")
|
|
167
|
+
|
|
168
|
+
if showDebugger then
|
|
169
|
+
delayThread = task.delay(0.1, function()
|
|
170
|
+
delayThread = nil
|
|
171
|
+
if folder:GetAttribute("ShowDebugger") then
|
|
172
|
+
folder:SetAttribute("ShowDebugger", false)
|
|
173
|
+
warn("Install the PID Debug plugin: https://create.roblox.com/store/asset/16279661108/PID-Debug")
|
|
174
|
+
end
|
|
175
|
+
end)
|
|
176
|
+
end
|
|
177
|
+
end)
|
|
178
|
+
|
|
179
|
+
folder.Parent = parent or workspace
|
|
180
|
+
self._debug = folder
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
--[=[
|
|
184
|
+
Destroys the PID. This is only necessary if calling `PID:Debug`.
|
|
185
|
+
]=]
|
|
186
|
+
function PID:Destroy()
|
|
187
|
+
if self._debug then
|
|
188
|
+
self._debug:Destroy()
|
|
189
|
+
self._debug = nil
|
|
190
|
+
end
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
return {
|
|
194
|
+
new = PID.new,
|
|
195
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@rbxutil/pid",
|
|
3
|
+
"version": "2.1.0",
|
|
4
|
+
"main": "init.luau",
|
|
5
|
+
"repository": "github:Sleitnick/RbxUtil",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"types": "index.d.ts",
|
|
8
|
+
"files": [
|
|
9
|
+
"./",
|
|
10
|
+
"!*.toml",
|
|
11
|
+
"!*.json"
|
|
12
|
+
],
|
|
13
|
+
"publishConfig": {
|
|
14
|
+
"access": "public"
|
|
15
|
+
}
|
|
16
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
[package]
|
|
2
|
+
name = "sleitnick/pid"
|
|
3
|
+
description = "PID Controller class"
|
|
4
|
+
version = "2.1.0"
|
|
5
|
+
license = "MIT"
|
|
6
|
+
authors = ["Stephen Leitnick"]
|
|
7
|
+
registry = "https://github.com/UpliftGames/wally-index"
|
|
8
|
+
realm = "shared"
|
|
9
|
+
exclude = ["node_modules", "package.json", "**/*.ts"]
|