SCR_FactionHomeTerritoryConfig Interface Reference

Public Member Functions
SCR_UIInfo	GetHomeTerritoryUIInfo (int index)
	Get UI info of place of birth.
int	GetRandomHomeTerritoryIndex (RandomGenerator randomizer=null, bool useWeightedRandom=true)
	Get random place of birth index of faction using random Generator.
float	GetSharedPlaceOfBirthWeight ()
	Get percentage of AI group members sharing the same place of birth.
void	SCR_FactionHomeTerritoryConfig ()

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

Constructor & Destructor Documentation

SCR_FactionHomeTerritoryConfig()

void SCR_FactionHomeTerritoryConfig.SCR_FactionHomeTerritoryConfig

(

)

Member Function Documentation

GetHomeTerritoryUIInfo()

SCR_UIInfo SCR_FactionHomeTerritoryConfig.GetHomeTerritoryUIInfo

(

int

index

)

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

GetRandomHomeTerritoryIndex()

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

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

GetSharedPlaceOfBirthWeight()

float SCR_FactionHomeTerritoryConfig.GetSharedPlaceOfBirthWeight

(

)

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

Returns

Percentage

Member Data Documentation

m_aFactionHomeTerritories

ref array<ref SCR_FactionHomeTerritory> SCR_FactionHomeTerritoryConfig.m_aFactionHomeTerritories

protected

m_fSharedPlaceOfBirthWeight

float SCR_FactionHomeTerritoryConfig.m_fSharedPlaceOfBirthWeight

protected

m_iTotalWeight

int SCR_FactionHomeTerritoryConfig.m_iTotalWeight

protected

---

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

• Game/Identity/Containers/SCR_FactionHomeTerritoryConfig.c