Using Checkpoints

A checkpoint is a marker you place in your story. When you play your story back in the Story Viewer, you can use a checkpoint to jump immediately to that specific point. The checkpoint will restore both the state of the story and the camera angle you saved.

Setting Checkpoints in the Story Viewer

You can insert a checkpoint in the Story Viewer while your story is playing:

  1. Build and play your story in the Story Viewer.
  2. At the time you want to checkpoint, use the Playback > Checkpoints > Quick save menu item (Ctrl+S on Windows or Cmd+S on Mac). A new checkpoint named “quicksave” appears in the Playback > Checkpoints menu.

Checkpoints you set in the Story Viewer are saved automatically to disk. They will be available the next time you play the story.

Setting Checkpoints in the Story Editor

If you want to set up checkpoints before you play back your story, you can create them in the Story Editor using the Checkpoint command. You can add the command either to a state at a particular frame, or to a transition.

  1. Create a Checkpoint command in your state or transition. (For more information on creating commands, see Actions.)
  2. Give your checkpoint a label (name) in the Properties window. The checkpoint will not work without a label.
  3. Ensure that the “Use Story Viewer” checkbox is checked in the Story Editor preferences.
  4. Use the Play > Build and Play menu item to run your story.

Once the story plays past the point of your checkpoint once, it will then appear in the Story Viewer’s Playback menu.

Using Checkpoints in the Story Viewer

Starting at a Checkpoint

Once a checkpoint appears in the Playback menu, it will also be available in the Story Editor’s Build and Play dialog box. Simply choose a checkpoint from the Start at Checkpoint pull-down, and your story will start playing from that point.

While the Story is Playing

In the Story Viewer, use the Playback > Checkpoints menu and choose from the list of checkpoints. The story will jump to that point in time, restoring the state of the story including the user’s camera position.

Note: You can not use checkpoints in the Story Editor’s story player, only in the Story Viewer.

Removing Checkpoints

Currently, to remove checkpoints, you use the Tools > Clean Cached Assets menu item in the Story Editor. It will not remove saved checkpoint commands added in the Story Editor. However no checkpoints will be available again until the story is played past those checkpoints in the Story Viewer.

Known Issues

  • A checkpoint will not appear in the Story Viewer or the Story Editor’s Build and Play dialog until the story has played past the checkpoint once.
  • You must enter a label for a checkpoint when adding it in the Story Editor. Otherwise the checkpoint will not appear.
  • The list of available checkpoints will occasionally add redundant copies of checkpoints added in the Story Editor.
  • If the Checkpoint menu options are grayed out in the Story Viewer, the network connection may not have started properly. Close the reopen the Story Viewer.