SCR_AssignedGroupLabelUIComponent Interface Reference

Inheritance diagram for SCR_AssignedGroupLabelUIComponent:

Public Member Functions
override void	HandlerAttached (Widget w)
void	LoadGroupFlag (notnull SCR_AIGroup aiGroup)
void	LoadGroupName (notnull SCR_AIGroup aiGroup)
	Set formated group name based on group callsign data.
void	SetGroupName (string name)
void	SetGroupIcon (ResourceName imageset, string iconName)
void	SetGroupIconFromFaction (Faction faction, string iconName=string.Empty)
	Sets group icon based on its faction.
Public Member Functions inherited from SCR_ScriptedWidgetComponent
override bool	OnClick (Widget w, int x, int y, int button)
Widget	GetRootWidget ()
bool	IsVisible ()

Protected Member Functions
void	SetFlagButtonFromImageSet (string name)
	Sets flag visuals.

Protected Attributes
ResourceName	m_sGroupsBLUFOR
ResourceName	m_sGroupsOPFOR
ResourceName	m_sGroupsINDFOR
ResourceName	m_sGroupsCIVILIAN
ref SCR_AssignedGroupLabelWidgets	m_Widgets = new SCR_AssignedGroupLabelWidgets()
Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Static Protected Attributes
const string	DEFAULT_ICON_NAME = "undefined"
const string	CUSTOM_GROUP_NAME_FORMAT = "#AR-Player_Groups_CustomName_Format"

Additional Inherited Members
Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.
Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Member Function Documentation

HandlerAttached()

override void SCR_AssignedGroupLabelUIComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ScriptedWidgetComponent.

LoadGroupFlag()

void SCR_AssignedGroupLabelUIComponent.LoadGroupFlag

(

notnull SCR_AIGroup

aiGroup

)

LoadGroupName()

void SCR_AssignedGroupLabelUIComponent.LoadGroupName

(

notnull SCR_AIGroup

aiGroup

)

Set formated group name based on group callsign data.

Parameters

[in]

aiGroup

to have name loaded

SetFlagButtonFromImageSet()

void SCR_AssignedGroupLabelUIComponent.SetFlagButtonFromImageSet ( string name )

protected

Sets flag visuals.

Parameters

[in]

name

of flag in imagest

SetGroupIcon()

void SCR_AssignedGroupLabelUIComponent.SetGroupIcon	(	ResourceName	imageset,
		string	iconName )

SetGroupIconFromFaction()

void SCR_AssignedGroupLabelUIComponent.SetGroupIconFromFaction	(	Faction	faction,
		string	iconName = string::Empty )

Sets group icon based on its faction.

Parameters

[in]	faction	of group
[in]	iconName	of icon in imageset

SetGroupName()

void SCR_AssignedGroupLabelUIComponent.SetGroupName

(

string

name

)

Parameters

[in]

name

of group to be set

Member Data Documentation

CUSTOM_GROUP_NAME_FORMAT

const string SCR_AssignedGroupLabelUIComponent.CUSTOM_GROUP_NAME_FORMAT = "#AR-Player_Groups_CustomName_Format"

staticprotected

DEFAULT_ICON_NAME

const string SCR_AssignedGroupLabelUIComponent.DEFAULT_ICON_NAME = "undefined"

staticprotected

m_sGroupsBLUFOR

ResourceName SCR_AssignedGroupLabelUIComponent.m_sGroupsBLUFOR

protected

m_sGroupsCIVILIAN

ResourceName SCR_AssignedGroupLabelUIComponent.m_sGroupsCIVILIAN

protected

m_sGroupsINDFOR

ResourceName SCR_AssignedGroupLabelUIComponent.m_sGroupsINDFOR

protected

m_sGroupsOPFOR

ResourceName SCR_AssignedGroupLabelUIComponent.m_sGroupsOPFOR

protected

m_Widgets

ref SCR_AssignedGroupLabelWidgets SCR_AssignedGroupLabelUIComponent.m_Widgets = new SCR_AssignedGroupLabelWidgets()

protected

---

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

• Game/UI/Tasks/SCR_AssignedGroupLabelUIComponent.c