@quenty/steputils 3.6.3 → 3.7.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.
Files changed (3) hide show
  1. package/CHANGELOG.md +20 -94
  2. package/package.json +2 -2
  3. package/src/Shared/StepUtils.lua +30 -3
package/CHANGELOG.md CHANGED
@@ -3,187 +3,113 @@
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](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.6.2...@quenty/steputils@3.6.3) (2026-01-12)
7
-
6
+ # [3.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.6.3...@quenty/steputils@3.7.0) (2026-07-23)
8
7
 
9
8
  ### Bug Fixes
10
9
 
11
- * Fix dependency installation process for pnpm ([9651b09](https://github.com/Quenty/NevermoreEngine/commit/9651b09af34f252ef3f9c7c539793cc878dd8cba))
10
+ - Cleanup code a bit ([fa8c596](https://github.com/Quenty/NevermoreEngine/commit/fa8c596544e45610e180f5ae3797154f35930ccd))
11
+
12
+ ### Features
12
13
 
14
+ - Add baseline player-mock and support across Nevermore for mocked players. ([567d121](https://github.com/Quenty/NevermoreEngine/commit/567d121ffc014b42391554088189a1a6296dda83))
13
15
 
16
+ ## [3.6.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.6.2...@quenty/steputils@3.6.3) (2026-01-12)
14
17
 
18
+ ### Bug Fixes
15
19
 
20
+ - Fix dependency installation process for pnpm ([9651b09](https://github.com/Quenty/NevermoreEngine/commit/9651b09af34f252ef3f9c7c539793cc878dd8cba))
16
21
 
17
22
  ## [3.6.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.6.1...@quenty/steputils@3.6.2) (2026-01-10)
18
23
 
19
24
  **Note:** Version bump only for package @quenty/steputils
20
25
 
21
-
22
-
23
-
24
-
25
26
  ## [3.6.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.6.0...@quenty/steputils@3.6.1) (2026-01-03)
26
27
 
27
28
  **Note:** Version bump only for package @quenty/steputils
28
29
 
29
-
30
-
31
-
32
-
33
30
  # [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.5.5...@quenty/steputils@3.6.0) (2025-05-10)
34
31
 
35
32
  **Note:** Version bump only for package @quenty/steputils
36
33
 
37
-
38
-
39
-
40
-
41
34
  ## [3.5.5](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.5.3...@quenty/steputils@3.5.5) (2025-04-07)
42
35
 
43
-
44
36
  ### Bug Fixes
45
37
 
46
- * Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
47
- * Bump package versions for republishing ([ba47c62](https://github.com/Quenty/NevermoreEngine/commit/ba47c62e32170bf74377b0c658c60b84306dc294))
48
-
49
-
50
-
51
-
38
+ - Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
39
+ - Bump package versions for republishing ([ba47c62](https://github.com/Quenty/NevermoreEngine/commit/ba47c62e32170bf74377b0c658c60b84306dc294))
52
40
 
53
41
  ## [3.5.4](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.5.3...@quenty/steputils@3.5.4) (2025-04-07)
54
42
 
55
-
56
43
  ### Bug Fixes
57
44
 
58
- * Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
59
-
60
-
61
-
62
-
45
+ - Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
63
46
 
64
47
  ## [3.5.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.5.2...@quenty/steputils@3.5.3) (2025-03-21)
65
48
 
66
49
  **Note:** Version bump only for package @quenty/steputils
67
50
 
68
-
69
-
70
-
71
-
72
51
  ## [3.5.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.5.1...@quenty/steputils@3.5.2) (2024-10-09)
73
52
 
74
-
75
53
  ### Bug Fixes
76
54
 
77
- * Deprecate a large set of APIs ([#506](https://github.com/Quenty/NevermoreEngine/issues/506)) ([d6bdd65](https://github.com/Quenty/NevermoreEngine/commit/d6bdd6567668f238c45d3bd0c85bedb763d30e5c))
78
-
79
-
80
-
81
-
55
+ - Deprecate a large set of APIs ([#506](https://github.com/Quenty/NevermoreEngine/issues/506)) ([d6bdd65](https://github.com/Quenty/NevermoreEngine/commit/d6bdd6567668f238c45d3bd0c85bedb763d30e5c))
82
56
 
83
57
  ## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.5.0...@quenty/steputils@3.5.1) (2024-10-04)
84
58
 
85
59
  **Note:** Version bump only for package @quenty/steputils
86
60
 
87
-
88
-
89
-
90
-
91
61
  # [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.4.0...@quenty/steputils@3.5.0) (2024-09-25)
92
62
 
93
63
  **Note:** Version bump only for package @quenty/steputils
94
64
 
95
-
96
-
97
-
98
-
99
65
  # [3.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.3.0...@quenty/steputils@3.4.0) (2024-05-09)
100
66
 
101
-
102
67
  ### Bug Fixes
103
68
 
104
- * Fix .package-lock.json replicating in packages ([75d0efe](https://github.com/Quenty/NevermoreEngine/commit/75d0efeef239f221d93352af71a5b3e930ec23c5))
105
-
106
-
107
-
108
-
69
+ - Fix .package-lock.json replicating in packages ([75d0efe](https://github.com/Quenty/NevermoreEngine/commit/75d0efeef239f221d93352af71a5b3e930ec23c5))
109
70
 
110
71
  # [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.2.0...@quenty/steputils@3.3.0) (2023-09-04)
111
72
 
112
-
113
73
  ### Features
114
74
 
115
- * Add StepUtils.deferWait() ([caac896](https://github.com/Quenty/NevermoreEngine/commit/caac896fc8439d0de87245cf4bdcb534ba2a9efe))
116
-
117
-
118
-
119
-
75
+ - Add StepUtils.deferWait() ([caac896](https://github.com/Quenty/NevermoreEngine/commit/caac896fc8439d0de87245cf4bdcb534ba2a9efe))
120
76
 
121
77
  # [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.1.0...@quenty/steputils@3.2.0) (2022-10-11)
122
78
 
123
-
124
79
  ### Features
125
80
 
126
- * Add StepUtils.bindToStepped ([f49f70d](https://github.com/Quenty/NevermoreEngine/commit/f49f70d870fa9fd8276a9cb0056a40ebeb85c049))
127
-
128
-
129
-
130
-
81
+ - Add StepUtils.bindToStepped ([f49f70d](https://github.com/Quenty/NevermoreEngine/commit/f49f70d870fa9fd8276a9cb0056a40ebeb85c049))
131
82
 
132
83
  # [3.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.0.1...@quenty/steputils@3.1.0) (2022-03-27)
133
84
 
134
85
  **Note:** Version bump only for package @quenty/steputils
135
86
 
136
-
137
-
138
-
139
-
140
87
  ## [3.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.0.0...@quenty/steputils@3.0.1) (2021-12-30)
141
88
 
142
89
  **Note:** Version bump only for package @quenty/steputils
143
90
 
144
-
145
-
146
-
147
-
148
91
  # [3.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@2.0.0...@quenty/steputils@3.0.0) (2021-09-11)
149
92
 
150
-
151
93
  ### Features
152
94
 
153
- * Add new methods to StepUtils ([738712a](https://github.com/Quenty/NevermoreEngine/commit/738712a3fea2ccf5ba1d479749d6db73d28a0902))
154
-
155
-
156
-
157
-
95
+ - Add new methods to StepUtils ([738712a](https://github.com/Quenty/NevermoreEngine/commit/738712a3fea2ccf5ba1d479749d6db73d28a0902))
158
96
 
159
97
  # [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@1.2.0...@quenty/steputils@2.0.0) (2021-09-05)
160
98
 
161
-
162
99
  ### Bug Fixes
163
100
 
164
- * Remove peer dependencies. This is because lerna doesn't really support peer dependencies being linked and getting a new version on build, which is unfortunate. ([5f5aeee](https://github.com/Quenty/NevermoreEngine/commit/5f5aeeea8de9975435309e53679f0ef7064f9dd0))
165
-
166
-
167
-
168
-
101
+ - Remove peer dependencies. This is because lerna doesn't really support peer dependencies being linked and getting a new version on build, which is unfortunate. ([5f5aeee](https://github.com/Quenty/NevermoreEngine/commit/5f5aeeea8de9975435309e53679f0ef7064f9dd0))
169
102
 
170
103
  # 1.2.0 (2021-07-31)
171
104
 
172
-
173
105
  ### Bug Fixes
174
106
 
175
- * Add CI and CD ([47513e9](https://github.com/Quenty/NevermoreEngine/commit/47513e9b568162707534af132396dd8756947dd3))
176
- * Adjust CI badge to show automatic build and release state ([5a55d3f](https://github.com/Quenty/NevermoreEngine/commit/5a55d3f19bf8d66a760d67da9b56ed47fab74656))
177
- * Fix selene linting ([45fc074](https://github.com/Quenty/NevermoreEngine/commit/45fc07489ee59127ac6582689f19a0e87c1e5b5a))
178
-
179
-
107
+ - Add CI and CD ([47513e9](https://github.com/Quenty/NevermoreEngine/commit/47513e9b568162707534af132396dd8756947dd3))
108
+ - Adjust CI badge to show automatic build and release state ([5a55d3f](https://github.com/Quenty/NevermoreEngine/commit/5a55d3f19bf8d66a760d67da9b56ed47fab74656))
109
+ - Fix selene linting ([45fc074](https://github.com/Quenty/NevermoreEngine/commit/45fc07489ee59127ac6582689f19a0e87c1e5b5a))
180
110
 
181
111
  ## 1.0.2 (2021-07-25)
182
112
 
183
-
184
-
185
113
  ## 1.0.1 (2021-07-25)
186
114
 
187
-
188
-
189
115
  # 1.0.0 (2021-07-24)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quenty/steputils",
3
- "version": "3.6.3",
3
+ "version": "3.7.0",
4
4
  "description": "Binds animations into step, where the animation only runs as needed",
5
5
  "keywords": [
6
6
  "Roblox",
@@ -30,5 +30,5 @@
30
30
  "publishConfig": {
31
31
  "access": "public"
32
32
  },
33
- "gitHead": "55f4a7407de7247aceea574de4d2f57dab70cb91"
33
+ "gitHead": "1de37218a2bedb8e3f8614a2e09bba9eddc812da"
34
34
  }
package/src/Shared/StepUtils.lua CHANGED
@@ -10,7 +10,34 @@ local RunService = game:GetService("RunService")
10
10
  local StepUtils = {}
11
11
 
12
12
  --[=[
13
- Binds the given update function to [RunService.RenderStepped].
13
+ Returns the signal animation should step on: [RunService.RenderStepped] on the client,
14
+ [RunService.Stepped] (the physics pre-step) on a running server so that writes land before
15
+ the physics step -- springs that drive CFrames stay in lockstep with constraints, characters,
16
+ and replication. Heartbeat is only the fallback for a non-running DataModel (headless test
17
+ runs, edit mode), where Stepped never fires.
18
+
19
+ Use this instead of hand-rolling the realm branch at call sites.
20
+
21
+ :::caution
22
+ The argument shape is realm-dependent: RenderStepped fires `(deltaTime)` but Stepped fires
23
+ `(time, deltaTime)`. Shared code connecting directly to this signal must not assume the
24
+ first argument is deltaTime.
25
+ :::
26
+
27
+ @return RBXScriptSignal
28
+ ]=]
29
+ function StepUtils.getAnimationStepSignal(): RBXScriptSignal
30
+ if RunService:IsClient() then
31
+ return RunService.RenderStepped
32
+ elseif RunService:IsRunning() then
33
+ return RunService.Stepped
34
+ else
35
+ return RunService.Heartbeat
36
+ end
37
+ end
38
+
39
+ --[=[
40
+ Binds the given update function to [StepUtils.getAnimationStepSignal].
14
41
 
15
42
  ```lua
16
43
  local spring = Spring.new(0)
@@ -37,7 +64,7 @@ local StepUtils = {}
37
64
  @return () -> () -- Disconnect function
38
65
  ]=]
39
66
  function StepUtils.bindToRenderStep(update: () -> boolean): (() -> (), () -> ())
40
- return StepUtils.bindToSignal(RunService.RenderStepped, update)
67
+ return StepUtils.bindToSignal(StepUtils.getAnimationStepSignal(), update)
41
68
  end
42
69
 
43
70
  --[=[
@@ -183,7 +210,7 @@ end
183
210
  @return function -- Call this function to cancel call
184
211
  ]=]
185
212
  function StepUtils.onceAtRenderStepped(func: () -> ()): () -> ()
186
- local conn = RunService.RenderStepped:Once(func)
213
+ local conn = StepUtils.getAnimationStepSignal():Once(func)
187
214
  return function()
188
215
  conn:Disconnect()
189
216
  end