Using the Rewind Debugger, you can record a gameplay segment of a project during runtime, and rewind the simulation to observe information about animation behaviors and interactions. Building off of the Animation Insights foundation, the Rewind Debugger provides a refreshed visual interface to debug animation content in Unreal Engine.
Prerequisites
Enable the Animation Insights plugin. Navigate in the Menu Bar to Edit > Plugins and locate Animation Insights in the Animation section, or use the Search Bar. Enable the plugin and restart the editor.
Overview
When working with character animation systems in Unreal Engine, it can be difficult to isolate the source of a bug. Using the Rewind Debugger, you can record a segment of gameplay, and then scrub through the recording to debug animation content in a more functional and stable work environment.
Animation data is represented visually, on tracks that populate the Rewind Debugger Timeline after selecting a target object. The Rewind Debugger tracks can contain information about Animation Blueprints, Sequence playback, animation variables, notifies and more.
To open the Rewind Debugger window, navigate in the Menu Bar to Tools > Debug > Rewind Debugger.
You can view more precise animation data in the Rewind Debugger Details panel, after selecting a track from the Rewind Debugger Timeline. To open the Rewind Debugger Details panel, navigate in the Menu Bar to Tools > Debug > Rewind Debugger Details.
Rewind Debugger Interface
The Rewind Debugger panel is populated with a unique interface you can use to observe animation data while navigating recorded gameplay segments.
|
Feature |
Image |
Description |
|---|---|---|
|
1. Project Simulation Controls |
|
Controls the project's simulation with features such as Play, Pause, and Stop. For more information, refer to the Unreal Editor Interface documentation. |
|
2. Rewind Debugger Camera Menu |
|
Select the camera behavior for the gameplay recording playback. The Camera Modes are as follows:
This option does not track the selected object, it moves the camera based on the same movement data as the character.
Eject the player control in the Project Simulation Controls before attempting to change the Camera Control Mode. |
|
3. Object Outliner |
|
After recording a gameplay segment, you can choose a game object from the Object Outliner dropdown menu to populate the Rewind Debugger panel. After selecting a game object, the Object Outliner lists the selected object, and all child objects and components, including any that are created or destroyed during runtime as well as any attached controllers. The Object Outline has the following tools you can use to assist in selecting game objects to debug, and in filtering their connected components.
Some game objects are composed of many components, such as a [Movement Component](understanding-the-basics\components\movement-components) , Animation Blueprints, and more. Each of these components is listed as a child object in the Object Outliner with an associated track in the Rewind Debugger Timeline, and must be selected individually to see their respective data within the Rewind Debugger Details panel.
|
|
4. Playback Controls |
|
Lets you control the playback of the recorded gameplay segment. You can Start and Stop the recording with the Record Button, as well as Play, Pause, and Scrub through the Rewind Debugger Timeline. |
|
5. Rewind Debugger Timeline |
|
After selecting a game object to debug, the Rewind Debugger Timeline populates with the selected game object's components and child objects. Each component or child object is given a track where you can visually see changes in its data, variables, and curve values during the recorded gameplay segment. You can select a track in the Rewind Debugger Timeline to observe more precise animation data values in the Rewind Debugger Details panel. By clicking and dragging the red playhead, you can scrub through the Timeline manually to observe the animation data changes in the Rewind Debugger Details Panel and Viewport simultaneously. |
|
**6. Rewind Debugger Details Panel |
|
The Rewind Debugger Details panel displays all available data depending on the selected track in the Rewind Debugger Timeline and the position on the Timeline. Displayed information can include variable values, boolean states, and more. Depending on the track you have selected in the Rewind Debugger Timeline, contextual data populates the panel. You can open the Rewind Debugger Details panel by navigating in the Menu Bar to Tools > Debug > Rewind Debugger Details. |
Using the Rewind Debugger
To use the Rewind Debugger, first start the game simulation by clicking the Green Play Button in the Project Simulation Controls.
Click Record in the Rewind Debugger Playback controls to begin recording the project simulation.
To disconnect your cursor from the simulation, without stopping or pausing the simulation, use the hot key Shift + F1.
When you have recorded a gameplay segment, pause the simulation and eject the camera using the Project Simulation Controls.
![in the simulation controls pause and then eject the game controller]()
The recording stops automatically when the simulation is paused.
The recorded section of gameplay is now prepared for use. You can begin debugging game objects by selecting a game object from the Object Outliner or by selecting your game object in the Viewport using the Dropper tool.
After selecting a game object, the Rewind Debugger Timeline contextually populates with tracks of animation data relevant to the game object's components and child objects. You can scrub through the Rewind Debugger Timeline with the Playhead or the Playback Controls, to see how the recorded animation data updates the game object in the Viewport.
For a quick readout of animation data values in the Timeline, hover over a timeline track to see a readout of the current value of the animation track at the position in time of the recorded segment.
Within the Rewind Debugger Menu you can also select a different Camera Mode to obtain a different view of the subject while debugging. For example, with the Disabled option, you can detach the camera and position it freely and observe your game object from any angle to assist in your workflow.
After making edits to your game object or animation system, you can simply reattach the game controller using the controller icon in the Project Simulation Controls, and resume the game to continue debugging. The Rewind Debugger continues recording gameplay when the game simulation is resumed, unless manually stopped.
Animation Blueprints
After obtaining a recorded gameplay segment you can double-click an Animation Blueprint component in the Object Outliner to open and attach the Animation Blueprint Editor in a new window. While scrubbing through the recorded segment, the Animation Blueprint Editor displays the recorded state of the selected Animation Blueprint corresponding to the recorded moment of the game object.
With this functionality, you can observe how the animation blueprint produces the Output pose at any moment of the recorded gameplay segment. You can observe Animation Blueprint nodes, variables, state machine positions and more.
Pose Watch
While within an Animation Blueprint, you can enable pose watching on Animation Blueprint Nodes to see each node's effect on the Output Animation Pose during the recorded gameplay. This can be extremely useful for understanding what influence each node has on the object's animation during the gameplay recording.
Animation Blueprint Nodes must be enabled to Pose Watch, before the Rewind Debugger records a segment of gameplay. Pose Watching can then be toggled while using the recorded gameplay segment.
Rewind Debugger Settings
Here you can reference the Rewind Debugger Settings, accessed in Unreal Engine's Project Settings. Open the Project Settings by selecting Edit > Project Settings in the menu. The Rewind Debugger Settings section is listed under the Plugins category.
|
Setting |
Description |
|---|---|
|
Camera Mode |
Here you can view the current, saved Camera Mode. You can set the saved Camera Mode option within the settings, or within the Rewind Debugger Camera Menu. You can select from the following camera options:
This option does not track the selected object, it moves the camera based on the same movement data as the character.
|
|
Should Auto Record on PIE (Play In Editor) |
When enabled, the Rewind Debugger will automatically record gameplay when the game simulation has begun, as long as the Rewind Debugger is open. When disabled, gameplay recording will need to be manually activated. |
|
Show Empty Object Tracks |
When enabled, empty animation data tracks will still be visible in the Rewind Debugger Timeline. When disabled, all empty tracks will be hidden. |
Extensibility
The Rewind Debugger's uses extend beyond the version packaged with the Animation Insights plugin. Teams can build and add their own custom tracks to Rewind Debugger to display their project specific components or gameplay elements.
An example of how the Rewind Debugger can be modified to fit a project's specific needs can be seen in the Pose Search plugin with unique debug tools designed for working with Pose Searching animations.
With both plugins installed, a custom Pose Search track is added to the Rewind Debugger when the selected character uses the Pose Searching node, which contains expanded Pose Search animation data to assist with debugging.
You can try out the Pose Searching feature, but it is Experimental, and we do not recommend shipping projects with it.