DialogUI Interface Reference

Inheritance diagram for DialogUI:

Public Member Functions
override void	OnMenuOpen ()
override void	OnMenuInit ()
override void	OnMenuClose ()
override void	OnMenuUpdate (float tDelta)
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 ()

Public Attributes
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

Protected Member Functions
void	OnConfirm ()
void	OnCancel ()
void	SetDialogType (EDialogType type)
	Set color based on dialog type.

Protected Attributes
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.
Static Protected Attributes inherited from ChimeraMenuBase
const string	INPUT_CONTEXT_EDIT = "MenuTextEditContext"
static ChimeraMenuBase	m_ThisMenu

Member Function Documentation

CloseAnimated()

void DialogUI.CloseAnimated

(

)

animates dialog closure

GetFooterComponent()

SCR_DynamicFooterComponent DialogUI.GetFooterComponent

(

)

GetMessage()

string DialogUI.GetMessage

(

)

GetTitle()

string DialogUI.GetTitle

(

)

OnCancel()

void DialogUI.OnCancel ( )

protected

OnConfirm()

void DialogUI.OnConfirm ( )

protected

Implemented in CreateGroupSettingsDialogUI, GroupSettingsDialogUI, ReportDialogUI, SCR_GroupFlagSelectionMenu, SCR_GroupLeaderVolunteerDialogUI, and WelcomeDialogUI.

OnMenuClose()

override void DialogUI.OnMenuClose

(

)

Implements ChimeraMenuBase.

Implemented in GroupSettingsDialogUI, SCR_ConfigurableDialogUiProxy, and SCR_GamepadRemovalUI.

OnMenuInit()

override void DialogUI.OnMenuInit

(

)

Implements ChimeraMenuBase.

OnMenuOpen()

override void DialogUI.OnMenuOpen

(

)

Implements ChimeraMenuBase.

Implemented in CreateGroupSettingsDialogUI, ErrorDialogUI, GroupSettingsDialogUI, ReportDialogUI, SCR_AddonExportDialog, SCR_GamepadRemovalUI, SCR_GroupFlagSelectionMenu, and WelcomeDialogUI.

OnMenuUpdate()

override void DialogUI.OnMenuUpdate

(

float

tDelta

)

Implements ChimeraMenuBase.

Implemented in CreateGroupSettingsDialogUI, GroupSettingsDialogUI, ReportDialogUI, SCR_ConfigurableDialogUiProxy, SCR_GroupFlagSelectionMenu, and WelcomeDialogUI.

SetCancelText()

void DialogUI.SetCancelText

(

string

text

)

SetConfirmText()

void DialogUI.SetConfirmText

(

string

text

)

SetDialogType()

void DialogUI.SetDialogType ( EDialogType type )

protected

Set color based on dialog type.

SetMessage()

void DialogUI.SetMessage

(

string

text

)

SetTitle()

void DialogUI.SetTitle

(

string

text

)

SetTitleIcon() [1/2]

void DialogUI.SetTitleIcon	(	ResourceName	image,
		string	imageName )

Set title icons with custom image.

SetTitleIcon() [2/2]

void DialogUI.SetTitleIcon

(

string

imageName

)

Set title icon by image name from image set in dialog data.

SetType()

void DialogUI.SetType

(

EDialogType

type

)

Member Data Documentation

m_Cancel

SCR_InputButtonComponent DialogUI.m_Cancel

protected

m_Confirm

SCR_InputButtonComponent DialogUI.m_Confirm

protected

m_DialogData

SCR_DialogDataComponent DialogUI.m_DialogData

protected

m_DynamicFooter

SCR_DynamicFooterComponent DialogUI.m_DynamicFooter

protected

m_fAnimationRate

float DialogUI.m_fAnimationRate = UIConstants.FADE_RATE_FAST

protected

m_iDialogType

EDialogType DialogUI.m_iDialogType

protected

m_OnCancel

ref ScriptInvoker DialogUI.m_OnCancel = new ScriptInvoker()

m_OnConfirm

ref ScriptInvoker DialogUI.m_OnConfirm = new ScriptInvoker()

m_wCancelButton

Widget DialogUI.m_wCancelButton

protected

m_wConfirmButton

Widget DialogUI.m_wConfirmButton

protected

m_wContent

TextWidget DialogUI.m_wContent

protected

m_wImgTitleIcon

ImageWidget DialogUI.m_wImgTitleIcon

protected

m_wImgTopLine

ImageWidget DialogUI.m_wImgTopLine

protected

m_wTitle

TextWidget DialogUI.m_wTitle

protected

---

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

• Game/UI/Menu/DialogUI.c