BaseLoadingAnim Interface Reference

Inheritance diagram for BaseLoadingAnim:

Public Member Functions
void	Load ()
void	Unload ()
void	BaseLoadingAnim (WorkspaceWidget workspaceWidget)
void	~BaseLoadingAnim ()
Widget	CreateLayout (WorkspaceWidget workspaceWidget)
override void	Update (float timeSlice, float progress, float minDurationRatio)
	Used for updating the loading screen animations and progress bars.
override void	Show ()
	Called just before loading animation is shown.
override void	Hide ()
	Called when loading animation has finished and should be hidden.
Public Member Functions inherited from LoadingAnim
void	LoadingAnim (WorkspaceWidget workspaceWidget)
void	Show ()
	Called just before loading animation is shown.
void	Update (float timeSlice, float progress, float minDurationRatio)
	Used for updating the loading screen animations and progress bars.
void	Hide ()
	Called when loading animation has finished and should be hidden.

Protected Attributes
Widget	m_wRoot
ImageWidget	m_wProgressImage

Static Protected Attributes
const float	MAX_ANGLE = 360
static int	s_NumReloads
	Sets from engine side, number is increased after each game reinitialization
static float	s_fProgress = 0

Additional Inherited Members
Public Attributes inherited from LoadingAnim
WorkspaceWidget	m_WorkspaceWidget

Constructor & Destructor Documentation

BaseLoadingAnim()

void BaseLoadingAnim.BaseLoadingAnim

(

WorkspaceWidget

workspaceWidget

)

~BaseLoadingAnim()

void BaseLoadingAnim.~BaseLoadingAnim

(

)

Member Function Documentation

CreateLayout()

Widget BaseLoadingAnim.CreateLayout

(

WorkspaceWidget

workspaceWidget

)

Hide()

override void BaseLoadingAnim.Hide

(

)

Called when loading animation has finished and should be hidden.

Warning

This function is called concurrently with loading and initialization of resources (including scripted entities and components). Do not access anything that may be modified from somewhere else.

Implements LoadingAnim.

Load()

void BaseLoadingAnim.Load

(

)

Show()

override void BaseLoadingAnim.Show

(

)

Called just before loading animation is shown.

You shouldn't perform any expensive operations here (such as loading images and UI layouts) to avoid freezes when loading screen is shown.

Warning

This function is called concurrently with loading and initialization of resources (including scripted entities and components). Do not access anything that may be modified from somewhere else.

Implements LoadingAnim.

Unload()

void BaseLoadingAnim.Unload

(

)

Update()

override void BaseLoadingAnim.Update	(	float	timeSlice,
		float	progress,
		float	minDurationRatio
	)

Used for updating the loading screen animations and progress bars.

Progress value is based on how many resources are still left in loading queue. However, loading new resources can cause more things to be added to the queue, so this value can jump up and down and these cases need to be handled, otherwise progress may appear to go backwards.

Some platforms require that loading screen is visible for at least certain minimum amount of time. To account for this, minDurationRatio provides percentage of this minimum duration that has already elapsed.

Warning

This function is called concurrently with loading and initialization of resources (including scripted entities and components). Do not access anything that may be modified somewhere else.

Parameters

timeSlice	Time slice in seconds.
progress	Unmodified loading progress value between 0 and 1. This value may decrease.
minDurationRatio	Ratio of minimal duration that has already elapsed, between 0 and 1. This value never decreases.

Implements LoadingAnim.

Member Data Documentation

m_wProgressImage

ImageWidget BaseLoadingAnim.m_wProgressImage

protected

m_wRoot

Widget BaseLoadingAnim.m_wRoot

protected

MAX_ANGLE

const float BaseLoadingAnim.MAX_ANGLE = 360

staticprotected

s_fProgress

float BaseLoadingAnim.s_fProgress = 0

staticprotected

s_NumReloads

int BaseLoadingAnim.s_NumReloads

staticprotected

Sets from engine side, number is increased after each game reinitialization

---

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

• GameLib/gameLib.c