SCR_GroupPreset Interface Reference

Inheritance diagram for SCR_GroupPreset:

Public Member Functions
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
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

GetDefaultActiveRadioChannel()

int SCR_GroupPreset.GetDefaultActiveRadioChannel

(

)

GetDefaultGroupFlagName()

string SCR_GroupPreset.GetDefaultGroupFlagName

(

)

Returns

default group flag name

GetGroupDescription()

string SCR_GroupPreset.GetGroupDescription

(

)

GetGroupFlag()

ResourceName SCR_GroupPreset.GetGroupFlag

(

)

GetGroupName()

string SCR_GroupPreset.GetGroupName

(

)

GetGroupRole()

SCR_EGroupRole SCR_GroupPreset.GetGroupRole

(

)

Returns

group role

GetGroupSize()

int SCR_GroupPreset.GetGroupSize

(

)

GetRadioFrequency()

int SCR_GroupPreset.GetRadioFrequency

(

)

GetRequiredRank()

SCR_ECharacterRank SCR_GroupPreset.GetRequiredRank

(

)

Returns

required character rank

IsPrivacyChangeable()

bool SCR_GroupPreset.IsPrivacyChangeable

(

)

IsPrivate()

bool SCR_GroupPreset.IsPrivate

(

)

SetGroupName()

void SCR_GroupPreset.SetGroupName

(

string

name

)

SetGroupSize()

void SCR_GroupPreset.SetGroupSize

(

int

size

)

SetIsPrivate()

void SCR_GroupPreset.SetIsPrivate

(

bool

privacy

)

SetRadioFrequency()

void SCR_GroupPreset.SetRadioFrequency

(

int

freq

)

SetupGroup()

void SCR_GroupPreset.SetupGroup

(

SCR_AIGroup

group

)

SetupGroupFlag()

void SCR_GroupPreset.SetupGroupFlag	(	SCR_AIGroup	group,
		SCR_Faction	faction )

Parameters

[in]	group
[in]	faction

SetupGroupWithOverride()

void SCR_GroupPreset.SetupGroupWithOverride	(	SCR_AIGroup	group,
		SCR_GroupPreset	overridingGroupPreset )

Parameters

[in]	group
[in]	overridingGroupPreset

Member Data Documentation

m_bIsPrivacyChangeable

bool SCR_GroupPreset.m_bIsPrivacyChangeable

protected

m_bIsPrivate

bool SCR_GroupPreset.m_bIsPrivate

protected

m_eGroupRole

SCR_EGroupRole SCR_GroupPreset.m_eGroupRole

protected

m_eRequiredRank

SCR_ECharacterRank SCR_GroupPreset.m_eRequiredRank

protected

m_iDefaultActiveRadioChannel

int SCR_GroupPreset.m_iDefaultActiveRadioChannel

protected

m_iGroupSize

int SCR_GroupPreset.m_iGroupSize

protected

m_iRadioFrequency

int SCR_GroupPreset.m_iRadioFrequency

protected

m_sGroupDescription

string SCR_GroupPreset.m_sGroupDescription

protected

m_sGroupFlagName

string SCR_GroupPreset.m_sGroupFlagName

protected

m_sGroupName

string SCR_GroupPreset.m_sGroupName

protected

---

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

• Game/Groups/SCR_GroupPreset.c