UInteractionPingWidget Class Reference

#include <InteractionPingWidget.h>

Inheritance diagram for UInteractionPingWidget:

Public Member Functions
virtual bool	Initialize () override
virtual void	NativeConstruct () override
void	ActorConstruct ()
virtual void	NativeDestruct () override
void	SetPingData (const FPingData &Ping, AActor *Sender)
void	OnReceivePingData (const FPingData &Ping, const AActor *Sender)
void	SetPingActor (AActor *Actor)
void	SetDistanceText ()
float	GetDistance (const bool bMeters=true) const

Protected Attributes
class UImage *	PingIcon
class UTextBlock *	ContextTextBlock
class UTextBlock *	DistanceTextBlock
bool	bUseDistance = true
float	DistanceUpdateSpeed = 0.5f
AActor *	PingActor
AActor *	OwnerActor

Private Member Functions
void	GetOwnerActor ()

Private Attributes
FTimerHandle	DistanceTimerHandle
FNumberFormattingOptions	NumberFormatOptions

Member Function Documentation

ActorConstruct()

void UInteractionPingWidget::ActorConstruct

(

)

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

GetDistance()

float UInteractionPingWidget::GetDistance

(

const bool

bMeters = true

)

const

{
    if(OwnerActor != nullptr && PingActor != nullptr)
    {
        const float Distance = UKismetMathLibrary::Vector_Distance(OwnerActor->GetActorLocation(), PingActor->GetActorLocation());
        if(bMeters)
        {
            if(Distance == 0.0f)
            {
                return 0.0f;
            }
            return (Distance / 100.0f);
        }
        return Distance;
    }
    UE_LOG(LogTemp, Warning, TEXT("Get Distance Failed"));
    return 0.0f;
}

GetOwnerActor()

void UInteractionPingWidget::GetOwnerActor ( )

private

{
    if(OwnerActor != nullptr){return;}
    if(GetOwningPlayer() != nullptr && GetOwningPlayer()->GetPawn() != nullptr)
    {
        OwnerActor = GetOwningPlayer()->GetPawn();
    }
}

Initialize()

bool UInteractionPingWidget::Initialize ( )

overridevirtual

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

NativeConstruct()

void UInteractionPingWidget::NativeConstruct ( )

overridevirtual

{
    Super::NativeConstruct();
}

NativeDestruct()

void UInteractionPingWidget::NativeDestruct ( )

overridevirtual

{
    if(GetWorld() != nullptr)
    {
        GetWorld()->GetTimerManager().ClearTimer(DistanceTimerHandle);
    }
    Super::NativeDestruct();
}

OnReceivePingData()

void UInteractionPingWidget::OnReceivePingData	(	const FPingData &	Ping,
		const AActor *	Sender )

SetDistanceText()

void UInteractionPingWidget::SetDistanceText

(

)

{
    if(DistanceTextBlock == nullptr)
    {
        if(GetWorld() != nullptr)
        {
            GetWorld()->GetTimerManager().ClearTimer(DistanceTimerHandle);
        }
        return;
    }
    const FText DistanceText = FText::Format(NSLOCTEXT("YourNamespace","DistanceFormat" , "{0} m"), 
                     FText::AsNumber(FMath::RoundToInt(GetDistance(true)), &NumberFormatOptions));
    DistanceTextBlock->SetText(DistanceText);
}

SetPingActor()

void UInteractionPingWidget::SetPingActor ( AActor * Actor )

inline

{PingActor = Actor;};

SetPingData()

void UInteractionPingWidget::SetPingData	(	const FPingData &	Ping,
		AActor *	Sender )

{
    OwnerActor = Sender;
    if(OwnerActor == nullptr)
    {
        GetOwnerActor();
    }
    OnReceivePingData(Ping, Sender);
}

Member Data Documentation

bUseDistance

bool UInteractionPingWidget::bUseDistance = true

protected

ContextTextBlock

class UTextBlock* UInteractionPingWidget::ContextTextBlock

protected

DistanceTextBlock

class UTextBlock* UInteractionPingWidget::DistanceTextBlock

protected

DistanceTimerHandle

FTimerHandle UInteractionPingWidget::DistanceTimerHandle

private

DistanceUpdateSpeed

float UInteractionPingWidget::DistanceUpdateSpeed = 0.5f

protected

NumberFormatOptions

FNumberFormattingOptions UInteractionPingWidget::NumberFormatOptions

private

OwnerActor

AActor* UInteractionPingWidget::OwnerActor

protected

PingActor

AActor* UInteractionPingWidget::PingActor

protected

PingIcon

class UImage* UInteractionPingWidget::PingIcon

protected

---

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

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