Skip to content

Commit 6bc3e72

Browse files
sammygreyIgnisRBX
andauthored
Update RunService.yaml (#1042)
Added deprecation messages for Heartbeat, RenderStepped, and Stepped. Changed statements in PreRender, PreSimulation, and PostSimulation saying that they are equivalent to RenderStepped, Stepped, and Heartbeat to saying that they are their respective replacements. ## Checks By submitting your pull request for review, you agree to the following: - [X] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [X] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [X] To the best of my knowledge, all proposed changes are accurate. --------- Co-authored-by: IgnisRBX <[email protected]>
1 parent 321787a commit 6bc3e72

File tree

1 file changed

+8
-34
lines changed

1 file changed

+8
-34
lines changed

content/en-us/reference/engine/classes/RunService.yaml

Lines changed: 8 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ events:
618618
summary: |
619619
Fires every frame, prior to the frame being rendered.
620620
description: |
621-
The `PreRender` event (equivalent to
621+
The `PreRender` event (replacement for
622622
`Class.RunService.RenderStepped|RenderStepped`) fires every frame, prior
623623
to the frame being rendered. The `deltaTimeRender` argument indicates the
624624
time that has elapsed since the previous frame.
@@ -653,7 +653,7 @@ events:
653653
summary: |
654654
Fires every frame, prior to the physics simulation.
655655
description: |
656-
The `PreSimulation` event (equivalent to
656+
The `PreSimulation` event (replacement for
657657
`Class.RunService.Stepped|Stepped`) fires every frame, prior to the
658658
physics simulation. The `deltaTimeSim` argument indicates the time that
659659
has elapsed since the previous frame.
@@ -679,25 +679,7 @@ events:
679679
- name: RunService.RenderStepped
680680
summary: |
681681
Fires every frame, prior to the frame being rendered.
682-
description: |
683-
The `RenderStepped` event (equivalent to
684-
`Class.RunService.PreRender|PreRender`) fires every frame, prior to the
685-
frame being rendered. The `deltaTime` argument indicates the time that has
686-
elapsed since the previous frame.
687-
688-
This event allows you to run code and update the world before it's drawn
689-
on a player's screen. This is useful for last‑minute adjustments such as
690-
changing object positions, updating animations, or preparing visual
691-
effects, but it should be used sparingly as the engine cannot start to
692-
render the frame until code running in this event has finished executing.
693-
694-
As `RenderStepped` is client-side, it can only be used in a
695-
`Class.LocalScript`, in a `Class.ModuleScript` required by a
696-
`Class.LocalScript`, or in a `Class.Script` with
697-
`Class.BaseScript.RunContext|RunContext` set to `Enum.RunContext.Client`.
698-
699-
Following the `RenderStepped` phase, the simulation phase begins with the
700-
`Class.RunService.PreAnimation|PreAnimation` event.
682+
description: ''
701683
code_samples: []
702684
parameters:
703685
- name: deltaTime
@@ -706,25 +688,16 @@ events:
706688
summary: |
707689
The time (in seconds) that has elapsed since the previous frame.
708690
tags: []
709-
deprecation_message: ''
691+
deprecation_message: |
692+
This event has been superseded by `Class.RunService.PreRender|PreRender` which should be used for new work.
710693
security: None
711694
thread_safety: Unsafe
712695
capabilities: []
713696
writeCapabilities: []
714697
- name: RunService.Stepped
715698
summary: |
716699
Fires every frame, prior to the physics simulation.
717-
description: |
718-
The `Stepped` event (equivalent to
719-
`Class.RunService.PreSimulation|PreSimulation`) fires every frame, prior
720-
to the physics simulation. The `deltaTime` argument indicates the time
721-
that has elapsed since the previous frame.
722-
723-
This event is useful for adjusting properties like velocity or forces just
724-
before they're applied as part of the simulation. The simulation then
725-
runs, potentially multiple times, as the physics solver runs at a higher
726-
frequency than other engine systems. Once this is complete, the
727-
`Class.RunService.PostSimulation|PostSimulation` event is fired.
700+
description: ''
728701
code_samples: []
729702
parameters:
730703
- name: time
@@ -739,7 +712,8 @@ events:
739712
summary: |
740713
The time (in seconds) that has elapsed since the previous frame.
741714
tags: []
742-
deprecation_message: ''
715+
deprecation_message: |
716+
This event has been superseded by `Class.RunService.PreSimulation|PreSimulation` which should be used for new work.
743717
security: None
744718
thread_safety: Unsafe
745719
capabilities: []

0 commit comments

Comments
 (0)