Getting Started#

After downloading and installing Radiant AutoAnimNotify make sure you enter it as a dependency into your .uproject file.

"Plugins": [
    ...
    {
        "Name":  "RadiantAutoAnimNotify",
        "Enabled":  true
    },
    ...
]

Alternatively, you can enable the plugin using the editor using the Plugins window found under Edit/Plugin, after downloading it from fab.

Applying the Modifier#

Radiant AutoAnimNotify key tool is a modifier that needs to be applied to the animation sequence one wants to generated notifies for. When an animation is opened in Persona (Animation editor), one can apply a modifier by selecting one form the dropdown.

Here you need to select the Radiant Auto Notify Modifier, which will be added to the stack. By default the modifier has not notify class selected, in case you just want to test if the notifies are placed correctly this is fine. When applying the modifier and not notify class is selected a warning popup will appear. There are a few steps that are needed in order to configure the Modifier to your needs.

Set the target bones#

In order for the modifier to detect which bones the notifies should be placed for they need to be selected. Make sure the named of the bones match the bones in your skeleton in this step. By default the ball_r and ball_l bones are selected for convenient footstep notify placement on biped skeletons.

Set the detection shape#

The detection shape can be selected from the modifiers details panel and is used to determine when a notify needs to be placed in the timeline. There are two options here, plane and sphere. Plane the detection will trigger when any of the target bones pass the set plane. The offset for the plane added calculated from the pivot of the underlying skeleton and the direction can be arbitrarily chosen. The default is set as a plane facing down for convenient footstep notify placement on biped skeletons.
Sphere detection triggers once one of the target bones leaves the defined sphere. In addition the sphere is anchored to a target bone and will stick to the define sphere throughout the entire animation sequence. This can for example, be used to detect if a punch extends past a certain reach.

Choosing the placement mode#

Placement modes can be chosen in the modifiers details panel and will determine how notifies are added to the timeline once the detection triggers. There are 5 different modes to select from:

First: which is the default, will place a notify on the first frame the detection triggers.
Last will: place a notify on the last frame the detection triggers.
Minimum: will place a notify on the frame where the bone as the smallest distance to the detection shape
Maximum: will place a notify on the frame where the bone as the largest distance to the detection shape
Every Frame: will place a notify every frame the detection triggers.

This allows you to fine tune the placement of the notifies to a larger extent.

Debug View#

Whenever the modifier is applied the debug view will toggle on directly in the animation editor and show the detection shape as well as the placed notifies in the chosen track color.