CogEngine: Make the Cheat Execution implementable in blueprint

- Deprecate CogAbilityWindow_Cheats as it is now replaced with CogEngineWindow_Cheats
- Add CogAbilityCheat_Execution_ActivateAbility for cheats that rely on an ability
- CogSample: Add new cheats

Plugins/Cog/Config/DefaultCog.ini

@@ -1,2 +1,4 @@
 [CoreRedirects]
 +StructRedirects=(OldName="/Script/CogDebug.CogLogCategory",NewName="/Script/CogCommon.CogLogCategory")
++PropertyRedirects=(OldName="/Script/CogEngine.CogEngineCheatCategory.PersistentEffects",NewName="/Script/CogEngine.CogEngineCheatCategory.PersistentCheats")
++PropertyRedirects=(OldName="/Script/CogEngine.CogEngineCheatCategory.InstantEffects",NewName="/Script/CogEngine.CogEngineCheatCategory.InstantCheats")

Plugins/Cog/Source/CogEngine/Private/CogEngineDataAsset.cpp

@@ -1,12 +1,12 @@
 #include "CogEngineDataAsset.h"
 
 //--------------------------------------------------------------------------------------------------------------------------
-void UCogEngineCheat_Execution::Execute_Implementation(const AActor* Instigator, const TArray<AActor*>& Targets) const
+void UCogEngineCheat_Execution::Execute_Implementation(const UObject* WorldContextObject, const AActor* Instigator, const TArray<AActor*>& Targets) const
 {
 }
 
 //--------------------------------------------------------------------------------------------------------------------------
-ECogEngineCheat_ActiveState UCogEngineCheat_Execution::IsActiveOnTargets_Implementation(const TArray<AActor*>& Targets) const
+ECogEngineCheat_ActiveState UCogEngineCheat_Execution::IsActiveOnTargets_Implementation(const UObject* WorldContextObject, const TArray<AActor*>& Targets) const
 {
 	return ECogEngineCheat_ActiveState::Inactive;
 }

Plugins/Cog/Source/CogEngine/Private/CogEngineReplicator.cpp

@@ -230,16 +230,16 @@ void ACogEngineReplicator::Server_ApplyCheat_Implementation(const AActor* CheatI
         return;
     }
 
-    Cheat.Execution->Execute(CheatInstigator, Targets);
+    Cheat.Execution->Execute(GetWorld(), CheatInstigator, Targets);
 }
 
 //--------------------------------------------------------------------------------------------------------------------------
-ECogEngineCheat_ActiveState ACogEngineReplicator::IsCheatActiveOnTargets(const TArray<AActor*>& Targets, const FCogEngineCheat& Cheat)
+ECogEngineCheat_ActiveState ACogEngineReplicator::IsCheatActiveOnTargets(const TArray<AActor*>& Targets, const FCogEngineCheat& Cheat) const
 {
     if (Cheat.Execution == nullptr)
     {
         return ECogEngineCheat_ActiveState::Inactive;
     }
 
-    return Cheat.Execution->IsActiveOnTargets(Targets);
+    return Cheat.Execution->IsActiveOnTargets(GetWorld(), Targets);
 }

Plugins/Cog/Source/CogEngine/Private/CogEngineWindow_Cheats.cpp

@@ -43,18 +43,25 @@ void FCogEngineWindow_Cheats::Initialize()
             {
                 if (InArgs.Num() > 0)
                 {
-                    if (const FCogEngineCheat* cheat = FindCheatByName(InArgs[0], false))
-                    {
-                        const bool ApplyToEnemies = InArgs.Contains("-Enemies");
-                        const bool ApplyToAllies = InArgs.Contains("-Allies");
-                        const bool ApplyToControlled = InArgs.Contains("-Controlled");
-
-                        RequestCheat(GetLocalPlayerPawn(), GetSelection(), *cheat, ApplyToEnemies, ApplyToAllies, ApplyToControlled);
-                    }
-                    else
+                    const FCogEngineCheat* Cheat = FindCheatByName(InArgs[0], false);
+                    if (Cheat == nullptr)
                     {
                         UE_LOG(LogCogImGui, Warning, TEXT("Cog.Cheat %s | Cheat not found"), *InArgs[0]);
+                        return;
                     }
+
+                    ACogEngineReplicator* Replicator = ACogEngineReplicator::GetLocalReplicator(*InWorld);
+                    if (Replicator == nullptr)
+                    {
+                        UE_LOG(LogCogImGui, Warning, TEXT("Cog.Cheat %s | Repliactor not found"), *InArgs[0]);
+                        return;
+                    }
+                    
+                    const bool ApplyToEnemies = InArgs.Contains("-Enemies");
+                    const bool ApplyToAllies = InArgs.Contains("-Allies");
+                    const bool ApplyToControlled = InArgs.Contains("-Controlled");
+
+                    RequestCheat(*Replicator, GetLocalPlayerPawn(), GetSelection(), *Cheat, ApplyToEnemies, ApplyToAllies, ApplyToControlled);
                 }
             }));
 
@@ -64,12 +71,12 @@ void FCogEngineWindow_Cheats::Initialize()
 
     for (const FCogEngineCheatCategory& CheatCategory : Asset->CheatCategories)
     {
-        for (const FCogEngineCheat& Cheat : CheatCategory.PersistentEffects)
+        for (const FCogEngineCheat& Cheat : CheatCategory.PersistentCheats)
         {
             UpdateCheatColor(Cheat);
         }
 
-        for (const FCogEngineCheat& Cheat : CheatCategory.InstantEffects)
+        for (const FCogEngineCheat& Cheat : CheatCategory.InstantCheats)
         {
             UpdateCheatColor(Cheat);
         }
@@ -179,6 +186,12 @@ void FCogEngineWindow_Cheats::RenderContent()
         return;
     }
 
+    ACogEngineReplicator* Replicator = ACogEngineReplicator::GetLocalReplicator(*GetWorld());
+    if (Replicator == nullptr)
+    {
+        ImGui::TextDisabled("No Replicator");
+    }
+
     if (ImGui::BeginMenuBar())
     {
         if (ImGui::BeginMenu("Options"))
@@ -276,9 +289,9 @@ void FCogEngineWindow_Cheats::RenderContent()
             }
 
             int Index = 0;
-            for (const FCogEngineCheat& Cheat : CheatCategory.PersistentEffects)
+            for (const FCogEngineCheat& Cheat : CheatCategory.PersistentCheats)
             {
-                AddCheat(Index, ControlledActor, SelectedActor, Cheat, true);
+                AddCheat(*Replicator, Index, ControlledActor, SelectedActor, Cheat, true);
                 Index++;
             }
 
@@ -290,10 +303,10 @@ void FCogEngineWindow_Cheats::RenderContent()
             //----------------------------------------------------------------------------
             if (SelectedActor == ControlledActor)
             {
-                for (const FCogEngineCheat& Cheat : CheatCategory.PersistentEffects)
+                for (const FCogEngineCheat& Cheat : CheatCategory.PersistentCheats)
                 {
                     TArray<AActor*> Targets = { SelectedActor };
-                    if (ACogEngineReplicator::IsCheatActiveOnTargets(Targets, Cheat) == ECogEngineCheat_ActiveState::Active)
+                    if (Replicator->IsCheatActiveOnTargets(Targets, Cheat) == ECogEngineCheat_ActiveState::Active)
                     {
                         Config->AppliedCheats.AddUnique(Cheat.Name);
                     }
@@ -307,9 +320,9 @@ void FCogEngineWindow_Cheats::RenderContent()
             ImGui::TableNextColumn();
 
             Index = 0;
-            for (const FCogEngineCheat& Cheat : CheatCategory.InstantEffects)
+            for (const FCogEngineCheat& Cheat : CheatCategory.InstantCheats)
             {
-                AddCheat(Index, ControlledActor, SelectedActor, Cheat, false);
+                AddCheat(*Replicator, Index, ControlledActor, SelectedActor, Cheat, false);
                 Index++;
             }
 
@@ -327,7 +340,7 @@ void FCogEngineWindow_Cheats::RenderContent()
 }
 
 //--------------------------------------------------------------------------------------------------------------------------
-bool FCogEngineWindow_Cheats::AddCheat(const int32 Index, AActor* ControlledActor, AActor* SelectedActor, const FCogEngineCheat& Cheat, bool IsPersistent)
+bool FCogEngineWindow_Cheats::AddCheat(ACogEngineReplicator& Replicator, const int32 Index, AActor* ControlledActor, AActor* SelectedActor, const FCogEngineCheat& Cheat, bool IsPersistent)
 {
     const auto CheatName = StringCast<ANSICHAR>(*Cheat.Name);
 
@@ -346,10 +359,10 @@ bool FCogEngineWindow_Cheats::AddCheat(const int32 Index, AActor* ControlledActo
     if (IsPersistent)
     {
         TArray<AActor*> Targets = { SelectedActor };
-        bool isEnabled = ACogEngineReplicator::IsCheatActiveOnTargets(Targets, Cheat) == ECogEngineCheat_ActiveState::Active;
+        bool isEnabled = Replicator.IsCheatActiveOnTargets(Targets, Cheat) == ECogEngineCheat_ActiveState::Active;
         if (ImGui::Checkbox(CheatName.Get(), &isEnabled))
         {
-            RequestCheat(ControlledActor, SelectedActor, Cheat, IsShiftDown, IsAltDown, IsControlDown);
+            RequestCheat(Replicator, ControlledActor, SelectedActor, Cheat, IsShiftDown, IsAltDown, IsControlDown);
             bIsPressed = true;
         }
     }
@@ -357,7 +370,7 @@ bool FCogEngineWindow_Cheats::AddCheat(const int32 Index, AActor* ControlledActo
     {
         if (ImGui::Button(CheatName.Get(), ImVec2(-1, 0)))
         {
-            RequestCheat(ControlledActor, SelectedActor, Cheat, IsShiftDown, IsAltDown, IsControlDown);
+            RequestCheat(Replicator, ControlledActor, SelectedActor, Cheat, IsShiftDown, IsAltDown, IsControlDown);
             bIsPressed = true;
         }
     }
@@ -365,10 +378,10 @@ bool FCogEngineWindow_Cheats::AddCheat(const int32 Index, AActor* ControlledActo
     if (ImGui::IsItemHovered())
     {
         ImGui::BeginTooltip();
-        ImGui::TextColored(ImVec4(1.0f, 1.0f, 1.0f, IsShiftDown || IsAltDown || IsControlDown ? 0.5f : 1.0f),   "On Selection");
-        ImGui::TextColored(ImVec4(1.0f, 1.0f, 1.0f, IsShiftDown ? 1.0f : 0.5f),                                 "On Enemies    [SHIFT]");
-        ImGui::TextColored(ImVec4(1.0f, 1.0f, 1.0f, IsAltDown ? 1.0f : 0.5f),                                   "On Allies     [ALT]");
-        ImGui::TextColored(ImVec4(1.0f, 1.0f, 1.0f, IsControlDown ? 1.0f : 0.5f),                               "On Controlled [CTRL]");
+        ImGui::TextColored(ImVec4(1.0f, 1.0f, 1.0f, IsShiftDown || IsAltDown || IsControlDown ? 0.5f : 1.0f),   "Selection");
+        ImGui::TextColored(ImVec4(1.0f, 1.0f, 1.0f, IsShiftDown ? 1.0f : 0.5f),                                 "Enemies    [SHIFT]");
+        ImGui::TextColored(ImVec4(1.0f, 1.0f, 1.0f, IsAltDown ? 1.0f : 0.5f),                                   "Allies     [ALT]");
+        ImGui::TextColored(ImVec4(1.0f, 1.0f, 1.0f, IsControlDown ? 1.0f : 0.5f),                               "Controlled [CTRL]");
         ImGui::EndTooltip();
     }
 
@@ -380,7 +393,7 @@ bool FCogEngineWindow_Cheats::AddCheat(const int32 Index, AActor* ControlledActo
 }
 
 //--------------------------------------------------------------------------------------------------------------------------
-void FCogEngineWindow_Cheats::RequestCheat(AActor* ControlledActor, AActor* SelectedActor, const FCogEngineCheat& Cheat, bool ApplyToEnemies, bool ApplyToAllies, bool ApplyToControlled)
+void FCogEngineWindow_Cheats::RequestCheat(ACogEngineReplicator& Replicator, AActor* ControlledActor, AActor* SelectedActor, const FCogEngineCheat& Cheat, bool ApplyToEnemies, bool ApplyToAllies, bool ApplyToControlled)
 {
     TArray<AActor*> Actors;
 
@@ -416,14 +429,7 @@ void FCogEngineWindow_Cheats::RequestCheat(AActor* ControlledActor, AActor* Sele
         Actors.Add(SelectedActor);
     }
 
-    if (ACogEngineReplicator* Replicator = ACogEngineReplicator::GetLocalReplicator(*GetWorld()))
-    {
-        Replicator->Server_ApplyCheat(ControlledActor, Actors, Cheat);
-    }
-    else
-    {
-        UE_LOG(LogCogImGui, Warning, TEXT("FCogAbilityWindow_Cheats::RequestCheat | Replicator not found"));
-    }
+    Replicator.Server_ApplyCheat(ControlledActor, Actors, Cheat);
 }
 
 //--------------------------------------------------------------------------------------------------------------------------
@@ -431,7 +437,7 @@ const FCogEngineCheat* FCogEngineWindow_Cheats::FindCheatByName(const FString& C
 {
     for (const FCogEngineCheatCategory& CheatCategory : Asset->CheatCategories)
     {
-        for (const FCogEngineCheat& Cheat : CheatCategory.PersistentEffects)
+        for (const FCogEngineCheat& Cheat : CheatCategory.PersistentCheats)
         {
             if (Cheat.Name == CheatName)
             {
@@ -444,7 +450,7 @@ const FCogEngineCheat* FCogEngineWindow_Cheats::FindCheatByName(const FString& C
             continue;
         }
 
-        for (const FCogEngineCheat& Cheat : CheatCategory.InstantEffects)
+        for (const FCogEngineCheat& Cheat : CheatCategory.InstantCheats)
         {
             if (Cheat.Name == CheatName)
             {

Plugins/Cog/Source/CogEngine/Public/CogEngineDataAsset.h

@@ -16,7 +16,7 @@ enum class ECogEngineCheat_ActiveState : uint8
 };
 
 //--------------------------------------------------------------------------------------------------------------------------
-UCLASS(BlueprintType, Abstract, Const, DefaultToInstanced, EditInlineNew, CollapseCategories)
+UCLASS(BlueprintType, Blueprintable, Abstract, Const, DefaultToInstanced, EditInlineNew, CollapseCategories, Meta = (ShowWorldContextPin))
 class COGENGINE_API UCogEngineCheat_Execution
     : public UObject
 {
@@ -24,11 +24,11 @@ class COGENGINE_API UCogEngineCheat_Execution
 
 public:
 
-    UFUNCTION(BlueprintNativeEvent)
-    void Execute(const AActor* Instigator, const TArray<AActor*>& Targets) const;
+    UFUNCTION(BlueprintNativeEvent, meta = (DevelopmentOnly, WorldContext = "WorldContextObject"))
+    void Execute(const UObject* WorldContextObject, const AActor* Instigator, const TArray<AActor*>& Targets) const;
 
-    UFUNCTION(BlueprintNativeEvent)
-    ECogEngineCheat_ActiveState IsActiveOnTargets(const TArray<AActor*>& Targets) const;
+    UFUNCTION(BlueprintNativeEvent, meta = (DevelopmentOnly, WorldContext = "WorldContextObject"))
+    ECogEngineCheat_ActiveState IsActiveOnTargets(const UObject* WorldContextObject, const TArray<AActor*>& Targets) const;
 
     virtual bool GetColor(const FCogWindow& InCallingWindow, FLinearColor& OutColor) const;
 };
@@ -61,10 +61,10 @@ struct COGENGINE_API FCogEngineCheatCategory
     FString Name;
 
     UPROPERTY(Category = "Cheats", EditAnywhere, meta = (TitleProperty = "Name"))
-    TArray<FCogEngineCheat> PersistentEffects;
+    TArray<FCogEngineCheat> PersistentCheats;
 
     UPROPERTY(Category = "Cheats", EditAnywhere, meta = (TitleProperty = "Name"))
-    TArray<FCogEngineCheat> InstantEffects;
+    TArray<FCogEngineCheat> InstantCheats;
 };
 
 //--------------------------------------------------------------------------------------------------------------------------

Plugins/Cog/Source/CogEngine/Public/CogEngineReplicator.h

@@ -54,7 +54,7 @@ public:
     UFUNCTION(Reliable, Server)
     void Server_ApplyCheat(const AActor* CheatInstigator, const TArray<AActor*>& TargetActors, const FCogEngineCheat& Cheat) const;
 
-	static ECogEngineCheat_ActiveState IsCheatActiveOnTargets(const TArray<AActor*>& Targets, const FCogEngineCheat& Cheat);
+	ECogEngineCheat_ActiveState IsCheatActiveOnTargets(const TArray<AActor*>& Targets, const FCogEngineCheat& Cheat) const;
 
 protected:
 

Plugins/Cog/Source/CogEngine/Public/CogEngineWindow_Cheats.h

@@ -5,6 +5,7 @@
 #include "CogWindow.h"
 #include "CogEngineWindow_Cheats.generated.h"
 
+class ACogEngineReplicator;
 class AActor;
 class UCogEngineConfig_Cheats;
 class UCogEngineDataAsset;
@@ -29,9 +30,9 @@ protected:
 
     virtual void TryReapplyCheats();
 
-    virtual bool AddCheat(const int32 Index, AActor* ControlledActor, AActor* TargetActor, const FCogEngineCheat& CheatEffect, bool IsPersistent);
+    virtual bool AddCheat(ACogEngineReplicator& Replicator, const int32 Index, AActor* ControlledActor, AActor* TargetActor, const FCogEngineCheat& CheatEffect, bool IsPersistent);
 
-    virtual void RequestCheat(AActor* ControlledActor, AActor* SelectedActor, const FCogEngineCheat& Cheat, bool ApplyToEnemies, bool ApplyToAllies, bool ApplyToControlled);
+    virtual void RequestCheat(ACogEngineReplicator& Replicator, AActor* ControlledActor, AActor* SelectedActor, const FCogEngineCheat& Cheat, bool ApplyToEnemies, bool ApplyToAllies, bool ApplyToControlled);
 
     virtual const FCogEngineCheat* FindCheatByName(const FString& CheatName, const bool OnlyPersistentCheats);