UCommonWidgetBase Class Reference

#include <CommonWidgetBase.h>

Inheritance diagram for UCommonWidgetBase:

Public Member Functions
void	PlaySlateSound (const FSlateSound &SlateSound) const

Protected Member Functions
virtual void	NativePreConstruct () override
virtual void	NativeConstruct () override
virtual void	Setup ()
void	LogDebugError (const FString &Message) const
void	LogDebugError (const FString &Message, const int32 Value) const
void	LogDebugError (const FString &Message, const float Value) const
void	LogDebugWarning (const FString &Message) const
void	LogDebugWarning (const FString &Message, const int32 Value) const
void	LogDebugWarning (const FString &Message, const float Value) const
void	LogDebugMessage (const FString &Message, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const int32 Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const float Value, const bool bWarning=false, const bool bError=false) const
void	LogDebugMessage (const FString &Message, const bool bValue, const bool bWarning, const bool bError) const
void	LogOnScreenMessage (const int32 Key, const FString &Message, FColor Color=FColor::Green) const
void	SetCategoryName (const FLogCategoryBase &Category)

Protected Attributes
bool	bDebuggingMode = false

Private Attributes
FLogCategoryName	CategoryName = LogCommonBaseWidget.GetCategoryName()

Member Function Documentation

LogDebugError() [1/3]

void UCommonWidgetBase::LogDebugError ( const FString & Message ) const

protected

{
    LogDebugMessage(Message, true, true);
}

LogDebugError() [2/3]

void UCommonWidgetBase::LogDebugError ( const FString & Message, const float Value ) const

protected

{
    LogDebugMessage(Message, Value, true, true);
}

LogDebugError() [3/3]

void UCommonWidgetBase::LogDebugError ( const FString & Message, const int32 Value ) const

protected

{
    LogDebugMessage(Message, Value, true, true);
}

LogDebugMessage() [1/4]

void UCommonWidgetBase::LogDebugMessage ( const FString & Message, const bool bValue, const bool bWarning, const bool bError ) const

protected

{
    LogDebugMessage(FString::Printf(TEXT("%s: %s"), *Message, bValue ? *FString("true") : *FString("false")), bWarning, bError);
}

LogDebugMessage() [2/4]

void UCommonWidgetBase::LogDebugMessage ( const FString & Message, const bool bWarning = false, const bool bError = false ) const

protected

{
    if(bDebuggingMode == false && bError == false){return;}
    FOutputDevice* OutputDevice = GWarn;
    if(OutputDevice == nullptr){return;}
    FString NetModeString;
    switch(GetWorld()->GetNetMode())
    {
    case NM_Standalone:
        NetModeString = FString("SDL");
        break;
    case NM_DedicatedServer:
        NetModeString = FString("DServer");
        break;
    case NM_ListenServer:
        NetModeString = FString("LServer");
        break;
    case NM_Client:
        NetModeString = FString("Client");
        break;
    default:
        NetModeString = FString("Unknown");
        break;
    }
    const FString FullMessage = FString::Printf(TEXT("%s: %s::%s"), *NetModeString, *GetName(), *Message);
    if(bError)
    {
        OutputDevice->Log(CategoryName, ELogVerbosity::Error, FullMessage);
    }
    else if(bWarning)
    {
        OutputDevice->Log(CategoryName, ELogVerbosity::Warning, FullMessage);
    }
    else
    {
        OutputDevice->Log(CategoryName, ELogVerbosity::Log, FullMessage);
    }
}

LogDebugMessage() [3/4]

void UCommonWidgetBase::LogDebugMessage ( const FString & Message, const float Value, const bool bWarning = false, const bool bError = false ) const

protected

{
    LogDebugMessage(FString::Printf(TEXT("%s: %f"), *Message, Value), bWarning, bError);    
}

LogDebugMessage() [4/4]

void UCommonWidgetBase::LogDebugMessage ( const FString & Message, const int32 Value, const bool bWarning = false, const bool bError = false ) const

protected

{
    LogDebugMessage(FString::Printf(TEXT("%s: %i"), *Message, Value), bWarning, bError);
}

LogDebugWarning() [1/3]

void UCommonWidgetBase::LogDebugWarning ( const FString & Message ) const

protected

{
    LogDebugMessage(Message, true);
}

LogDebugWarning() [2/3]

void UCommonWidgetBase::LogDebugWarning ( const FString & Message, const float Value ) const

protected

{
    LogDebugMessage(Message, Value, true);
}

LogDebugWarning() [3/3]

void UCommonWidgetBase::LogDebugWarning ( const FString & Message, const int32 Value ) const

protected

{
    LogDebugMessage(Message, Value, true);
}

LogOnScreenMessage()

void UCommonWidgetBase::LogOnScreenMessage ( const int32 Key, const FString & Message, FColor Color = FColor::Green ) const

protected

{
    if(GetOwningPlayer() == nullptr){return;}
    if(bDebuggingMode)
    {
        GEngine->AddOnScreenDebugMessage(Key, 2.0f, Color,
            FString::Printf(TEXT(" %s  - in %s of %s"), ToCStr(Message), ToCStr(GetName()), ToCStr(GetOwningPlayer()->GetName())));
    }
}

NativeConstruct()

void UCommonWidgetBase::NativeConstruct ( )

overrideprotectedvirtual

Reimplemented in UCommonCheckbox, UCommonSlider, and USelectionButtonMenuSystem.

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

NativePreConstruct()

void UCommonWidgetBase::NativePreConstruct ( )

overrideprotectedvirtual

Reimplemented in UCommonCheckbox, UCommonSlider, and USelectionButtonMenuSystem.

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

PlaySlateSound()

void UCommonWidgetBase::PlaySlateSound

(

const FSlateSound &

SlateSound

)

const

{
    if(SlateSound.GetResourceObject() != nullptr && GetOwningPlayer() != nullptr)
    {
        USoundBase* Sound = Cast<USoundBase>(SlateSound.GetResourceObject());
        if(Sound != nullptr)
        {
            UGameplayStatics::PlaySound2D(GetOwningPlayer(), Sound);
        }
    }
}

SetCategoryName()

void UCommonWidgetBase::SetCategoryName ( const FLogCategoryBase & Category )

inlineprotected

{CategoryName = Category.GetCategoryName();};

Setup()

void UCommonWidgetBase::Setup ( )

protectedvirtual

Reimplemented in UCommonCheckbox, and UCommonSlider.

{
    
}

Member Data Documentation

bDebuggingMode

bool UCommonWidgetBase::bDebuggingMode = false

protected

CategoryName

FLogCategoryName UCommonWidgetBase::CategoryName = LogCommonBaseWidget.GetCategoryName()

private

---

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

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