SCR_WelcomeScreenDynamicObjectivesContent Interface Reference

Class handling mission objectives that are dynamically created during the mission. More...

Inheritance diagram for SCR_WelcomeScreenDynamicObjectivesContent:

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.
void	FillDynamicObjectivesWidget (Widget content)
	Fills content widget with dynamic mission objectives.
int	GetCurrentPage ()
void	SetCurrentPage (int page)
	Sets current page number which just changes the member variable and nothing more.
string	GetTitleText ()
Public Member Functions inherited from SCR_WelcomeScreenBaseContent
void	InitContent (SCR_WelcomeScreenMenu menu, string column, string columnButton)
	Initialises content for given column.
void	ToggleInteractions (bool enabled)
	Toggles whether or not this content is interactive.
string	GetContentName ()
bool	GetIsInteractible ()
	Get if it is interactible.

Protected Member Functions
void	AddTask (SCR_BaseTask task)
	Calls method with delay to add a task to the array of objectives to be displayed.
void	AddTaskCalledLater (SCR_BaseTask task)
	Adds task to the array of objectives to be displayed.
void	RemoveTask (SCR_BaseTask task)
	Removes task from the array of objectives to be displayed.
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_WelcomeScreenDynamicTaskFaction >	m_aFactions
ResourceName	m_sFinishedObjectivesTileLayout
ResourceName	m_sFinishedObjectivesLayout
Widget	m_wFinishedObjectivesWidget
Widget	m_wPaginationWidget
ButtonWidget	m_wColumnButton
ref array< SCR_BaseTask >	m_aObjectivesToDisplay = {}
ref array< Widget >	m_aDynamicObjectivesWidgets = {}
int	m_iCurrentPage
int	m_iDynamicObjectivesCount
SCR_FactionManager	m_FactionManager
Protected Attributes inherited from SCR_WelcomeScreenBaseContent
bool	m_bIsInteractible
string	m_sContentName

Detailed Description

Class handling mission objectives that are dynamically created during the mission.

Currently not enabled for WB usage due to GM tasks not properly working in MP.

Member Function Documentation

AddTask()

void SCR_WelcomeScreenDynamicObjectivesContent.AddTask ( SCR_BaseTask  task )

protected

Calls method with delay to add a task to the array of objectives to be displayed.

Parameters

[in]

task

AddTaskCalledLater()

void SCR_WelcomeScreenDynamicObjectivesContent.AddTaskCalledLater ( SCR_BaseTask  task )

protected

Adds task to the array of objectives to be displayed.

Parameters

[in]

task

ButtonClicked()

void SCR_WelcomeScreenDynamicObjectivesContent.ButtonClicked ( )

protected

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

FillDynamicObjectivesWidget()

void SCR_WelcomeScreenDynamicObjectivesContent.FillDynamicObjectivesWidget

(

Widget

content

)

Fills content widget with dynamic mission objectives.

Parameters

[in]

content

FlipPage()

void SCR_WelcomeScreenDynamicObjectivesContent.FlipPage ( int  currentPage )

protected

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

Parameters

[in]

currentPage

GetCurrentPage()

int SCR_WelcomeScreenDynamicObjectivesContent.GetCurrentPage

(

)

Returns

current page

GetTitleText()

string SCR_WelcomeScreenDynamicObjectivesContent.GetTitleText

(

)

Returns

title

HandlePagination()

void SCR_WelcomeScreenDynamicObjectivesContent.HandlePagination ( bool  enabled = false )

protected

Handles inputs of buttons.

Parameters

[in]

enabled

InitContent()

override void SCR_WelcomeScreenDynamicObjectivesContent.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_WelcomeScreenDynamicObjectivesContent.InitPagination ( )

protected

Initialises pagination by registering button actions.

NextButtonActivated()

void SCR_WelcomeScreenDynamicObjectivesContent.NextButtonActivated ( )

protected

Flips page to the next one.

PreviousButtonActivated()

void SCR_WelcomeScreenDynamicObjectivesContent.PreviousButtonActivated ( )

protected

Flips page to the previous one.

RemoveTask()

void SCR_WelcomeScreenDynamicObjectivesContent.RemoveTask ( SCR_BaseTask  task )

protected

Removes task from the array of objectives to be displayed.

Parameters

[in]

task

SetCurrentPage()

void SCR_WelcomeScreenDynamicObjectivesContent.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_WelcomeScreenDynamicObjectivesContent.ToggleInteractions

(

bool

enabled

)

Toggles whether or not this content is interactive.

Parameters

[in]

enabled

Implements SCR_WelcomeScreenBaseContent.

Member Data Documentation

m_aDynamicObjectivesWidgets

ref array<Widget> SCR_WelcomeScreenDynamicObjectivesContent.m_aDynamicObjectivesWidgets = {}

protected

m_aFactions

ref array<ref SCR_WelcomeScreenDynamicTaskFaction> SCR_WelcomeScreenDynamicObjectivesContent.m_aFactions

protected

m_aObjectivesToDisplay

ref array<SCR_BaseTask> SCR_WelcomeScreenDynamicObjectivesContent.m_aObjectivesToDisplay = {}

protected

m_FactionManager

SCR_FactionManager SCR_WelcomeScreenDynamicObjectivesContent.m_FactionManager

protected

m_iCurrentPage

int SCR_WelcomeScreenDynamicObjectivesContent.m_iCurrentPage

protected

m_iDynamicObjectivesCount

int SCR_WelcomeScreenDynamicObjectivesContent.m_iDynamicObjectivesCount

protected

m_sFinishedObjectivesLayout

ResourceName SCR_WelcomeScreenDynamicObjectivesContent.m_sFinishedObjectivesLayout

protected

m_sFinishedObjectivesTileLayout

ResourceName SCR_WelcomeScreenDynamicObjectivesContent.m_sFinishedObjectivesTileLayout

protected

m_sTitleText

string SCR_WelcomeScreenDynamicObjectivesContent.m_sTitleText

protected

m_wColumnButton

ButtonWidget SCR_WelcomeScreenDynamicObjectivesContent.m_wColumnButton

protected

m_wFinishedObjectivesWidget

Widget SCR_WelcomeScreenDynamicObjectivesContent.m_wFinishedObjectivesWidget

protected

m_wPaginationWidget

Widget SCR_WelcomeScreenDynamicObjectivesContent.m_wPaginationWidget

protected

---

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

• Game/GameMode/Respawn/SCR_WelcomeScreenComponent.c