UGameInstanceLoadingScreen Class Reference

#include <GameInstanceLoadingScreen.h>

Inheritance diagram for UGameInstanceLoadingScreen:

Public Member Functions
virtual void	Init () override
virtual void	UpdateLevelInfoList ()
const TArray< const class ULevelInfo * > &	GetLevelInfoList () const
virtual void	BeginLoadingScreen (const FString &InMapName)
virtual void	EndLoadingScreen (class UWorld *InLoadedWorld)
virtual void	CheckFadeScreen (TWeakObjectPtr< UWorld > InLoadedWorld)
virtual void	LoadComplete (const float LoadTime, const FString &MapName) override
virtual void	RemoveLoadingScreen ()
void	UpdateUseLoadingScreen (bool bNewUseLoadingScreen)
void	FadeScreen (const float inFadeDuration, const bool bInToBlack, const float inFadeDelay=0.0f, const bool bInForceFadeToBlack=false)
bool	IsFading () const
Public Member Functions inherited from UVivoxGameInstance
	UVivoxGameInstance ()
virtual void	Init () override
virtual void	Shutdown () override
void	OnClientTravel (const FString &PendingURL, ETravelType TravelType, bool bIsSeamlessTravel)
virtual const FString	GetPlatformAccountID ()
float	GetParticipantVolume () const
bool	IsUsingPushToTalk () const
void	UpdateParticipantVolume (const float Volume)
void	UpdatePushToTalk (const bool bNewPushToTalk)
virtual bool	Exec (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Out= *GLog) override
	Runtime console commands. More...
virtual void	InitBeaconHost () override
virtual void	InitBeaconClient (const FOnlineSessionSearchResult &DesiredHost) override
virtual void	InitBeaconClientForServerPlayer () override
void	BindLoginSessionHandlers (bool DoBind, ILoginSession &LoginSession)
	Bind or unbind event handlers for ILoginSession property changes. More...
void	BindChannelSessionHandlers (bool DoBind, IChannelSession &ChannelSession)
	Bind or unbind event handlers for IChannelSession property changes. More...
VivoxCoreError	Initialize (int logLevel)
void	Uninitialize ()
VivoxCoreError	Login (const FString &PlayerName)
void	ReLog ()
void	Logout ()
void	ReJoinVoiceChannels ()
void	ReJoinLastKnownSquadChannel ()
void	RejoinPartyVoiceChannel ()
VivoxCoreError	JoinVoiceChannels (FString OnlineSessionId, int32 TeamNum=-1)
VivoxCoreError	JoinVoiceChannels (FString OnlineSessionId, int32 TeamNum, bool bUseOpenMic)
VivoxCoreError	Join (ChannelType Type, bool IsOpenMic, FString ChannelName)
VivoxCoreError	MultiChanPushToTalk (bool PTTKeyPressed)
void	LeaveVoiceChannels (FVoiceChannelInfo Exception=FVoiceChannelInfo())
void	LeaveVoiceChannel (FVoiceChannelInfo ChannelToLeave)
void	Update3DPosition (APawn *Pawn)
void	MutePlayerByPlayerState (const class AProjectXPlayerState *PlayerState, bool bToggle)
void	OnLoginSessionStateChanged (LoginState State)
void	OnChannelParticipantAdded (const IParticipant &Participant)
void	OnChannelParticipantRemoved (const IParticipant &Participant)
void	OnChannelParticipantUpdated (const IParticipant &Participant)
void	OnChannelAudioStateChanged (const IChannelConnectionState &State)
void	OnChannelTextStateChanged (const IChannelConnectionState &State)
void	OnChannelTextMessageReceived (const IChannelTextMessage &Message)
virtual bool	IsInitialized ()
virtual bool	IsLoggedIn ()
TSharedPtr< IChannelSession >	GetChannelSessionForRoster ()

Protected Attributes
TSharedPtr< class SProjectXLoadingScreen >	LoadingScreenSlateWidget
FSlateBrush	LoadingScreenBackground
FSlateBrush	LoadingScreenForeground
FSlateBrush	LoadingScreenLoadIcon
FSlateBrush	MiddleGroundTitleBrush
FSlateBrush	LoadingScreenFrame
FSlateBrush	MapTitleBackground
FSlateFontInfo	LoadingScreenLevelNameFont
FSlateFontInfo	LoadingScreenLevelSizeFont
FSlateFontInfo	LoadingScreenAuthorNameFont
FSlateFontInfo	LoadingScreenDescriptionFont
FSlateFontInfo	MapDescriptionFont
FSlateColor	LevelNameColor
FSlateColor	ModeColor
FSlateColor	DescriptionColor
FText	DefaultLevelName = FText::FromString("Untitled Level")
FText	DefaultAuthorName = FText::FromString("None")
FText	DefaultDescription = FText::FromString("")
FText	DefaultMapDescription = FText::FromString("")
FText	DefaultLevelSize = FText::FromString("")
FTimerHandle	RemoveLoadingScreenTimer
bool	bUseLoadingScreen = false
TArray< const class ULevelInfo * >	LevelInfoList

Additional Inherited Members
Static Public Member Functions inherited from UVivoxGameInstance
static FString	GetVivoxSafeName (const FString BaseName)
static FString	GetVivoxSafePlayerName (const FString BaseName)
static APlayerState *	GetPlayerStateByVivoxName (const UObject *WorldContextObject, UPARAM(ref) const FString &ID)
Public Attributes inherited from UVivoxGameInstance
FParticipantUpdated	OnParticipantUpdated
IClient *	VivoxVoiceClient
AccountId	LoggedInAccountID
bool	bInitialized
bool	bInitializing
bool	bLoggedIn
bool	bLoggingIn
bool	bRelogging
FVoiceChannelInfo	PartyVoiceChannel
Protected Member Functions inherited from UVivoxGameInstance
virtual void	OnPlayerStateEvent (ASteamBeaconPlayerState *InPlayerState) override
virtual void	OnSteamBeaconHostConnectionFailureEvent () override

Detailed Description

Handles loading screen tasks for the ProjectX Game Instance

Member Function Documentation

BeginLoadingScreen()

void UGameInstanceLoadingScreen::BeginLoadingScreen ( const FString &  InMapName )

virtual

CheckFadeScreen()

void UGameInstanceLoadingScreen::CheckFadeScreen ( TWeakObjectPtr< UWorld >  InLoadedWorld )

virtual

EndLoadingScreen()

void UGameInstanceLoadingScreen::EndLoadingScreen ( class UWorld *  InLoadedWorld )

virtual

FadeScreen()

void UGameInstanceLoadingScreen::FadeScreen	(	const float	inFadeDuration,
		const bool	bInToBlack,
		const float	inFadeDelay = 0.0f,
		const bool	bInForceFadeToBlack = false
	)

GetLevelInfoList()

const TArray< const class ULevelInfo * > & UGameInstanceLoadingScreen::GetLevelInfoList ( ) const

inline

Init()

void UGameInstanceLoadingScreen::Init ( )

overridevirtual

Reimplemented from UVivoxGameInstance.

Reimplemented in UProjectXGameInstance.

IsFading()

bool UGameInstanceLoadingScreen::IsFading

(

)

const

LoadComplete()

void UGameInstanceLoadingScreen::LoadComplete ( const float  LoadTime, const FString &  MapName  )

overridevirtual

RemoveLoadingScreen()

void UGameInstanceLoadingScreen::RemoveLoadingScreen ( )

virtual

UpdateLevelInfoList()

void UGameInstanceLoadingScreen::UpdateLevelInfoList ( )

virtual

UpdateUseLoadingScreen()

void UGameInstanceLoadingScreen::UpdateUseLoadingScreen ( bool  bNewUseLoadingScreen )

inline

Member Data Documentation

bUseLoadingScreen

bool UGameInstanceLoadingScreen::bUseLoadingScreen = false

protected

DefaultAuthorName

FText UGameInstanceLoadingScreen::DefaultAuthorName = FText::FromString("None")

protected

DefaultDescription

FText UGameInstanceLoadingScreen::DefaultDescription = FText::FromString("")

protected

DefaultLevelName

FText UGameInstanceLoadingScreen::DefaultLevelName = FText::FromString("Untitled Level")

protected

DefaultLevelSize

FText UGameInstanceLoadingScreen::DefaultLevelSize = FText::FromString("")

protected

DefaultMapDescription

FText UGameInstanceLoadingScreen::DefaultMapDescription = FText::FromString("")

protected

DescriptionColor

FSlateColor UGameInstanceLoadingScreen::DescriptionColor

protected

LevelInfoList

TArray<const class ULevelInfo*> UGameInstanceLoadingScreen::LevelInfoList

protected

LevelNameColor

FSlateColor UGameInstanceLoadingScreen::LevelNameColor

protected

LoadingScreenAuthorNameFont

FSlateFontInfo UGameInstanceLoadingScreen::LoadingScreenAuthorNameFont

protected

LoadingScreenBackground

FSlateBrush UGameInstanceLoadingScreen::LoadingScreenBackground

protected

LoadingScreenDescriptionFont

FSlateFontInfo UGameInstanceLoadingScreen::LoadingScreenDescriptionFont

protected

LoadingScreenForeground

FSlateBrush UGameInstanceLoadingScreen::LoadingScreenForeground

protected

LoadingScreenFrame

FSlateBrush UGameInstanceLoadingScreen::LoadingScreenFrame

protected

LoadingScreenLevelNameFont

FSlateFontInfo UGameInstanceLoadingScreen::LoadingScreenLevelNameFont

protected

LoadingScreenLevelSizeFont

FSlateFontInfo UGameInstanceLoadingScreen::LoadingScreenLevelSizeFont

protected

LoadingScreenLoadIcon

FSlateBrush UGameInstanceLoadingScreen::LoadingScreenLoadIcon

protected

LoadingScreenSlateWidget

TSharedPtr<class SProjectXLoadingScreen> UGameInstanceLoadingScreen::LoadingScreenSlateWidget

protected

MapDescriptionFont

FSlateFontInfo UGameInstanceLoadingScreen::MapDescriptionFont

protected

MapTitleBackground

FSlateBrush UGameInstanceLoadingScreen::MapTitleBackground

protected

MiddleGroundTitleBrush

FSlateBrush UGameInstanceLoadingScreen::MiddleGroundTitleBrush

protected

ModeColor

FSlateColor UGameInstanceLoadingScreen::ModeColor

protected

RemoveLoadingScreenTimer

FTimerHandle UGameInstanceLoadingScreen::RemoveLoadingScreenTimer

protected

---

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

• E:/ProjectY/Source/ProjectX/Public/System/GameInstanceLoadingScreen.h
• E:/ProjectY/Source/ProjectX/Private/System/GameInstanceLoadingScreen.cpp