GameStateBase.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Templates/SubclassOf.h"
#include "Engine/EngineTypes.h"
#include "GameFramework/Actor.h"
#include "GameFramework/Info.h"
#include "GameFramework/GameModeBase.h"
#include "Stats/Stats.h"
#include "GameStateBase.generated.h"
 
class APlayerState;
class ASpectatorPawn;
 
ENGINE_API DECLARE_LOG_CATEGORY_EXTERN(LogGameState, Log, All);
 
DECLARE_CYCLE_STAT_EXTERN( TEXT( "GetPlayerStateFromUniqueId" ), STAT_GetPlayerStateFromUniqueId, STATGROUP_Game , ENGINE_API);
 
class AGameModeBase;
class ASpectatorPawn;
class APlayerState;
class AController;
 
UCLASS(config=Game, notplaceable, BlueprintType, Blueprintable, MinimalAPI)
class AGameStateBase : public AInfo
{
    GENERATED_UCLASS_BODY()
 
public:
 
    //~=============================================================================
    // General accessors and variables
 
    UPROPERTY(Transient, BlueprintReadOnly, Category=GameState, ReplicatedUsing=OnRep_GameModeClass)
    TSubclassOf<AGameModeBase>  GameModeClass;
 
    UPROPERTY(Transient, BlueprintReadOnly, Category=GameState)
    TObjectPtr<AGameModeBase> AuthorityGameMode;
 
    UPROPERTY(Transient, BlueprintReadOnly, Category=GameState, ReplicatedUsing=OnRep_SpectatorClass)
    TSubclassOf<ASpectatorPawn> SpectatorClass;
 
    UPROPERTY(Transient, BlueprintReadOnly, Category=GameState)
    TArray<TObjectPtr<APlayerState>> PlayerArray;
 
    virtual void AsyncPackageLoaded(UObject* Package) {}
 
    ENGINE_API const AGameModeBase* GetDefaultGameMode() const;
 
    template< class T >
    const T* GetDefaultGameMode() const
    {
        return Cast<T>(GetDefaultGameMode());
    }
 
    UFUNCTION(BlueprintCallable, Category=GameState)
    ENGINE_API virtual double GetServerWorldTimeSeconds() const;
 
    UFUNCTION(BlueprintCallable, Category=GameState)
    ENGINE_API virtual bool HasBegunPlay() const;
 
    UFUNCTION(BlueprintCallable, Category=GameState)
    ENGINE_API virtual bool HasMatchStarted() const;
 
    UFUNCTION(BlueprintCallable, Category = Game)
    ENGINE_API virtual bool HasMatchEnded() const;
 
    UFUNCTION(BlueprintCallable, Category=GameState)
    ENGINE_API virtual float GetPlayerStartTime(AController* Controller) const;
 
    UFUNCTION(BlueprintCallable, Category=GameState)
    ENGINE_API virtual float GetPlayerRespawnDelay(AController* Controller) const;
 
    ENGINE_API virtual void GetLifetimeReplicatedProps(TArray< FLifetimeProperty > &OutLifetimeProps) const;
 
    ENGINE_API APlayerState* GetPlayerStateFromUniqueNetId(const FUniqueNetIdWrapper& InPlayerId) const;
 
    //~=============================================================================
    // Interaction with GameModeBase
 
    ENGINE_API virtual void ReceivedGameModeClass();
 
    ENGINE_API virtual void ReceivedSpectatorClass();
 
    ENGINE_API virtual void SeamlessTravelTransitionCheckpoint(bool bToTransitionMap);
 
    ENGINE_API virtual void AddPlayerState(APlayerState* PlayerState);
 
    ENGINE_API virtual void RemovePlayerState(APlayerState* PlayerState);
 
    ENGINE_API virtual void HandleBeginPlay();
 
    //~ Begin AActor Interface
    ENGINE_API virtual void PostInitializeComponents() override;
    //~ End AActor Interface
 
protected:
 
    UFUNCTION()
    ENGINE_API virtual void OnRep_GameModeClass();
 
    UFUNCTION()
    ENGINE_API virtual void OnRep_SpectatorClass();
 
    UFUNCTION()
    ENGINE_API virtual void OnRep_ReplicatedHasBegunPlay();
 
    UPROPERTY(Transient, ReplicatedUsing = OnRep_ReplicatedHasBegunPlay)
    bool bReplicatedHasBegunPlay;
 
    ENGINE_API virtual void UpdateServerTimeSeconds();
 
    UFUNCTION()
    ENGINE_API virtual void OnRep_ReplicatedWorldTimeSecondsDouble();
 
    UPROPERTY(Transient, ReplicatedUsing = OnRep_ReplicatedWorldTimeSecondsDouble)
    double ReplicatedWorldTimeSecondsDouble;
 
    UPROPERTY(Transient)
    float ServerWorldTimeSecondsDelta;
 
    UPROPERTY(EditDefaultsOnly, Category=GameState)
    float ServerWorldTimeSecondsUpdateFrequency;
 
    FTimerHandle TimerHandle_UpdateServerTimeSeconds;
 
    double SumServerWorldTimeSecondsDelta;
    uint32 NumServerWorldTimeSecondsDeltas;
 
private:
    // Hidden functions that don't make sense to use on this class.
    HIDE_ACTOR_TRANSFORM_FUNCTIONS();
 
    friend class UDemoNetDriver;
    friend class FReplayHelper;
};