From a4bf9d857dda7aa8165e6d7b453c80d4ae80052b Mon Sep 17 00:00:00 2001 From: ColRealPro <64316078+ColRealPro@users.noreply.github.com> Date: Mon, 21 Apr 2025 17:50:37 -0500 Subject: [PATCH 1/3] Update RunService.yaml --- content/en-us/reference/engine/classes/RunService.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en-us/reference/engine/classes/RunService.yaml b/content/en-us/reference/engine/classes/RunService.yaml index 867f36c4c..817639ca4 100644 --- a/content/en-us/reference/engine/classes/RunService.yaml +++ b/content/en-us/reference/engine/classes/RunService.yaml @@ -669,7 +669,7 @@ events: type: double default: summary: | - The time (in seconds) that has elapsed since the previous frame. + The time (in seconds) that has elapsed since the previous simulation step. tags: [] deprecation_message: '' security: None From 517c47aab3c625bdaf4e5e8be32185a51cfe7f73 Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Wed, 23 Apr 2025 06:35:17 -1000 Subject: [PATCH 2/3] Update RunService.yaml --- .../reference/engine/classes/RunService.yaml | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/content/en-us/reference/engine/classes/RunService.yaml b/content/en-us/reference/engine/classes/RunService.yaml index 817639ca4..52263494c 100644 --- a/content/en-us/reference/engine/classes/RunService.yaml +++ b/content/en-us/reference/engine/classes/RunService.yaml @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -669,7 +672,8 @@ events: type: double default: summary: | - The time (in seconds) that has elapsed since the previous simulation step. + The time (in seconds) that the current frame will step the physics + simulation, not accounting for physics throttling. tags: [] deprecation_message: '' security: None From 4b5b8f5086e431d59fcbaaed664b85d05de1313c Mon Sep 17 00:00:00 2001 From: IgnisRBX <43388550+IgnisRBX@users.noreply.github.com> Date: Thu, 24 Apr 2025 05:39:18 -1000 Subject: [PATCH 3/3] Update RunService.yaml --- .../reference/engine/classes/RunService.yaml | 25 ++++++++++++------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/content/en-us/reference/engine/classes/RunService.yaml b/content/en-us/reference/engine/classes/RunService.yaml index 52263494c..5b5a72bed 100644 --- a/content/en-us/reference/engine/classes/RunService.yaml +++ b/content/en-us/reference/engine/classes/RunService.yaml @@ -683,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 @@ -692,9 +698,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.PreRender|PreRender` - which should be used for new work. + deprecation_message: '' security: None thread_safety: Unsafe capabilities: [] @@ -702,7 +706,13 @@ events: - 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 @@ -717,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: []