Blueprint / C++ API

The full API is available in both Blueprints and C++. To use it from C++, add "VersionForge" to your module's dependencies and include the header shown in each section.

UVersionForgeStaticsCopy Anchor Link

Blueprint function library. Every function is static, and can be called from C++ with UVersionForgeStatics::FunctionName().

#include "VersionForgeStatics.h"

GetGameVersionInfoCopy Anchor Link

Returns a fully populated FGameVersionInfo structure for the current build.

const FGameVersionInfo Info = UVersionForgeStatics::GetGameVersionInfo();
UE_LOG(LogTemp, Log, TEXT("Build %d on %s"), Info.BuildNumber, *Info.Platform);

GetVersionStringCopy Anchor Link

Returns the Long Version string, formatted with the Format Template setting. For example 1.5.7+Windows.Shipping.20261123.418.

const FString Version = UVersionForgeStatics::GetVersionString();

GetShortVersionStringCopy Anchor Link

Returns the Short Version string, the Long Version string without the metadata after the first +. For example 1.5.7, or 1.5.7-beta.

const FString Short = UVersionForgeStatics::GetShortVersionString();

FormatVersionStringCopy Anchor Link

Formats a FGameVersionInfo with the provided template.

Tokens: {major} {minor} {patch} {projectpatch} {build} {cl} {prerelease} {platform} {config} {date}

See Format Template for details.

const FGameVersionInfo Info = UVersionForgeStatics::GetGameVersionInfo();
const FString Text = UVersionForgeStatics::FormatVersionString(Info, TEXT("v{major}.{minor} (build {build})"));

GetNetworkVersionStringCopy Anchor Link

Returns the Network Version string, resolved from the Network Version Source setting.

const FString NetworkVersion = UVersionForgeStatics::GetNetworkVersionString();

GetMajorVersionCopy Anchor Link

Returns the first segment of the version number.

const int32 Major = UVersionForgeStatics::GetMajorVersion();

GetMinorVersionCopy Anchor Link

Returns the second segment of the version number.

const int32 Minor = UVersionForgeStatics::GetMinorVersion();

GetPatchVersionCopy Anchor Link

Returns the third segment of the version number resolved from the Patch Source setting. It can be Project Patch, the Build Number, or the Changelist if numeric.

const int32 Patch = UVersionForgeStatics::GetPatchVersion();

GetProjectPatchVersionCopy Anchor Link

Returns the third segment of Project Version regardless of the Patch Source setting.

const int32 ProjectPatch = UVersionForgeStatics::GetProjectPatchVersion();

AreBuildValuesAvailableCopy Anchor Link

Returns true when a packaged build contains build values Version Forge captured at build time. Returns false in the editor or if a build did not capture any values.

if (!UVersionForgeStatics::AreBuildValuesAvailable())
{
	// No build values
}

GetBuildNumberCopy Anchor Link

Returns the build number captured at build time, or 0 if none was captured.

const int32 Build = UVersionForgeStatics::GetBuildNumber();

GetChangelistCopy Anchor Link

Returns the changelist or commit identifier captured at build time, or an empty string if none was captured.

const FString Changelist = UVersionForgeStatics::GetChangelist();

GetPlatformCopy Anchor Link

Returns the platform the game (or editor) was built for, such as Windows, Mac, Android, or IOS.

const FString Platform = UVersionForgeStatics::GetPlatform();

GetConfigurationCopy Anchor Link

Returns the configuration that was built, such as Development or Shipping. Returns Editor during PIE.

const FString Config = UVersionForgeStatics::GetConfiguration();

GetBuildDateCopy Anchor Link

Returns the timestamp captured at build time, or midnight UTC of the current date in the editor.

const FDateTime BuildDate = UVersionForgeStatics::GetBuildDate();
const FString Day = BuildDate.ToString(TEXT("%Y-%m-%d"));

GetPreReleaseTagCopy Anchor Link

Returns the pre-release label: alpha, beta, rc, ea, or your custom tag. Empty when none is configured.

const bool bIsPreRelease = !UVersionForgeStatics::GetPreReleaseTag().IsEmpty();

CompareGameVersionsCopy Anchor Link

Compares Major.Minor.Patch values.

Returns:

• -1 if A is older than B
• 0 if A and B are equal
• 1 if A is newer than B.

if (UVersionForgeStatics::CompareGameVersions(SavedVersion, UVersionForgeStatics::GetGameVersionInfo()) < 0)
{
    MigrateSaveData();
}

IsGameVersionAtLeastCopy Anchor Link

Returns true if Version is greater than or equal to the provided Major.Minor.Patch.

const FGameVersionInfo Current = UVersionForgeStatics::GetGameVersionInfo();
if (UVersionForgeStatics::IsGameVersionAtLeast(Current, 1, 2, 0))
{
    EnableNewMenu();
}

FGameVersionInfoCopy Anchor Link

The struct that contains every part of the version information for a build.

#include "VersionForgeTypes.h"

MakeGameVersionInfoCopy Anchor Link

Builds a FGameVersionInfo struct from the provided Major.Minor.Patch values. The other fields are left at their defaults.

const FGameVersionInfo Required = UVersionForgeStatics::MakeGameVersionInfo(1, 2, 0);
const bool bOutdated = UVersionForgeStatics::CompareGameVersions(Current, Required) < 0;

BreakGameVersionInfoCopy Anchor Link

Splits a FGameVersionInfo into its individual fields.

int32 Major, Minor, ProjectPatch, Patch, BuildNumber;
FString Changelist, Platform, Configuration, PreReleaseTag;
FDateTime BuildDate;
UVersionForgeStatics::BreakGameVersionInfo(Info, Major, Minor, ProjectPatch, Patch, BuildNumber, Changelist, Platform, Configuration, BuildDate, PreReleaseTag);

UVersionTextBlockCopy Anchor Link

A UMG UTextBlock widget that displays the current version. Font, color, justification, etc are all customizable. Appears in the UMG Palette under the Version Forge category as Version Text.

#include "VersionTextBlock.h"

SetDisplayModeCopy Anchor Link

Changes DisplayMode and refreshes the text.

VersionText->SetDisplayMode(EVersionTextMode::NetworkVersion);

SetPrefixWithVCopy Anchor Link

Changes bPrefixWithV and refreshes the text.

VersionText->SetPrefixWithV(true);

SetCustomFormatCopy Anchor Link

Changes CustomFormat and refreshes the text. Changes DisplayMode to Custom.

VersionText->SetCustomFormat(FText::FromString(TEXT("v{major}.{minor}.{patch}")));