Recorded Animations

This feature does not function in the Gearbox HEK release.

Introduction

Recorded animations are a simple way for designers to animate a scene using ingame tools without any need for animating a scene in 3D modeling software. This feature allows you to record your inputs and save them for playback. They can then be invoked through a script to have a unit play out the prerecorded inputs. We will go over how recorded animations in the toolset works.

Be warned that recordings done after reloading a scenario in Sapien may cause stability issues. Try to keep it to your first scenario load.

Entering scripted camera mode

You will need to set your editor mode so that we can start using recording commands. Find the toolbar in the top left and select the camera icon. This will set your Sapien instance to scripted camera mode.

Make sure you've selected this. You won't be able to use any of the hotkeys said below if you aren't using this mode.

Some additional notes for this section. There are some new hotkeys you gain access to in this mode:

  • A: Toggle "Attach camera to unit" option.
  • E: Toggle "Edit camera point" option.
  • C: Toggle "Scripted camera control".
  • Space: Current game view camera position is used to create a new camera point if "Edit camera point" is disabled. If "Edit camera point" is enabled then it instead moves the "Active camera point" to the current position of the game view camera.

Taking over a unit

We will need to pick a unit for us to take over. A unit here is typically a biped or a biped in a vehicle placed in your scene. Look over to your game window and look at a biped you wish to take over. Once you've made your choice go ahead and left click on the biped directly. A sphere should encircle the biped and gradually shrink. This indicates that you have selected the unit.

Do not attempt to select the unit from the hierarchy list. You must select the unit from the game window screen.

Once the unit is selected you can press the following keys to take over the unit:

  • Shift + V: Some additional notes for this section. There are some new hotkeys you gain access to in this mode.
  • Backspace: Toggle "Camera type". Pressing this key will cycle between 3 modes for your camera.
    • First Person
    • Third Person
    • Flycam

Begin recording

Now that you've taken over the unit you should see a view that looks pretty similar to a standard ingame session. Press the Caps lock key to start recording.

If you want some flashy effects for your high speed chase.

Pressing the above key will bring up a simple menu. No idea for what or if it affects the recording in anyway. You can just leave it empty or click cancel if you don't want to bother with it. Type in a script function and hit ok if you want to see what it does.

Numbers and stuff

Once you've moved on past this menu you should notice some new details in output giving you the current information for your recording. Total frames should starting increasing, indicating that the recording is currently in progress. Take a quick walk around the level and join me at the next section when you're ready.

Saving your recording

When you have finished performing the actions you want recorded, press Caps lock to save the animation. This will bring up the following menu:

Name it something funny

Clicking "Don't Save" will throw the recorded animation data away while saving it will place the data under the hierarchy folder named "Recorded animations".

Playing your recording

In order to play the recording on a unit you will have to call it through a script function. The script function we will be using in this example is as follows:

recording_play <unit name> <recorded animation name>

For example, recording_play elite_1_2 jumping.