1. Links

2. Video

3. Animation List

4. Technical Information

5. Table of Contents

1. Links

Fab Marketplace - https://www.fab.com/listings/bb06916a-cb63-41c5-aad7-b54b5b01a320
Unity Asset Store - not available
Demo Build - https://vanillaloop.com/demo-project

2. Video

3. Animation List

4. Technical Information

Features:

• Number of Blueprints: 17

• Input: (Keyboard, Mouse)

• Network Replicated: Not Tested

ABP created only for the UE5 Mannequin skeleton.

This package categorizes animations as follows:

• Cover stand (CoverHi): 121

• Cover crouch (CoverLo): 121

Total Animations:

• Root Motion: 121

• In Place: 121

Retargeting:

• Animations retargeted for Unreal skeleton.

Rigging & Skeleton:

• Rigged to Epic skeleton: Yes

• IK Bones Included: Yes

Animation Count:

• Root Motion: 121

• In Place: 121

Animation Types:

• Root Motion & In Place

Characters:

• 1 character SK_Mannequin UE5

Supported Platforms:

• Windows: Yes

• Mac: Yes

Source Files:

• Included - Downloadable from the Additional Files section on the Fab.com website. Includes .fbx files for direct import and MotionBuilder files for editing in any 3D software.

Table of Contents

Migrate Logic to your project
Enable the Motion Warping
Copy Custom Data
Setup Cover animations
Create custom Anim Slot
Setup custom structures to store animations
Recompile custom Data Assets
Add necessary logic to Pawn
Add events in the character’s ABP for custom Anim Notifies
Hints For Custom Modifications
Credits

Migrate logic to your project

The proposed sequence of steps will allow you to copy the basic CoverSet logic into your project.

Make sure the CoverSystem project UE version is identical to your project UE version. This is necessary to carry out the asset migration process according to the given steps.

It uses Root Motion solution!

Enable the Motion Warping

In this solution Motion Warping is used to snap the pawn’s root to the obstacle while moving across. You can find details in the Epic’s documentation : https://docs.unrealengine.com/5.0/en-US/motion-warping-in-unreal-engine/

1. Open your project in the UE editor.

2. Go to Edit -> Plugins.

1. Enable Motion Warping plugin.

1. Restart the editor.

2. Go to Edit -> Plugins again and check if the Motion Warping plugin is enabled.

3. Close the editor with you project.

Copy Custom Data

This step uses the migrate action available for .uassets. This speeds up the process of migrating assets between UE projects.

To be able to migrate assets, it is important to set the folder properties of your project correctly.

To do this, follow the steps below:

1. If you still have your project open in the UE editor, close it.

2. Open File Explorer.

3. Navigate to the main folder of your project.

4. Right-click on this folder and open Properties.

1. Make sure the read-only checkbox is unchecked.

1. Press the Apply button and then Ok.

2. Open the CoverSet project in the UE editor.

3. Open ContentBrowser.

4. Navigate to the CoverSet folder.

5. Right-click on this folder and click on Migrate.

1. Select folders and assets as in the image below.

Due to the fact that UE 5.3 template projects use EnhancedInput as the default input handling solution, but in earlier versions it is Binding in the Project Settings, this step of the migration process depends on the input you have in your project.

For UE projects using EnhancedInput

For UE projects using Binding Input in Project Settings

1. Click Ok button.

2. File Explorer should appear so you can select your project folder. Be sure to select the Content folder (otherwise the migration will fail).

3. Now you should have the following folders and assets in your project folder visible in File Explorer.

1. Open you project in the UE editor.

2. Click Fix Up Redirectors in Folder on the folder to which you migrated the data in an earlier step.

Setup Cover animations

The following setup needs animations from RootMotion. Make sure you use the correct ones dedicated to this solution (”…\Content\CoverSet\Animations\Mannequin\RootMotion”).

Create custom AnimNotifies in a skeleton

Anim Notifes are used to handle events in a specific animation frame or animation time range. You can read more in the Epic’s documentation: https://docs.unrealengine.com/5.0/en-US/animation-notifies-in-unreal-engine/

1. Open the skeleton of the character you are adapting this solution for. If you are using the template UE project, this will probably be SK_Mannequin.

2. Right-click on a free space in the Animation Notifies tab. You should see a context menu for creating new anim notifies.

1. Click New… and add all of the following names. You will use them later in the setup of some cover set animation sequences.

*Cover_EnableCoverSnapRotation*

*Cover_EnableCoverInput*

*Cover_EndLook*

*Cover_SetForcedIdleState*

*Cover_EndThroughObstacles*

*Cover_EndHighLowTransition*

1. Save the skeleton asset.

Create custom Anim Slot

More information about animation slots are here: https://docs.unrealengine.com/5.0/en-US/animation-slots-in-unreal-engine/

1. Open your character ABP.

2. Go to Window→Anim Slot Manager.

1. Press Add Slot in the Anim Slot Manager.

1. Type CoverAdditionals in the pop-up and press enter.

1. You should see new CoverAdditionals anim slot on the list.

1. Set this slot in the AnimGraph.

1. Compile and save your ABP asset.

Create custom AnimMontages

The proposed CoverSet mechanic uses custom Anim Montages for two cases:

• playing animations of passing through obstacles,

• looking up from behind the wall.

1. In Content Browser navigate to the folder with RootMotion animations: (”…\Content\CoverSet\Animations\Mannequin\RootMotion”).

2. Right-click on the content free space and press the Animation→Anim Montage.

   

3. Select the skeleton you are using.

4. Give your new asset name AM_CoverHi_L_Through_Obstacle and open it.

1. Open this Anim Montage.

2. Change default anim slot to the CoverAdditionals.

1. Drag and drop A_CoverHi_L_ThroughObstacle from the Asset Browser to the anim montage track.

1. Save this anim montage.

2. Repeat steps 2-8 for below anim montages names:

   AM_CoverHi_R_Through_Obstacle (drag and drop A_CoverHi_R_ThroughObstacle)

AM_CoverLo_L_Through_Obstacle (drag and drop A_CoverLo_L_ThroughObstacle)

AM_CoverLo_R_Through_Obstacle (drag and drop A_CoverLo_R_ThroughObstacle)

1. You should have new, 4 Anim Montages for passing throug obstacles.

1. Now create Anim Montages for looking up. Right-click on the content free space and press the Animation→Anim Montage again.

2. Rename new Anim Montage with AM_CoverHi_Look_Center_L.

3. Open this Anim Montage (AM_CoverHi_Look_Center_L).

4. Change slot anim group to the CoverAdditionals.

1. Drag and drop A_CoverHi_Look_Center_L_Start to the anim track.

1. Drag and drop A_CoverHi_Look_Center_L_Loop to the anim track next to the previous anim sequence.

1. Drag and drop A_CoverHi_Look_Center_L_End to the anim track next to the previous anim sequence.

1. Right-click on the free space in the section tracks to create a new section.

1. Create Loop anim section on the 45 frame.

1. In the same way, create an End section on the 126 frame.

1. Go to the Montage Sections tab. Press the arrow between Loop and End section. Choose the Loop option.

1. Your AM_CoverHi_Look_Center_L should it should look like this:

1. Repeat steps 11-22 for the following combinations:

AM_CoverHi_Look_Center_R:

- Default section: A_CoverHi_Look_Center_R_Start

- Loop section (frame 40): A_CoverHi_Look_Center_R_Loop

- End section (frame 121): A_CoverHi_Look_Center_R_End

AM_CoverLow_Look_Center_R:

• Default section: A_CoverLo_Look_Center_R_Start

• Loop section (frame 35): A_CoverLo_Look_Center_R_Loop

• End section (frame 106): A_CoverLo_Look_Center_R_End

1. Finally, you should have 8 new Anim Montages as shown in the image below:

Add custom AnimNotifies to some cover set animation sequences

Here you created custom anim notifies. Now you need to set them in few animations.

1. Open A_CoverHi_L_ThrowBait.

2. Optionally, you can change default notify track name from 1 to CoverNotifies.

1. Righ-click on the free space in the Notify track.

2. Add CovetSet_EnableCoverInput anim notify **on the 50 frame.

1. Repeat adding the appropriate notifications according to the list below.

A_CoverHi_L_ThrowBait

• Cover_EnableCoverInput (frame 50)

A_CoverHi_R_ThrowBait

• Cover_EnableCoverInput (frame 50)

A_CoverLo_L_ThrowBait

• Cover_EnableCoverInput (frame 40)

A_CoverLo_R_ThrowBait

• Cover_EnableCoverInput (frame 35)

A_CoverHi_L_to_CoverLo_L

• Cover_EndHighLowTransition (frame 40)

A_CoverHi_L_to_CoverLo_R

• Cover_EndHighLowTransition (frame 60)

A_CoverHi_R_to_CoverLo_L

• Cover_EndHighLowTransition (frame 50)

A_CoverHi_R_to_CoverLo_R

• Cover_EndHighLowTransition (frame 35)

A_CoverLo_L_to_CoverHi_L

• Cover_EndHighLowTransition (frame 50)

A_CoverLo_L_to_CoverHi_R

• Cover_EndHighLowTransition (frame 30)

A_CoverLo_R_to_CoverHi_L

• Cover_EndHighLowTransition (frame 27)

A_CoverLo_R_to_CoverHi_R

• Cover_EndHighLowTransition (frame 56)

A_CoverHi_Walk_L_Stop

• Cover_SetForcedIdleState (frame 30)

A_CoverHi_Walk_R_Stop

• Cover_SetForcedIdleState (frame 30)

A_CoverLo_Walk_L_Stop

• Cover_SetForcedIdleState (frame 45)

A_CoverLo_Walk_R_Stop

• Cover_SetForcedIdleState (frame 50)

A_Idle_to_CoverHi_L

• Cover_EnableCoverSnapRotation (frame 25)

• Cover_EnableCoverInput (frame 42)

A_Idle_to_CoverHi_R

• Cover_EnableCoverSnapRotation (frame 20)

• Cover_EnableCoverInput (frame 50)

A_Idle_to_CoverLo_L

• Cover_EnableCoverSnapRotation (frame 20)

• Cover_EnableCoverInput (frame 58)

A_Idle_to_CoverLo_R

• Cover_EnableCoverSnapRotation (frame 30)

• Cover_EnableCoverInput (frame 54)

AM_CoverHi_L_Through_Obstacle

• Cover_EndThroughObstacles (frame 132)

• Motion Warping (Notify Begin : 1.019539, Anim State Duration: 0.663029)

Click on the Motion Warping anim notify and set Root Motion Modifier in the Details Tab:

AM_CoverHi_R_Through_Obstacle

• Cover_EndThroughObstacles (frame 125)

• Motion Warping (Notify Begin : 0.855249, Anim State Duration: 0.792114)

Click on the Motion Warping anim notify and set Root Motion Modifier in the Details Tab:

AM_CoverLo_L_Through_Obstacle

• Cover_EndThroughObstacles (frame 150)

• Motion Warping (Notify Begin : 1.019539, Anim State Duration: 0.692366)

Click on the Motion Warping anim notify and set Root Motion Modifier in the Details Tab:

AM_CoverLo_R_Through_Obstacle

• Cover_EndThroughObstacles (frame 150)

• Motion Warping (Notify Begin : 1.019539, Anim State Duration: 0.692366)

Click on the Motion Warping anim notify and set Root Motion Modifier in the Details Tab:

AM_CoverHi_Look_Center_L

• Cover_EndLook (frame 162)

AM_CoverHi_Look_Center_R

• Cover_EndLook (frame 153)

AM_CoverLow_Look_Center_L

• Cover_EndLook (frame 140)

AM_CoverLow_Look_Center_R

• Cover_EndLook (frame 154)

Setup custom structures to store animations

There are few custom structures that store references to animations.

1. Open F_CoverHighAdditionalAnimations and assign animations according to the images below.

1. Open F_CoverLowAdditionalAnimations and assign animations according to the images below.

1. Open F_CoverLowAdditionalAnimations and assign animations according to the images below.

Recompile custom Data Assets

There is a custom Data Asset (DA_) which is used by the system to select an appropriate animations.

1. Open the editor.

2. Open DA_CoverAdditionalAnimationsBase asset.

3. Check if animations are assigned in the details panel as in the structures from the previous step.

1. Click compile.

2. Save this asset.

3. Open DA_CoverAdditionalAnimations asset.

4. Check if animations are assigned in the details panel as in the structures from the previous step.

1. Save this asset.

Add sockets to the skeleton

Custom sockets are used to track and detect walls and obstacles.

1. Open the skeleton of the character you are adapting this solution for. If you are using the template UE project, this will probably be SK_Mannequin.

2. Right-click on a root in bones hierarchy tree and press Add Socket.

1. Add sockets as per the images below. Pay attention to their location in the Details panel. Make sure the rotation of all custom sockets is zero.

LookAimRight

• Location: (-55.0, 0.0, 53.601317)

LookAimLeft

• Location: (55.0, 0.0, 53.601317)

WallCoverHighCheck

• Location: (0.0, 0.0, 130.457701)

WallForwardCheck

• Location: (0.0, 14.462126, 64.098026)

WallCornerCheckLeft

• Location: (-40.0, 0.0, 50.0)

1. Save the skeleton asset.

Add necessary logic to Pawn

Open the pawn you are adapting this solution for. If you are using the template UE project, this will probably be BP_ThirdPersonCharacter.

AC_CoverComponent

AC_CoverComponent is a dedicated actor component that needs to be added to your Pawn. It does all the calculations to CoverSet and manages the logic.

1. Add AC_CoverComponent.

1. Compile and save the Pawn.

Motion Warping Component

As mentioned earlier, Motion Warping is used to play passing obstacles animations.

1. Add Motion Warping.

1. Compile and save the Pawn.

Components Verification

Now you should have those two components in your Pawn.

Adding new input control methods to Pawn

In order for the CoverSet logic to be used, you need to add input support and some custom methods to your Pawn.

1. Add AddMovementInput method or copy it from the CoverSet BP_ThirdPersonCharacter.

2. If you didn’t copy this method from BP_ThirdPersonCharacter, paste this blueprint to your method:

https://blueprintue.com/render/9o_vc2d0/

(but remember to set arguments manually for it).

1. Add AddMovementInputSides method or copy it from the CoverSet BP_ThirdPersonCharacter.

2. If you didn’t copy this method from BP_ThirdPersonCharacter, paste this blueprint to this method:

https://blueprintue.com/render/ab689w1l/

(but remember to set arguments manually for it).

1. Set calling those methods in your Pawn like in this picture.

5.1. For EnhancedInput

5.2. For Binding Input

1. Compile and save the Pawn asset.

2. Set input bindings and input events.

For Enhanced Input (default in 5.3)

7.1. Check if you have IA_ assets.

7.2. Open your InputMappingContext (IMC_) asset and add cover set IA_ assets.

7.3. Copy and paste this blueprint to the Pawn’s Event Graph:

https://blueprintue.com/render/sy_mt-k_/

https://blueprintue.com/render/sy_mt-k_/

For Binding Input (default in 5.0 - 5.2)

7.1. Go to Edit→Project Settings → Engine → Inputs and binding cover set inputs.

7.2. Copy and paste this blueprint to the Pawn’s Event Graph:

https://blueprintue.com/render/k99s5c2s/

1. Compile and save your Pawn asset.

Add events in the character’s ABP for custom Anim Notifies

To use the created AnimNotifies, you need to add events for them in the character's ABP.

The examples below contain images from a dedicated ABP_Manny_Cover in the sample CoverSet project. You need to perform the following steps on your character’s ABP for which you are adapting this solution.

1. Open the character’s ABP.

2. Create those variables:

   • CurrentCoverState (ECoverStates)

   • CurrentCoverDirectionState (ECoverDirections)

   • CharacterOwner (Your Pawn Blueprint)

   • SnapToObstacleMotionWarpingName (Name)

1. Copy and paste this blueprint to the end of the EventBlueprintInitializeAnimation (rememebr to set casting pin from the Character like in th epicutre below):

https://blueprintue.com/render/p3u7y52h/

1. Copy and paste this blueprint with custom Anim Notifies events to your EventGraph:

https://blueprintue.com/render/mhrx5eye/

1. Go to your Locomotion state machine. Copy “Cover” anim state machine from the ABP_MannyCover and pase it to your Pawn’s ABP.

1. If you want to pass to the Cover state set the condition:

1. If you want to pass from the Cover state to the Idle state set the condition:

1. If you want to pass from the Cover state to the Walk/Run state set the condition:

1. Set you Cover state anim graph nodes if they disapeared during copying.

1. Set RootMotionFromEverything in your ABP.

1. You can check how it is implemented in the CoverSet ABP_MannyCover example.

Hints For Custom Modifications

Tips For Custom Modifications

This solution is a basic implementation. You can expand and modify it to suit your needs.

The following subsections contain tips that may be useful to you when adapting the solution to your project.

Custom Enums

The above enums are used both in custom structures and in the calculation logic in AC_CoverComponent. You can extend them as you wish or add similar ones based on this.

E_CoverAdditionalAnimationType - contains all available animation types in cover system logic different then idles and loops (ThroughObstacle, LookAiming, ThrowItem, CoverTypeTransition).

E_CoverDirections - four types are specifed; standing in idle (left, right) and moving (left, right).

E_CoverHighLowTransitionTypes - provides types for transitions between different directions (right, left) and heights (up, down) (e.g. HighLeftToLowLeft, LowRightToHighRight). You can expand them or use them to your additional mechanics. Check PlayHighLowTransitionAnimation method and its usage in EnableCovering in AC_CoverComponent.

E_CoverStates - is responsible for types determining whether it is a standing (cover up) or crouching cover (cover down) (CoverStand, CoverCrouch, NoCover).

E_CoverToIdleTypes - it is used in the logic that determines the type of end cover. If a character is on the corner of walls and the player forces the move, this will be a CoverRightToSide or CoverLeftToSide condition. Otherwise CoverRightToIdleForward or CoverRightToIdleForward. Check SelectCoverEndToIdleAnimation method in the AC_CoverComponent.

Custom structures for animation references

In this project, two custom structures were created to store references to Cover Set animations. You can treat them as a base for placing references for subsequent animations and expanding this solution.

F_CoverHighAdditionalAnimations - uses custom enums to store references to the Cover Set High (cover up) animations. This structure is as a variable in DA_CoverAdditionalAnimatioBase which contains a number of methods that return the appropriate animation for a given situation in runtime.

F_CoverLowAdditionalAnimations - uses custom enums to store references to the Cover Set Low (cover low) animations. This structure is as a variable in DA_CoverAdditionalAnimatioBase which contains a number of methods that return the appropriate animation for a given situation in runtime.

DA_CoverAdditionalAnimationBase

This is the base class providing:

• ability to store references to custom structures,

• calling a method that retrieves specific animation.

It is highly recommended to add further animations to custom structures and then create a method in this class that will return them in other blueprints e.g. in AC_CoverComponent. Thanks to this, you will have all the operations for getting animations in one place.

The use of methods from this blueprint that allow you to take appropriate animations can be found in those AC_CoverComponent methods: EnableCovering, SelectCoverDirectionTransitionAdditionalAnim, SelectCoverEndToIdleAnimation, PlayHighLowTransitionAnimation, ThrowItem, PlayLookAimingAnimation, PlayThroughObstacleAnimation by finding reference “Get CoverAdditionalAnimationsDataAsset”.

An example of calling one of the *DA_CoverAdditionalAnimationBase’*s method:

DA_CoverAdditionalAnimation

This is a child of the base class DA_CoverAdditionalAnimationBase. It is used in AC_CoverComponent as an assigned Data Asset to get information about available animations.

In you next steps, you can create your own similar data assets and thus get animations in AC_CoverComponent.

AC_CoverComponent

This component is the heart and brain of the entire solution. This is where tracing, calculations and animation playback take place. Methods and variables are assigned to different categories so that you can more easily find the appropriate fragments responsible for specific tasks.

States - operations responsible for changing states in the system (e.g. switching from cover up to cover down (crouch)).

Tracing - fragments related to detecting walls and obstacles.

Debug - logic to help debug. Prints information about incorrect setup and provides the ability to render debug traces.

Animation - they help in playing the animations. The animations themselves are stored in dedicated Data Assets, not in this component.

Tracing

One of the most important elements of this solution is tracing for detecting walls and obstacles.

To see all traces for detection walls in runtime, find the DrawAllTraceDebugs variable in AC_CoverComponent.

The logic for tracing can be found in AC_CoverComonent in the Trace category.

Tracing occurs for several actions.

• Checking if the character is standing against the wall to start/end the cover.

• Line tracing in the direction the character moves along the wall to detect the wall in front of the character.

• Box tracing from the chest behind the back to check if the wall is high (and force a crouch if it is low).

• Double line tracing from the side of the knees to the back to detect walls and decide whether to finish the cover if there is no wall behind or to check if the character can start look aiming.

• Capsule tracing in front of the character to detect obstacles.

The key methods are in AC_CoverComponent:

TraceLinesToDetectWallsAndObstacles

TraceLookAimFreeSpace

You can find there the operations described above. Additionally, if you want to change values that affect tracing, you will find them in the same category among variables.

Custom sockets on the skeleton are also important, as they are starting points for tracing. You can change their position for adapting the tracing to your character's size and locomotion needs. You added those socktes in this step.

Additionally, the project includes the F_CoverTracedObject structure for storing information from basic line tracing for walls during cover. It only has one variable, but you can expand it in the future.

Snapping to a wall

Snapping locations and character rotation to the wall can be found in the AttachCharacterToTracedCoverObject and RotateCharacterToTracedCoverObject methods in AC_CoverComponent.

The following parameters affect snapping speed.

BP_Obstacle

This actor is prepared to play the animation of crossing over an obstacle.

As previously described here, this animated action is handled using MotionWarping.

You can read about the details in the Epic documentation here.

BP_Obstacle has an MotionWarpingSnapPoint in its hierarchy. This is the snap orientation point for Motion Warping anim notifications while the animation is playing. The location and rotation of this point is returned by the methods GetSnapLocation and GetSnapRotation . They are called in the AC_CoverComponent in the TraceObstalces method just before the animation is triggered.

You can move this point according to your needs.

Instances of this actor can be found on the demo level.

Custom Log Errors

When you extend this solution you can use the custom LogError in AC_CoverComponent. This is a good practice that will help you find setup and logical errors. It is used many times in this component, so you can see examples.

Credits

Full “Cover System” Programming - Anorien