WelcomeDialogUI Class Reference

Inheritance diagram for WelcomeDialogUI:

Protected Member Functions
override void	OnMenuOpen ()
override void	OnMenuUpdate (float tDelta)
override void	OnConfirm ()
void	OnPrevious ()
void	OnNext ()
void	OnLinkButtonFocus (Widget linkButton)
void	ShowIndex (int index)

Protected Attributes
string	m_sHeaderName = "Title"
string	m_sTextName = "Text"
string	m_sSelectionHintName = "SelectionHint"
string	m_sPreviousName = "Previous"
string	m_sNextName = "Next"
string	m_sLinksName = "Links"
TextWidget	m_wText
Widget	m_wHeader
Widget	m_wLinks
ref array< ref Widget >	m_wLinkButtons = new array<ref Widget>
Widget	m_wLastFocusedLinkButton
SCR_SelectionHintComponent	m_SelectionHint
SCR_InputButtonComponent	m_Previous
SCR_InputButtonComponent	m_Next
int	m_iCurrentIndex
int	m_iMaxIndex
ref array< string >	m_aPageTexts
ref array< string >	m_aPageTextsPS

Detailed Description

Definition at line 2 of file WelcomeDialog.c.

Member Function Documentation

OnConfirm()

override void WelcomeDialogUI::OnConfirm ( )

inlineprotected

SCR_BrowserLinkComponent already reacts to OnClick events, meaning that the confirm button is only necessary as a visual indicator or if the player clicks it specifically

Definition at line 102 of file WelcomeDialog.c.

OnLinkButtonFocus()

void WelcomeDialogUI::OnLinkButtonFocus ( Widget linkButton )

inlineprotected

Definition at line 125 of file WelcomeDialog.c.

OnMenuOpen()

override void WelcomeDialogUI::OnMenuOpen ( )

inlineprotected

Definition at line 42 of file WelcomeDialog.c.

OnMenuUpdate()

override void WelcomeDialogUI::OnMenuUpdate ( float tDelta )

inlineprotected

Definition at line 94 of file WelcomeDialog.c.

OnNext()

void WelcomeDialogUI::OnNext ( )

inlineprotected

Definition at line 119 of file WelcomeDialog.c.

OnPrevious()

void WelcomeDialogUI::OnPrevious ( )

inlineprotected

Definition at line 113 of file WelcomeDialog.c.

ShowIndex()

void WelcomeDialogUI::ShowIndex ( int index )

inlineprotected

Focus one of the link buttons

Prevents SCR_BrowserLinkComponent from opening webpages while on another tab

Definition at line 133 of file WelcomeDialog.c.

Member Data Documentation

m_aPageTexts

ref array<string> WelcomeDialogUI::m_aPageTexts

protected

Initial value:

                             = 
{
    "#ar-welcomescreen_text_01",
    "#ar-welcomescreen_text_02",
    "#ar-welcomescreen_text_03",
    "#ar-welcomescreen_text_04",
    "#ar-welcomescreen_text_05",
    "#ar-welcomescreen_text_06",
    "#ar-welcomescreen_text_07"
}

Definition at line 22 of file WelcomeDialog.c.

m_aPageTextsPS

ref array<string> WelcomeDialogUI::m_aPageTextsPS

protected

Initial value:

                               = 
{
    "#ar-welcomescreen_text_01",
    "#ar-welcomescreen_text_02",
    "#ar-welcomescreen_text_03",
    "#ar-welcomescreen_text_06"
}

Definition at line 33 of file WelcomeDialog.c.

m_iCurrentIndex

int WelcomeDialogUI::m_iCurrentIndex

protected

Definition at line 20 of file WelcomeDialog.c.

m_iMaxIndex

int WelcomeDialogUI::m_iMaxIndex

protected

Definition at line 21 of file WelcomeDialog.c.

m_Next

SCR_InputButtonComponent WelcomeDialogUI::m_Next

protected

Definition at line 18 of file WelcomeDialog.c.

m_Previous

SCR_InputButtonComponent WelcomeDialogUI::m_Previous

protected

Definition at line 17 of file WelcomeDialog.c.

m_SelectionHint

SCR_SelectionHintComponent WelcomeDialogUI::m_SelectionHint

protected

Definition at line 16 of file WelcomeDialog.c.

m_sHeaderName

string WelcomeDialogUI::m_sHeaderName = "Title"

protected

Definition at line 4 of file WelcomeDialog.c.

m_sLinksName

string WelcomeDialogUI::m_sLinksName = "Links"

protected

Definition at line 9 of file WelcomeDialog.c.

m_sNextName

string WelcomeDialogUI::m_sNextName = "Next"

protected

Definition at line 8 of file WelcomeDialog.c.

m_sPreviousName

string WelcomeDialogUI::m_sPreviousName = "Previous"

protected

Definition at line 7 of file WelcomeDialog.c.

m_sSelectionHintName

string WelcomeDialogUI::m_sSelectionHintName = "SelectionHint"

protected

Definition at line 6 of file WelcomeDialog.c.

m_sTextName

string WelcomeDialogUI::m_sTextName = "Text"

protected

Definition at line 5 of file WelcomeDialog.c.

m_wHeader

Widget WelcomeDialogUI::m_wHeader

protected

Definition at line 12 of file WelcomeDialog.c.

m_wLastFocusedLinkButton

Widget WelcomeDialogUI::m_wLastFocusedLinkButton

protected

Definition at line 15 of file WelcomeDialog.c.

m_wLinkButtons

ref array<ref Widget> WelcomeDialogUI::m_wLinkButtons = new array<ref Widget>

protected

Definition at line 14 of file WelcomeDialog.c.

m_wLinks

Widget WelcomeDialogUI::m_wLinks

protected

Definition at line 13 of file WelcomeDialog.c.

m_wText

TextWidget WelcomeDialogUI::m_wText

protected

Definition at line 11 of file WelcomeDialog.c.

---

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

• scripts/Game/UI/Menu/Dialogs/WelcomeDialog.c