SCR_WelcomeScreenIntroductionContent Interface Reference

Class handling introduction content. More...

Inheritance diagram for SCR_WelcomeScreenIntroductionContent:

Public Member Functions
override void	InitContent (SCR_WelcomeScreenMenu menu, string column, string columnButton)
	Initialises content for given column.
override void	ToggleInteractions (bool enabled)
	Toggles whether or not this content is interactive.
int	GetIntroduction (out array< ref SCR_WelcomeScreenIntroduction > introduction)
	Get Introduction which can be separated into several pages.
string	GetTitleText ()
int	GetCurrentPage ()
void	SetCurrentPage (int page)
	Sets current page number which just changes the member variable and nothing more.
Public Member Functions inherited from SCR_WelcomeScreenBaseContent
string	GetContentName ()
bool	GetIsInteractible ()
	Get if it is interactible.

Protected Member Functions
void	FillIntroductionWidget (Widget column)
	Fills content widget with dynamic introductions.
void	InitPagination ()
	Initialises pagination by registering button actions.
void	ButtonClicked ()
	Changes focus to the column from which that button originates. It is supposed to be invoked.
void	HandlePagination (bool enabled=false)
	Handles inputs of buttons.
void	PreviousButtonActivated ()
	Flips page to the previous one.
void	NextButtonActivated ()
	Flips page to the next one.
void	FlipPage (int currentPage)
	Changes the content of current page based on the provided number.

Protected Attributes
string	m_sTitleText
ref array< ref SCR_WelcomeScreenIntroduction >	m_aIntroduction
int	m_iCurrentPage
int	m_iIntroductionCount
ResourceName	m_sIntroductionColumnLayout
Widget	m_wIntroductionContentWidget
ButtonWidget	m_wColumnButton
Protected Attributes inherited from SCR_WelcomeScreenBaseContent
bool	m_bIsInteractible
string	m_sContentName

Detailed Description

Class handling introduction content.

Member Function Documentation

ButtonClicked()

void SCR_WelcomeScreenIntroductionContent.ButtonClicked ( )

protected

Changes focus to the column from which that button originates. It is supposed to be invoked.

FillIntroductionWidget()

void SCR_WelcomeScreenIntroductionContent.FillIntroductionWidget ( Widget column )

protected

Fills content widget with dynamic introductions.

Parameters

[in]

column

FlipPage()

void SCR_WelcomeScreenIntroductionContent.FlipPage ( int currentPage )

protected

Changes the content of current page based on the provided number.

Parameters

[in]

currentPage

GetCurrentPage()

int SCR_WelcomeScreenIntroductionContent.GetCurrentPage

(

)

Returns

current page

GetIntroduction()

int SCR_WelcomeScreenIntroductionContent.GetIntroduction

(

out array< ref SCR_WelcomeScreenIntroduction >

introduction

)

Get Introduction which can be separated into several pages.

Parameters

[out]

introduction

array of introductions

Returns

number of introductions

GetTitleText()

string SCR_WelcomeScreenIntroductionContent.GetTitleText

(

)

Returns

title

HandlePagination()

void SCR_WelcomeScreenIntroductionContent.HandlePagination ( bool enabled = false )

protected

Handles inputs of buttons.

Parameters

[in]

enabled

InitContent()

override void SCR_WelcomeScreenIntroductionContent.InitContent	(	SCR_WelcomeScreenMenu	menu,
		string	column,
		string	columnButton )

Initialises content for given column.

Parameters

[in]	menu
[in]	column
[in]	columnButton

Implements SCR_WelcomeScreenBaseContent.

InitPagination()

void SCR_WelcomeScreenIntroductionContent.InitPagination ( )

protected

Initialises pagination by registering button actions.

NextButtonActivated()

void SCR_WelcomeScreenIntroductionContent.NextButtonActivated ( )

protected

Flips page to the next one.

PreviousButtonActivated()

void SCR_WelcomeScreenIntroductionContent.PreviousButtonActivated ( )

protected

Flips page to the previous one.

SetCurrentPage()

void SCR_WelcomeScreenIntroductionContent.SetCurrentPage

(

int

page

)

Sets current page number which just changes the member variable and nothing more.

Method FlipPage actually performs UI Changes based on this member variable.

Parameters

[in]

page

ToggleInteractions()

override void SCR_WelcomeScreenIntroductionContent.ToggleInteractions

(

bool

enabled

)

Toggles whether or not this content is interactive.

Parameters

[in]

enabled

Implements SCR_WelcomeScreenBaseContent.

Member Data Documentation

m_aIntroduction

ref array<ref SCR_WelcomeScreenIntroduction> SCR_WelcomeScreenIntroductionContent.m_aIntroduction

protected

m_iCurrentPage

int SCR_WelcomeScreenIntroductionContent.m_iCurrentPage

protected

m_iIntroductionCount

int SCR_WelcomeScreenIntroductionContent.m_iIntroductionCount

protected

m_sIntroductionColumnLayout

ResourceName SCR_WelcomeScreenIntroductionContent.m_sIntroductionColumnLayout

protected

m_sTitleText

string SCR_WelcomeScreenIntroductionContent.m_sTitleText

protected

m_wColumnButton

ButtonWidget SCR_WelcomeScreenIntroductionContent.m_wColumnButton

protected

m_wIntroductionContentWidget

Widget SCR_WelcomeScreenIntroductionContent.m_wIntroductionContentWidget

protected

---

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

• Game/GameMode/Respawn/SCR_WelcomeScreenComponent.c