UHealthHUDWidget Class Reference

A widget class used for displaying health-related information in the HUD. Including Health Bar & Low Health Vignette. More...

#include <HealthHUDWidget.h>

Inheritance diagram for UHealthHUDWidget:

Public Member Functions
virtual void	NativePreConstruct () override
virtual void	NativeConstruct () override
virtual void	HealthChanged (const float Health, const float MaxHealth, const class UDamageType *DamageType) override
virtual void	HealthAndShieldChanged (const float Health, const float MaxHealth, const float ShieldHealth, const float MaxShieldHealth, const class UDamageType *DamageType) override
virtual void	ShieldBreak () override
virtual void	InjuredBodyPart (const EBodyPartName InjuredBodyPart, const FVector &HitLocation, const TArray< FBodyPart > &AllBodyParts) override
virtual void	SetHasShield (const bool bHasShield) override

Protected Member Functions
virtual bool	Initialize () override
void	ApplyDamageMaterial ()

Protected Attributes
FLinearColor	HealthColor = FLinearColor(0.548611f, 0.0f, 0.0f, 0.0f)
FLinearColor	ShieldColor = FLinearColor(0.1f, 0.0f, 0.5f, 0.0f)
UMaterialInterface *	DamageVignetteMaterial = nullptr
UMaterialInstanceDynamic *	DamageVignette = nullptr
class UHealthWidget *	HealthWidget = nullptr
class UImage *	LowHealthImage = nullptr

Private Attributes
bool	bShield = false

Detailed Description

A widget class used for displaying health-related information in the HUD. Including Health Bar & Low Health Vignette.

Todo

Add in Damage Indicator

Member Function Documentation

ApplyDamageMaterial()

void UHealthHUDWidget::ApplyDamageMaterial ( )

protected

{
    if(DamageVignette != nullptr){return;}
    if(DamageVignetteMaterial == nullptr)
    {
        UE_LOG(LogHealthSystem, Error, TEXT("UHealthHUDWidget::ApplyDamageMaterial: Add Damage Vin Material"));
        return;
    }
    if(GetWorld() != nullptr)
    {
        DamageVignette = UKismetMaterialLibrary::CreateDynamicMaterialInstance(GetWorld(), DamageVignetteMaterial);
        if(LowHealthImage != nullptr)
        {
            LowHealthImage->SetBrushFromMaterial(DamageVignette);
        }
    }
}

HealthAndShieldChanged()

void UHealthHUDWidget::HealthAndShieldChanged ( const float Health, const float MaxHealth, const float ShieldHealth, const float MaxShieldHealth, const class UDamageType * DamageType )

overridevirtual

Implements IHealthInterface.

{
    HealthWidget->UpdateHealthAndShield(Health, MaxHealth, ShieldHealth, MaxShieldHealth, DamageType);
    if(DamageVignette != nullptr)
    {
        DamageVignette->SetScalarParameterValue(FName("Opacity"), ((Health / MaxHealth) - 1.0f) * -1.0f);
        if(bShield)
        {
            if(ShieldHealth > 5.0f)
            {
                DamageVignette->SetScalarParameterValue(FName("Opacity"), ((ShieldHealth / MaxShieldHealth) - 1.0f) * -1.0f);
                DamageVignette->SetVectorParameterValue(FName("Color"), ShieldColor);
            }
            else
            {
                DamageVignette->SetScalarParameterValue(FName("Opacity"), ((Health / MaxHealth) - 1.0f) * -1.0f);
                DamageVignette->SetVectorParameterValue(FName("Color"), HealthColor);
            }
        }
    }
}

HealthChanged()

void UHealthHUDWidget::HealthChanged ( const float Health, const float MaxHealth, const class UDamageType * DamageType )

overridevirtual

Implements IHealthInterface.

{
    HealthWidget->UpdateHealth(Health, MaxHealth, DamageType);
    if(DamageVignette != nullptr)
    {
        DamageVignette->SetScalarParameterValue(FName("Opacity"), ((Health / MaxHealth) - 1.0f) * -1.0f);
    }
}

Initialize()

bool UHealthHUDWidget::Initialize ( )

overrideprotectedvirtual

{
    const bool Success = Super::Initialize();
    if(!Success) return false;
    if (!ensure(HealthWidget != nullptr)) return false;
    if (!ensure(LowHealthImage != nullptr)) return false;
    return true;
}

InjuredBodyPart()

void UHealthHUDWidget::InjuredBodyPart ( const EBodyPartName InjuredBodyPart, const FVector & HitLocation, const TArray< FBodyPart > & AllBodyParts )

overridevirtual

Implements IHealthInterface.

{
    HealthWidget->InjuredBodyPart(InjuredBodyPart, HitLocation, AllBodyParts);
}

NativeConstruct()

void UHealthHUDWidget::NativeConstruct ( )

overridevirtual

{
    Super::NativeConstruct();
    ApplyDamageMaterial();      
}

NativePreConstruct()

void UHealthHUDWidget::NativePreConstruct ( )

overridevirtual

{
    Super::NativePreConstruct();
    ApplyDamageMaterial();
}

SetHasShield()

void UHealthHUDWidget::SetHasShield ( const bool bHasShield )

overridevirtual

Implements IHealthInterface.

{
    bShield = bHasShield;
    HealthWidget->SetHasShield(bHasShield);
    if(bHasShield)
    {
        DamageVignette->SetVectorParameterValue(FName("Color"), ShieldColor);
    }
    else
    {
        DamageVignette->SetVectorParameterValue(FName("Color"), HealthColor);
    }
 
}

ShieldBreak()

void UHealthHUDWidget::ShieldBreak ( )

overridevirtual

Implements IHealthInterface.

{
    HealthWidget->ShieldBroken();
    DamageVignette->SetVectorParameterValue(FName("Color"), HealthColor);
}

Member Data Documentation

bShield

bool UHealthHUDWidget::bShield = false

private

DamageVignette

UMaterialInstanceDynamic* UHealthHUDWidget::DamageVignette = nullptr

protected

DamageVignetteMaterial

UMaterialInterface* UHealthHUDWidget::DamageVignetteMaterial = nullptr

protected

HealthColor

FLinearColor UHealthHUDWidget::HealthColor = FLinearColor(0.548611f, 0.0f, 0.0f, 0.0f)

protected

HealthWidget

class UHealthWidget* UHealthHUDWidget::HealthWidget = nullptr

protected

LowHealthImage

class UImage* UHealthHUDWidget::LowHealthImage = nullptr

protected

ShieldColor

FLinearColor UHealthHUDWidget::ShieldColor = FLinearColor(0.1f, 0.0f, 0.5f, 0.0f)

protected

---

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

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