DataRegistryToolset.DataRegistryTools

Provides tools for querying and inspecting Data Registries.

7 tool(s).

DataRegistryToolset.DataRegistryTools.GetItems

Returns cached item data. Items must be loaded in the registry cache to be returned.

Input schema

{
  "properties": {
    "itemNames": {
      "description": "Item names to retrieve.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "registryName": {
      "description": "The registry name.",
      "type": "string"
    }
  },
  "required": [
    "registryName",
    "itemNames"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "additionalProperties": {
        "properties": {
          "_structType": {
            "description": "UScriptStruct path name for polymorphic type identification (e.g. /Script/Module.StructName).",
            "type": "string"
          }
        },
        "title": "FInstancedStruct",
        "type": "object"
      },
      "description": "A map from item name to its struct data. Names that were not found in the cache are simply omitted from the result.",
      "type": "object"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

DataRegistryToolset.DataRegistryTools.GetRegistryInfo

Returns detailed information about a specific registry.

Input schema

{
  "properties": {
    "registryName": {
      "description": "The registry name.",
      "type": "string"
    }
  },
  "required": [
    "registryName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Detailed info including description and id format.",
      "properties": {
        "availability": {
          "description": "Lowest availability across all sources on this registry. DoesNotExist indicates the\nregistry has not been initialized.",
          "enum": [
            "DoesNotExist",
            "Unknown",
            "Remote",
            "OnDisk",
            "LocalAsset",
            "PreCached"
          ],
          "title": "EDataRegistryAvailability",
          "type": "string"
        },
        "description": {
          "description": "Human-readable description.",
          "type": "string"
        },
        "idFormat": {
          "description": "Base GameplayTag of the ID format, if any.",
          "type": "string"
        },
        "itemCount": {
          "description": "Number of item IDs known to this registry.",
          "type": "integer"
        },
        "itemStruct": {
          "description": "The UScriptStruct used for items in this registry. May be null.",
          "properties": {
            "refPath": {
              "description": "The reference stored as a soft path string.",
              "type": "string"
            }
          },
          "required": [
            "refPath"
          ],
          "title": "/Script/CoreUObject.ScriptStruct",
          "type": "object"
        },
        "registryName": {
          "description": "The registry name.",
          "type": "string"
        }
      },
      "required": [
        "registryName",
        "description",
        "itemStruct",
        "itemCount",
        "availability",
        "idFormat"
      ],
      "title": "DataRegistryInfo",
      "type": "object"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

DataRegistryToolset.DataRegistryTools.GetSchema

Returns the item struct schema as JSON.

Input schema

{
  "properties": {
    "registryName": {
      "description": "The registry name.",
      "type": "string"
    }
  },
  "required": [
    "registryName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "A JSON string describing the struct's fields and types.",
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

DataRegistryToolset.DataRegistryTools.ListDataSources

Returns the editor-defined sources configured on a Data Registry. These are the sources as authored on the registry asset, before any runtime expansion of meta sources.

Input schema

{
  "properties": {
    "registryName": {
      "description": "The registry name.",
      "type": "string"
    }
  },
  "required": [
    "registryName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "A list of source summaries, in definition order.",
      "items": {
        "properties": {
          "availability": {
            "description": "Availability of this source.",
            "enum": [
              "DoesNotExist",
              "Unknown",
              "Remote",
              "OnDisk",
              "LocalAsset",
              "PreCached"
            ],
            "title": "EDataRegistryAvailability",
            "type": "string"
          },
          "bIsInitialized": {
            "description": "Whether the source is initialized.",
            "type": "boolean"
          },
          "bIsTransient": {
            "description": "Whether this is a runtime-only (transient) source.",
            "type": "boolean"
          },
          "debugString": {
            "description": "Human-readable description of the source.",
            "type": "string"
          },
          "parentSourceDebugString": {
            "description": "Debug string of the parent (original) source, if this is a transient child. Empty otherwise.",
            "type": "string"
          },
          "sourceAssetPath": {
            "description": "Path to the underlying asset, if any.",
            "properties": {
              "refPath": {
                "description": "The reference stored as a soft path string.",
                "type": "string"
              }
            },
            "required": [
              "refPath"
            ],
            "title": "/Script/CoreUObject.Object",
            "type": "object"
          },
          "sourceClass": {
            "description": "Class of the source.",
            "properties": {
              "refPath": {
                "description": "The reference stored as a soft path string.",
                "type": "string"
              }
            },
            "required": [
              "refPath"
            ],
            "title": "Class@/Script/CoreUObject.Object",
            "type": "object"
          }
        },
        "required": [
          "sourceClass",
          "debugString",
          "sourceAssetPath",
          "availability",
          "bIsInitialized",
          "bIsTransient",
          "parentSourceDebugString"
        ],
        "title": "DataRegistrySourceSummary",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

DataRegistryToolset.DataRegistryTools.ListItems

Returns all item names in a Data Registry.

Input schema

{
  "properties": {
    "registryName": {
      "description": "The registry name.",
      "type": "string"
    }
  },
  "required": [
    "registryName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "All item names defined on the registry, in registry order.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

DataRegistryToolset.DataRegistryTools.ListRegistries

Returns the names of all registered Data Registries.

Input schema

{
  "properties": {
    "structFilter": {
      "default": null,
      "description": "If non-null, only registries whose item struct inherits from this struct are returned.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/CoreUObject.ScriptStruct",
      "type": "object"
    }
  },
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "A list of registry names.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

DataRegistryToolset.DataRegistryTools.ListRuntimeSources

Returns the runtime sources for a Data Registry. This is the expanded list including transient child sources generated from meta sources. Will equal ListDataSources when the registry has no meta sources.

Input schema

{
  "properties": {
    "registryName": {
      "description": "The registry name.",
      "type": "string"
    }
  },
  "required": [
    "registryName"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "A list of source summaries, in runtime order.",
      "items": {
        "properties": {
          "availability": {
            "description": "Availability of this source.",
            "enum": [
              "DoesNotExist",
              "Unknown",
              "Remote",
              "OnDisk",
              "LocalAsset",
              "PreCached"
            ],
            "title": "EDataRegistryAvailability",
            "type": "string"
          },
          "bIsInitialized": {
            "description": "Whether the source is initialized.",
            "type": "boolean"
          },
          "bIsTransient": {
            "description": "Whether this is a runtime-only (transient) source.",
            "type": "boolean"
          },
          "debugString": {
            "description": "Human-readable description of the source.",
            "type": "string"
          },
          "parentSourceDebugString": {
            "description": "Debug string of the parent (original) source, if this is a transient child. Empty otherwise.",
            "type": "string"
          },
          "sourceAssetPath": {
            "description": "Path to the underlying asset, if any.",
            "properties": {
              "refPath": {
                "description": "The reference stored as a soft path string.",
                "type": "string"
              }
            },
            "required": [
              "refPath"
            ],
            "title": "/Script/CoreUObject.Object",
            "type": "object"
          },
          "sourceClass": {
            "description": "Class of the source.",
            "properties": {
              "refPath": {
                "description": "The reference stored as a soft path string.",
                "type": "string"
              }
            },
            "required": [
              "refPath"
            ],
            "title": "Class@/Script/CoreUObject.Object",
            "type": "object"
          }
        },
        "required": [
          "sourceClass",
          "debugString",
          "sourceAssetPath",
          "availability",
          "bIsInitialized",
          "bIsTransient",
          "parentSourceDebugString"
        ],
        "title": "DataRegistrySourceSummary",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}