SCR_FactionHomeTerritoryConfig Class Reference

Protected Member Functions
SCR_UIInfo	GetHomeTerritoryUIInfo (int index)
int	GetRandomHomeTerritoryIndex (RandomGenerator randomizer=null, bool useWeightedRandom=true)
float	GetSharedPlaceOfBirthWeight ()
void	SCR_FactionHomeTerritoryConfig ()

Protected Attributes
ref array< ref SCR_FactionHomeTerritory >	m_aFactionHomeTerritories
float	m_fSharedPlaceOfBirthWeight
int	m_iTotalWeight

Detailed Description

Definition at line 2 of file SCR_FactionHomeTerritoryConfig.c.

Constructor & Destructor Documentation

SCR_FactionHomeTerritoryConfig()

void SCR_FactionHomeTerritoryConfig::SCR_FactionHomeTerritoryConfig ( )

inlineprotected

Definition at line 81 of file SCR_FactionHomeTerritoryConfig.c.

Member Function Documentation

GetHomeTerritoryUIInfo()

SCR_UIInfo SCR_FactionHomeTerritoryConfig::GetHomeTerritoryUIInfo ( int index )

inlineprotected

Get UI info of place of birth

Parameters

[in]

useWeightedRandom

if true it will randomize the entries with the given weight

Returns

Random (weighted) index

Definition at line 17 of file SCR_FactionHomeTerritoryConfig.c.

GetRandomHomeTerritoryIndex()

int SCR_FactionHomeTerritoryConfig::GetRandomHomeTerritoryIndex ( RandomGenerator randomizer = null, bool useWeightedRandom = true )

inlineprotected

Get random place of birth index of faction using random Generator

Parameters

[in]	random	Generator. Set null it should not use Generator
[in]	useWeightedRandom	if true it will randomize the entries with the given weight

Returns

Random (weighted) index

Definition at line 30 of file SCR_FactionHomeTerritoryConfig.c.

GetSharedPlaceOfBirthWeight()

float SCR_FactionHomeTerritoryConfig::GetSharedPlaceOfBirthWeight ( )

inlineprotected

Get percentage of AI group members sharing the same place of birth

Returns

Percentage

Definition at line 75 of file SCR_FactionHomeTerritoryConfig.c.

Member Data Documentation

m_aFactionHomeTerritories

ref array<ref SCR_FactionHomeTerritory> SCR_FactionHomeTerritoryConfig::m_aFactionHomeTerritories

protected

Definition at line 5 of file SCR_FactionHomeTerritoryConfig.c.

m_fSharedPlaceOfBirthWeight

float SCR_FactionHomeTerritoryConfig::m_fSharedPlaceOfBirthWeight

protected

Definition at line 8 of file SCR_FactionHomeTerritoryConfig.c.

m_iTotalWeight

int SCR_FactionHomeTerritoryConfig::m_iTotalWeight

protected

Definition at line 11 of file SCR_FactionHomeTerritoryConfig.c.

---

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

• scripts/Game/Identity/Containers/SCR_FactionHomeTerritoryConfig.c