Jazz2::Editor::EpisodeFile struct

An episode file (.j2e) as the editor reads and writes it.

The same layout as ContentResolver::GetEpisodeByPath() reads and Compatibility::JJ2Episode writes: the display name, the position in the list of episodes, the first level, the previous and the next episode, then the title image and the background image.

Public static functions

static auto Read(StringView path, EpisodeFile& episode) -> bool
Reads an episode file, returns false if it isn't one.

Public functions

auto Write(StringView path, bool keepBackup) const -> bool
Writes the episode file through a temporary file, with keepBackup the old one is kept as .bak.

Public variables

std::uint16_t Flags
Flags as the file stores them, none are defined.
String DisplayName
Name shown in the list of episodes.
std::uint16_t Position
Position in the list of episodes.
String FirstLevel
Name of the first level, without the episode.
String PreviousEpisode
Name of the episode before this one.
String NextEpisode
Name of the episode after this one.
EpisodeImage Title
Image with the name of the episode.
EpisodeImage Background
Image behind the list of episodes.