LEAP Documentation 40220
Documentation for the LEAP project
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
UProjectXGameViewportClient Class Reference

#include <ProjectXGameViewportClient.h>

Inheritance diagram for UProjectXGameViewportClient:

Public Member Functions

virtual void Tick (float DeltaTime) override
 
virtual void PostRender (UCanvas *Canvas) override
 
virtual void Init (struct FWorldContext &WorldContext, UGameInstance *OwningGameInstance, bool bCreateNewAudioDevice=true) override
 
virtual void ClearFade ()
 
virtual void Fade (const float inFadeDuration, const bool bInToBlack, const float inFadeDelay=0.0f, const bool &bInForceFadeToBlack=false)
 
void DrawScreenFade (UCanvas *Canvas)
 
bool IsFading () const
 
void ReinitializeViewportClientFade ()
 
void CleanViewport ()
 
void MenuBack ()
 
void ToggleEscMenu ()
 
void ToggleMap ()
 
void OpenMap ()
 
void OpenLandingScreen ()
 
void DeferredOpenMapTimerComplete ()
 
void CloseMap ()
 
void CloseLandingScreen ()
 
void DeferredOpenMap (float Delay=-1.f)
 
void ClearMapTimers ()
 
void NavigateBumperLeft ()
 
void NavigateBumperRight ()
 
bool IsPlayerBindingNewButton () const
 
void SetPlayerBindingNewButton (const bool bIsPlayerCurrentlyBinding)
 
void TopFaceButton ()
 
void BottomFaceButton ()
 
void RightFaceButton ()
 
void LeftFaceButton ()
 
void ToggleKickVoteMenu ()
 
void ToggleMapVoteMenu ()
 
void ShowScoreboard ()
 
void HideScoreboard ()
 
bool CanToggleChat () const
 
bool HasLegalPawn () const
 
void OpenPostGameScreen ()
 
void OpenQuickChat ()
 
void CloseQuickChat ()
 
void ToggleDeathWidget (bool OpenWidget)
 
void ToggleHUD (bool bToggle)
 
void RemoveHUDUserWidget (UUserWidget *Widget)
 
void RemoveAllHUDUserWidgets ()
 
virtual void ToggleSoftwareCursor (const bool bToggle)
 
bool SetUserFocusOnAdvancedUserWidget (UAdvancedUserWidget *Widget)
 
bool SetUserFocusOnFirstChild (UUserWidget *Widget)
 
bool AreAnyActiveWidgetsDisablingInput () const
 
void AddHUDBaseWidgetToList (UHUDBasicUserWidget *WidgetToAdd)
 
void RemoveHUDBaseWidgetFromList (UHUDBasicUserWidget *WidgetToRemove)
 
virtual void LevelTravel ()
 
template<class T >
void ToggleWidgetByClass ()
 
void ToggleWidgetByClass (TSubclassOf< UAdvancedUserWidget > WidgetClass, EWindowToggleCommand ToggleCommand=EWindowToggleCommand::Toggle)
 
void ToggleWidget (UAdvancedUserWidget *UserWidget, const EWindowToggleCommand ToggleCommand, const UObject *ContextObject=nullptr)
 
UAdvancedUserWidget * GetWidgetByClass (TSubclassOf< UUserWidget > WidgetClass, bool bReturnInheritedClasses=false) const
 
void CloseAllWidgets (const bool bClosedByAnotherWidget=false)
 
void OnWidgetDestroyed (UAdvancedUserWidget *Widget)
 
UContextMenuWidget * CreateContextMenu (const TArray< FContextMenuOption > &ContextMenuOptions, const FText Title, const bool bDismissable, const UObject *ContextObject=nullptr)
 
UContextMenuWidget * CreateGlobalMessageDialogue (FContextMenuOption ContextMenuOption1, FContextMenuOption ContextMenuOption2, const FText Title, const FText Message, const bool bDismissable, const UObject *ContextObject=nullptr)
 
UHUDBasicUserWidget * FindOrCreateHUDUserWidget (UClass *WidgetClass, const int32 ZOrder)
 
UUserWidget * GetHUDWidgetByClass (TSubclassOf< UUserWidget > WidgetClass) const
 
AProjectXHUD * GetHUD () const
 
UAdvancedUserWidget * GetOrCreateViewportWidget (UClass *WidgetClass, const int32 ZOrder, const bool bDontCreateCopies=false)
 
void ToggleDisplayMesh (bool bToggled)
 
AActor *const GetDisplayMesh () const
 
bool IsDisplayMeshVisible () const
 
void KeysRebound ()
 
TSubclassOf< UAdvancedUserWidget > GetHighestActiveWidget () const
 
UUserWidget * GetTooltipWidget ()
 
void SetPlayerInputLockingState ()
 
bool IsUsingGamePad () const
 
UAdvancedUserWidget * GetHighestPriorityActiveWidget () const
 

Static Public Member Functions

static UUserWidget * CreateUserWidgetFromPool (UObject *const WorldContextObject, TSubclassOf< UUserWidget > UserWidget)
 
static void ReleaseUserWidgetFromPool (UObject *const WorldContextObject, UUserWidget *const UserWidget)
 
static void BuildWidgetPoolForWidget (UObject *const WorldContextObject, TSubclassOf< UUserWidget > UserWidget, int32 PoolSize=10)
 
static UAdvancedUserWidget * CreateAdvancedUserWidget (const UObject *WorldContextObject, TSubclassOf< UAdvancedUserWidget > AdvancedUserWidgetClass, const int32 ZOrder)
 
static void ToggleAdvancedUserWidget (const UObject *WorldContextObject, UAdvancedUserWidget *AdvancedUserWidgetClass, const EWindowToggleCommand ToggleCommand)
 
static UAdvancedUserWidget * ToggleAdvancedUserWidgetByClass (const UObject *WorldContextObject, TSubclassOf< UAdvancedUserWidget > AdvancedUserWidgetClass, const EWindowToggleCommand ToggleCommand)
 
static bool IsAdvancedUserWidgetActiveByClass (const UObject *WorldContextObject, TSubclassOf< UAdvancedUserWidget > AdvancedUserWidgetClass)
 
static UProjectXGameViewportClient * GetViewportClient (const UObject *WorldContextObject)
 

Public Attributes

FWidgetChangedSignature OnHighestActiveWidgetChanged
 
FDisplayMeshVisibilityUpdatedSignature OnDisplayMeshVisibilityChangedEvent
 
FViewportGamePadStateChangeSignature OnGamepadStateChanged
 
FOnKeyBindingViewportUpdatedSignature OnViewportKeybindUpdatedEvent
 

Protected Member Functions

virtual void BeginDestroy () override
 
virtual APlayerController * GetOwningPlayerController () const
 
virtual bool InputKey (const FInputKeyEventArgs &EventArgs) override
 
virtual bool InputAxis (FViewport *InViewport, int32 ControllerId, FKey Key, float Delta, float DeltaTime, int32 NumSamples, bool bGamepad) override
 
void SetUsingGamepad (bool bToggle)
 
void LogFocusedWidget ()
 

Protected Attributes

TSubclassOf< UUserWidget > TooltipWidgetClass = NULL
 

Friends

class UAdvancedUserWidget
 
class AProjectXHUD
 
class UProjectXGameInstance
 

Member Function Documentation

◆ AddHUDBaseWidgetToList()

void UProjectXGameViewportClient::AddHUDBaseWidgetToList ( UHUDBasicUserWidget *  WidgetToAdd)

◆ AreAnyActiveWidgetsDisablingInput()

bool UProjectXGameViewportClient::AreAnyActiveWidgetsDisablingInput ( ) const

◆ BeginDestroy()

void UProjectXGameViewportClient::BeginDestroy ( )
overrideprotectedvirtual

◆ BottomFaceButton()

void UProjectXGameViewportClient::BottomFaceButton ( )

◆ BuildWidgetPoolForWidget()

void UProjectXGameViewportClient::BuildWidgetPoolForWidget ( UObject *const  WorldContextObject,
TSubclassOf< UUserWidget >  UserWidget,
int32  PoolSize = 10 
)
static

◆ CanToggleChat()

bool UProjectXGameViewportClient::CanToggleChat ( ) const

◆ CleanViewport()

void UProjectXGameViewportClient::CleanViewport ( )

◆ ClearFade()

void UProjectXGameViewportClient::ClearFade ( )
virtual

◆ ClearMapTimers()

void UProjectXGameViewportClient::ClearMapTimers ( )

◆ CloseAllWidgets()

void UProjectXGameViewportClient::CloseAllWidgets ( const bool  bClosedByAnotherWidget = false)

◆ CloseLandingScreen()

void UProjectXGameViewportClient::CloseLandingScreen ( )

◆ CloseMap()

void UProjectXGameViewportClient::CloseMap ( )

◆ CloseQuickChat()

void UProjectXGameViewportClient::CloseQuickChat ( )

◆ CreateAdvancedUserWidget()

UAdvancedUserWidget * UProjectXGameViewportClient::CreateAdvancedUserWidget ( const UObject *  WorldContextObject,
TSubclassOf< UAdvancedUserWidget >  AdvancedUserWidgetClass,
const int32  ZOrder 
)
static

◆ CreateContextMenu()

UContextMenuWidget * UProjectXGameViewportClient::CreateContextMenu ( const TArray< FContextMenuOption > &  ContextMenuOptions,
const FText  Title,
const bool  bDismissable,
const UObject *  ContextObject = nullptr 
)

◆ CreateGlobalMessageDialogue()

UContextMenuWidget * UProjectXGameViewportClient::CreateGlobalMessageDialogue ( FContextMenuOption  ContextMenuOption1,
FContextMenuOption  ContextMenuOption2,
const FText  Title,
const FText  Message,
const bool  bDismissable,
const UObject *  ContextObject = nullptr 
)

◆ CreateUserWidgetFromPool()

UUserWidget * UProjectXGameViewportClient::CreateUserWidgetFromPool ( UObject *const  WorldContextObject,
TSubclassOf< UUserWidget >  UserWidget 
)
static

◆ DeferredOpenMap()

void UProjectXGameViewportClient::DeferredOpenMap ( float  Delay = -1.f)

◆ DeferredOpenMapTimerComplete()

void UProjectXGameViewportClient::DeferredOpenMapTimerComplete ( )

◆ DrawScreenFade()

void UProjectXGameViewportClient::DrawScreenFade ( UCanvas *  Canvas)

◆ Fade()

void UProjectXGameViewportClient::Fade ( const float  inFadeDuration,
const bool  bInToBlack,
const float  inFadeDelay = 0.0f,
const bool &  bInForceFadeToBlack = false 
)
virtual

◆ FindOrCreateHUDUserWidget()

UHUDBasicUserWidget * UProjectXGameViewportClient::FindOrCreateHUDUserWidget ( UClass *  WidgetClass,
const int32  ZOrder 
)

◆ GetDisplayMesh()

AActor *const UProjectXGameViewportClient::GetDisplayMesh ( ) const

◆ GetHighestActiveWidget()

TSubclassOf< UAdvancedUserWidget > UProjectXGameViewportClient::GetHighestActiveWidget ( ) const
inline

◆ GetHighestPriorityActiveWidget()

UAdvancedUserWidget * UProjectXGameViewportClient::GetHighestPriorityActiveWidget ( ) const

◆ GetHUD()

AProjectXHUD * UProjectXGameViewportClient::GetHUD ( ) const

◆ GetHUDWidgetByClass()

UUserWidget * UProjectXGameViewportClient::GetHUDWidgetByClass ( TSubclassOf< UUserWidget >  WidgetClass) const

◆ GetOrCreateViewportWidget()

UAdvancedUserWidget * UProjectXGameViewportClient::GetOrCreateViewportWidget ( UClass *  WidgetClass,
const int32  ZOrder,
const bool  bDontCreateCopies = false 
)

◆ GetOwningPlayerController()

APlayerController * UProjectXGameViewportClient::GetOwningPlayerController ( ) const
protectedvirtual

◆ GetTooltipWidget()

UUserWidget * UProjectXGameViewportClient::GetTooltipWidget ( )

◆ GetViewportClient()

UProjectXGameViewportClient * UProjectXGameViewportClient::GetViewportClient ( const UObject *  WorldContextObject)
static

◆ GetWidgetByClass()

UAdvancedUserWidget * UProjectXGameViewportClient::GetWidgetByClass ( TSubclassOf< UUserWidget >  WidgetClass,
bool  bReturnInheritedClasses = false 
) const

◆ HasLegalPawn()

bool UProjectXGameViewportClient::HasLegalPawn ( ) const

◆ HideScoreboard()

void UProjectXGameViewportClient::HideScoreboard ( )

◆ Init()

void UProjectXGameViewportClient::Init ( struct FWorldContext &  WorldContext,
UGameInstance *  OwningGameInstance,
bool  bCreateNewAudioDevice = true 
)
overridevirtual

◆ InputAxis()

bool UProjectXGameViewportClient::InputAxis ( FViewport *  InViewport,
int32  ControllerId,
FKey  Key,
float  Delta,
float  DeltaTime,
int32  NumSamples,
bool  bGamepad 
)
overrideprotectedvirtual

◆ InputKey()

bool UProjectXGameViewportClient::InputKey ( const FInputKeyEventArgs &  EventArgs)
overrideprotectedvirtual

◆ IsAdvancedUserWidgetActiveByClass()

bool UProjectXGameViewportClient::IsAdvancedUserWidgetActiveByClass ( const UObject *  WorldContextObject,
TSubclassOf< UAdvancedUserWidget >  AdvancedUserWidgetClass 
)
static

◆ IsDisplayMeshVisible()

bool UProjectXGameViewportClient::IsDisplayMeshVisible ( ) const
inline

◆ IsFading()

bool UProjectXGameViewportClient::IsFading ( ) const

◆ IsPlayerBindingNewButton()

bool UProjectXGameViewportClient::IsPlayerBindingNewButton ( ) const
inline

◆ IsUsingGamePad()

bool UProjectXGameViewportClient::IsUsingGamePad ( ) const
inline

◆ KeysRebound()

void UProjectXGameViewportClient::KeysRebound ( )
inline

◆ LeftFaceButton()

void UProjectXGameViewportClient::LeftFaceButton ( )

◆ LevelTravel()

void UProjectXGameViewportClient::LevelTravel ( )
virtual

◆ LogFocusedWidget()

void UProjectXGameViewportClient::LogFocusedWidget ( )
protected

◆ MenuBack()

void UProjectXGameViewportClient::MenuBack ( )

◆ NavigateBumperLeft()

void UProjectXGameViewportClient::NavigateBumperLeft ( )

◆ NavigateBumperRight()

void UProjectXGameViewportClient::NavigateBumperRight ( )

◆ OnWidgetDestroyed()

void UProjectXGameViewportClient::OnWidgetDestroyed ( UAdvancedUserWidget *  Widget)

◆ OpenLandingScreen()

void UProjectXGameViewportClient::OpenLandingScreen ( )

◆ OpenMap()

void UProjectXGameViewportClient::OpenMap ( )

◆ OpenPostGameScreen()

void UProjectXGameViewportClient::OpenPostGameScreen ( )

◆ OpenQuickChat()

void UProjectXGameViewportClient::OpenQuickChat ( )

◆ PostRender()

void UProjectXGameViewportClient::PostRender ( UCanvas *  Canvas)
overridevirtual

◆ ReinitializeViewportClientFade()

void UProjectXGameViewportClient::ReinitializeViewportClientFade ( )

◆ ReleaseUserWidgetFromPool()

void UProjectXGameViewportClient::ReleaseUserWidgetFromPool ( UObject *const  WorldContextObject,
UUserWidget *const  UserWidget 
)
static

◆ RemoveAllHUDUserWidgets()

void UProjectXGameViewportClient::RemoveAllHUDUserWidgets ( )

◆ RemoveHUDBaseWidgetFromList()

void UProjectXGameViewportClient::RemoveHUDBaseWidgetFromList ( UHUDBasicUserWidget *  WidgetToRemove)

◆ RemoveHUDUserWidget()

void UProjectXGameViewportClient::RemoveHUDUserWidget ( UUserWidget *  Widget)

◆ RightFaceButton()

void UProjectXGameViewportClient::RightFaceButton ( )

◆ SetPlayerBindingNewButton()

void UProjectXGameViewportClient::SetPlayerBindingNewButton ( const bool  bIsPlayerCurrentlyBinding)
inline

◆ SetPlayerInputLockingState()

void UProjectXGameViewportClient::SetPlayerInputLockingState ( )

◆ SetUserFocusOnAdvancedUserWidget()

bool UProjectXGameViewportClient::SetUserFocusOnAdvancedUserWidget ( UAdvancedUserWidget *  Widget)

◆ SetUserFocusOnFirstChild()

bool UProjectXGameViewportClient::SetUserFocusOnFirstChild ( UUserWidget *  Widget)

◆ SetUsingGamepad()

void UProjectXGameViewportClient::SetUsingGamepad ( bool  bToggle)
protected

◆ ShowScoreboard()

void UProjectXGameViewportClient::ShowScoreboard ( )

◆ Tick()

void UProjectXGameViewportClient::Tick ( float  DeltaTime)
overridevirtual

◆ ToggleAdvancedUserWidget()

void UProjectXGameViewportClient::ToggleAdvancedUserWidget ( const UObject *  WorldContextObject,
UAdvancedUserWidget *  AdvancedUserWidgetClass,
const EWindowToggleCommand  ToggleCommand 
)
static

◆ ToggleAdvancedUserWidgetByClass()

UAdvancedUserWidget * UProjectXGameViewportClient::ToggleAdvancedUserWidgetByClass ( const UObject *  WorldContextObject,
TSubclassOf< UAdvancedUserWidget >  AdvancedUserWidgetClass,
const EWindowToggleCommand  ToggleCommand 
)
static

◆ ToggleDeathWidget()

void UProjectXGameViewportClient::ToggleDeathWidget ( bool  OpenWidget)

◆ ToggleDisplayMesh()

void UProjectXGameViewportClient::ToggleDisplayMesh ( bool  bToggled)

◆ ToggleEscMenu()

void UProjectXGameViewportClient::ToggleEscMenu ( )

◆ ToggleHUD()

void UProjectXGameViewportClient::ToggleHUD ( bool  bToggle)

◆ ToggleKickVoteMenu()

void UProjectXGameViewportClient::ToggleKickVoteMenu ( )

◆ ToggleMap()

void UProjectXGameViewportClient::ToggleMap ( )

◆ ToggleMapVoteMenu()

void UProjectXGameViewportClient::ToggleMapVoteMenu ( )

◆ ToggleSoftwareCursor()

void UProjectXGameViewportClient::ToggleSoftwareCursor ( const bool  bToggle)
virtual

◆ ToggleWidget()

void UProjectXGameViewportClient::ToggleWidget ( UAdvancedUserWidget *  UserWidget,
const EWindowToggleCommand  ToggleCommand,
const UObject *  ContextObject = nullptr 
)

◆ ToggleWidgetByClass() [1/2]

template<class T >
void UProjectXGameViewportClient::ToggleWidgetByClass ( )
inline

◆ ToggleWidgetByClass() [2/2]

void UProjectXGameViewportClient::ToggleWidgetByClass ( TSubclassOf< UAdvancedUserWidget >  WidgetClass,
EWindowToggleCommand  ToggleCommand = EWindowToggleCommand::Toggle 
)

◆ TopFaceButton()

void UProjectXGameViewportClient::TopFaceButton ( )

Friends And Related Function Documentation

◆ AProjectXHUD

friend class AProjectXHUD
friend

◆ UAdvancedUserWidget

friend class UAdvancedUserWidget
friend

◆ UProjectXGameInstance

friend class UProjectXGameInstance
friend

Member Data Documentation

◆ OnDisplayMeshVisibilityChangedEvent

FDisplayMeshVisibilityUpdatedSignature UProjectXGameViewportClient::OnDisplayMeshVisibilityChangedEvent

◆ OnGamepadStateChanged

FViewportGamePadStateChangeSignature UProjectXGameViewportClient::OnGamepadStateChanged

◆ OnHighestActiveWidgetChanged

FWidgetChangedSignature UProjectXGameViewportClient::OnHighestActiveWidgetChanged

◆ OnViewportKeybindUpdatedEvent

FOnKeyBindingViewportUpdatedSignature UProjectXGameViewportClient::OnViewportKeybindUpdatedEvent

◆ TooltipWidgetClass

TSubclassOf<UUserWidget> UProjectXGameViewportClient::TooltipWidgetClass = NULL
protected
The documentation for this class was generated from the following files: