GroupSettingsDialogUI Interface Reference

Inheritance diagram for GroupSettingsDialogUI:

Public Member Functions
override void	OnMenuOpen ()
override void	OnMenuClose ()
void	OnPrivilegeCallback (UserPrivilege privilege, UserPrivilegeResult result)
override void	OnMenuUpdate (float tDelta)
void	OnStatusChanged (SCR_ComboBoxComponent combo, int index)
Public Member Functions inherited from DialogUI
override void	OnMenuInit ()
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
override void	OnConfirm ()
void	SetupGroupStatusCombo ()
void	SetupGroupLeaderCombo ()
void	OnGroupLeaderChanged (int groupId, int playerId)
	Group leader changed, if local player is not group leader anymore, the group settings dialog should close.
int	GetPlayerIdFromName (string name)
	Finds a player id from the player's name.
Protected Member Functions inherited from DialogUI
void	OnCancel ()
void	SetDialogType (EDialogType type)
	Set color based on dialog type.

Protected Attributes
SCR_ComboBoxComponent	m_GroupLeader
SCR_EditBoxComponent	m_Description
SCR_ComboBoxComponent	m_GroupStatus
SCR_EditBoxComponent	m_GroupName
SCR_EditBoxComponent	m_GroupDescription
SCR_PlayerControllerGroupComponent	m_PlayerComponent
SCR_GroupsManagerComponent	m_GroupsManager
SCR_AIGroup	m_PlayerGroup
bool	m_bHasPrivilege
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

Static Protected Attributes
static ref SCR_ScriptPlatformRequestCallback	m_CallbackGetPrivilege
Static Protected Attributes inherited from ChimeraMenuBase
const string	INPUT_CONTEXT_EDIT = "MenuTextEditContext"
static ChimeraMenuBase	m_ThisMenu

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

Member Function Documentation

GetPlayerIdFromName()

int GroupSettingsDialogUI.GetPlayerIdFromName ( string name )

protected

Finds a player id from the player's name.

Parameters

[in]

name

Returns

playerId

OnConfirm()

override void GroupSettingsDialogUI.OnConfirm ( )

protected

Implements DialogUI.

OnGroupLeaderChanged()

void GroupSettingsDialogUI.OnGroupLeaderChanged ( int groupId, int playerId )

protected

Group leader changed, if local player is not group leader anymore, the group settings dialog should close.

Parameters

[in]	groupId
[in]	playerId

OnMenuClose()

override void GroupSettingsDialogUI.OnMenuClose

(

)

Implements DialogUI.

OnMenuOpen()

override void GroupSettingsDialogUI.OnMenuOpen

(

)

Implements DialogUI.

OnMenuUpdate()

override void GroupSettingsDialogUI.OnMenuUpdate

(

float

tDelta

)

Implements DialogUI.

OnPrivilegeCallback()

void GroupSettingsDialogUI.OnPrivilegeCallback	(	UserPrivilege	privilege,
		UserPrivilegeResult	result )

OnStatusChanged()

void GroupSettingsDialogUI.OnStatusChanged	(	SCR_ComboBoxComponent	combo,
		int	index )

SetupGroupLeaderCombo()

void GroupSettingsDialogUI.SetupGroupLeaderCombo ( )

protected

SetupGroupStatusCombo()

void GroupSettingsDialogUI.SetupGroupStatusCombo ( )

protected

Member Data Documentation

m_bHasPrivilege

bool GroupSettingsDialogUI.m_bHasPrivilege

protected

m_CallbackGetPrivilege

ref SCR_ScriptPlatformRequestCallback GroupSettingsDialogUI.m_CallbackGetPrivilege

staticprotected

m_Description

SCR_EditBoxComponent GroupSettingsDialogUI.m_Description

protected

m_GroupDescription

SCR_EditBoxComponent GroupSettingsDialogUI.m_GroupDescription

protected

m_GroupLeader

SCR_ComboBoxComponent GroupSettingsDialogUI.m_GroupLeader

protected

m_GroupName

SCR_EditBoxComponent GroupSettingsDialogUI.m_GroupName

protected

m_GroupsManager

SCR_GroupsManagerComponent GroupSettingsDialogUI.m_GroupsManager

protected

m_GroupStatus

SCR_ComboBoxComponent GroupSettingsDialogUI.m_GroupStatus

protected

m_PlayerComponent

SCR_PlayerControllerGroupComponent GroupSettingsDialogUI.m_PlayerComponent

protected

m_PlayerGroup

SCR_AIGroup GroupSettingsDialogUI.m_PlayerGroup

protected

---

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

• Game/UI/Menu/GroupSettingsDialogUI.c