Skip to content

Blueprint / C++ API Reference

Baseline: OverAnim 0.1.0 Beta · Unreal Engine 5.8
Public header root: OverAnimation/

This section is a reference organized around identifiers, properties, functions, and enums. For authoring workflows and the meaning of editor screens, see the Manual. Actual Unreal Editor UI labels, class names, Blueprint node names, and C++ property names remain in English.

Scope of This Reference

The documentation covers the Blueprint/C++ contracts that the plugin exposes externally.

Included Excluded
UOverAnimMeshDeformer, UOverAnimComponent, Animation Notifies Instance Manager, Bone Group runtime instances, render proxies, shaders
9 Effect Modules and Signal/Response/Region/Motion/Camera/Time types Internal Tick and lifecycle implementation, internal caches and history state
BlueprintCallable and BlueprintPure nodes, and public C++ authoring helpers Editor widgets and Preview implementation details

How to Read This Reference

  • A Blueprint display name is the name used to search for a node. Items without a display name use the function name.
  • A C++ declaration identifies a supported call boundary. The header path appears at the top of each page.
  • A precondition is a state that must be satisfied before a call or property can take effect.
  • A rejection/failure is a condition that makes the return value false or prevents a request from being interpreted. void functions do not return failure state.
  • A visibility condition in a Details table describes the UI exposure rule from EditCondition or the validity of the corresponding value.

Quick Reference

Looking for Reference
Per-Skeleton OverAnim authoring asset UOverAnimMeshDeformer
Regions, Bone Groups, masks, LOD Bone Group · Region
Module selection and shared contracts Effect Modules
Runtime installation, Signal, Time, and Camera APIs UOverAnimComponent
Animation Timeline Notifies Animation Notifies
Signal Protocol, Impact input, and Signal structs Signal · Impact Types
Response Rules, Response Sets, and per-module Response Parameters Response Types
Motion Analyzer, Simulation, and Calibration Motion · Simulation, Region · Calibration
Camera Safety, Readability, and Time policy enums Camera · Time Types

Supported version

This documentation is based on the current public headers and UFUNCTION metadata. Public declarations not covered here may expose internal implementation and are not considered part of the external integration contract.