Struct FTryllDevCheckout¶

#include <TryllDevCheckout.h>

Public Static Attributes¶

Type	Name
const TCHAR *const	RepoLicenceFile
const TCHAR *const	UnstampedVersion

Public Static Functions¶

Type	Name
FString	FindRepoRoot (const FString & Start)
bool	IsUnstamped ()
FString	ReadVersionFile (const FString & Dir)
FString	RepoLicencePath ()
FString	RepoRoot ()
FString	RepoVersion ()

Detailed Description¶

Facts a release stamps into the plugin, read from the source tree when the plugin runs from a development checkout instead. The release pipeline sets the .uplugin VersionName from the repo-root VERSION file and copies docs/legal/LICENSE.md into the plugin root (ci/release.toml [paths].licence_file); an in-tree plugin has neither, so it reads them from the repo. A released plugin never looks outside its own folder. The same rules as Unity's TryllVersionLookup. Plugin-internal.

Public Static Attributes Documentation¶

variable RepoLicenceFile¶

const TCHAR* const FTryllDevCheckout::RepoLicenceFile;

The licence source, relative to the repo root.

variable UnstampedVersion¶

const TCHAR* const FTryllDevCheckout::UnstampedVersion;

The .uplugin VersionName of a plugin no release has stamped.

Public Static Functions Documentation¶

function FindRepoRoot¶

static FString FTryllDevCheckout::FindRepoRoot (
    const FString & Start
)

Walks up from Start to the first folder whose VERSION holds a version number; empty when none.

function IsUnstamped¶

static bool FTryllDevCheckout::IsUnstamped ()

True when the TryllClient plugin's VersionName is still UnstampedVersion.

function ReadVersionFile¶

static FString FTryllDevCheckout::ReadVersionFile (
    const FString & Dir
)

The version number in Dir/VERSION, or empty when it is missing or holds something else.

function RepoLicencePath¶

static FString FTryllDevCheckout::RepoLicencePath ()

<repo>/docs/legal/LICENSE.md when RepoRoot() has one, else empty.

function RepoRoot¶

static FString FTryllDevCheckout::RepoRoot ()

The repo root above the unstamped TryllClient plugin, or empty for a released plugin or one outside a checkout. Read once per process.

function RepoVersion¶

static FString FTryllDevCheckout::RepoVersion ()

The repo-root VERSION (a version number), or empty when RepoRoot() is.

The documentation for this class was generated from the following file C:/_tryll/_monorepo3/tryll/clients/unreal/Source/TryllClient/Public/TryllDevCheckout.h