PolySpatial Tooling

Logging

PolySpatial logging messages are tagged by category and level to facilitate more targeted debugging. From Project Settings > PolySpatial > Logging Categories, you can toggle which categories are enabled and whether they should generate stack traces.

Debug Links

To facilitate debugging in Play Mode, the PolySpatial runtime adds DebugPolySpatialGameObjectLinks components to connect each simulation GameObject to its corresponding backing GameObject(s) in the Unity SceneGraph. A backing GameObject will be created for each volume that the simulation GameObject is instanced into.

Recording & Playback

Recording & Playback lets users record a PolySpatial PlayMode session to a file, and then play it back. To open the Recording & Playback window, go to Windows > PolySpatial > Recording and Playback.

Recording

Press the Record button to enter Play mode and start recording. Perform interactions and supply input normally, then exit play mode, or press the Stop Recording button to stop recording. A new file will be added to the recordings list. Recordings are saved in Library/PolySpatialRecordings. Playback is version-sensitive: each recording is stamped with the PolySpatial protocol version and the Unity Editor version (Major.Minor) that produced it, and it plays back only on a build with a matching protocol version and the same or a newer Editor (an older recording plays on a newer Editor, but not the reverse). A recording that is incompatible is rejected when playback starts.

Recording Framerate

Enter a positive Recording Framerate value, and enable Limit Framerate While Recording to limit recording framerate to this value. Otherwise, recording framerate is set to unlimited.

Playback

To replay a recording, select it from the recordings list, and press the Play button. New input won't be processed, but the input encoded in the original recording will replay.

Usages

Among other things, theses files can be submitted to Unity support allowing us to debug many project-specific issues without needing a full zip of your project.