FGantryAPI

#include "API/GantryAPI.h"

The game's declared API, at run time: what it offers to its own systems and to side-loaded content, and whether a given type, function or property is part of it.

Read from the manifest (UGantryAPIManifest), resolved through reflection, which cooked builds keep.

Declaring the API

Mark what the game offers in its code:

UCLASS(meta = (GantryAPI = "Trains", GantryAPIBlueprint))
class ATrain : public AActor
{
    UFUNCTION(BlueprintCallable, meta = (GantryAPI, GantryAPISince = "1.1"))
    void Couple(ACar* Car);
};

• GantryAPI on a class, struct or enum puts the type in (its value is the namespace; empty for the module's name). On a function or property it puts that member in, and its type with it.
• GantryAPIBlueprint on a type puts in every member Blueprint can see: callable, pure and event functions, and visible properties, declared in that type.
• GantryAPISince = "1.1" and GantryAPIDeprecated = "Use Couple instead" on anything.

What the code cannot be marked for (engine types, other plugins) goes in Project Settings > Plugins > Gantry Core > API Allowlist. Channels are declared in the channel registry. The game's API version is set in the same settings; mods declare the range they target.

static FString FGantryAPI::GetVersion()

Returns: The API version the game declares.

static const UGantryAPIManifest * FGantryAPI::GetManifest()

Returns: The manifest.

static bool FGantryAPI::IsExposed(const UField *Type)

Returns: Whether a class, struct or enum is part of the API.

static bool FGantryAPI::IsExposed(const UFunction *Function)

Returns: Whether a function is part of the API.

static bool FGantryAPI::IsExposed(const FProperty *Property)

Returns: Whether a property is part of the API.

static UFunction * FGantryAPI::FindFunction(const UClass *Class, FName Name)

A function of the API, by class and name.

Returns: The function, when the class (or a parent) has it and it is part of the API; otherwise null.

static FProperty * FGantryAPI::FindProperty(const UStruct *Type, FName Name)

A property of the API, by owning type and name.

Returns: The property, when the type (or a parent) has it and it is part of the API; otherwise null.

static void FGantryAPI::Reset()

Forgets what was resolved, so the next question reads the manifest again (after it changes).