UWaypointWidget Class Reference

#include <WaypointWidget.h>

Inheritance diagram for UWaypointWidget:

Public Member Functions
virtual void	ActorConstruct ()
void	SetWaypointActor (AActor *Actor)
float	GetDistance (const bool bMeters=true) const

Protected Member Functions
virtual bool	Initialize () override
virtual void	NativeConstruct () override
virtual void	NativePreConstruct () override
void	SetDistanceText () const

Protected Attributes
class UImage *	WaypointIcon
class UTextBlock *	DistanceTextBlock
class UTextBlock *	ContextTextBlock
bool	bUseDistance = true
float	DistanceUpdateSpeed = 0.5f
float	HideDistance = 10.0f
bool	bDebuggingMode = false
AActor *	WaypointActor

Private Attributes
FTimerHandle	DistanceTimerHandle
FNumberFormattingOptions	NumberFormatOptions

Member Function Documentation

ActorConstruct()

void UWaypointWidget::ActorConstruct ( )

virtual

{
    if(bUseDistance && GetWorld() != nullptr)
    {
        NumberFormatOptions.SetUseGrouping(false); // This turns off comma separators
        GetWorld()->GetTimerManager().SetTimer(DistanceTimerHandle, this, &UWaypointWidget::SetDistanceText, DistanceUpdateSpeed, true, 0.0f);
    }
}

GetDistance()

float UWaypointWidget::GetDistance

(

const bool

bMeters = true

)

const

{
    if(GetOwningPlayer() == nullptr || GetOwningPlayer()->GetPawn() == nullptr)
    {
        if(bDebuggingMode){UE_LOG(LogBaseHelpers, Error, TEXT("Error getting Pawn for Distance, Waypoint Widget"));}
        return -999.0f;
    }
    
    if(GetOwningPlayer()->GetPawn() != nullptr && WaypointActor != nullptr)
    {
        const float Distance = UKismetMathLibrary::Vector_Distance(GetOwningPlayer()->GetPawn()->GetActorLocation(), WaypointActor->GetActorLocation());
        if(bMeters)
        {
            if(Distance == 0.0f)
            {
                return 0.0f;
            }
            return (Distance / 100.0f);
        }
        return Distance;
    }
    if(bDebuggingMode){UE_LOG(LogTemp, Warning, TEXT("Get Distance Failed"));}
    return 0.0f;
}

Initialize()

bool UWaypointWidget::Initialize ( )

overrideprotectedvirtual

{
    const bool Success = Super::Initialize();
    if(!Success) return false;
    if (!ensure(ContextTextBlock != nullptr)) return false;
    if (!ensure(WaypointIcon != nullptr)) return false;
    if (!ensure(DistanceTextBlock != nullptr)) return false;
 
    return true;
}

NativeConstruct()

void UWaypointWidget::NativeConstruct ( )

overrideprotectedvirtual

{
    Super::NativeConstruct();
    SetVisibility(ESlateVisibility::Hidden);
    if(ContextTextBlock->GetText().IsEmpty())
    {
        ContextTextBlock->SetVisibility(ESlateVisibility::Hidden);
    }
    else
    {
        ContextTextBlock->SetVisibility(ESlateVisibility::Visible);
    }
}

NativePreConstruct()

void UWaypointWidget::NativePreConstruct ( )

overrideprotectedvirtual

{
    Super::NativePreConstruct();
}

SetDistanceText()

void UWaypointWidget::SetDistanceText ( ) const

protected

{
    if(GetDistance(true) < HideDistance)
    {
        DistanceTextBlock->SetVisibility(ESlateVisibility::Hidden);
    }
    else
    {
        DistanceTextBlock->SetVisibility(ESlateVisibility::Visible);
    }
    const FText DistanceText = FText::Format(NSLOCTEXT("YourNamespace","DistanceFormat" , "{0} m"), 
                     FText::AsNumber(FMath::RoundToInt(GetDistance(true)), &NumberFormatOptions));
    DistanceTextBlock->SetText(DistanceText);
}

SetWaypointActor()

void UWaypointWidget::SetWaypointActor ( AActor * Actor )

inline

{WaypointActor = Actor;};

Member Data Documentation

bDebuggingMode

bool UWaypointWidget::bDebuggingMode = false

protected

bUseDistance

bool UWaypointWidget::bUseDistance = true

protected

ContextTextBlock

class UTextBlock* UWaypointWidget::ContextTextBlock

protected

DistanceTextBlock

class UTextBlock* UWaypointWidget::DistanceTextBlock

protected

DistanceTimerHandle

FTimerHandle UWaypointWidget::DistanceTimerHandle

private

The player who made this waypoint

DistanceUpdateSpeed

float UWaypointWidget::DistanceUpdateSpeed = 0.5f

protected

HideDistance

float UWaypointWidget::HideDistance = 10.0f

protected

Once this close, the Distance text will hide

NumberFormatOptions

FNumberFormattingOptions UWaypointWidget::NumberFormatOptions

private

WaypointActor

AActor* UWaypointWidget::WaypointActor

protected

This is the Actor in 3D space of the Waypoint

WaypointIcon

class UImage* UWaypointWidget::WaypointIcon

protected

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/BaseHelpers/Source/BaseHelpers/Public/Widgets/WaypointWidget.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/BaseHelpers/Source/BaseHelpers/Private/Widgets/WaypointWidget.cpp