ActorPruningSystem.h

Go to the documentation of this file.

// Copyright Blue Isle Studios Inc 2018. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "ReactsToMatchEvents.h"
#include "ActorPruningSystem.generated.h"
 
#define CHUNK_SIZE 256
#define CHUNK_DELAY 0.2f
 
USTRUCT(Blueprintable)
struct FActorPruneInfo
{
    GENERATED_USTRUCT_BODY()
 
public:
    /* Class of actor to prune and eventually show based on conditions below. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    TSubclassOf<AActor> ActorClassToPrune = nullptr;
    /* Minimum number of actors to show. The system will throw an error if this value is higher than the number of available actors */
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    int32 MinCount = 0;
    /* Show actors once the match has begun. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    bool bShowAllAtMatchStart = true;
    /* Begin showing actors when the match elapsed time is equal to this value. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, meta = (EditCondition = "!bShowAllAtMatchStart"))
    float StartShowingAtMatchTime = 0.0f;
    /* Constrains the actor spawn volume to this actor's bounds rather than using it's own. Mincount will potentially be ignored if this is active since there may not be enough actors within that region. */
    UPROPERTY(EditAnywhere, BlueprintReadWrite)
    AActor* ActorBoundsOverride = nullptr;
 
    bool bSpawned = false;
};
 
UCLASS()
class PROJECTX_API AActorPruningSystem : public AActor, public IReactsToMatchEvents
{
    GENERATED_BODY()
    
public:
    /* Class and configuration of actors to be removed and shown at a later stage in the match */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = ActorPruning)
    TArray<FActorPruneInfo> ActorsToPrune;
    /* Show helpful debugging information regarding spawning/chunking */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = ActorPruning)
    bool bDebug = false;
 
    AActorPruningSystem();
 
    static int ShownActorCount;
 
    virtual void EndPlay(const EEndPlayReason::Type EndPlayReason) override;
    virtual void BeginPlay() override;
    virtual void Tick(float DeltaSeconds) override;
    virtual void MatchStarted() override;
    
    void SetActorEnabled(AActor* Actor, const bool bToggle);
 
    void SendChunk(const TArray<AActor*> Chunk);
    void HideAllActors();
    void ValidateActorList(TArray<AActor*>& ActorList);
    void BuildShowActorList();
    void SpawnInitialActorsOnServer();
    void ChunkAndSendShowActorArray(const TArray<AActor*>& ActorsToShow);
    bool BuildActorBoundsOverrideList(const FActorPruneInfo& ActorPruneInfo);
 
    /* Any UObjects that subscribe to IReactsToActorPruner will receive Enable and Disable events so that an actor can disable itself in its own way without technically being destroyed */
    static void CallActorPrunerEvents(UObject* Object, const bool bToggle);
 
    UFUNCTION(NetMulticast, Reliable)
    void Multicast_ShowActors(const TArray<AActor*>& ActorsToShow);
 
private:
    TMap<TSubclassOf<AActor>, TArray<AActor*>> ShowActorList;
};