Skip to content

editor_toolset.toolsets.curve_table.CurveTableTools

Provides tools for creating and editing CurveTable assets.

9 tool(s).

editor_toolset.toolsets.curve_table.CurveTableTools.add_key

Adds a key to a row.

    Args:
        curve_table: The CurveTable to modify.
        row_name: The name of the row to modify.
        key: The key to add, containing the time and value.

    Returns:
        True if the key was added successfully.

Input schema

{
  "properties": {
    "curve_table": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/Engine.CurveTable",
      "type": "object"
    },
    "key": {
      "properties": {
        "time": {
          "description": "Time at this key",
          "type": "number"
        },
        "value": {
          "description": "Value at this key",
          "type": "number"
        }
      },
      "required": [
        "time",
        "value"
      ],
      "title": "SimpleCurveKey",
      "type": "object"
    },
    "row_name": {
      "type": "string"
    }
  },
  "required": [
    "curve_table",
    "row_name",
    "key"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

editor_toolset.toolsets.curve_table.CurveTableTools.add_row

Adds a new row to the curve table with an optional default value.

    Args:
        curve_table: The CurveTable to modify.
        row_name: The name for the new row.
        default_value: The default value returned when sampling outside the key range.

Input schema

{
  "properties": {
    "curve_table": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/Engine.CurveTable",
      "type": "object"
    },
    "default_value": {
      "default": null,
      "type": "number"
    },
    "row_name": {
      "type": "string"
    }
  },
  "required": [
    "curve_table",
    "row_name"
  ],
  "type": "object"
}

editor_toolset.toolsets.curve_table.CurveTableTools.create

Creates a new CurveTable asset.

    Args:
        folder_path: The path to the folder that will contain the asset.
        asset_name: The name of the asset.

    Returns:
        The created CurveTable.

Input schema

{
  "properties": {
    "asset_name": {
      "type": "string"
    },
    "folder_path": {
      "type": "string"
    }
  },
  "required": [
    "folder_path",
    "asset_name"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/Engine.CurveTable",
      "type": "object"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

editor_toolset.toolsets.curve_table.CurveTableTools.get_keys

Returns all keys for a row.

    Args:
        curve_table: The CurveTable to query.
        row_name: The name of the row to query.

    Returns:
        A list of SimpleCurveKey objects for the row.

Input schema

{
  "properties": {
    "curve_table": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/Engine.CurveTable",
      "type": "object"
    },
    "row_name": {
      "type": "string"
    }
  },
  "required": [
    "curve_table",
    "row_name"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "time": {
            "description": "Time at this key",
            "type": "number"
          },
          "value": {
            "description": "Value at this key",
            "type": "number"
          }
        },
        "required": [
          "time",
          "value"
        ],
        "title": "SimpleCurveKey",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

editor_toolset.toolsets.curve_table.CurveTableTools.import_file

Imports a file from disk as a CurveTable asset.

    The file's first column is the row name; subsequent columns are sample
    times and values. interp_mode controls how the imported keys are
    interpolated between samples.

    Args:
        folder_path: The content-browser folder to create the asset in.
        asset_name: The name of the new asset.
        source_file: The absolute path to the source file on disk.
        interp_mode: Interpolation mode applied to every imported key.
            Must be RCIM_LINEAR or RCIM_CONSTANT.

    Returns:
        The assets produced by the import (typically a single CurveTable).

Input schema

{
  "properties": {
    "asset_name": {
      "type": "string"
    },
    "folder_path": {
      "type": "string"
    },
    "interp_mode": {
      "enum": [
        "RCIM_Linear",
        "RCIM_Constant",
        "RCIM_Cubic",
        "RCIM_None"
      ],
      "title": "ERichCurveInterpMode",
      "type": "string"
    },
    "source_file": {
      "type": "string"
    }
  },
  "required": [
    "folder_path",
    "asset_name",
    "source_file",
    "interp_mode"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "properties": {
          "refPath": {
            "description": "The reference stored as a soft path string.",
            "type": "string"
          }
        },
        "required": [
          "refPath"
        ],
        "title": "/Script/CoreUObject.Object",
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

editor_toolset.toolsets.curve_table.CurveTableTools.list_rows

Lists the names of all rows in the curve table.

    Args:
        curve_table: The CurveTable to query.

    Returns:
        A list of row names.

Input schema

{
  "properties": {
    "curve_table": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/Engine.CurveTable",
      "type": "object"
    }
  },
  "required": [
    "curve_table"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}

editor_toolset.toolsets.curve_table.CurveTableTools.remove_row

Removes a row from the curve table.

    Args:
        curve_table: The CurveTable to modify.
        row_name: The name of the row to remove.

Input schema

{
  "properties": {
    "curve_table": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/Engine.CurveTable",
      "type": "object"
    },
    "row_name": {
      "type": "string"
    }
  },
  "required": [
    "curve_table",
    "row_name"
  ],
  "type": "object"
}

editor_toolset.toolsets.curve_table.CurveTableTools.rename_row

Renames a row in the curve table.

    Args:
        curve_table: The CurveTable to modify.
        row_name: The current name of the row.
        new_row_name: The new name for the row.

Input schema

{
  "properties": {
    "curve_table": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/Engine.CurveTable",
      "type": "object"
    },
    "new_row_name": {
      "type": "string"
    },
    "row_name": {
      "type": "string"
    }
  },
  "required": [
    "curve_table",
    "row_name",
    "new_row_name"
  ],
  "type": "object"
}

editor_toolset.toolsets.curve_table.CurveTableTools.set_keys

Replaces all keys in a row with the provided list.

    Args:
        curve_table: The CurveTable to modify.
        row_name: The name of the row to modify.
        keys: The keys to set in the row.

    Returns:
        True if all keys were set successfully.

Input schema

{
  "properties": {
    "curve_table": {
      "description": "Represents a reference to a UObject or UClass.",
      "properties": {
        "refPath": {
          "description": "The reference stored as a soft path string.",
          "type": "string"
        }
      },
      "required": [
        "refPath"
      ],
      "title": "/Script/Engine.CurveTable",
      "type": "object"
    },
    "keys": {
      "items": {
        "properties": {
          "time": {
            "description": "Time at this key",
            "type": "number"
          },
          "value": {
            "description": "Value at this key",
            "type": "number"
          }
        },
        "required": [
          "time",
          "value"
        ],
        "title": "SimpleCurveKey",
        "type": "object"
      },
      "type": "array"
    },
    "row_name": {
      "type": "string"
    }
  },
  "required": [
    "curve_table",
    "row_name",
    "keys"
  ],
  "type": "object"
}

Output schema

{
  "properties": {
    "returnValue": {
      "type": "boolean"
    }
  },
  "required": [
    "returnValue"
  ],
  "type": "object"
}