Skip to content

EditorToolset.LogsToolset

Provides tools for reading the Unreal Engine output log and controlling log category verbosity.

4 tool(s).

EditorToolset.LogsToolset.GetLogCategories

Returns a sorted list of registered log categories.

Input schema

{
  "properties": {
    "filter": {
      "description": "If non-empty, only returns categories whose name contains this substring.",
      "type": "string"
    }
  },
  "required": [
    "filter"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "A sorted list of log category names (e.g. [\"LogBlueprint\", \"LogTemp\"]).",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

EditorToolset.LogsToolset.GetLogEntries

Returns log entries from the current session's log file.

Input schema

{
  "properties": {
    "category": {
      "default": "LogsToolset",
      "description": "If non-empty, only returns entries from this log category (e.g. \"LogTemp\").",
      "type": "string"
    },
    "maxEntries": {
      "default": 1000,
      "description": "Maximum number of entries to return, taken from the end of the log. Pass 0 for no limit. Defaults to 1000.",
      "type": "integer"
    },
    "pattern": {
      "description": "If non-empty, only returns entries whose text matches this regular expression.",
      "type": "string"
    }
  },
  "required": [
    "pattern"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "A list of matching log entries in chronological order.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

EditorToolset.LogsToolset.GetVerbosity

Returns the current verbosity level for a log category.

Input schema

{
  "properties": {
    "category": {
      "default": "LogsToolset",
      "description": "The log category name, e.g. \"LogTemp\".",
      "type": "string"
    }
  },
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "The verbosity level as a string: one of \"NoLogging\", \"Fatal\", \"Error\", \"Warning\", \"Display\", \"Log\", \"Verbose\", or \"VeryVerbose\". Raises a script error if the category is not found.",
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

EditorToolset.LogsToolset.SetVerbosity

Sets the verbosity level for a log category.

Input schema

{
  "properties": {
    "category": {
      "default": "LogsToolset",
      "description": "The log category name, e.g. \"LogTemp\".",
      "type": "string"
    },
    "verbosity": {
      "description": "The verbosity level: one of \"NoLogging\", \"Fatal\", \"Error\", \"Warning\", \"Display\", \"Log\", \"Verbose\", or \"VeryVerbose\".",
      "type": "string"
    }
  },
  "required": [
    "verbosity"
  ],
  "type": "object"
}