Skip to content

GantryCore

NamespaceGantryCoreC++ only

Class selection: choosing the one class in a hierarchy that is allowed to exist.

Members

VersionMajor

int32 GantryCore::VersionMajor

Major version: incremented for releases that break compatibility.

VersionMinor

int32 GantryCore::VersionMinor

Minor version: incremented for releases that add features compatibly.

VersionPatch

int32 GantryCore::VersionPatch

Patch version: incremented for fix-only releases.

ResolveSelectedClass

UClass * GantryCore::ResolveSelectedClass(const FSoftClassPath &Configured, UClass *DefaultClass, bool bLogFailure=true)

Resolves a configured soft class path, falling back to a default.

  • Configured:

    Soft class path from settings. May be empty or unresolvable.

  • DefaultClass:

    Class to use when Configured is empty or fails to resolve.

  • bLogFailure:

    Log a warning when Configured is set but does not resolve.

Returns: The resolved class, never null as long as DefaultClass is not null.

IsSelectedClass

bool GantryCore::IsSelectedClass(const UClass *CandidateClass, const FSoftClassPath &Configured, UClass *DefaultClass)

Whether a class is the one selected class of its hierarchy, so the only one to create.

Call from ShouldCreateSubsystem, or anywhere else a hierarchy must create exactly one class.

  • CandidateClass:

    Usually GetClass().

  • Configured:

    Soft class path from settings.

  • DefaultClass:

    The Gantry base, used when nothing is configured.

Returns: True only for the selected class. Abstract classes always return false.

ValidateSelectedClass

bool GantryCore::ValidateSelectedClass(const FSoftClassPath &Configured, UClass *RequiredBase, FString &OutError)

Checks that a configured class can serve a hierarchy, and says why when it cannot.

For startup and editor validation. Blocking: it loads the class.

  • Configured:

    Soft class path from settings. Empty is valid and means "use the default".

  • RequiredBase:

    The hierarchy's base, which the class must derive from. Null skips that check.

  • OutError:

    Cleared, then set to a one-line reason when the class is unusable.

Returns: True when the setting is empty or names a loadable, concrete subclass of RequiredBase.

GetVersionString

FString GantryCore::GetVersionString()

"0.1.0".