Added animation budget plugin implementation for bots

enabled animation budget plugin and implemented for the enemy minions. Included it with the significance manager

Author: tomlooman

ActionRoguelike.uproject

@@ -450,6 +450,10 @@
 		{
 			"Name": "TraceSourceFilters",
 			"Enabled": true
+		},
+		{
+			"Name": "AnimationBudgetAllocator",
+			"Enabled": true
 		}
 	],
 	"TargetPlatforms": [

Binaries/Win64/UnrealEditor-ActionRoguelike.dll

@@ -18,11 +18,12 @@ r.PSOPrecache.ProxyCreationWhenPSOReady=1
 r.PSOPrecache.Validation=2
 ; settings below for old bundled PSO steps to combine with PSO Precache
 r.ShaderPipelineCache.ExcludePrecachePSO=1
+; required for bundled PSO gathering
 r.ShaderPipelineCache.Enabled=1
 ; start up background mode so we can run hitchless in a main menu
 r.ShaderPipelineCache.StartupMode=2
-
-; required for bundled PSO gathering
+; Animation budgeter plugin
+a.Budget.Enabled=1
 
 [DevOptions.Shaders]
 NeedsShaderStableKeys=true

Config/DefaultEngine.ini

@@ -4,12 +4,16 @@
 
 [ViewDistanceQuality@0]
 SigMan.SignificanceBucketSizeMultiplier=0.5
+a.Budget.BudgetMs=1.0
 
 [ViewDistanceQuality@1]
 SigMan.SignificanceBucketSizeMultiplier=0.8
+a.Budget.BudgetMs=1.0
 
 [ViewDistanceQuality@2]
 SigMan.SignificanceBucketSizeMultiplier=1.0
+a.Budget.BudgetMs=1.0
 
 [ViewDistanceQuality@3]
-SigMan.SignificanceBucketSizeMultiplier=1.5
+SigMan.SignificanceBucketSizeMultiplier=1.5
+a.Budget.BudgetMs=1.0

Config/DefaultScalability.ini

@@ -10,6 +10,7 @@
 #include "NiagaraComponent.h"
 #include "SharedGameplayTags.h"
 #include "SignificanceManager.h"
+#include "SkeletalMeshComponentBudgeted.h"
 #include "UI/RogueWorldUserWidget.h"
 #include "Components/CapsuleComponent.h"
 #include "GameFramework/CharacterMovementComponent.h"
@@ -18,11 +19,15 @@
 #include "Components/AudioComponent.h"
 #include "Components/CanvasPanel.h"
 #include "Perception/AISense_Damage.h"
+#include "IAnimationBudgetAllocator.h"
+#include "AnimationBudgetAllocator/Private/AnimationBudgetAllocatorModule.h"
 
 #include UE_INLINE_GENERATED_CPP_BY_NAME(RogueAICharacter)
 
 
-ARogueAICharacter::ARogueAICharacter()
+ARogueAICharacter::ARogueAICharacter(const FObjectInitializer& ObjectInitializer)
+	// Override the SkelMesh with the Anim Budget variant for balancing anim cost across all AI bots
+	:Super(ObjectInitializer.SetDefaultSubobjectClass<USkeletalMeshComponentBudgeted>(ACharacter::MeshComponentName))
 {
 	ActionComp = CreateDefaultSubobject<URogueActionComponent>(TEXT("ActionComp"));
 	// Set some defaults, ideally we handle this through some data asset instead
@@ -63,6 +68,14 @@ void ARogueAICharacter::BeginPlay()
 {
 	Super::BeginPlay();
 
+	// Only needs to enable the module once, placing in beginplay for convenience
+	// They didn't expose the blueprint library, so we instead call directly into the module
+	FAnimationBudgetAllocatorModule& AnimationBudgetAllocatorModule = FModuleManager::LoadModuleChecked<FAnimationBudgetAllocatorModule>("AnimationBudgetAllocator");
+	if(IAnimationBudgetAllocator* AnimationBudgetAllocator = AnimationBudgetAllocatorModule.GetBudgetAllocatorForWorld(GetWorld()))
+	{
+		AnimationBudgetAllocator->SetEnabled(true);
+	}
+
 	// Significance Manager
 	{
 		USignificanceManager* SigMan = USignificanceManager::Get(GetWorld());
@@ -96,19 +109,33 @@ void ARogueAICharacter::BeginPlay()
 				DistanceSqrt *= 0.5f;
 			}
 
-			// Note: AI can further define significance, for example,
-			//			while in combat or having the player as a known target we could increase its significance
+			// Note: AI could further define significance, for example, while in combat or having the player as a known target we could increase its significance
 
 			// Negative distance to easily have larger distance mean lower significance
 			return -DistanceSqrt;
 		};
 
+		// Register with post significance function to easily tie-in with the animation budgeter
+		// We could also choose to let the budgeter calculate the significance itself instead
+		auto PostSignificanceFunc = [&](USignificanceManager::FManagedObjectInfo* ObjectInfo, float OldSignificance, float Significance, bool bFinal)
+		{
+			USkeletalMeshComponentBudgeted* BudgetMesh = Cast<USkeletalMeshComponentBudgeted>(GetMesh());
+			BudgetMesh->SetComponentSignificance(Significance);
+		};
+		
+
+		// Additional flag in the budgetter to allow us to 'toggle' and turn off certain animation features custom to the game, this could mean detaching components on our skeletal mesh
+		// it's entirely game dependent on what we could throttle here
+		USkeletalMeshComponentBudgeted* BudgetMesh = Cast<USkeletalMeshComponentBudgeted>(GetMesh());
+		BudgetMesh->OnReduceWork().BindUObject(this, &ARogueAICharacter::OnReduceAnimationWork);
+
 		// Instead of passing the entire Actor, we can pass the minimal data, such as the RootComponent, or SkeletalMeshComponent
 		// This should allow us to be more cache efficient (from simple testing this does run slightly faster than using the Actor)
-		SigMan->RegisterObject(GetMesh(), SignificanceTag, SignificanceFunc);
+		SigMan->RegisterObject(GetMesh(), SignificanceTag, SignificanceFunc, USignificanceManager::EPostSignificanceType::Concurrent, PostSignificanceFunc);
 	}
 }
 
+
 void ARogueAICharacter::EndPlay(const EEndPlayReason::Type EndPlayReason)
 {
 	// Remove from SigMan
@@ -241,6 +268,14 @@ void ARogueAICharacter::SignificanceLODChanged(int32 NewLOD)
 }
 
 
+void ARogueAICharacter::OnReduceAnimationWork(class USkeletalMeshComponentBudgeted* InComponent, bool bReduce)
+{
+	UE_LOG(LogGame, Warning, TEXT("OnReduceAnimWork for bot %s, reducing = %s"), *GetName(), (bReduce ? TEXT("true") : TEXT("false")));
+
+	// @todo: Actually throttle some work, for example, detach certain components on the skeletal mesh IF we had any in the first place
+}
+
+
 FGenericTeamId ARogueAICharacter::GetGenericTeamId() const
 {
 	// Fetch from the AI Controller who has built-in TeamId

Source/ActionRoguelike/AI/RogueAICharacter.cpp

@@ -60,12 +60,14 @@ class ACTIONROGUELIKE_API ARogueAICharacter : public ACharacter, public IGeneric
 public:
 
 	virtual void SignificanceLODChanged(int32 NewLOD) override;
+
+	void OnReduceAnimationWork(class USkeletalMeshComponentBudgeted* InComponent, bool bReduce);
 
 	virtual FGenericTeamId GetGenericTeamId() const override;
 
 	virtual void PostInitializeComponents() override;
 
-	ARogueAICharacter();
+	ARogueAICharacter(const FObjectInitializer& ObjectInitializer);
 
 	virtual void BeginPlay() override;
 
@@ -81,4 +83,4 @@ class ACTIONROGUELIKE_API ARogueAICharacter : public ACharacter, public IGeneric
 
 	FTimerHandle OverlayTimerHandle;
 
-};
+};

Source/ActionRoguelike/AI/RogueAICharacter.h

@@ -37,7 +37,8 @@ public ActionRoguelike(ReadOnlyTargetRules Target) : base(Target)
 		PrivateDependencyModuleNames.AddRange(new string[]
 		{
 			"MoviePlayer", // loading screen
-			"RenderCore" // for PSO caching code access
+			"RenderCore", // for PSO caching code access
+			"AnimationBudgetAllocator" 
 		});
 	}
 }

Source/ActionRoguelike/ActionRoguelike.Build.cs

@@ -193,13 +193,14 @@ float URogueSignificanceComponent::GetSignificanceByDistance(float DistanceSqrd)
 void URogueSignificanceComponent::UpdateParticleSignificance(float NewSignificance)
 {
 	// Niagara Particle Systems
-	TArray<UNiagaraComponent*> NiagaraSystems;
+	// @todo: we don't need to call into niagara, the EffectType significance handler can do this for us...
+	/*TArray<UNiagaraComponent*> NiagaraSystems;
 	GetOwner()->GetComponents<UNiagaraComponent>(NiagaraSystems);
 
 	for (UNiagaraComponent* Comp : NiagaraSystems)
 	{
 		// Niagara uses 'int32 index' to set significance, you should map this with the input "float NewSignificance" (eg. not something between 0.0-1.0 as it gets rounded)
 		
 		Comp->SetSystemSignificanceIndex(NewSignificance);
-	}
+	}*/
 }