FCustomFieldEntry

Navigation

API > API/Developer > API/Developer/CookMetadata > API/Developer/CookMetadata/FCookMetadataPluginHierarchy

The list of custom field names. The values stored on an entry index in to this for the name. These values are copied from the plugins' json descriptor to allow for carrying through project specific data in to the metadata.

To enable custom field replication, add the CookMetadataCustomPluginFields section to the relevant Editor.ini file and add to the follow arrays, as desired:

BoolFields, StringFields, PerPlatformBoolFields, PerPlatformStringFields

Bool and String refer to the json type, and will emit as bool or FString here. The PerPlatform arrays will check in the uplugin json for a field named PerPlatform. That field is expected to be an array of override objects. Each object is required to have the platform name and override value. E.g.:

[CookMetadataCustomPluginFields] +PerPlatformBoolFields = ExampleProjectBool +StringField = ExampleProjectString

Will look in the uplugin file for this: "ExampleProjectBool": true "PerPlatformExampleProjectBool": [ { "Platform": "Windows", "Value": false } ] "ExampleProjectString": "AProjectString"

Note that in the per platform case, the base value is not required (i.e. ExampleProjectBool above), however it provides a default value for unlisted platforms. If it does not exist, false is used for bool fields, and an empty string for string fields.

Syntax

struct FCustomFieldEntry  
Copy full snippet

struct FCustomFieldEntry

Variables

Public