ALSCharacterAnimInstance.h

Go to the documentation of this file.

// Copyright:       Copyright (C) 2022 Doğa Can Yanıkoğlu
// Source Code:     https://github.com/dyanikoglu/ALS-Community
 
#pragma once
 
#include "CoreMinimal.h"
#include "Animation/AnimInstance.h"
#include "Data/BaseData.h"
#include "Interfaces/ALSAnimInterface.h"
#include "Interfaces/CustomAnimInstance.h"
#include "Library/ALSAnimationStructLibrary.h"
#include "Library/ALSStructEnumLibrary.h"
 
#include "ALSCharacterAnimInstance.generated.h"
 
// forward declarations
class UALSDebugComponent;
class AALSBaseCharacter;
class UCurveFloat;
class UAnimSequence;
class UCurveVector;
 
UCLASS(Blueprintable, BlueprintType)
class ALSV4_CPP_API UALSCharacterAnimInstance : public UAnimInstance, public ICustomAnimInstance, public IALSAnimInterface
{
    GENERATED_BODY()
 
public:
    virtual void NativeInitializeAnimation() override;
 
    virtual void NativeBeginPlay() override;
 
    virtual void NativeUpdateAnimation(float DeltaSeconds) override;
    virtual void NativeThreadSafeUpdateAnimation(float DeltaSeconds) override;
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Animation")
    void PlayTransition(const FALSDynamicMontageParams& Parameters);
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Animation")
    void PlayTransitionChecked(const FALSDynamicMontageParams& Parameters);
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Animation")
    void PlayDynamicTransition(float ReTriggerDelay, FALSDynamicMontageParams Parameters);
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Event")
    void OnJumped();
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Event")
    void OnPivot();
 
 
    //~     Custom Anim Instance    ~//
    
    virtual void SetFiringWeapon(const bool bValue) override;
 
    virtual void SetRecoilTransform(const FTransform& Transform) override;
    virtual void SetPivotPoint(const FTransform& Transform) override;
    virtual void DisableFootIK(const float DelayTime) override;
 
    virtual void SetInjured(const EBodyPartName BodyPartName, const float InjuredAmount) override;
 
    
    //~     Custom Anim Instance    ~//
    
    UFUNCTION(BlueprintImplementableEvent, Category="Custom ALS")
    void OnDisableFootIK(const float DelayTime);
    UFUNCTION(BlueprintImplementableEvent, Category="Custom ALS")
    void OnInjured(const EBodyPartName BodyPartName, const float InjuredAmount);
 
    UFUNCTION(BlueprintCallable, Category="Custom ALS")
    bool GetFiringWeapon() const{return bFiringWeapon;};
 
    virtual void SetEssentialInfo(const FALSAnimValues& Value) override;
    virtual void SetOptimize(const bool bValue) override;
    virtual void SetMovementState(const FALSMovementState& Value) override;
    virtual void SetOverlayOverrideState(const int32 Value) override;
    virtual void SetGait(const FALSGait& Value) override;
    virtual void SetStance(const FALSStance& Value) override;
    virtual void SetViewMode(const EALSViewMode Value) override;
    virtual void SetOverlayState(const FALSOverlayState& Value) override;
    virtual void SetNewGroundedEntryState(const FALSGroundedEntryState& Value) override;
    virtual void SetRotationMode(const FALSRotationMode Value) override;
    
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="ALS|Debug")
    bool bOptimize = false;
 
    UFUNCTION(BlueprintCallable, Category="Custom ALS")
    FRotator GetRecoilRotation() const {return RecoilTransform.Rotator();};
    UFUNCTION(BlueprintCallable, Category="Custom ALS")
    FVector GetPivotPointLocation() const {return PivotPoint.GetLocation() + GunOffset;};
    UFUNCTION(BlueprintCallable, Category="Custom ALS")
    bool GetShouldOverlayStateUsePRASIK() const;
 
protected:
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Grounded")
    void SetTrackedHipsDirection(EALSHipsDirection HipsDirection)
    {
        Grounded.TrackedHipsDirection = HipsDirection;
    }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Grounded")
    void SetGroundedEntryState(EALSGroundedEntryState NewState)
    {
        GroundedEntryState = NewState;
    }
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Grounded")
    bool ShouldMoveCheck() const;
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Grounded")
    bool CanRotateInPlace() const;
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Grounded")
    bool CanTurnInPlace() const;
 
    UFUNCTION(BlueprintCallable, Category = "ALS|Grounded")
    bool CanDynamicTransition() const;
 
private:
    void PlayDynamicTransitionDelay();
 
    void OnJumpedDelay();
 
    void OnPivotDelay();
 
    void UpdateAimingValues(float DeltaSeconds);
 
    void UpdateLayerValues();
 
    void UpdateFootIK(float DeltaSeconds);
 
    void UpdateMovementValues(float DeltaSeconds);
 
    void UpdateRotationValues();
 
    void UpdateInAirValues(float DeltaSeconds);
 
    void UpdateRagdollValues();
 
    void SetFootLocking(float DeltaSeconds, FName EnableFootIKCurve, FName FootLockCurve, FName IKFootBone,
                          float& CurFootLockAlpha, bool& UseFootLockCurve,
                          FVector& CurFootLockLoc, FRotator& CurFootLockRot) const;
 
    void SetFootLockOffsets(float DeltaSeconds, FVector& LocalLoc, FRotator& LocalRot) const;
 
    void SetPelvisIKOffset(float DeltaSeconds, FVector FootOffsetLTarget, FVector FootOffsetRTarget);
 
    void ResetIKOffsets(float DeltaSeconds);
 
    void SetFootOffsets(float DeltaSeconds, FName EnableFootIKCurve, FName IKFootBone, FName RootBone,
                          FVector& CurLocationTarget, FVector& CurLocationOffset, FRotator& CurRotationOffset) const;
 
    void RotateInPlaceCheck();
 
    void TurnInPlaceCheck(float DeltaSeconds);
 
    void DynamicTransitionCheck();
 
    FALSVelocityBlend CalculateVelocityBlend() const;
 
    void TurnInPlace(FRotator TargetRotation, float PlayRateScale, float StartTime, bool OverrideCurrent);
 
    FVector CalculateRelativeAccelerationAmount() const;
 
    float CalculateStrideBlend() const;
 
    float CalculateWalkRunBlend() const;
 
    float CalculateStandingPlayRate() const;
 
    float CalculateDiagonalScaleAmount() const;
 
    float CalculateCrouchingPlayRate() const;
 
    float CalculateLandPrediction() const;
 
    FALSLeanAmount CalculateAirLeanAmount() const;
 
    EALSMovementDirection CalculateMovementDirection() const;
 
    float GetAnimCurveClamped(const FName& Name, float Bias, float ClampMin, float ClampMax) const;
 
public:
    UPROPERTY(BlueprintReadOnly, Category = "Read Only Data|Character Information")
    TObjectPtr<AALSBaseCharacter> Character = nullptr;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Character Information", Meta = (
        ShowOnlyInnerProperties))
    FALSAnimCharacterInformation CharacterInformation;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Character Information")
    FALSMovementState MovementState = EALSMovementState::None;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Character Information")
    FALSMovementAction MovementAction = EALSMovementAction::None;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Character Information")
    FALSRotationMode RotationMode = EALSRotationMode::VelocityDirection;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Character Information")
    FALSGait Gait = EALSGait::Walking;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Character Information")
    FALSStance Stance = EALSStance::Standing;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Character Information")
    FALSOverlayState OverlayState = EALSOverlayState::Default;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Grounded", Meta = (
        ShowOnlyInnerProperties))
    FALSAnimGraphGrounded Grounded;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Grounded")
    FALSVelocityBlend VelocityBlend;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Grounded")
    FALSLeanAmount LeanAmount;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Grounded")
    FVector RelativeAccelerationAmount = FVector::ZeroVector;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Grounded")
    FALSGroundedEntryState GroundedEntryState = EALSGroundedEntryState::None;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Grounded")
    FALSMovementDirection MovementDirection = EALSMovementDirection::Forward;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - In Air", Meta = (
        ShowOnlyInnerProperties))
    FALSAnimGraphInAir InAir;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Aiming Values", Meta = (
        ShowOnlyInnerProperties))
    FALSAnimGraphAimingValues AimingValues;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Aiming Values")
    FVector2D SmoothedAimingAngle = FVector2D::ZeroVector;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Ragdoll")
    float FlailRate = 0.0f;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Layer Blending", Meta = (
        ShowOnlyInnerProperties))
    FALSAnimGraphLayerBlending LayerBlendingValues;
 
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Foot IK", Meta = (
        ShowOnlyInnerProperties))
    FALSAnimGraphFootIK FootIKValues;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Turn In Place", Meta = (
        ShowOnlyInnerProperties))
    FALSAnimTurnInPlace TurnInPlaceValues;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Rotate In Place", Meta = (
            ShowOnlyInnerProperties))
    FALSAnimRotateInPlace RotateInPlace;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Main Configuration", Meta = (
        ShowOnlyInnerProperties))
    FALSAnimConfiguration Config;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Blend Curves")
    TObjectPtr<UCurveFloat> DiagonalScaleAmountCurve = nullptr;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Blend Curves")
    TObjectPtr<UCurveFloat> StrideBlend_N_Walk = nullptr;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Blend Curves")
    TObjectPtr<UCurveFloat> StrideBlend_N_Run = nullptr;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Blend Curves")
    TObjectPtr<UCurveFloat> StrideBlend_C_Walk = nullptr;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Blend Curves")
    TObjectPtr<UCurveFloat> LandPredictionCurve = nullptr;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Blend Curves")
    TObjectPtr<UCurveFloat> LeanInAirCurve = nullptr;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Blend Curves")
    TObjectPtr<UCurveVector> YawOffset_FB = nullptr;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Blend Curves")
    TObjectPtr<UCurveVector> YawOffset_LR = nullptr;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Dynamic Transition")
    TObjectPtr<UAnimSequenceBase> TransitionAnim_R = nullptr;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Dynamic Transition")
    TObjectPtr<UAnimSequenceBase> TransitionAnim_L = nullptr;
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Anim Graph - Foot IK")
    FName IkFootL_BoneName = FName(TEXT("ik_foot_l"));
 
    UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = "Configuration|Anim Graph - Foot IK")
    FName IkFootR_BoneName = FName(TEXT("ik_foot_r"));
 
 
    //~     Custom Anim Vars    ~//
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Recoil")
    FVector GunOffset = FVector::ZeroVector;
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Recoil")
    FTransform RecoilTransform;
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Recoil")
    FTransform PivotPoint;
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Recoil")
    bool bFiringWeapon = false;
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Injured")
    EBodyPartName InjuredBodyPart = EBodyPartName::Pelvis;
    UPROPERTY(VisibleDefaultsOnly, BlueprintReadOnly, Category = "Read Only Data|Anim Graph - Injured")
    float InjuredAlpha = 0.0f;
    //~     Custom Anim Vars    ~//
 
 
private:
    FTimerHandle OnPivotTimer;
 
    FTimerHandle PlayDynamicTransitionTimer;
 
    FTimerHandle OnJumpedTimer;
 
    bool bCanPlayDynamicTransition = true;
 
    UPROPERTY()
    TObjectPtr<UALSDebugComponent> ALSDebugComponent = nullptr;
 
 
};