Class

Namespace

CoreFramework.Settings

Represents the project settings for managing versions and backward compatibility.

[FilePath("ProjectSettings/VersionProjectSettings.asset", FilePathAttribute.Location.ProjectFolder)]
public class VersionProjectSettings : ScriptableSingleton<VersionProjectSettings>

Inheritance

object

Object

ScriptableObject

ScriptableSingleton<VersionProjectSettings>

Extension Methods

GameObjectExtensions.OrNull<T>(T)

TaskExtensions.AsCompletedTask<T>(T)

Fields

_build

The build version component (version when you make backward compatible bug fixes).

[SerializeField]
private int _build

Field Value

int

_major

The major version component (when you make incompatible API changes).

[SerializeField]
private int _major

Field Value

int

_minBuild

The build version component of the minimum supported save file format.

[SerializeField]
private int _minBuild

Field Value

int

_minMajor

The major version component of the minimum supported save file format.

[SerializeField]
private int _minMajor

Field Value

int

_minMinor

The minor version component of the minimum supported save file format.

[SerializeField]
private int _minMinor

Field Value

int

_minRevision

The revision version component of the minimum supported save file format.

[SerializeField]
private int _minRevision

Field Value

int

_minor

The minor version component (when you add functionality in a backward compatible manner).

[SerializeField]
private int _minor

Field Value

int

_revision

The revision version (Pre-release).

[SerializeField]
private int _revision

Field Value

int

Properties

CurrentFileVersion

Represents the latest version. This should be incremented whenever there's a change in the structure or data stored in save files. Major(when you make incompatible API changes), Minor(when you add functionality in a backward compatible manner, i.e. new feature), Build(version when you make backward compatible bug fixes), Revision(Pre-release number i.e. internal testing)

public Version CurrentFileVersion { get; set; }

Property Value

Version

MinFileVersion

Denotes the earliest version of the save file that the game still supports. This allows the game to handle older save files by potentially migrating or upgrading them to the current format.

public Version MinFileVersion { get; set; }

Property Value

Version