SCR_LoadingScreenComponent Interface Reference

Inheritance diagram for SCR_LoadingScreenComponent:

Public Member Functions
void	OnMissionDataRetrieved (SCR_MissionHeader header)
override void	OnHideInternal ()
override void	Update (float timeSlice, float progress=0, float minDurationRatio=0)
void	SetJoiningCrossPlay (bool isCrossPlay)
void	SetLoadingModded (bool isModded)
Public Member Functions inherited from SCR_BaseLoadingScreenComponent
void	SaveLoadingTime (float loadingTime)
float	GetLoadingTime ()

Protected Member Functions
override void	HandlerAttached (Widget w)
override void	InitWidgets ()
void	SetProgressBar (float progress)
Protected Member Functions inherited from SCR_BaseLoadingScreenComponent
void	Fade (Widget w, bool show, float length, float timeslice)

Protected Attributes
bool	m_bMissionDataRetrieved
Widget	m_wBuildVersion
Protected Attributes inherited from SCR_BaseLoadingScreenComponent
Widget	m_wRoot
ref SCR_ScenarioLoadingScreenWidgets	m_Widgets
SCR_LoadingSpinner	m_SpinnerComp
float	m_fLoadingTime

Static Protected Attributes
const string	AUTHOR_FORMAT = "#AR-AuthorLoadingScreen"
const string	AUTHOR_UNKNOWN = "#AR-Author_Unknown"
const float	MAX_DESCRIPTION_LENGTH = 1000
const float	FADE_TIME = 1
Static Protected Attributes inherited from SCR_BaseLoadingScreenComponent
static const float	FADE_TIME_BLACK_OVERLAY = 1

Additional Inherited Members
Static Public Member Functions inherited from SCR_BaseLoadingScreenComponent
static void	ResetLoadingTime ()

Member Function Documentation

HandlerAttached()

override void SCR_LoadingScreenComponent.HandlerAttached ( Widget w )

protected

Implements SCR_BaseLoadingScreenComponent.

InitWidgets()

override void SCR_LoadingScreenComponent.InitWidgets ( )

protected

Implements SCR_BaseLoadingScreenComponent.

OnHideInternal()

override void SCR_LoadingScreenComponent.OnHideInternal

(

)

Implements SCR_BaseLoadingScreenComponent.

OnMissionDataRetrieved()

void SCR_LoadingScreenComponent.OnMissionDataRetrieved

(

SCR_MissionHeader

header

)

SetJoiningCrossPlay()

void SCR_LoadingScreenComponent.SetJoiningCrossPlay

(

bool

isCrossPlay

)

SetLoadingModded()

void SCR_LoadingScreenComponent.SetLoadingModded

(

bool

isModded

)

SetProgressBar()

void SCR_LoadingScreenComponent.SetProgressBar ( float progress )

protected

Update()

override void SCR_LoadingScreenComponent.Update	(	float	timeSlice,
		float	progress = 0,
		float	minDurationRatio = 0 )

Parameters

[in]	timeSlice
[in]	progress
[in]	minDurationRatio

Implements SCR_BaseLoadingScreenComponent.

Member Data Documentation

AUTHOR_FORMAT

const string SCR_LoadingScreenComponent.AUTHOR_FORMAT = "#AR-AuthorLoadingScreen"

staticprotected

AUTHOR_UNKNOWN

const string SCR_LoadingScreenComponent.AUTHOR_UNKNOWN = "#AR-Author_Unknown"

staticprotected

FADE_TIME

const float SCR_LoadingScreenComponent.FADE_TIME = 1

staticprotected

m_bMissionDataRetrieved

bool SCR_LoadingScreenComponent.m_bMissionDataRetrieved

protected

m_wBuildVersion

Widget SCR_LoadingScreenComponent.m_wBuildVersion

protected

MAX_DESCRIPTION_LENGTH

const float SCR_LoadingScreenComponent.MAX_DESCRIPTION_LENGTH = 1000

staticprotected

---

The documentation for this interface was generated from the following file:

• Game/UI/LoadingScreen/SCR_LoadingScreenComponent.c