diff --git a/src/main/java/com/minecrafttas/tasmod/playback/tasfile/flavor/SerialiserFlavorBase.java b/src/main/java/com/minecrafttas/tasmod/playback/tasfile/flavor/SerialiserFlavorBase.java index 82284888..5edabd61 100644 --- a/src/main/java/com/minecrafttas/tasmod/playback/tasfile/flavor/SerialiserFlavorBase.java +++ b/src/main/java/com/minecrafttas/tasmod/playback/tasfile/flavor/SerialiserFlavorBase.java @@ -19,6 +19,7 @@ import com.minecrafttas.tasmod.playback.filecommands.PlaybackFileCommand.PlaybackFileCommandContainer; import com.minecrafttas.tasmod.playback.filecommands.PlaybackFileCommand.PlaybackFileCommandExtension; import com.minecrafttas.tasmod.playback.metadata.PlaybackMetadata; +import com.minecrafttas.tasmod.playback.tasfile.PlaybackSerialiser; import com.minecrafttas.tasmod.playback.tasfile.exception.PlaybackLoadException; import com.minecrafttas.tasmod.registries.TASmodAPIRegistry; import com.minecrafttas.tasmod.virtual.Subtickable; @@ -33,32 +34,54 @@ *
All serialisation and deserialisation is broken apart into functions whenever possible,
* with the intention of allowing small changes to the existing syntax.
*
- *
Adding functionality to playback should be made via {@link PlaybackFileCommand PlaybackFileCommands} instead of creating a new syntax
- * and adding new information to the header should be made via {@link PlaybackMetadata}
+ *
Adding functionality to playback should be made via {@link PlaybackFileCommand PlaybackFileCommands}
+ * instead of creating a new syntax and adding new information to the header should be made via {@link PlaybackMetadata}
*
*
The TASfile has 2 main sections: + *
The TASfile has 2 main sections, which are called seperately by the {@link PlaybackSerialiser}: * *
Serialises the flavor of this file, the enabled file commands and other metadata. + *
{@link #serialiseFlavorName(List)} + *
+ * serialiseHeader + * ├── {@link #headerStart()} // The start of the header + * ├── {@link #serialiseFlavorName(List)} // The name of the flavor + * ├── {@link #serialiseFileCommandNames(List)} // The names of the enabled file commands + * ├── {@link #serialiseMetadata(List)} // The metadata of this movie + * │ ├── {@link #serialiseMetadataName(List, String)} // The metadata extension name + * │ └── {@link #serialiseMetadataValues(List, LinkedHashMap)} // All values in the extension + * └── {@link #headerEnd()} // The end of the header + ** @return List of lines containing the header */ public List
How the flavor name is serialised. + *
You normally don't have to edit this,
+ * as the flavor name is taken from the extension name.
+ *
+ * @param out The serialised lines, passed by reference
+ */
protected void serialiseFlavorName(List