SCR_WelcomeScreenFactionContent Interface Reference

Class handling Factions that are present in the game. More...

Inheritance diagram for SCR_WelcomeScreenFactionContent:

Public Member Functions
override void	InitContent (SCR_WelcomeScreenMenu menu, string column, string columnButton)
	Initialises content for given column.
string	GetTitleText ()
string	GetBottomTitleText ()
Public Member Functions inherited from SCR_WelcomeScreenBaseContent
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	AddFactionWidget ()
	Adds new faction widget to the content.
void	FillFactionWidget (notnull SCR_Faction faction, notnull Widget content, Color color)
	Fills content widget with factions.
void	UpdateFactionPlayerCount (Faction faction, int playerCountParam)
	Updates faction player count when player count of said faction changes.
void	UpdateFactionPlayability (Faction faction, bool playable)
	Updates faction playability when playability of said faction changes.

Protected Attributes
string	m_sTitleText
string	m_sBottomTitleText
ResourceName	m_sFactionColumnLayout
ResourceName	m_sFactionLayout
Widget	m_wFactionContentWidget
ref array< Widget >	m_aFactionWidgets = {}
ref SCR_SortedArray< SCR_Faction >	m_SortedFactions = new SCR_SortedArray<SCR_Faction>()
Protected Attributes inherited from SCR_WelcomeScreenBaseContent
bool	m_bIsInteractible
string	m_sContentName

Detailed Description

Class handling Factions that are present in the game.

Member Function Documentation

AddFactionWidget()

void SCR_WelcomeScreenFactionContent.AddFactionWidget ( )

protected

Adds new faction widget to the content.

FillFactionWidget()

void SCR_WelcomeScreenFactionContent.FillFactionWidget ( notnull SCR_Faction faction, notnull Widget content, Color color )

protected

Fills content widget with factions.

Parameters

[in]	faction
[in]	content
[in]	color

GetBottomTitleText()

string SCR_WelcomeScreenFactionContent.GetBottomTitleText

(

)

Returns

bottom title

GetTitleText()

string SCR_WelcomeScreenFactionContent.GetTitleText

(

)

Returns

title

InitContent()

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

Initialises content for given column.

Parameters

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

Implements SCR_WelcomeScreenBaseContent.

UpdateFactionPlayability()

void SCR_WelcomeScreenFactionContent.UpdateFactionPlayability ( Faction faction, bool playable )

protected

Updates faction playability when playability of said faction changes.

Parameters

[in]	faction
[in]	playable

UpdateFactionPlayerCount()

void SCR_WelcomeScreenFactionContent.UpdateFactionPlayerCount ( Faction faction, int playerCountParam )

protected

Updates faction player count when player count of said faction changes.

Parameters

[in]	faction
[in]	playerCountParam

Member Data Documentation

m_aFactionWidgets

ref array<Widget> SCR_WelcomeScreenFactionContent.m_aFactionWidgets = {}

protected

m_sBottomTitleText

string SCR_WelcomeScreenFactionContent.m_sBottomTitleText

protected

m_sFactionColumnLayout

ResourceName SCR_WelcomeScreenFactionContent.m_sFactionColumnLayout

protected

m_sFactionLayout

ResourceName SCR_WelcomeScreenFactionContent.m_sFactionLayout

protected

m_SortedFactions

ref SCR_SortedArray<SCR_Faction> SCR_WelcomeScreenFactionContent.m_SortedFactions = new SCR_SortedArray<SCR_Faction>()

protected

m_sTitleText

string SCR_WelcomeScreenFactionContent.m_sTitleText

protected

m_wFactionContentWidget

Widget SCR_WelcomeScreenFactionContent.m_wFactionContentWidget

protected

---

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

• Game/GameMode/Respawn/SCR_WelcomeScreenComponent.c