Skip to content

Commit eeb311c

Browse files
authored
Update RunService.yaml
1 parent 5dd0f6e commit eeb311c

File tree

1 file changed

+10
-34
lines changed

1 file changed

+10
-34
lines changed

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

Lines changed: 10 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -566,13 +566,13 @@ events:
566566
summary: |
567567
Fires every frame, after the physics simulation has completed.
568568
description: |
569-
The `PostSimulation` event (replacement for
570-
`Class.RunService.Heartbeat|Heartbeat`) fires every frame, after the physics simulation
569+
The `PostSimulation` event fires every frame, after the physics simulation
571570
has completed. The `deltaTimeSim` argument indicates the time that has
572571
elapsed since the previous frame.
573572
574573
This event is useful for making final adjustments to the outcome of the
575-
simulation.
574+
simulation. Following this phase, the engine triggers the
575+
`Class.RunService.Heartbeat|Heartbeat` event.
576576
code_samples:
577577
parameters:
578578
- name: deltaTimeSim
@@ -671,32 +671,15 @@ events:
671671
summary: |
672672
The time (in seconds) that has elapsed since the previous frame.
673673
tags: []
674-
deprecation_message: 'This event has been superceded by <code>Class.RunService.PreRender|PreRender</code>.'
674+
deprecation_message: ''
675675
security: None
676676
thread_safety: Unsafe
677677
capabilities: []
678678
writeCapabilities: []
679679
- name: RunService.RenderStepped
680680
summary: |
681681
Fires every frame, prior to the frame being rendered.
682-
description: |
683-
The `RenderStepped` event fires every frame, prior to the
684-
frame being rendered. The `deltaTime` argument indicates the time that has
685-
elapsed since the previous frame.
686-
687-
This event allows you to run code and update the world before it's drawn
688-
on a player's screen. This is useful for last‑minute adjustments such as
689-
changing object positions, updating animations, or preparing visual
690-
effects, but it should be used sparingly as the engine cannot start to
691-
render the frame until code running in this event has finished executing.
692-
693-
As `RenderStepped` is client-side, it can only be used in a
694-
`Class.LocalScript`, in a `Class.ModuleScript` required by a
695-
`Class.LocalScript`, or in a `Class.Script` with
696-
`Class.BaseScript.RunContext|RunContext` set to `Enum.RunContext.Client`.
697-
698-
Following the `RenderStepped` phase, the simulation phase begins with the
699-
`Class.RunService.Stepped|Stepped` event.
682+
description: ''
700683
code_samples: []
701684
parameters:
702685
- name: deltaTime
@@ -705,24 +688,16 @@ events:
705688
summary: |
706689
The time (in seconds) that has elapsed since the previous frame.
707690
tags: []
708-
deprecation_message: 'This event has been superceded by <code>Class.RunService.PreSimulation|PreSimulation</code>.'
691+
deprecation_message: |
692+
This event has been superseded by `Class.RunService.PreRender|PreRender` which should be used for new work.
709693
security: None
710694
thread_safety: Unsafe
711695
capabilities: []
712696
writeCapabilities: []
713697
- name: RunService.Stepped
714698
summary: |
715699
Fires every frame, prior to the physics simulation.
716-
description: |
717-
The `Stepped` event fires every frame, prior
718-
to the physics simulation. The `deltaTime` argument indicates the time
719-
that has elapsed since the previous frame.
720-
721-
This event is useful for adjusting properties like velocity or forces just
722-
before they're applied as part of the simulation. The simulation then
723-
runs, potentially multiple times, as the physics solver runs at a higher
724-
frequency than other engine systems. Once this is complete, the
725-
`Class.RunService.Heartbeat|Heartbeat` event is fired.
700+
description: ''
726701
code_samples: []
727702
parameters:
728703
- name: time
@@ -737,7 +712,8 @@ events:
737712
summary: |
738713
The time (in seconds) that has elapsed since the previous frame.
739714
tags: []
740-
deprecation_message: ''
715+
deprecation_message: |
716+
This event has been superseded by `Class.RunService.PreSimulation|PreSimulation` which should be used for new work.
741717
security: None
742718
thread_safety: Unsafe
743719
capabilities: []

0 commit comments

Comments
 (0)