Class GameVersion

Namespace

Vintagestory.API.Config

Assembly

VintagestoryAPI.dll

The games current version

public static class GameVersion

Inheritance

object

GameVersion

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

APIVersion

Version of the Mod API

public const string APIVersion = "1.21.0"

Field Value

string

AssemblyVersion

Assembly Info Version number in the format: major.minor.revision

public const string AssemblyVersion = "1.0.0.0"

Field Value

string

BlockItemMappingVersion

"Version" of the block and item mapping. This number gets increased by 1 when remappings are needed

public static int BlockItemMappingVersion

Field Value

int

Branch

Whether this is a stable or unstable version

public const EnumGameBranch Branch = Unstable

Field Value

EnumGameBranch

ChunkdataVersion

Version of the chunkdata compression for individual WorldChunks (0 is Deflate; 1 is ZSTD and palettised) Also affects compression of network packets sent

public const int ChunkdataVersion = 2

Field Value

int

CopyRight

Copyright notice

public const string CopyRight = "Copyright © 2016-2024 Anego Studios"

Field Value

string

DatabaseVersion

Version of the savegame database

public static int DatabaseVersion

Field Value

int

LongGameVersion

Version number in the format: major.minor.revision [release title]

public static string LongGameVersion

Field Value

string

NetworkVersion

Version of the Network Protocol

public const string NetworkVersion = "1.21.5"

Field Value

string

OverallVersion

Assembly Info Version number in the format: major.minor.revision

public const string OverallVersion = "1.21.0"

Field Value

string

ShortGameVersion

Version number in the format: major.minor.revision[appendix]

public const string ShortGameVersion = "1.21.0-pre.2"

Field Value

string

WorldGenVersion

Version of the world generator - a change in version will insert a smoothed chunk between old and new version

public const int WorldGenVersion = 3

Field Value

int

Properties

ReleaseType

public static EnumReleaseType ReleaseType { get; }

Property Value

EnumReleaseType

Methods

EnsureEqualVersionOrKillExecutable(ICoreAPI, string, string, string)

public static void EnsureEqualVersionOrKillExecutable(ICoreAPI api, string version, string reference, string modName)

Parameters

api ICoreAPI

version string

reference string

modName string

GetReleaseType(string)

public static EnumReleaseType GetReleaseType(string version)

Parameters

version string

Returns

EnumReleaseType

IsAtLeastVersion(string)

Returns true if supplied version is the same or higher as the current version

public static bool IsAtLeastVersion(string version)

Parameters

version string

Returns

bool

IsAtLeastVersion(string, string)

Returns true if supplied version is the same or higher as the reference version

public static bool IsAtLeastVersion(string version, string reference)

Parameters

version string

reference string

Returns

bool

IsCompatibleApiVersion(string)

Returns true if given version has the same major and minor version. Ignores revision.

public static bool IsCompatibleApiVersion(string version)

Parameters

version string

Returns

bool

IsCompatibleNetworkVersion(string)

Returns true if given version has the same major and minor version. Ignores revision.

public static bool IsCompatibleNetworkVersion(string version)

Parameters

version string

Returns

bool

IsLowerVersionThan(string, string)

public static bool IsLowerVersionThan(string version, string reference)

Parameters

version string

reference string

Returns

bool

IsNewerVersionThan(string, string)

Returns true if supplied version is the higher as the reference version

public static bool IsNewerVersionThan(string version, string reference)

Parameters

version string

reference string

Returns

bool

SplitVersionString(string)

public static int[] SplitVersionString(string version)

Parameters

version string

Returns

int[]