SCR_GroupRolePresetConfig Interface Reference

Inheritance diagram for SCR_GroupRolePresetConfig:

Public Member Functions
LocalizedString	GetGroupRoleName ()
bool	IsLoadoutInGroup (notnull SCR_FactionPlayerLoadout loadout)
bool	CanBeCreatedByPlayer ()
	Can be group created by player.
bool	CanPlayerJoin ()
	Can player join to group.
array< ResourceName >	GetLoadouts ()
Public Member Functions inherited from SCR_GroupPreset
void	SetupGroup (SCR_AIGroup group)
void	SetupGroupWithOverride (SCR_AIGroup group, SCR_GroupPreset overridingGroupPreset)
void	SetupGroupFlag (SCR_AIGroup group, SCR_Faction faction)
string	GetGroupName ()
ResourceName	GetGroupFlag ()
int	GetGroupSize ()
int	GetRadioFrequency ()
int	GetDefaultActiveRadioChannel ()
string	GetGroupDescription ()
bool	IsPrivate ()
bool	IsPrivacyChangeable ()
SCR_EGroupRole	GetGroupRole ()
string	GetDefaultGroupFlagName ()
SCR_ECharacterRank	GetRequiredRank ()
void	SetGroupName (string name)
void	SetGroupSize (int size)
void	SetRadioFrequency (int freq)
void	SetIsPrivate (bool privacy)

Protected Attributes
LocalizedString	m_sGroupRoleName
ref array< ResourceName >	m_aLoadoutResources
bool	m_bCanBeCreatedByPlayer
bool	m_bCanPlayerJoin
Protected Attributes inherited from SCR_GroupPreset
string	m_sGroupName
SCR_EGroupRole	m_eGroupRole
string	m_sGroupFlagName
string	m_sGroupDescription
int	m_iGroupSize
int	m_iRadioFrequency
int	m_iDefaultActiveRadioChannel
SCR_ECharacterRank	m_eRequiredRank
bool	m_bIsPrivate
bool	m_bIsPrivacyChangeable

Member Function Documentation

CanBeCreatedByPlayer()

bool SCR_GroupRolePresetConfig.CanBeCreatedByPlayer

(

)

Can be group created by player.

Returns

false - it will be not visible in create group menu

CanPlayerJoin()

bool SCR_GroupRolePresetConfig.CanPlayerJoin

(

)

Can player join to group.

Returns

false - join button will be disabled and join requests cannot be sent to the group

GetGroupRoleName()

LocalizedString SCR_GroupRolePresetConfig.GetGroupRoleName

(

)

Returns

localized group role name

GetLoadouts()

array< ResourceName > SCR_GroupRolePresetConfig.GetLoadouts

(

)

IsLoadoutInGroup()

bool SCR_GroupRolePresetConfig.IsLoadoutInGroup

(

notnull SCR_FactionPlayerLoadout

loadout

)

Parameters

[in]

loadout

Returns

true if loadout is in preset

Member Data Documentation

m_aLoadoutResources

ref array<ResourceName> SCR_GroupRolePresetConfig.m_aLoadoutResources

protected

m_bCanBeCreatedByPlayer

bool SCR_GroupRolePresetConfig.m_bCanBeCreatedByPlayer

protected

m_bCanPlayerJoin

bool SCR_GroupRolePresetConfig.m_bCanPlayerJoin

protected

m_sGroupRoleName

LocalizedString SCR_GroupRolePresetConfig.m_sGroupRoleName

protected

---

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

• Game/Groups/SCR_GroupRolePresetConfig.c