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

Inheritance diagram for SCR_GroupRequestUIComponent:

Protected Member Functions
override void	HandlerAttached (Widget w)
override void	ToggleCollapsed ()
override void	SetExpanded (bool expanded)
override bool	IsExpanded ()
override void	HandlerDeattached (Widget w)
void	SetGroupFlags ()
	Function that manages group flags, setting the correct icon to player local group.
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	SetPlayerGroup (SCR_AIGroup group)
	Update the expandable button name.
void	ShowAvailableGroups (notnull Faction faction)
	Show groups available for given faction.
void	ShowGroupSelector (bool show)
void	JoinGroupAutomatically ()
	Joins an automatically selected group.
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	OnNewGroupButtonClicked ()
void	RequestJoinGroup (notnull SCR_GroupButton groupBtn)
	Sends a request for joining a 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.
void	ClearGroupList ()
	Clear the 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 ()

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
ref SCR_GroupFlagImageComponent	m_GroupFlagImage
Widget	m_wGroupFlagButton
ScriptedWidgetEventHandler	m_GroupFlagHandler
Faction	m_PlyFaction
string	m_sFlagName
int	m_iShownGroupId = -1
ref ScriptInvoker< SCR_GroupButton >	m_OnPlayerGroupJoined
ref ScriptInvoker< int >	m_OnLocalPlayerGroupJoined
ImageWidget	m_wGroupIcon

Detailed Description

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

Definition at line 3 of file SCR_GroupRequestUIComponent.c.

Member Function Documentation

◆ AddGroup()

void SCR_GroupRequestUIComponent::AddGroup ( SCR_AIGroup group )

inlineprotected

Adds a new group button into the list.

Definition at line 383 of file SCR_GroupRequestUIComponent.c.

◆ ClearGroupList()

void SCR_GroupRequestUIComponent::ClearGroupList ( )

inlineprotected

Clear the group list.

Definition at line 532 of file SCR_GroupRequestUIComponent.c.

◆ CreateNewGroupButton()

void SCR_GroupRequestUIComponent::CreateNewGroupButton ( )

inlineprotected

Creates a button which handles creating of a new group.

Definition at line 350 of file SCR_GroupRequestUIComponent.c.

◆ GetGroupButton()

SCR_GroupButton SCR_GroupRequestUIComponent::GetGroupButton ( SCR_AIGroup group )

inlineprotected

Gets relevant group button.

Definition at line 495 of file SCR_GroupRequestUIComponent.c.

◆ GetGroupList()

Widget SCR_GroupRequestUIComponent::GetGroupList ( )

inlineprotected

Return current group list.

Definition at line 509 of file SCR_GroupRequestUIComponent.c.

◆ GetOnLocalPlayerGroupJoined()

ScriptInvoker SCR_GroupRequestUIComponent::GetOnLocalPlayerGroupJoined ( )

inlineprotected

Definition at line 569 of file SCR_GroupRequestUIComponent.c.

◆ GetOnPlayerGroupJoined()

ScriptInvoker SCR_GroupRequestUIComponent::GetOnPlayerGroupJoined ( )

inlineprotected

Definition at line 560 of file SCR_GroupRequestUIComponent.c.

◆ GetPlayerGroup()

SCR_AIGroup SCR_GroupRequestUIComponent::GetPlayerGroup ( )

inlineprotected

Return local player's group.

Definition at line 516 of file SCR_GroupRequestUIComponent.c.

◆ GetShownGroupId()

int SCR_GroupRequestUIComponent::GetShownGroupId ( )

inlineprotected

Gets id of a currently displayed group.

Definition at line 547 of file SCR_GroupRequestUIComponent.c.

◆ HandlerAttached()

override void SCR_GroupRequestUIComponent::HandlerAttached ( Widget w )

inlineprotected

Definition at line 33 of file SCR_GroupRequestUIComponent.c.

◆ HandlerDeattached()

override void SCR_GroupRequestUIComponent::HandlerDeattached ( Widget w )

inlineprotected

Definition at line 102 of file SCR_GroupRequestUIComponent.c.

◆ IsExpanded()

override bool SCR_GroupRequestUIComponent::IsExpanded ( )

inlineprotected

Definition at line 97 of file SCR_GroupRequestUIComponent.c.

◆ JoinGroupAutomatically()

void SCR_GroupRequestUIComponent::JoinGroupAutomatically ( )

inlineprotected

Joins an automatically selected group.

Definition at line 305 of file SCR_GroupRequestUIComponent.c.

◆ OnButtonFocused()

void SCR_GroupRequestUIComponent::OnButtonFocused ( Widget w )

inlineprotected

Called when the group button is focused.

Definition at line 438 of file SCR_GroupRequestUIComponent.c.

◆ OnNewGroupButtonClicked()

void SCR_GroupRequestUIComponent::OnNewGroupButtonClicked ( )

inlineprotected

Definition at line 450 of file SCR_GroupRequestUIComponent.c.

◆ RemoveGroup()

void SCR_GroupRequestUIComponent::RemoveGroup ( SCR_AIGroup group )

inlineprotected

Removes the group button from the list.

Definition at line 324 of file SCR_GroupRequestUIComponent.c.

◆ RequestJoinGroup()

void SCR_GroupRequestUIComponent::RequestJoinGroup ( notnull SCR_GroupButton groupBtn )

inlineprotected

Sends a request for joining a group.

Definition at line 469 of file SCR_GroupRequestUIComponent.c.

◆ RequestNewGroup()

void SCR_GroupRequestUIComponent::RequestNewGroup ( )

inlineprotected

Requests creation of a new group.

Definition at line 374 of file SCR_GroupRequestUIComponent.c.

◆ SetExpanded()

override void SCR_GroupRequestUIComponent::SetExpanded ( bool expanded )

inlineprotected

Definition at line 91 of file SCR_GroupRequestUIComponent.c.

◆ SetGroupFlags()

void SCR_GroupRequestUIComponent::SetGroupFlags ( )

inlineprotected

Function that manages group flags, setting the correct icon to player local group.

Definition at line 123 of file SCR_GroupRequestUIComponent.c.

◆ SetListWidget()

override void SCR_GroupRequestUIComponent::SetListWidget ( Widget list )

inlineprotected

Set current group list.

Definition at line 523 of file SCR_GroupRequestUIComponent.c.

◆ SetPlayerGroup()

void SCR_GroupRequestUIComponent::SetPlayerGroup ( SCR_AIGroup group )

inlineprotected

Update the expandable button name.

Definition at line 262 of file SCR_GroupRequestUIComponent.c.

◆ SetShownGroupId()

void SCR_GroupRequestUIComponent::SetShownGroupId ( int groupId )

inlineprotected

Set id of a currently displayed group.

Definition at line 554 of file SCR_GroupRequestUIComponent.c.

◆ ShowAvailableGroups()

void SCR_GroupRequestUIComponent::ShowAvailableGroups ( notnull Faction faction )

inlineprotected

Show groups available for given faction.

Definition at line 270 of file SCR_GroupRequestUIComponent.c.

◆ ShowGroupSelector()

void SCR_GroupRequestUIComponent::ShowGroupSelector ( bool show )

inlineprotected

Definition at line 298 of file SCR_GroupRequestUIComponent.c.

◆ ToggleCollapsed()

override void SCR_GroupRequestUIComponent::ToggleCollapsed ( )

inlineprotected

Definition at line 80 of file SCR_GroupRequestUIComponent.c.

◆ UpdateGroupFlag()

void SCR_GroupRequestUIComponent::UpdateGroupFlag ( )

inlineprotected

Set group flag.

Definition at line 250 of file SCR_GroupRequestUIComponent.c.

◆ UpdateGroupFrequency()

void SCR_GroupRequestUIComponent::UpdateGroupFrequency ( )

inlineprotected

Set group frequency.

Definition at line 238 of file SCR_GroupRequestUIComponent.c.

◆ UpdateGroupNames()

void SCR_GroupRequestUIComponent::UpdateGroupNames ( )

inlineprotected

Set group name.

Definition at line 222 of file SCR_GroupRequestUIComponent.c.

◆ UpdateGroupPlayers()

void SCR_GroupRequestUIComponent::UpdateGroupPlayers	(	SCR_AIGroup	group,
		int	pid )

inlineprotected

Update the group widget when player joins/leaves group.

Definition at line 145 of file SCR_GroupRequestUIComponent.c.

◆ UpdateGroupPrivacy()

void SCR_GroupRequestUIComponent::UpdateGroupPrivacy	(	int	groupId,
		bool	isPrivate )

inlineprotected

Set group private.

Definition at line 204 of file SCR_GroupRequestUIComponent.c.

◆ UpdateLocalPlayerGroup()

void SCR_GroupRequestUIComponent::UpdateLocalPlayerGroup ( int groupId )

inlineprotected

Update the group widget relevant to local player.

Definition at line 170 of file SCR_GroupRequestUIComponent.c.

◆ UpdateNewGroupButton()

void SCR_GroupRequestUIComponent::UpdateNewGroupButton ( )

inlineprotected

Updates visibility of the button for creating a new group.

Definition at line 366 of file SCR_GroupRequestUIComponent.c.

Member Data Documentation

◆ m_bCreateNewGroupButton

bool SCR_GroupRequestUIComponent::m_bCreateNewGroupButton

protected

Definition at line 17 of file SCR_GroupRequestUIComponent.c.

◆ m_GroupFlagHandler

ScriptedWidgetEventHandler SCR_GroupRequestUIComponent::m_GroupFlagHandler

protected

Definition at line 23 of file SCR_GroupRequestUIComponent.c.

◆ m_GroupFlagImage

ref SCR_GroupFlagImageComponent SCR_GroupRequestUIComponent::m_GroupFlagImage

protected

Definition at line 21 of file SCR_GroupRequestUIComponent.c.

◆ m_GroupManager

SCR_GroupsManagerComponent SCR_GroupRequestUIComponent::m_GroupManager

protected

Definition at line 19 of file SCR_GroupRequestUIComponent.c.

◆ m_iShownGroupId

int SCR_GroupRequestUIComponent::m_iShownGroupId = -1

protected

Definition at line 26 of file SCR_GroupRequestUIComponent.c.

◆ m_OnLocalPlayerGroupJoined

ref ScriptInvoker<int> SCR_GroupRequestUIComponent::m_OnLocalPlayerGroupJoined

protected

Definition at line 29 of file SCR_GroupRequestUIComponent.c.

◆ m_OnPlayerGroupJoined

ref ScriptInvoker<SCR_GroupButton> SCR_GroupRequestUIComponent::m_OnPlayerGroupJoined

protected

Definition at line 28 of file SCR_GroupRequestUIComponent.c.

◆ m_PlyFaction

Faction SCR_GroupRequestUIComponent::m_PlyFaction

protected

Definition at line 24 of file SCR_GroupRequestUIComponent.c.

◆ m_PlyGroupComp

SCR_PlayerControllerGroupComponent SCR_GroupRequestUIComponent::m_PlyGroupComp

protected

Definition at line 20 of file SCR_GroupRequestUIComponent.c.

◆ m_sFlagName

string SCR_GroupRequestUIComponent::m_sFlagName

protected

Definition at line 25 of file SCR_GroupRequestUIComponent.c.

◆ m_sGroupButton

ResourceName SCR_GroupRequestUIComponent::m_sGroupButton

protected

Definition at line 10 of file SCR_GroupRequestUIComponent.c.

◆ m_sGroupList

string SCR_GroupRequestUIComponent::m_sGroupList

protected

Definition at line 6 of file SCR_GroupRequestUIComponent.c.

◆ m_sNewGroupButton

ResourceName SCR_GroupRequestUIComponent::m_sNewGroupButton

protected

Definition at line 13 of file SCR_GroupRequestUIComponent.c.

◆ m_wGroupFlagButton

Widget SCR_GroupRequestUIComponent::m_wGroupFlagButton

protected

Definition at line 22 of file SCR_GroupRequestUIComponent.c.

◆ m_wGroupIcon

ImageWidget SCR_GroupRequestUIComponent::m_wGroupIcon

protected

Definition at line 30 of file SCR_GroupRequestUIComponent.c.

◆ m_wGroupList

Widget SCR_GroupRequestUIComponent::m_wGroupList

protected

Definition at line 7 of file SCR_GroupRequestUIComponent.c.

◆ m_wNewGroupButton

Widget SCR_GroupRequestUIComponent::m_wNewGroupButton

protected

Definition at line 14 of file SCR_GroupRequestUIComponent.c.

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

scripts/Game/UI/Menu/DeployMenu/SCR_GroupRequestUIComponent.c

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ AddGroup()

◆ ClearGroupList()

◆ CreateNewGroupButton()

◆ GetGroupButton()

◆ GetGroupList()

◆ GetOnLocalPlayerGroupJoined()

◆ GetOnPlayerGroupJoined()

◆ GetPlayerGroup()

◆ GetShownGroupId()

◆ HandlerAttached()

◆ HandlerDeattached()

◆ IsExpanded()

◆ JoinGroupAutomatically()

◆ OnButtonFocused()

◆ OnNewGroupButtonClicked()

◆ RemoveGroup()

◆ RequestJoinGroup()

◆ RequestNewGroup()

◆ SetExpanded()

◆ SetGroupFlags()

◆ SetListWidget()

◆ SetPlayerGroup()

◆ SetShownGroupId()

◆ ShowAvailableGroups()

◆ ShowGroupSelector()

◆ ToggleCollapsed()

◆ UpdateGroupFlag()

◆ UpdateGroupFrequency()

◆ UpdateGroupNames()

◆ UpdateGroupPlayers()

◆ UpdateGroupPrivacy()

◆ UpdateLocalPlayerGroup()

◆ UpdateNewGroupButton()

Member Data Documentation

◆ m_bCreateNewGroupButton

◆ m_GroupFlagHandler

◆ m_GroupFlagImage

◆ m_GroupManager

◆ m_iShownGroupId

◆ m_OnLocalPlayerGroupJoined

◆ m_OnPlayerGroupJoined

◆ m_PlyFaction

◆ m_PlyGroupComp

◆ m_sFlagName

◆ m_sGroupButton

◆ m_sGroupList

◆ m_sNewGroupButton

◆ m_wGroupFlagButton

◆ m_wGroupIcon

◆ m_wGroupList

◆ m_wNewGroupButton