Component responsible for handling group requests and visualization in deploy menu. More...

Inheritance diagram for SCR_GroupRequestUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)

override void	SetExpanded (bool expanded)

override void	HandlerDeattached (Widget w)

void	SetPlayerGroup (SCR_AIGroup group)
	Update the expandable button name.

void	ShowAvailableGroups (notnull Faction faction)
	Show groups available for given faction.

void	JoinGroupAutomatically ()
	Joins an automatically selected group.

SCR_GroupButton	GetGroupButton (SCR_AIGroup group)
	Gets relevant group button.

Widget	GetGroupList ()
	Return current group list.

SCR_AIGroup	GetPlayerGroup ()
	Return local player's group.

override void	SetListWidget (Widget list)
	Set current group list.

int	GetShownGroupId ()
	Gets id of a currently displayed group.

void	SetShownGroupId (int groupId)
	Set id of a currently displayed group.

ScriptInvoker	GetOnPlayerGroupJoined ()

ScriptInvoker	GetOnLocalPlayerGroupJoined ()

Public Member Functions inherited from SCR_DeployRequestUIBaseComponent
override void	HandlerAttached (Widget w)

void	Update (float dt)

void	Unlock ()
	Unlock this component's buttons.

bool	IsEnabled ()

SCR_DeployButtonBase	GetFirstValidButton ()
	Gets first available button from the m_aButtons list.

void	SetExpanded (bool expanded)

bool	IsExpanded ()

void	SetListWidget (Widget list)
	Marks which widget should be used as a root for creating buttons.

Widget	GetListWidget ()
	Gets current list widget.

ScriptInvoker	GetOnButtonFocused ()

ScriptInvoker	GetOnMouseLeft ()

Protected Member Functions
override void	ToggleCollapsed ()

override bool	IsExpanded ()

void	UpdateGroupPlayers (SCR_AIGroup group, int pid)
	Update the group widget when player joins/leaves group.

void	UpdateLocalPlayerGroup (int groupId)
	Update the group widget relevant to local player.

void	UpdateGroupPrivacy (int groupId, bool isPrivate)
	Set group private.

void	UpdateGroupNames ()
	Set group name.

void	UpdateGroupFrequency ()
	Set group frequency.

void	UpdateGroupFlag ()
	Set group flag.

void	RemoveGroup (SCR_AIGroup group)
	Removes the group button from the list.

void	CreateNewGroupButton ()
	Creates a button which handles creating of a new group.

void	UpdateNewGroupButton ()
	Updates visibility of the button for creating a new group.

void	RequestNewGroup ()
	Requests creation of a new group.

void	AddGroup (SCR_AIGroup group)
	Adds a new group button into the list.

void	OnButtonFocused (Widget w)
	Called when the group button is focused.

void	RequestJoinGroup (notnull SCR_GroupButton groupBtn)
	Sends a request for joining a group.

void	ClearGroupList ()
	Clear the group list.

Protected Member Functions inherited from SCR_DeployRequestUIBaseComponent
void	Lock (SCR_DeployButtonBase btn)
	Lock this component's buttons from processing any further requests. Unlock() should be called once you receive a response.

void	ToggleCollapsed ()

void	OnListExpand (SCR_DeployRequestUIBaseComponent component, bool expanded)

void	OnMouseLeft ()

Protected Attributes
string	m_sGroupList

Widget	m_wGroupList

ResourceName	m_sGroupButton

ResourceName	m_sNewGroupButton

Widget	m_wNewGroupButton

bool	m_bCreateNewGroupButton

SCR_GroupsManagerComponent	m_GroupManager

SCR_PlayerControllerGroupComponent	m_PlyGroupComp

Faction	m_PlyFaction

int	m_iShownGroupId = -1

ref ScriptInvoker< SCR_GroupButton >	m_OnPlayerGroupJoined

ref ScriptInvoker< int >	m_OnLocalPlayerGroupJoined

Protected Attributes inherited from SCR_DeployRequestUIBaseComponent
string	m_sExpandButton

Widget	m_wExpandButton

string	m_sExpandButtonName

TextWidget	m_wExpandButtonName

string	m_sExpandButtonIcon

ImageWidget	m_wExpandButtonIcon

bool	m_bUseListFromButton

bool	m_bEnabled = true

bool	m_bLocked = false

ref array< SCR_DeployButtonBase >	m_aButtons = {}

Widget	m_wRoot

ref ScriptInvoker	m_OnButtonFocused = new ScriptInvoker()

ref ScriptInvoker	m_OnMouseLeft = new ScriptInvoker()

Additional Inherited Members
Static Public Member Functions inherited from SCR_DeployRequestUIBaseComponent
static ScriptInvoker	GetOnListCollapse ()

Static Protected Attributes inherited from SCR_DeployRequestUIBaseComponent
static ref ScriptInvoker< SCR_DeployRequestUIBaseComponent, bool >	s_OnListExpand

Detailed Description

Component responsible for handling group requests and visualization in deploy menu.

Member Function Documentation

◆ AddGroup()

void SCR_GroupRequestUIComponent.AddGroup ( SCR_AIGroup group )

protected

Adds a new group button into the list.

◆ ClearGroupList()

void SCR_GroupRequestUIComponent.ClearGroupList ( )

protected

Clear the group list.

◆ CreateNewGroupButton()

void SCR_GroupRequestUIComponent.CreateNewGroupButton ( )

protected

Creates a button which handles creating of a new group.

◆ GetGroupButton()

SCR_GroupButton SCR_GroupRequestUIComponent.GetGroupButton ( SCR_AIGroup group )

Gets relevant group button.

◆ GetGroupList()

Widget SCR_GroupRequestUIComponent.GetGroupList ( )

Return current group list.

◆ GetOnLocalPlayerGroupJoined()

ScriptInvoker SCR_GroupRequestUIComponent.GetOnLocalPlayerGroupJoined ( )

◆ GetOnPlayerGroupJoined()

ScriptInvoker SCR_GroupRequestUIComponent.GetOnPlayerGroupJoined ( )

◆ GetPlayerGroup()

SCR_AIGroup SCR_GroupRequestUIComponent.GetPlayerGroup ( )

Return local player's group.

◆ GetShownGroupId()

int SCR_GroupRequestUIComponent.GetShownGroupId ( )

Gets id of a currently displayed group.

◆ HandlerAttached()

override void SCR_GroupRequestUIComponent.HandlerAttached ( Widget w )

Implements SCR_DeployRequestUIBaseComponent.

◆ HandlerDeattached()

override void SCR_GroupRequestUIComponent.HandlerDeattached ( Widget w )

◆ IsExpanded()

override bool SCR_GroupRequestUIComponent.IsExpanded ( )

protected

Implements SCR_DeployRequestUIBaseComponent.

◆ JoinGroupAutomatically()

void SCR_GroupRequestUIComponent.JoinGroupAutomatically ( )

Joins an automatically selected group.

◆ OnButtonFocused()

void SCR_GroupRequestUIComponent.OnButtonFocused ( Widget w )

protected

Called when the group button is focused.

◆ RemoveGroup()

void SCR_GroupRequestUIComponent.RemoveGroup ( SCR_AIGroup group )

protected

Removes the group button from the list.

◆ RequestJoinGroup()

void SCR_GroupRequestUIComponent.RequestJoinGroup ( notnull SCR_GroupButton groupBtn )

protected

Sends a request for joining a group.

◆ RequestNewGroup()

void SCR_GroupRequestUIComponent.RequestNewGroup ( )

protected

Requests creation of a new group.

◆ SetExpanded()

override void SCR_GroupRequestUIComponent.SetExpanded ( bool expanded )

Implements SCR_DeployRequestUIBaseComponent.

◆ SetListWidget()

override void SCR_GroupRequestUIComponent.SetListWidget ( Widget list )

Set current group list.

Implements SCR_DeployRequestUIBaseComponent.

◆ SetPlayerGroup()

void SCR_GroupRequestUIComponent.SetPlayerGroup ( SCR_AIGroup group )

Update the expandable button name.

◆ SetShownGroupId()

void SCR_GroupRequestUIComponent.SetShownGroupId ( int groupId )

Set id of a currently displayed group.

◆ ShowAvailableGroups()

void SCR_GroupRequestUIComponent.ShowAvailableGroups ( notnull Faction faction )

Show groups available for given faction.

◆ ToggleCollapsed()

override void SCR_GroupRequestUIComponent.ToggleCollapsed ( )

protected

Implements SCR_DeployRequestUIBaseComponent.

◆ UpdateGroupFlag()

void SCR_GroupRequestUIComponent.UpdateGroupFlag ( )

protected

Set group flag.

◆ UpdateGroupFrequency()

void SCR_GroupRequestUIComponent.UpdateGroupFrequency ( )

protected

Set group frequency.

◆ UpdateGroupNames()

void SCR_GroupRequestUIComponent.UpdateGroupNames ( )

protected

Set group name.

◆ UpdateGroupPlayers()

void SCR_GroupRequestUIComponent.UpdateGroupPlayers	(	SCR_AIGroup	group,
		int	pid
	)

protected

Update the group widget when player joins/leaves group.

◆ UpdateGroupPrivacy()

void SCR_GroupRequestUIComponent.UpdateGroupPrivacy	(	int	groupId,
		bool	isPrivate
	)

protected

Set group private.

◆ UpdateLocalPlayerGroup()

void SCR_GroupRequestUIComponent.UpdateLocalPlayerGroup ( int groupId )

protected

Update the group widget relevant to local player.

◆ UpdateNewGroupButton()

void SCR_GroupRequestUIComponent.UpdateNewGroupButton ( )

protected

Updates visibility of the button for creating a new group.

Member Data Documentation

◆ m_bCreateNewGroupButton

bool SCR_GroupRequestUIComponent.m_bCreateNewGroupButton

protected

◆ m_GroupManager

SCR_GroupsManagerComponent SCR_GroupRequestUIComponent.m_GroupManager

protected

◆ m_iShownGroupId

int SCR_GroupRequestUIComponent.m_iShownGroupId = -1

protected

◆ m_OnLocalPlayerGroupJoined

ref ScriptInvoker<int> SCR_GroupRequestUIComponent.m_OnLocalPlayerGroupJoined

protected

◆ m_OnPlayerGroupJoined

ref ScriptInvoker<SCR_GroupButton> SCR_GroupRequestUIComponent.m_OnPlayerGroupJoined

protected

◆ m_PlyFaction

Faction SCR_GroupRequestUIComponent.m_PlyFaction

protected

◆ m_PlyGroupComp

SCR_PlayerControllerGroupComponent SCR_GroupRequestUIComponent.m_PlyGroupComp

protected

◆ m_sGroupButton

ResourceName SCR_GroupRequestUIComponent.m_sGroupButton

protected

◆ m_sGroupList

string SCR_GroupRequestUIComponent.m_sGroupList

protected

◆ m_sNewGroupButton

ResourceName SCR_GroupRequestUIComponent.m_sNewGroupButton

protected

◆ m_wGroupList

Widget SCR_GroupRequestUIComponent.m_wGroupList

protected

◆ m_wNewGroupButton

Widget SCR_GroupRequestUIComponent.m_wNewGroupButton

protected

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

Game/UI/Menu/DeployMenu/SCR_GroupRequestUIComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddGroup()

◆ ClearGroupList()

◆ CreateNewGroupButton()

◆ GetGroupButton()

◆ GetGroupList()

◆ GetOnLocalPlayerGroupJoined()

◆ GetOnPlayerGroupJoined()

◆ GetPlayerGroup()

◆ GetShownGroupId()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ IsExpanded()

◆ JoinGroupAutomatically()

◆ OnButtonFocused()

◆ RemoveGroup()

◆ RequestJoinGroup()

◆ RequestNewGroup()

◆ SetExpanded()

◆ SetListWidget()

◆ SetPlayerGroup()

◆ SetShownGroupId()

◆ ShowAvailableGroups()

◆ ToggleCollapsed()

◆ UpdateGroupFlag()

◆ UpdateGroupFrequency()

◆ UpdateGroupNames()

◆ UpdateGroupPlayers()

◆ UpdateGroupPrivacy()

◆ UpdateLocalPlayerGroup()

◆ UpdateNewGroupButton()

Member Data Documentation

◆ m_bCreateNewGroupButton

◆ m_GroupManager

◆ m_iShownGroupId

◆ m_OnLocalPlayerGroupJoined

◆ m_OnPlayerGroupJoined

◆ m_PlyFaction

◆ m_PlyGroupComp

◆ m_sGroupButton

◆ m_sGroupList

◆ m_sNewGroupButton

◆ m_wGroupList

◆ m_wNewGroupButton