roblox-opencode 1.0.0 → 1.0.2
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 +112 -122
- package/commands/setup-game.md +108 -108
- package/commands/sync-check.md +53 -53
- package/core/roblox-core.md +93 -93
- package/dist/server.js +189 -167
- package/package.json +35 -35
- package/skills/roblox-analytics/SKILL.md +277 -277
- package/skills/roblox-analytics/references/event-batcher.luau +75 -75
- package/skills/roblox-animation-vfx/SKILL.md +1325 -1325
- package/skills/roblox-architecture/SKILL.md +877 -863
- package/skills/roblox-architecture/references/combat-systems.md +1381 -1381
- package/skills/roblox-code-review/SKILL.md +686 -686
- package/skills/roblox-data/SKILL.md +889 -889
- package/skills/roblox-data/references/inventory-systems.md +1729 -1729
- package/skills/roblox-debug/SKILL.md +98 -98
- package/skills/roblox-gui/SKILL.md +1103 -1103
- package/skills/roblox-gui-fusion/SKILL.md +150 -150
- package/skills/roblox-gui-fusion/references/inventory.luau +427 -427
- package/skills/roblox-gui-fusion/references/settings-menu.luau +579 -579
- package/skills/roblox-gui-fusion/references/shop.luau +411 -411
- package/skills/roblox-luau-mastery/SKILL.md +1618 -1519
- package/skills/roblox-monetization/SKILL.md +1084 -1084
- package/skills/roblox-monetization/references/process-receipt.luau +131 -131
- package/skills/roblox-networking/SKILL.md +669 -669
- package/skills/roblox-networking/references/remote-validator.luau +193 -193
- package/skills/roblox-publish-checklist/SKILL.md +127 -127
- package/skills/roblox-runtime/SKILL.md +753 -753
- package/skills/roblox-sharp-edges/SKILL.md +294 -294
- package/skills/roblox-sync/SKILL.md +126 -126
- package/skills/roblox-testing/SKILL.md +943 -943
- package/skills/roblox-tooling/SKILL.md +149 -149
- package/vendor/LICENSES/ProfileStore-LICENSE +201 -201
- package/vendor/LICENSES/RbxUtil-LICENSE +7 -7
- package/vendor/LICENSES/promise-LICENSE +20 -20
- package/vendor/LICENSES/t-LICENSE +21 -21
- package/vendor/LICENSES/testez-LICENSE +200 -200
- package/vendor/README.md +83 -83
- package/vendor/fusion/Animation/ExternalTime.luau +83 -83
- package/vendor/fusion/Animation/Spring.luau +321 -321
- package/vendor/fusion/Animation/Stopwatch.luau +127 -127
- package/vendor/fusion/Animation/Tween.luau +187 -187
- package/vendor/fusion/Animation/getTweenDuration.luau +27 -27
- package/vendor/fusion/Animation/getTweenRatio.luau +47 -47
- package/vendor/fusion/Animation/lerpType.luau +163 -163
- package/vendor/fusion/Animation/packType.luau +99 -99
- package/vendor/fusion/Animation/springCoefficients.luau +80 -80
- package/vendor/fusion/Animation/unpackType.luau +102 -102
- package/vendor/fusion/Colour/Oklab.luau +70 -70
- package/vendor/fusion/Colour/sRGB.luau +54 -54
- package/vendor/fusion/External.luau +167 -167
- package/vendor/fusion/ExternalDebug.luau +69 -69
- package/vendor/fusion/Graph/Observer.luau +113 -113
- package/vendor/fusion/Graph/castToGraph.luau +28 -28
- package/vendor/fusion/Graph/change.luau +80 -80
- package/vendor/fusion/Graph/depend.luau +32 -32
- package/vendor/fusion/Graph/evaluate.luau +55 -55
- package/vendor/fusion/Instances/Attribute.luau +57 -57
- package/vendor/fusion/Instances/AttributeChange.luau +46 -46
- package/vendor/fusion/Instances/AttributeOut.luau +63 -63
- package/vendor/fusion/Instances/Child.luau +21 -21
- package/vendor/fusion/Instances/Children.luau +147 -147
- package/vendor/fusion/Instances/Hydrate.luau +32 -32
- package/vendor/fusion/Instances/New.luau +52 -52
- package/vendor/fusion/Instances/OnChange.luau +49 -49
- package/vendor/fusion/Instances/OnEvent.luau +53 -53
- package/vendor/fusion/Instances/Out.luau +69 -69
- package/vendor/fusion/Instances/applyInstanceProps.luau +148 -148
- package/vendor/fusion/Instances/defaultProps.luau +194 -194
- package/vendor/fusion/LICENSE +21 -21
- package/vendor/fusion/Logging/formatError.luau +48 -48
- package/vendor/fusion/Logging/messages.luau +51 -51
- package/vendor/fusion/Logging/parseError.luau +24 -24
- package/vendor/fusion/Memory/checkLifetime.luau +133 -133
- package/vendor/fusion/Memory/deriveScope.luau +23 -23
- package/vendor/fusion/Memory/deriveScopeImpl.luau +44 -44
- package/vendor/fusion/Memory/doCleanup.luau +78 -78
- package/vendor/fusion/Memory/innerScope.luau +33 -33
- package/vendor/fusion/Memory/legacyCleanup.luau +17 -17
- package/vendor/fusion/Memory/needsDestruction.luau +16 -16
- package/vendor/fusion/Memory/poisonScope.luau +33 -33
- package/vendor/fusion/Memory/scopePool.luau +54 -54
- package/vendor/fusion/Memory/scoped.luau +26 -26
- package/vendor/fusion/Memory/whichLivesLonger.luau +74 -74
- package/vendor/fusion/RobloxExternal.luau +97 -97
- package/vendor/fusion/State/Computed.luau +138 -138
- package/vendor/fusion/State/For/Disassembly.luau +210 -210
- package/vendor/fusion/State/For/ForTypes.luau +30 -30
- package/vendor/fusion/State/For/init.luau +109 -109
- package/vendor/fusion/State/ForKeys.luau +93 -93
- package/vendor/fusion/State/ForPairs.luau +96 -96
- package/vendor/fusion/State/ForValues.luau +93 -93
- package/vendor/fusion/State/Value.luau +87 -87
- package/vendor/fusion/State/castToState.luau +25 -25
- package/vendor/fusion/State/peek.luau +30 -30
- package/vendor/fusion/Types.luau +314 -314
- package/vendor/fusion/Utility/Contextual.luau +90 -90
- package/vendor/fusion/Utility/Safe.luau +22 -22
- package/vendor/fusion/Utility/isSimilar.luau +29 -29
- package/vendor/fusion/Utility/merge.luau +35 -35
- package/vendor/fusion/Utility/nameOf.luau +34 -34
- package/vendor/fusion/Utility/never.luau +13 -13
- package/vendor/fusion/Utility/nicknames.luau +10 -10
- package/vendor/fusion/Utility/xtypeof.luau +26 -26
- package/vendor/fusion/init.luau +82 -82
- package/vendor/profilestore/init.luau +2242 -2242
- package/vendor/promise/init.luau +1982 -1982
- package/vendor/rbxutil/buffer-util/Buffer.test.luau +25 -25
- package/vendor/rbxutil/buffer-util/BufferReader.luau +228 -228
- package/vendor/rbxutil/buffer-util/BufferWriter.luau +269 -269
- package/vendor/rbxutil/buffer-util/DataTypeBuffer.luau +223 -223
- package/vendor/rbxutil/buffer-util/Types.luau +60 -60
- package/vendor/rbxutil/buffer-util/index.d.ts +153 -153
- package/vendor/rbxutil/buffer-util/init.luau +41 -41
- package/vendor/rbxutil/buffer-util/package.json +16 -16
- package/vendor/rbxutil/buffer-util/wally.toml +9 -9
- package/vendor/rbxutil/comm/Client/ClientComm.luau +232 -232
- package/vendor/rbxutil/comm/Client/ClientRemoteProperty.luau +156 -156
- package/vendor/rbxutil/comm/Client/ClientRemoteSignal.luau +109 -109
- package/vendor/rbxutil/comm/Client/init.luau +135 -135
- package/vendor/rbxutil/comm/Server/RemoteProperty.luau +295 -295
- package/vendor/rbxutil/comm/Server/RemoteSignal.luau +211 -211
- package/vendor/rbxutil/comm/Server/ServerComm.luau +211 -211
- package/vendor/rbxutil/comm/Server/init.luau +140 -140
- package/vendor/rbxutil/comm/Types.luau +18 -18
- package/vendor/rbxutil/comm/Util.luau +27 -27
- package/vendor/rbxutil/comm/init.luau +35 -35
- package/vendor/rbxutil/comm/wally.toml +13 -13
- package/vendor/rbxutil/component/init.luau +759 -759
- package/vendor/rbxutil/component/init.test.luau +311 -311
- package/vendor/rbxutil/component/wally.toml +14 -14
- package/vendor/rbxutil/concur/init.luau +542 -542
- package/vendor/rbxutil/concur/init.test.luau +364 -364
- package/vendor/rbxutil/concur/wally.toml +8 -8
- package/vendor/rbxutil/enum-list/init.luau +101 -101
- package/vendor/rbxutil/enum-list/init.test.luau +91 -91
- package/vendor/rbxutil/enum-list/wally.toml +8 -8
- package/vendor/rbxutil/find/index.d.ts +20 -20
- package/vendor/rbxutil/find/init.luau +44 -44
- package/vendor/rbxutil/find/package.json +17 -17
- package/vendor/rbxutil/find/wally.toml +8 -8
- package/vendor/rbxutil/input/Gamepad.luau +559 -559
- package/vendor/rbxutil/input/Keyboard.luau +124 -124
- package/vendor/rbxutil/input/Mouse.luau +278 -278
- package/vendor/rbxutil/input/PreferredInput.luau +91 -91
- package/vendor/rbxutil/input/Touch.luau +120 -120
- package/vendor/rbxutil/input/init.luau +33 -33
- package/vendor/rbxutil/input/wally.toml +12 -12
- package/vendor/rbxutil/loader/index.d.ts +15 -15
- package/vendor/rbxutil/loader/init.luau +137 -137
- package/vendor/rbxutil/loader/wally.toml +8 -8
- package/vendor/rbxutil/log/index.d.ts +38 -38
- package/vendor/rbxutil/log/init.luau +746 -746
- package/vendor/rbxutil/log/wally.toml +8 -8
- package/vendor/rbxutil/net/init.luau +190 -190
- package/vendor/rbxutil/net/wally.toml +8 -8
- package/vendor/rbxutil/option/index.d.ts +44 -44
- package/vendor/rbxutil/option/init.luau +489 -489
- package/vendor/rbxutil/option/init.test.luau +342 -342
- package/vendor/rbxutil/option/wally.toml +8 -8
- package/vendor/rbxutil/pid/index.d.ts +53 -53
- package/vendor/rbxutil/pid/init.luau +195 -195
- package/vendor/rbxutil/pid/package.json +16 -16
- package/vendor/rbxutil/pid/wally.toml +9 -9
- package/vendor/rbxutil/quaternion/index.d.ts +117 -117
- package/vendor/rbxutil/quaternion/init.luau +570 -570
- package/vendor/rbxutil/quaternion/package.json +16 -16
- package/vendor/rbxutil/quaternion/wally.toml +9 -9
- package/vendor/rbxutil/query/index.d.ts +43 -43
- package/vendor/rbxutil/query/init.luau +117 -117
- package/vendor/rbxutil/query/package.json +18 -18
- package/vendor/rbxutil/query/wally.toml +9 -9
- package/vendor/rbxutil/sequent/index.d.ts +28 -28
- package/vendor/rbxutil/sequent/init.luau +340 -340
- package/vendor/rbxutil/sequent/package.json +16 -16
- package/vendor/rbxutil/sequent/wally.toml +9 -9
- package/vendor/rbxutil/ser/init.luau +175 -175
- package/vendor/rbxutil/ser/init.test.luau +50 -50
- package/vendor/rbxutil/ser/wally.toml +11 -11
- package/vendor/rbxutil/shake/index.d.ts +36 -36
- package/vendor/rbxutil/shake/init.luau +532 -532
- package/vendor/rbxutil/shake/init.test.luau +267 -267
- package/vendor/rbxutil/shake/package.json +16 -16
- package/vendor/rbxutil/shake/wally.toml +9 -9
- package/vendor/rbxutil/signal/index.d.ts +100 -100
- package/vendor/rbxutil/signal/init.luau +432 -432
- package/vendor/rbxutil/signal/init.test.luau +190 -190
- package/vendor/rbxutil/signal/package.json +17 -17
- package/vendor/rbxutil/signal/wally.toml +9 -9
- package/vendor/rbxutil/silo/TableWatcher.luau +65 -65
- package/vendor/rbxutil/silo/Util.luau +55 -55
- package/vendor/rbxutil/silo/init.luau +338 -338
- package/vendor/rbxutil/silo/init.test.luau +215 -215
- package/vendor/rbxutil/silo/wally.toml +8 -8
- package/vendor/rbxutil/spring/index.d.ts +40 -40
- package/vendor/rbxutil/spring/init.luau +97 -97
- package/vendor/rbxutil/spring/package.json +17 -17
- package/vendor/rbxutil/spring/wally.toml +8 -8
- package/vendor/rbxutil/stream/index.d.ts +88 -88
- package/vendor/rbxutil/stream/init.luau +597 -597
- package/vendor/rbxutil/stream/package.json +18 -18
- package/vendor/rbxutil/stream/wally.toml +9 -9
- package/vendor/rbxutil/streamable/Streamable.luau +202 -202
- package/vendor/rbxutil/streamable/StreamableUtil.luau +80 -80
- package/vendor/rbxutil/streamable/init.luau +8 -8
- package/vendor/rbxutil/streamable/wally.toml +12 -12
- package/vendor/rbxutil/symbol/init.luau +56 -56
- package/vendor/rbxutil/symbol/init.test.luau +37 -37
- package/vendor/rbxutil/symbol/wally.toml +8 -8
- package/vendor/rbxutil/table-util/init.luau +938 -938
- package/vendor/rbxutil/table-util/init.test.luau +439 -439
- package/vendor/rbxutil/task-queue/index.d.ts +27 -27
- package/vendor/rbxutil/task-queue/init.luau +97 -97
- package/vendor/rbxutil/task-queue/wally.toml +8 -8
- package/vendor/rbxutil/timer/index.d.ts +81 -81
- package/vendor/rbxutil/timer/init.luau +249 -249
- package/vendor/rbxutil/timer/init.test.luau +73 -73
- package/vendor/rbxutil/timer/wally.toml +11 -11
- package/vendor/rbxutil/tree/index.d.ts +15 -15
- package/vendor/rbxutil/tree/init.luau +137 -137
- package/vendor/rbxutil/tree/wally.toml +8 -8
- package/vendor/rbxutil/trove/index.d.ts +46 -46
- package/vendor/rbxutil/trove/init.luau +787 -787
- package/vendor/rbxutil/trove/init.test.luau +203 -203
- package/vendor/rbxutil/trove/wally.toml +8 -8
- package/vendor/rbxutil/typed-remote/init.luau +196 -196
- package/vendor/rbxutil/typed-remote/wally.toml +8 -8
- package/vendor/rbxutil/wait-for/index.d.ts +17 -17
- package/vendor/rbxutil/wait-for/init.luau +257 -257
- package/vendor/rbxutil/wait-for/init.test.luau +182 -182
- package/vendor/rbxutil/wait-for/wally.toml +11 -11
- package/vendor/t/t.lua +1350 -1350
- package/vendor/testez/Context.lua +26 -26
- package/vendor/testez/Expectation.lua +311 -311
- package/vendor/testez/ExpectationContext.lua +38 -38
- package/vendor/testez/LifecycleHooks.lua +89 -89
- package/vendor/testez/Reporters/TeamCityReporter.lua +101 -101
- package/vendor/testez/Reporters/TextReporter.lua +105 -105
- package/vendor/testez/Reporters/TextReporterQuiet.lua +96 -96
- package/vendor/testez/TestBootstrap.lua +146 -146
- package/vendor/testez/TestEnum.lua +27 -27
- package/vendor/testez/TestPlan.lua +304 -304
- package/vendor/testez/TestPlanner.lua +39 -39
- package/vendor/testez/TestResults.lua +111 -111
- package/vendor/testez/TestRunner.lua +188 -188
- package/vendor/testez/TestSession.lua +243 -243
- package/vendor/testez/init.lua +39 -39
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
[package]
|
|
2
|
-
name = "sleitnick/option"
|
|
3
|
-
description = "Represent optional values in Lua"
|
|
4
|
-
version = "1.0.5"
|
|
5
|
-
license = "MIT"
|
|
6
|
-
authors = ["Stephen Leitnick"]
|
|
7
|
-
registry = "https://github.com/UpliftGames/wally-index"
|
|
8
|
-
realm = "shared"
|
|
1
|
+
[package]
|
|
2
|
+
name = "sleitnick/option"
|
|
3
|
+
description = "Represent optional values in Lua"
|
|
4
|
+
version = "1.0.5"
|
|
5
|
+
license = "MIT"
|
|
6
|
+
authors = ["Stephen Leitnick"]
|
|
7
|
+
registry = "https://github.com/UpliftGames/wally-index"
|
|
8
|
+
realm = "shared"
|
|
@@ -1,53 +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;
|
|
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;
|
|
@@ -1,195 +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
|
-
}
|
|
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
|
+
}
|
|
@@ -1,16 +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
|
-
}
|
|
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
|
+
}
|
|
@@ -1,9 +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"]
|
|
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"]
|