> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinemation.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Gameplay animation

> Configure animation settings, procedural Animation Blueprints, layer interfaces, and the Sci-Fi FPS Pack animation graph.

export const intro_0 = "The Sci-Fi FPS Pack uses AC_GameplayAnimation to select animation settings, resolve overrides, play character and weapon montages, and feed movement and weapon state into its procedural Animation Blueprints."

export const settingsAssetName_0 = "BP_Gameplay_AnimationSettings"

export const configAssetName_0 = "BP_GameplayAnimationConfig"

export const configImageCaption_0 = "BP_GameplayAnimationConfig collects reusable animation configuration for the gameplay component."

export const configImage_0 = 
  <img
    src="/images/gameplay-framework/unreal/BP_GameplayAnimationConfig.png"
    alt="BP GameplayAnimationConfig Blueprint editor showing the animation configuration asset structure"
  />

export const generalImageCaption_0 = "Animation settings General section with idle pose, overlay class, and procedural layer class."

export const generalImage_0 = 
  <img
    src="/images/gameplay-framework/unreal/AnimationSettings_General.png"
    alt="Animation settings General section showing Idle Pose, Overlay Class, and Procedural Layer Class"
  />

export const viewmodelOffsetImageCaption_0 = "Viewmodel Offset section with pivot, weapon, and hand offsets."

export const viewmodelOffsetImage_0 = 
  <img
    src="/images/gameplay-framework/unreal/AnimationSettings_General_ViewmodelOffset.png"
    alt="Animation settings Viewmodel Offset section showing pivot location, rotation, scale, and weapon and hand offsets"
  />

export const proceduralMovementImageCaption_0 = "Procedural Movement section with motion, intensity, play rate, and movement-state offsets."

export const proceduralMovementImage_0 = 
  <img
    src="/images/gameplay-framework/unreal/AnimationSettings_ProceduralMovement.png"
    alt="Animation settings Procedural Movement section showing idle motion, intensity, play rate, and movement-state entries"
  />

export const shooterSettingsAssetName_0 = "BP_Shooter_AnimationSettings"

export const overlayInterfaceName_0 = "ALI_Gameplay_Overlay"

export const proceduralInterfaceName_0 = "ALI_Gameplay_ProceduralLayer"

export const shooterSettingsImageCaption_0 = "ShooterCore animation settings class and interface assets."

export const shooterSettingsImage_0 = 
  <img
    src="/images/shooter-core/unreal/ShooterAnimationSettings_and_Interface.png"
    alt="Content Browser showing BP Shooter AnimationSettings Blueprint Class and BPI Shooter Animation Settings Blueprint Interface"
  />

export const aimingImageCaption_0 = "Shooter animation settings Aiming properties."

export const aimingImage_0 = 
  <img
    src="/images/shooter-core/unreal/ShooterAnimationSettings_Aiming.png"
    alt="Shooter animation settings Aiming section showing Ads Speed, Ads Easing, Ads Additive Blend, and Ads FOV"
  />

export const recoilImageCaption_0 = "Shooter animation settings Recoil property."

export const recoilImage_0 = 
  <img
    src="/images/shooter-core/unreal/ShooterAnimationSettings_Recoil.png"
    alt="Shooter animation settings Recoil section showing the Recoil Data asset property"
  />

export const swayImageCaption_0 = "Shooter animation settings Movement Sway properties."

export const swayImage_0 = 
  <img
    src="/images/shooter-core/unreal/ShooterAnimationSettings_Sway.png"
    alt="Shooter animation settings Movement Sway section showing position spring values and ADS scale"
  />

export const proceduralLayerDescription_0 = "ABP_SciFi-FPS connects the product animation graph to the shared gameplay layers. Its linked ABP_Procedural_SciFi-FPS layer reads the configured animation settings and combines movement, aiming, additive, sway, IK, and viewmodel-offset processing before returning the final pose."

export const proceduralAssets_0 = <><code>ABP_Procedural_ADS</code>, <code>ABP_Procedural_AimOffset</code>, <code>ABP_Procedural_Locomotion</code>, and <code>ABP_Procedural_Viewmodel</code>, with the supplied UE5 variants</>

export const interfaceImage_0 = 
  <Frame caption="A compatible Animation Blueprint implements the gameplay overlay and procedural layer interfaces.">
    <img src="/images/gameplay-framework/unreal/ABP_ImplementedInterfaces_Gameplay-Overlay_Gameplay-Procedural-Layer.png" alt="Animation Blueprint Class Settings with Gameplay Overlay and Gameplay Procedural Layer interfaces implemented" />
  </Frame>

export const proceduralLayerImages_0 = 
  <>
    <Frame caption="ABP_SciFi-FPS combines the base pose and linked gameplay animation layers.">
      <img src="/images/sci-fi-fps-pack/unreal/ABP_SciFi-FPS_AnimGraph_00000.png" alt="ABP SciFi FPS AnimGraph connecting the character pose to the shared overlay and procedural animation layers" />
    </Frame>
    <Frame caption="ABP_Procedural_SciFi-FPS procedural layer initialization and shared animation data flow, part 1.">
      <img src="/images/sci-fi-fps-pack/unreal/ABP_Procedural_SciFi-FPS_ProceduralLayer_00000.png" alt="ABP Procedural SciFi FPS graph beginning the procedural layer setup and animation data flow" />
    </Frame>
    <Frame caption="ABP_Procedural_SciFi-FPS procedural layer pose processing, part 2.">
      <img src="/images/sci-fi-fps-pack/unreal/ABP_Procedural_SciFi-FPS_ProceduralLayer_00001.png" alt="ABP Procedural SciFi FPS graph continuing procedural pose processing" />
    </Frame>
    <Frame caption="ABP_Procedural_SciFi-FPS procedural layer locomotion and viewmodel processing, part 3.">
      <img src="/images/sci-fi-fps-pack/unreal/ABP_Procedural_SciFi-FPS_ProceduralLayer_00002.png" alt="ABP Procedural SciFi FPS graph applying locomotion and viewmodel procedural data" />
    </Frame>
    <Frame caption="ABP_Procedural_SciFi-FPS procedural layer aiming processing, part 4.">
      <img src="/images/sci-fi-fps-pack/unreal/ABP_Procedural_SciFi-FPS_ProceduralLayer_00003.png" alt="ABP Procedural SciFi FPS graph applying aiming data in the procedural layer" />
    </Frame>
    <Frame caption="ABP_Procedural_SciFi-FPS procedural additive processing, part 5.">
      <img src="/images/sci-fi-fps-pack/unreal/ABP_Procedural_SciFi-FPS_ProceduralLayer_00004.png" alt="ABP Procedural SciFi FPS graph combining procedural additive animation" />
    </Frame>
    <Frame caption="ABP_Procedural_SciFi-FPS weapon sway processing, part 6.">
      <img src="/images/sci-fi-fps-pack/unreal/ABP_Procedural_SciFi-FPS_ProceduralLayer_00005.png" alt="ABP Procedural SciFi FPS graph applying weapon sway to the procedural pose" />
    </Frame>
    <Frame caption="ABP_Procedural_SciFi-FPS IK and viewmodel offset processing, part 7.">
      <img src="/images/sci-fi-fps-pack/unreal/ABP_Procedural_SciFi-FPS_ProceduralLayer_00006.png" alt="ABP Procedural SciFi FPS graph applying IK motion and viewmodel offsets" />
    </Frame>
    <Frame caption="ABP_Procedural_SciFi-FPS final procedural pose output, part 8.">
      <img src="/images/sci-fi-fps-pack/unreal/ABP_Procedural_SciFi-FPS_ProceduralLayer_00007.png" alt="ABP Procedural SciFi FPS graph producing the final procedural animation layer pose" />
    </Frame>
  </>

export const expectedResult_0 = "The animation settings select compatible content, the procedural layer returns a final pose for the character, and AC_GameplayAnimation resolves the configured animation assets and montages for the Sci-Fi FPS Pack."

## Gameplay animation runtime

{intro_0}

<code>AC\_GameplayAnimation</code> coordinates the active settings asset, action state, paired montage playback, animation overrides, and lean state.

| Function                                                                                        | Use                                                                                        |
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| <code>UpdateAnimationSettings</code>                                                            | Switches the active animation settings asset after the character and mesh are initialized. |
| <code>StartAction</code> / <code>EndAction</code>                                               | Gates an active character or item action.                                                  |
| <code>PlayCharacterMontage</code> / <code>PlayItemMontage</code>                                | Plays synchronized character and item content.                                             |
| <code>ResolveMontage</code>, <code>ResolveAnimInstance</code>, <code>ResolveAnimSequence</code> | Applies configured overrides before playback.                                              |
| <code>UpdateLeaning</code>                                                                      | Applies the runtime lean state.                                                            |

## Animation settings

<code>{settingsAssetName_0}</code> is the data asset that selects the animation content and the procedural layers used by the character. <code>{configAssetName_0}</code> is the editor-authored configuration asset used to organize those settings.

| Section             | Properties                                                                                                                        | What they control                                                                            |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| General             | <code>Idle Pose</code>, <code>Overlay Class</code>, <code>Procedural Layer Class</code>                                           | Base pose and the Animation Blueprint classes that provide overlay and procedural layers.    |
| Viewmodel Offset    | <code>PivotOffset</code>, <code>WeaponOffset</code>, <code>RightHandOffset</code>, <code>LeftHandOffset</code>                    | Position, rotation, and scale adjustments for the first-person weapon and hand presentation. |
| Procedural Movement | <code>Idle</code>, <code>Walk</code>, <code>Sprint</code>, <code>Jump Start</code>, <code>Jump Loop</code>, <code>Jump End</code> | Motion asset, intensity, play rate, and offset for each movement state.                      |
| Aiming              | <code>Ads Speed</code>, <code>Ads Easing</code>, <code>Ads Additive Blend</code>, <code>Ads FOV</code>                            | The transition and camera values used by the shooter animation layer while aiming.           |
| Recoil              | <code>Recoil Data</code>                                                                                                          | The <code>DA\_RecoilData</code> asset used by the shooter animation and recoil path.         |
| Sway                | Movement and aiming sway spring values                                                                                            | Position and rotation response to movement and aiming input.                                 |

<Frame caption={configImageCaption_0}>
  {configImage_0}
</Frame>

<Frame caption={generalImageCaption_0}>
  {generalImage_0}
</Frame>

<Frame caption={viewmodelOffsetImageCaption_0}>
  {viewmodelOffsetImage_0}
</Frame>

<Frame caption={proceduralMovementImageCaption_0}>
  {proceduralMovementImage_0}
</Frame>

### Shooter animation settings

<code>{shooterSettingsAssetName_0}</code> extends the settings contract for weapon presentation. It works with <code>{overlayInterfaceName_0}</code> and <code>{proceduralInterfaceName_0}</code>; the assigned Animation Blueprint must implement the interfaces expected by the configured layer classes.

<Frame caption={shooterSettingsImageCaption_0}>
  {shooterSettingsImage_0}
</Frame>

<Frame caption={aimingImageCaption_0}>
  {aimingImage_0}
</Frame>

<Frame caption={recoilImageCaption_0}>
  {recoilImage_0}
</Frame>

<Frame caption={swayImageCaption_0}>
  {swayImage_0}
</Frame>

## Procedural Animation Blueprints

{proceduralLayerDescription_0}

The supplied procedural choices include {proceduralAssets_0}.

The configured Animation Blueprint receives the character movement, gait, aim, lean, weapon, and viewmodel state through the shared animation interfaces. Its procedural layer combines the selected movement motion, additive or sway data, IK targets, viewmodel offsets, and the base pose, then returns the final pose to the character graph.

{interfaceImage_0}

{proceduralLayerImages_0}

## Apply a new settings asset

1. Create a project-owned <code>{settingsAssetName_0}</code> asset or duplicate a supplied asset that you must keep unchanged.
2. Assign compatible idle, movement, aiming, overlay, and procedural-layer assets.
3. Confirm that the selected mesh, Skeleton, Animation Blueprint, and UE4 or UE5 animation family match.
4. Call <code>AC\_GameplayAnimation.UpdateAnimationSettings(NewSettings)</code> after the character and mesh are initialized.
5. Use <code>BP\_GameplayAnimationOverride</code> when only selected assets differ; keep the complete settings asset stable.

<Warning>
  Do not mix a UE4 and UE5 animation family without verifying the Skeleton, retargeter, layer interfaces, and procedural graph.
</Warning>

<Check>
  {expectedResult_0}
</Check>