Skip to content

Commit a0d7f41

Browse files
authored
Update RunService.yaml
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.
1 parent 321787a commit a0d7f41

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

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

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ methods:
525525
- type: void
526526
summary: ''
527527
tags: []
528-
deprecation_message: ''
528+
deprecation_message: 'This event has been superceded by <code>Class.RunService.PostSimulation|PostSimulation</code>.'
529529
security: None
530530
thread_safety: Unsafe
531531
capabilities: []
@@ -566,13 +566,13 @@ events:
566566
summary: |
567567
Fires every frame, after the physics simulation has completed.
568568
description: |
569-
The `PostSimulation` event fires every frame, after the physics simulation
569+
The `PostSimulation` event (replacement for
570+
`Class.RunService.Heartbeat|Heartbeat`) fires every frame, after the physics simulation
570571
has completed. The `deltaTimeSim` argument indicates the time that has
571572
elapsed since the previous frame.
572573
573574
This event is useful for making final adjustments to the outcome of the
574-
simulation. Following this phase, the engine triggers the
575-
`Class.RunService.Heartbeat|Heartbeat` event.
575+
simulation.
576576
code_samples:
577577
parameters:
578578
- name: deltaTimeSim
@@ -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.
@@ -671,7 +671,7 @@ events:
671671
summary: |
672672
The time (in seconds) that has elapsed since the previous frame.
673673
tags: []
674-
deprecation_message: ''
674+
deprecation_message: ''This event has been superceded by <code>Class.RunService.PreRender|PreRender</code>.''
675675
security: None
676676
thread_safety: Unsafe
677677
capabilities: []
@@ -680,8 +680,7 @@ events:
680680
summary: |
681681
Fires every frame, prior to the frame being rendered.
682682
description: |
683-
The `RenderStepped` event (equivalent to
684-
`Class.RunService.PreRender|PreRender`) fires every frame, prior to the
683+
The `RenderStepped` event fires every frame, prior to the
685684
frame being rendered. The `deltaTime` argument indicates the time that has
686685
elapsed since the previous frame.
687686
@@ -697,7 +696,7 @@ events:
697696
`Class.BaseScript.RunContext|RunContext` set to `Enum.RunContext.Client`.
698697
699698
Following the `RenderStepped` phase, the simulation phase begins with the
700-
`Class.RunService.PreAnimation|PreAnimation` event.
699+
`Class.RunService.Stepped|Stepped` event.
701700
code_samples: []
702701
parameters:
703702
- name: deltaTime
@@ -706,7 +705,7 @@ events:
706705
summary: |
707706
The time (in seconds) that has elapsed since the previous frame.
708707
tags: []
709-
deprecation_message: ''
708+
deprecation_message: 'This event has been superceded by <code>Class.RunService.PreSimulation|PreSimulation</code>.'
710709
security: None
711710
thread_safety: Unsafe
712711
capabilities: []
@@ -715,16 +714,15 @@ events:
715714
summary: |
716715
Fires every frame, prior to the physics simulation.
717716
description: |
718-
The `Stepped` event (equivalent to
719-
`Class.RunService.PreSimulation|PreSimulation`) fires every frame, prior
717+
The `Stepped` event fires every frame, prior
720718
to the physics simulation. The `deltaTime` argument indicates the time
721719
that has elapsed since the previous frame.
722720
723721
This event is useful for adjusting properties like velocity or forces just
724722
before they're applied as part of the simulation. The simulation then
725723
runs, potentially multiple times, as the physics solver runs at a higher
726724
frequency than other engine systems. Once this is complete, the
727-
`Class.RunService.PostSimulation|PostSimulation` event is fired.
725+
`Class.RunService.Heartbeat|Heartbeat` event is fired.
728726
code_samples: []
729727
parameters:
730728
- name: time

0 commit comments

Comments
 (0)