Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 27 additions & 16 deletions content/en-us/reference/engine/classes/RunService.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -567,8 +567,9 @@ events:
Fires every frame, after the physics simulation has completed.
description: |
The `PostSimulation` event fires every frame, after the physics simulation
has completed. The `deltaTimeSim` argument indicates the time that has
elapsed since the previous frame.
has completed. The `deltaTimeSim` argument indicates the time that the
current frame has stepped the physics simulation, not accounting for
physics throttling.

This event is useful for making final adjustments to the outcome of the
simulation. Following this phase, the engine triggers the
Expand All @@ -579,7 +580,8 @@ events:
type: double
default:
summary: |
The time (in seconds) that has elapsed since the previous frame.
The time (in seconds) that the current frame has stepped the physics
simulation, not accounting for physics throttling.
tags: []
deprecation_message: ''
security: None
Expand All @@ -592,7 +594,7 @@ events:
description: |
The `PreAnimation` event fires every frame, prior to the physics
simulation but after rendering. The `deltaTimeSim` argument indicates the
time that has elapsed since the previous frame.
time that the current frame has stepped animations.

This event is useful for modifying animation objects, such as adjusting
their speed or priority. Once the `PreAnimation` event is complete, the
Expand All @@ -607,7 +609,7 @@ events:
type: double
default:
summary: |
The time (in seconds) that has elapsed since the previous frame.
The time (in seconds) that the current frame has stepped animations.
tags: []
deprecation_message: ''
security: None
Expand Down Expand Up @@ -656,7 +658,8 @@ events:
The `PreSimulation` event (replacement for
`Class.RunService.Stepped|Stepped`) fires every frame, prior to the
physics simulation. The `deltaTimeSim` argument indicates the time that
has elapsed since the previous frame.
the current frame will step the physics simulation, not accounting for
physics throttling.

This event is useful for adjusting properties like velocity or forces just
before they're applied as part of the simulation. The simulation then
Expand All @@ -669,7 +672,8 @@ events:
type: double
default:
summary: |
The time (in seconds) that has elapsed since the previous frame.
The time (in seconds) that the current frame will step the physics
simulation, not accounting for physics throttling.
tags: []
deprecation_message: ''
security: None
Expand All @@ -679,7 +683,13 @@ events:
- name: RunService.RenderStepped
summary: |
Fires every frame, prior to the frame being rendered.
description: ''
description: |
Fires every frame, prior to the frame being rendered.

##### Migration Note

This event has been superseded by `Class.RunService.PreRender|PreRender`
which should be used for new work.
code_samples: []
parameters:
- name: deltaTime
Expand All @@ -688,17 +698,21 @@ events:
summary: |
The time (in seconds) that has elapsed since the previous frame.
tags: []
deprecation_message: |
This event has been superseded by `Class.RunService.PreRender|PreRender`
which should be used for new work.
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
writeCapabilities: []
- name: RunService.Stepped
summary: |
Fires every frame, prior to the physics simulation.
description: ''
description: |
Fires every frame, prior to the physics simulation.

##### Migration Note

This event has been superseded by `Class.RunService.PreSimulation|PreSimulation`
which should be used for new work.
code_samples: []
parameters:
- name: time
Expand All @@ -713,10 +727,7 @@ events:
summary: |
The time (in seconds) that has elapsed since the previous frame.
tags: []
deprecation_message: |
This event has been superseded by
`Class.RunService.PreSimulation|PreSimulation` which should be used for
new work.
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
Expand Down