WorldConditionsToolset.WorldConditionTools

Inspect WorldCondition (FWorldConditionQueryDefinition, FWorldConditionBase) structs.

2 tool(s).

WorldConditionsToolset.WorldConditionTools.GetConditionDescription

Returns a human-readable description of a single world condition. The condition must be passed as an FInstancedStruct containing an FWorldConditionBase-derived struct.

Input schema

{
  "properties": {
    "condition": {
      "description": "The instanced struct holding the world condition.",
      "properties": {
        "_structType": {
          "description": "UScriptStruct path name for polymorphic type identification (e.g. /Script/Module.StructName).",
          "type": "string"
        }
      },
      "title": "FInstancedStruct",
      "type": "object"
    }
  },
  "required": [
    "condition"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Text description of the condition, or empty if invalid.",
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

WorldConditionsToolset.WorldConditionTools.GetQueryDescription

Returns a human-readable description of a world condition query.

Input schema

{
  "properties": {
    "queryDefinition": {
      "description": "The query definition to describe.",
      "properties": {
        "editableConditions": {
          "description": "Conditions used while editing, converted in to Conditions via Initialize().\nThose will be cleared for cooked builds but can still be used by hotfixes.",
          "items": {
            "properties": {
              "bInvert": {
                "description": "Controls whether the value of the expressions as calculated by IsTrue should be inverted.",
                "type": "boolean"
              },
              "condition": {
                "description": "Instance of a world condition.",
                "properties": {
                  "_structType": {
                    "description": "UScriptStruct path name for polymorphic type identification (e.g. /Script/Module.StructName).",
                    "type": "string"
                  }
                },
                "title": "FInstancedStruct",
                "type": "object"
              },
              "expressionDepth": {
                "description": "Expression depth controlling the parenthesis of the expression.",
                "type": "integer"
              },
              "operator": {
                "description": "Operator describing how the results of the condition is combined with other conditions.",
                "enum": [
                  "And",
                  "Or",
                  "Copy"
                ],
                "title": "EWorldConditionOperator",
                "type": "string"
              }
            },
            "required": [
              "expressionDepth",
              "operator",
              "bInvert",
              "condition"
            ],
            "title": "WorldConditionEditable",
            "type": "object"
          },
          "type": "array"
        },
        "schemaClass": {
          "description": "Schema of the definition, also stored in SharedDefinition.",
          "properties": {
            "refPath": {
              "description": "The reference stored as a soft path string.",
              "type": "string"
            }
          },
          "required": [
            "refPath"
          ],
          "title": "Class@/Script/WorldConditions.WorldConditionSchema",
          "type": "object"
        },
        "sharedDefinition": {
          "description": "The definition used to initialize and execute world conditions.\nCreated from editable conditions during edit via Initialize().",
          "title": "SharedStruct",
          "type": "object"
        }
      },
      "required": [
        "sharedDefinition",
        "schemaClass",
        "editableConditions"
      ],
      "title": "WorldConditionQueryDefinition",
      "type": "object"
    }
  },
  "required": [
    "queryDefinition"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Text description of all conditions in the query.",
      "type": "string"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}