|
@@ -9,18 +9,18 @@
|
|
|
*/
|
|
|
#pragma once
|
|
|
|
|
|
-/// This is enumeration that controls save compatibility support
|
|
|
-/// - 'MINIMAL' represents older supported version counter. Save can be loaded if its version is at least 'MINIMAL'
|
|
|
-/// - 'CURRENT' represent current save version. All saves are created using 'CURRENT' version
|
|
|
+/// This enumeration controls save compatibility support.
|
|
|
+/// - 'MINIMAL' represents the oldest supported version counter. A saved game can be loaded if its version is at least 'MINIMAL'.
|
|
|
+/// - 'CURRENT' represents the current save version. Saved games are created using the 'CURRENT' version.
|
|
|
///
|
|
|
-/// To add save-breaking change:
|
|
|
-/// - change 'MINIMAL' to value higher than CURRENT
|
|
|
-/// - remove all version enumerations inbetween
|
|
|
+/// To make a save-breaking change:
|
|
|
+/// - change 'MINIMAL' to a value higher than 'CURRENT'
|
|
|
+/// - remove all keys in enumeration between 'MINIMAL' and 'CURRENT' as well as all their usage (will be detected by compiler)
|
|
|
/// - change 'CURRENT' to 'CURRENT = MINIMAL'
|
|
|
///
|
|
|
-/// To add non-breaking change:
|
|
|
+/// To make a non-breaking change:
|
|
|
/// - add new enumeration value before 'CURRENT'
|
|
|
-/// - change 'CURRENT' to 'CURRENT = NEW_TEST_KEY'
|
|
|
+/// - change 'CURRENT' to 'CURRENT = NEW_TEST_KEY'.
|
|
|
///
|
|
|
/// To check for version in serialize() call use form
|
|
|
/// if (h.version >= Handler::Version::NEW_TEST_KEY)
|
|
@@ -32,7 +32,7 @@ enum class ESerializationVersion : int32_t
|
|
|
NONE = 0,
|
|
|
|
|
|
MINIMAL = 831,
|
|
|
- RELEASE_143, // 832 + text container in campaigns, +starting hero in RMG options
|
|
|
+ RELEASE_143, // 832 +text container in campaigns, +starting hero in RMG options
|
|
|
HAS_EXTRA_OPTIONS, // 833 +extra options struct as part of startinfo
|
|
|
|
|
|
CURRENT = HAS_EXTRA_OPTIONS
|