UGantryCoreSettings

ClassGantryCoreBlueprint-visibleconfigshown as “Gantry Core”

#include "Settings/GantryCoreSettings.h"

Settings shared by every Gantry module, under Project Settings > Plugins > Gantry Core.

It holds the warning for tag names nobody registered, the game's declared channels, and its API version and allowlist. Each Gantry module keeps the settings for its own system in its own section: the experience tree's base experience is under Gantry Experience, and the load tracking options are under Gantry Gauge.

Stored in DefaultGame.ini under [/Script/GantryCore.GantryCoreSettings].

In Blueprint, read the settings with Get Gantry Core Settings. In C++, use UGantryCoreSettings::Get().

Inherits: UDeveloperSettings

Properties

Property	Type	Default	Description
`bWarnOnUnregisteredTags` read-only config	`bool`	`True`	Logs a warning, once per tag name, when Gantry looks up a tag name that nobody registered. Default on. Applies to lookups through GantryTagRegistry::ResolveTagChecked, which C++ code calls where a tag arrives as data, such as an ini value or a save game. Turning it off only silences the warning: the lookup still returns an empty tag.
`ChannelSets` read-only config	`TArray<TSoftObjectPtr<UGantryChannelSet> >`		Channel Sets whose channels are declared for the whole game once the engine is up: the events and hooks it offers, for the API manifest and the checks below.
`bWarnOnUndeclaredChannels` read-only config	`bool`	`True`	Warns, once per channel, when a message is sent or a hook run on a channel nobody declared, of the wrong kind, with a payload other than the declared one, or deprecated. Off by default; a game that declares its channels turns it on to keep them honest.
`APIVersion` read-only config	`FString`	`1.0`	The version of the API the game offers (its declared types, functions, properties and channels). Raise it when the API changes; mods declare the range they target, and a mod made for another is refused, saying why.
`APIAllowlist` read-only config	`TArray<FGantryAPIAllowlistEntry>`		What goes in the API without being marked in its code (`meta=(GantryAPI)`): engine types, other plugins', Blueprint types. Read by the API generator; see `FGantryAPI`.

Functions

`GetGantryCoreSettings`

BlueprintCallableBlueprintPureStaticGantry|Settings

The project's Gantry Core settings, read-only, for Blueprint.

Pin	Type	Direction	Description
Return Value	`UGantryCoreSettings*`	out	The settings object; never null.

C++

Public C++ members that Blueprint does not see.

`UGantryCoreSettings`

UGantryCoreSettings::UGantryCoreSettings()

Sets the defaults: warnings on unregistered tags enabled.

`GetContainerName`

virtual FName UGantryCoreSettings::GetContainerName() const override

"Project": these settings appear under Project Settings.

`GetCategoryName`

virtual FName UGantryCoreSettings::GetCategoryName() const override

"Plugins": the category heading in Project Settings.

`GetSectionName`

virtual FName UGantryCoreSettings::GetSectionName() const override

"Gantry Core": the section name, and the key the settings viewer opens by.

`GetSectionText`

virtual FText UGantryCoreSettings::GetSectionText() const override

Display name of the section in the settings viewer.

`GetSectionDescription`

virtual FText UGantryCoreSettings::GetSectionDescription() const override

One-line description shown under the section title.

`ToDebugString`

FString UGantryCoreSettings::ToDebugString() const

Human-readable dump used by the Gantry.Core.DumpSettings console command.

`Get`

static const UGantryCoreSettings * UGantryCoreSettings::Get()

The settings object.

Settings are a CDO, so this never returns null once the class is loaded.