Correct the documentation for the startPlayback Lua function to take a full path instead

This commit is contained in:
Alexander Bock
2025-06-16 15:51:31 +02:00
parent 4c1a1fc57b
commit e3fe192bb2
@@ -62,12 +62,11 @@ namespace {
* Starts a playback session with keyframe times that are relative to the time since the
* recording was started (the same relative time applies to the playback). When playback
* starts, the simulation time is automatically set to what it was at recording time. The
* string argument is the filename to pull playback keyframes from (the file path is
* relative to the RECORDINGS variable specified in the config file). If a second input
* file argument is the filename to the session recording file. If a second input
* value of true is given, then playback will continually loop until it is manually
* stopped.
*/
[[codegen::luawrap]] void startPlayback(std::string file, bool loop = false,
[[codegen::luawrap]] void startPlayback(std::filesystem::path file, bool loop = false,
bool shouldWaitForTiles = true,
std::optional<int> screenshotFps = std::nullopt)
{