UReplayViewer Class Reference

The UI widget for controlling the Replay Clips. More...

#include <ReplayViewer.h>

Inheritance diagram for UReplayViewer:

Public Member Functions
virtual void	NativeConstruct () override
virtual bool	Initialize () override
void	SetReplayController (AReplaySpectatorController *Controller)

Public Attributes
UTextBlock *	CurrentTimeText
UTextBlock *	TotalTimeText
USlider *	TimeSlider
UButton *	PauseButton
UTextBlock *	PauseButtonText
UComboBoxString *	PlayRateComboBox
UButton *	RestartButton
UButton *	RewindButton
UButton *	MenuButton
UButton *	BackButton

Protected Member Functions
void	PauseButtonClicked ()
void	RestartButtonClicked ()
void	RewindButtonClicked ()
void	BackButtonClicked ()
void	MenuButtonClicked ()
void	PlaybackSelectionChanged (FString Item, ESelectInfo::Type SelectionType)
void	OnMouseCaptureSlider ()
void	OnMouseCaptureEndSlider ()
void	OnValueChanged (float Value)
virtual void	NativeTick (const FGeometry &MyGeometry, float InDeltaTime) override
FText	GetCurrentTimeText () const
FText	GetTotalTimeText () const
FText	GetPauseButtonText () const
float	GetSliderValue () const

Protected Attributes
int32	TotalTimeInSeconds = 0
int32	CurrentTimeInSeconds = 0
class AReplaySpectatorController *	ReplayController
bool	bSliderPickedByUser = false
bool	bCurrentlyPaused = false
float	SliderReleasedAtValue = 0.0f

Private Member Functions
void	GetReplaySpectatorController ()

Detailed Description

The UI widget for controlling the Replay Clips.

Member Function Documentation

BackButtonClicked()

void UReplayViewer::BackButtonClicked ( )

protected

{
    //@TODO go to menu
    const UWorld* World = GetWorld();
    if(!ensure(World != nullptr)) return;
    if(ReplayController == nullptr){GetReplaySpectatorController();}
    if(ReplayController != nullptr)
    {
        if(World->GetNetMode() == NM_ListenServer) 
        {
            AGameModeBase* GameMode = World->GetAuthGameMode<AGameModeBase>();
            if(GameMode)
            {
                GameMode->ReturnToMainMenuHost();
            }
        } 
        else 
        {
            if(ReplayController) 
            {
                ReplayController->ClientReturnToMainMenuWithTextReason(FText::FromString("Back to main menu"));
            }
        }
    }
}

GetCurrentTimeText()

FText UReplayViewer::GetCurrentTimeText ( ) const

protected

{
    const int32 Minutes = CurrentTimeInSeconds / 60;
    const int32 Seconds = CurrentTimeInSeconds % 60;
    return FText::Format(NSLOCTEXT("YourNamespace", "TimeFormat", "{0}:{1}"), 
                         FText::AsNumber(Minutes), 
                         FText::AsNumber(Seconds));
}

GetPauseButtonText()

FText UReplayViewer::GetPauseButtonText ( ) const

protected

{
    if(bCurrentlyPaused)
    {
        return FText::FromString("Play");
    }
    return FText::FromString("Pause");
}

GetReplaySpectatorController()

void UReplayViewer::GetReplaySpectatorController ( )

private

{
    if(GetOwningPlayer() != nullptr)
    {
        AReplaySpectatorController* ReplayControllerRef = Cast<AReplaySpectatorController>(GetOwningPlayer());
        if(ReplayControllerRef != nullptr)
        {
            ReplayController =  ReplayControllerRef;
        }
    }
}

GetSliderValue()

float UReplayViewer::GetSliderValue ( ) const

protected

{
    if (TotalTimeInSeconds == 0)
    {
        // Handle the zero case, 
        return 0.0f; 
    }
    const float CurrentTime = CurrentTimeInSeconds / TotalTimeInSeconds;
    if(bSliderPickedByUser)
    {
        return SliderReleasedAtValue;
    }
    return CurrentTime;
}

GetTotalTimeText()

FText UReplayViewer::GetTotalTimeText ( ) const

protected

{
    const int32 Minutes = TotalTimeInSeconds / 60;
    const int32 Seconds = TotalTimeInSeconds % 60;
    return FText::Format(NSLOCTEXT("YourNamespace", "TimeFormat", "{0}:{1}"), 
                         FText::AsNumber(Minutes), 
                         FText::AsNumber(Seconds));
}

Initialize()

bool UReplayViewer::Initialize ( )

overridevirtual

{
    const bool bSuccess = Super::Initialize();
    if (!ensure(CurrentTimeText != nullptr)) return false;
    if (!ensure(TotalTimeText != nullptr)) return false;    
    if (!ensure(TimeSlider != nullptr)) return false;    
    if (!ensure(PauseButton != nullptr)) return false;    
    if (!ensure(PlayRateComboBox != nullptr)) return false;
    if (!ensure(PauseButtonText != nullptr)) return false;
    if (!ensure(RestartButton != nullptr)) return false;
    if (!ensure(RewindButton != nullptr)) return false;
    if (!ensure(BackButton != nullptr)) return false;
    if (!ensure(MenuButton != nullptr)) return false;
    
 
    
    PauseButton->OnClicked.AddUniqueDynamic(this, &UReplayViewer::PauseButtonClicked);
    RestartButton->OnClicked.AddUniqueDynamic(this, &UReplayViewer::RestartButtonClicked);
    RewindButton->OnClicked.AddUniqueDynamic(this, &UReplayViewer::RewindButtonClicked);
    PlayRateComboBox->OnSelectionChanged.AddUniqueDynamic(this, &UReplayViewer::PlaybackSelectionChanged);
    
    BackButton->OnClicked.AddUniqueDynamic(this, &UReplayViewer::BackButtonClicked);
    MenuButton->OnClicked.AddUniqueDynamic(this, &UReplayViewer::MenuButtonClicked);
    
    TimeSlider->OnValueChanged.AddUniqueDynamic(this, &UReplayViewer::OnValueChanged);
    TimeSlider->OnMouseCaptureBegin.AddUniqueDynamic(this, &UReplayViewer::OnMouseCaptureSlider);
    TimeSlider->OnControllerCaptureBegin.AddUniqueDynamic(this, &UReplayViewer::OnMouseCaptureSlider);
    TimeSlider->OnMouseCaptureEnd.AddUniqueDynamic(this, &UReplayViewer::OnMouseCaptureEndSlider);
    TimeSlider->OnControllerCaptureEnd.AddUniqueDynamic(this, &UReplayViewer::OnMouseCaptureEndSlider);
 
    if(!bSuccess) return false;
    return true;
}

MenuButtonClicked()

void UReplayViewer::MenuButtonClicked ( )

protected

{
    if(ReplayController == nullptr){GetReplaySpectatorController();}
    if(ReplayController != nullptr)
    {
        ReplayController->OpenReplayMenu();
    }
}

NativeConstruct()

void UReplayViewer::NativeConstruct ( )

overridevirtual

{
    Super::NativeConstruct();
    if(ReplayController == nullptr){GetReplaySpectatorController();}
    if(ReplayController != nullptr)
    {
        TotalTimeInSeconds = ReplayController->GetCurrentReplayTotalTimeInSeconds();
        // if(TimeSlider != nullptr)
        // {
        //  TimeSlider->SetMaxValue(TotalTimeInSeconds);
        // }
    }
}

NativeTick()

void UReplayViewer::NativeTick ( const FGeometry & MyGeometry, float InDeltaTime )

overrideprotectedvirtual

{
    Super::NativeTick(MyGeometry, InDeltaTime);
    if(ReplayController == nullptr){GetReplaySpectatorController();}
    else
    {
        CurrentTimeInSeconds = ReplayController->GetCurrentReplayCurrentTimeInSeconds();
    }
    
}

OnMouseCaptureEndSlider()

void UReplayViewer::OnMouseCaptureEndSlider ( )

protected

{
    if(ReplayController == nullptr){GetReplaySpectatorController();}
    if(ReplayController != nullptr)
    {
        const int32 Seconds = FMath::RoundToInt(TotalTimeInSeconds * SliderReleasedAtValue);
        ReplayController->SetCurrentReplayTimeToSeconds(Seconds);
    }
    bSliderPickedByUser = false;
}

OnMouseCaptureSlider()

void UReplayViewer::OnMouseCaptureSlider ( )

protected

{
    bSliderPickedByUser = true;
}

OnValueChanged()

void UReplayViewer::OnValueChanged ( float Value )

protected

{
    SliderReleasedAtValue = Value;
}

PauseButtonClicked()

void UReplayViewer::PauseButtonClicked ( )

protected

{
    if(ReplayController == nullptr){GetReplaySpectatorController();}
    if(ReplayController != nullptr)
    {
        bCurrentlyPaused = ReplayController->SetCurrentReplayPausedState(!bCurrentlyPaused);
    }
}

PlaybackSelectionChanged()

void UReplayViewer::PlaybackSelectionChanged ( FString Item, ESelectInfo::Type SelectionType )

protected

{
    if(ReplayController == nullptr){GetReplaySpectatorController();}
    if(ReplayController != nullptr)
    {
        if(Item == "1/8x")
        {
            ReplayController->SetCurrentReplayPlayRate(0.125f);
        }
        if(Item == "1/4x")
        {
            ReplayController->SetCurrentReplayPlayRate(0.25f);
        }
        if(Item == "1/2x")
        {
            ReplayController->SetCurrentReplayPlayRate(0.5f);
        }
        if(Item == "2x")
        {
            ReplayController->SetCurrentReplayPlayRate(2.0f);
        }
        if(Item == "4x")
        {
            ReplayController->SetCurrentReplayPlayRate(4.0f);
        }
        if(Item == "8x")
        {
            ReplayController->SetCurrentReplayPlayRate(8.0f);
        }
        if(Item == "1x")
        {
            ReplayController->SetCurrentReplayPlayRate(1.0f);
        }
    }
}

RestartButtonClicked()

void UReplayViewer::RestartButtonClicked ( )

protected

{
    if(ReplayController == nullptr){GetReplaySpectatorController();}
    if(ReplayController != nullptr)
    {
        ReplayController->RestartReplay();
        bCurrentlyPaused = false;
    }
}

RewindButtonClicked()

void UReplayViewer::RewindButtonClicked ( )

protected

{
    if(ReplayController == nullptr){GetReplaySpectatorController();}
    if(ReplayController != nullptr)
    {
        ReplayController->RewindReplay();
    }
}

SetReplayController()

void UReplayViewer::SetReplayController ( AReplaySpectatorController * Controller )

inline

{ReplayController = Controller;};

Member Data Documentation

BackButton

UButton* UReplayViewer::BackButton

bCurrentlyPaused

bool UReplayViewer::bCurrentlyPaused = false

protected

bSliderPickedByUser

bool UReplayViewer::bSliderPickedByUser = false

protected

CurrentTimeInSeconds

int32 UReplayViewer::CurrentTimeInSeconds = 0

protected

CurrentTimeText

UTextBlock* UReplayViewer::CurrentTimeText

MenuButton

UButton* UReplayViewer::MenuButton

PauseButton

UButton* UReplayViewer::PauseButton

PauseButtonText

UTextBlock* UReplayViewer::PauseButtonText

PlayRateComboBox

UComboBoxString* UReplayViewer::PlayRateComboBox

ReplayController

class AReplaySpectatorController* UReplayViewer::ReplayController

protected

RestartButton

UButton* UReplayViewer::RestartButton

RewindButton

UButton* UReplayViewer::RewindButton

SliderReleasedAtValue

float UReplayViewer::SliderReleasedAtValue = 0.0f

protected

TimeSlider

USlider* UReplayViewer::TimeSlider

TotalTimeInSeconds

int32 UReplayViewer::TotalTimeInSeconds = 0

protected

TotalTimeText

UTextBlock* UReplayViewer::TotalTimeText

---

The documentation for this class was generated from the following files:

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/MenuSystem/Source/MenuSystem/Public/Widgets/Replays/ReplayViewer.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/MenuSystem/Source/MenuSystem/Private/Widgets/Replays/ReplayViewer.cpp