WelcomeDialogUI Interface Reference

Inheritance diagram for WelcomeDialogUI:

Public Member Functions
override void	OnMenuOpen ()
override void	OnMenuUpdate (float tDelta)
override void	OnConfirm ()
Public Member Functions inherited from DialogUI
override void	OnMenuInit ()
override void	OnMenuClose ()
void	SetTitle (string text)
string	GetTitle ()
void	SetMessage (string text)
string	GetMessage ()
void	SetConfirmText (string text)
void	SetCancelText (string text)
void	SetType (EDialogType type)
void	SetTitleIcon (ResourceName image, string imageName)
	Set title icons with custom image.
void	SetTitleIcon (string imageName)
	Set title icon by image name from image set in dialog data.
void	CloseAnimated ()
	animates dialog closure
SCR_DynamicFooterComponent	GetFooterComponent ()
Public Member Functions inherited from ChimeraMenuBase
override void	OnMenuOpened ()
override void	OnMenuFocusGained ()
override void	OnMenuFocusLost ()
override void	OnMenuShow ()
override void	OnMenuHide ()

Protected Member Functions
void	OnPrevious ()
void	OnNext ()
void	OnLinkButtonFocus (Widget linkButton)
void	ShowIndex (int index)
Protected Member Functions inherited from DialogUI
void	OnCancel ()
void	SetDialogType (EDialogType type)
	Set color based on dialog type.

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
Protected Attributes inherited from DialogUI
SCR_DialogDataComponent	m_DialogData
Widget	m_wCancelButton
Widget	m_wConfirmButton
SCR_InputButtonComponent	m_Cancel
SCR_InputButtonComponent	m_Confirm
ImageWidget	m_wImgTopLine
ImageWidget	m_wImgTitleIcon
TextWidget	m_wTitle
TextWidget	m_wContent
float	m_fAnimationRate = UIConstants.FADE_RATE_FAST
EDialogType	m_iDialogType
SCR_DynamicFooterComponent	m_DynamicFooter
Protected Attributes inherited from ChimeraMenuBase
bool	m_bTextEditActive = false

Additional Inherited Members
Static Public Member Functions inherited from ChimeraMenuBase
static ChimeraMenuBase	CurrentChimeraMenu ()
static ChimeraMenuBase	GetOwnerMenu (Widget w)
	Returns parent menu of a widget.
Public Attributes inherited from DialogUI
ref ScriptInvoker	m_OnConfirm = new ScriptInvoker()
ref ScriptInvoker	m_OnCancel = new ScriptInvoker()
Public Attributes inherited from ChimeraMenuBase
ref ScriptInvoker	m_OnTextEditContextChange = new ScriptInvoker
ref ScriptInvoker	m_OnUpdate = new ScriptInvoker
Static Protected Attributes inherited from ChimeraMenuBase
const string	INPUT_CONTEXT_EDIT = "MenuTextEditContext"
static ChimeraMenuBase	m_ThisMenu

Member Function Documentation

OnConfirm()

override void WelcomeDialogUI.OnConfirm

(

)

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

Implements DialogUI.

OnLinkButtonFocus()

void WelcomeDialogUI.OnLinkButtonFocus ( Widget linkButton )

protected

OnMenuOpen()

override void WelcomeDialogUI.OnMenuOpen

(

)

Implements DialogUI.

OnMenuUpdate()

override void WelcomeDialogUI.OnMenuUpdate

(

float

tDelta

)

Implements DialogUI.

OnNext()

void WelcomeDialogUI.OnNext ( )

protected

OnPrevious()

void WelcomeDialogUI.OnPrevious ( )

protected

ShowIndex()

void WelcomeDialogUI.ShowIndex ( int index )

protected

Focus one of the link buttons

Prevents SCR_BrowserLinkComponent from opening webpages while on another tab

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"
    }

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"
    }

m_iCurrentIndex

int WelcomeDialogUI.m_iCurrentIndex

protected

m_iMaxIndex

int WelcomeDialogUI.m_iMaxIndex

protected

m_Next

SCR_InputButtonComponent WelcomeDialogUI.m_Next

protected

m_Previous

SCR_InputButtonComponent WelcomeDialogUI.m_Previous

protected

m_SelectionHint

SCR_SelectionHintComponent WelcomeDialogUI.m_SelectionHint

protected

m_sHeaderName

string WelcomeDialogUI.m_sHeaderName = "Title"

protected

m_sLinksName

string WelcomeDialogUI.m_sLinksName = "Links"

protected

m_sNextName

string WelcomeDialogUI.m_sNextName = "Next"

protected

m_sPreviousName

string WelcomeDialogUI.m_sPreviousName = "Previous"

protected

m_sSelectionHintName

string WelcomeDialogUI.m_sSelectionHintName = "SelectionHint"

protected

m_sTextName

string WelcomeDialogUI.m_sTextName = "Text"

protected

m_wHeader

Widget WelcomeDialogUI.m_wHeader

protected

m_wLastFocusedLinkButton

Widget WelcomeDialogUI.m_wLastFocusedLinkButton

protected

m_wLinkButtons

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

protected

m_wLinks

Widget WelcomeDialogUI.m_wLinks

protected

m_wText

TextWidget WelcomeDialogUI.m_wText

protected

---

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

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