SCR_CharacterIdentityBioGroupConfig Interface Reference

Inheritance diagram for SCR_CharacterIdentityBioGroupConfig:

Public Member Functions
override bool	IsValidFaction (string factionKey)
	Is Valid faction.
override bool	IsValidFaction (int factionIndex)
	Is Valid faction.
override bool	IsValidForRandomization (IEntity entity, SCR_ExtendedIdentityComponent extendedIdentity)
	General check if group is valid for randomization param[in] entity Entity which will get a identity param[in] extendedIdentity Extended Identity Component of the entity.
override SCR_IdentityBio	GetIdentityBio (IEntity entity, int index)
	Get an bio from Index.
override void	AssignRandomAvailableBio (RandomGenerator randomizer, IEntity entity, out int index, out SCR_IdentityBio bio)
	Get an random available bio (Server Only) Also removes the bio from available list.
override SCR_IdentityBio	OnCharacterBioAssigned (IEntity entity, int index)
	Called when Character bio is assigned (Server Only) Also removes the bio from available list (Unless the group has no weight and thus need to be randonly assigned)
override void	ResetAvailable ()
	Resets all available indexes. Including Unique (Server Only)
void	SCR_CharacterIdentityBioGroupConfig ()
Public Member Functions inherited from SCR_IdentityBioGroupConfig
bool	IsEnabled ()
	Check if Bio Config is enabled.
int	GetWeight ()
	Return randomization weight.
string	GetBioGroupID ()
	Get bio group ID.
void	SCR_IdentityBioGroupConfig ()

Protected Member Functions
SCR_EIdentityGender	GetEntityGender (IEntity entity)
override void	DelayedInit ()
override void	SetAdditionalWeight ()

Protected Attributes
ref array< ref SCR_GenderSpecificIdentityBios >	m_aGenderSpecificIdentityLists
SCR_ECharacterIdentityBioGroupType	m_eIdentityGroupType
SCR_EIdentityCharacterControlType	m_eCharacterControlTypes
ref map< SCR_EIdentityGender, ref array< int > >	m_mAvailableGenderSpecificBioIndexLists
ref map< SCR_EIdentityGender, ref array< int > >	m_mUnavailableGenderSpecificBioIndexLists
Protected Attributes inherited from SCR_IdentityBioGroupConfig
bool	m_bEnabled
string	m_sBioGroupID
int	m_iWeight
float	m_fEntryAmountWeightMulti
ref array< string >	m_aNeedsFaction
ref array< ref SCR_IdentityBio >	m_aIdentityList
ref array< int >	m_aNeedsFactionIndexes
ref array< int >	m_aAvailableIdentityBioIndexList = {}
ref array< int >	m_aUnavailableIdentityBioIndexList = {}

Constructor & Destructor Documentation

SCR_CharacterIdentityBioGroupConfig()

void SCR_CharacterIdentityBioGroupConfig.SCR_CharacterIdentityBioGroupConfig

(

)

Member Function Documentation

AssignRandomAvailableBio()

override void SCR_CharacterIdentityBioGroupConfig.AssignRandomAvailableBio	(	RandomGenerator	randomizer,
		IEntity	entity,
		out int	index,
		out SCR_IdentityBio	bio )

Get an random available bio (Server Only) Also removes the bio from available list.

Parameters

[out]	index	Bio index
[out]	bio	Bio reference

Implements SCR_IdentityBioGroupConfig.

DelayedInit()

override void SCR_CharacterIdentityBioGroupConfig.DelayedInit ( )

protected

Implements SCR_IdentityBioGroupConfig.

GetEntityGender()

SCR_EIdentityGender SCR_CharacterIdentityBioGroupConfig.GetEntityGender ( IEntity entity )

protected

GetIdentityBio()

override SCR_IdentityBio SCR_CharacterIdentityBioGroupConfig.GetIdentityBio	(	IEntity	entity,
		int	index )

Get an bio from Index.

Parameters

[in]	entity	The entity that has the identity
[in]	index	Index of bio

Returns

Bio

Implements SCR_IdentityBioGroupConfig.

IsValidFaction() [1/2]

override bool SCR_CharacterIdentityBioGroupConfig.IsValidFaction

(

int

factionIndex

)

Is Valid faction.

Parameters

[in]

factionIndex

faction Index

Returns

Returns true if no faction needed for group if if given faction is within the needed faction list

Implements SCR_IdentityBioGroupConfig.

IsValidFaction() [2/2]

override bool SCR_CharacterIdentityBioGroupConfig.IsValidFaction

(

string

factionKey

)

Is Valid faction.

Parameters

[in]

factionKey

faction key

Returns

Returns true if no faction needed for group if if given faction is within the needed faction list

Implements SCR_IdentityBioGroupConfig.

IsValidForRandomization()

override bool SCR_CharacterIdentityBioGroupConfig.IsValidForRandomization	(	IEntity	entity,
		SCR_ExtendedIdentityComponent	extendedIdentity )

General check if group is valid for randomization param[in] entity Entity which will get a identity param[in] extendedIdentity Extended Identity Component of the entity.

Returns

Returns true if the group has a weight and if there are available identities's

Implements SCR_IdentityBioGroupConfig.

Implemented in SCR_UniquePlayerIdentityBioGroupConfig.

OnCharacterBioAssigned()

override SCR_IdentityBio SCR_CharacterIdentityBioGroupConfig.OnCharacterBioAssigned	(	IEntity	entity,
		int	index )

Called when Character bio is assigned (Server Only) Also removes the bio from available list (Unless the group has no weight and thus need to be randonly assigned)

Parameters

[in]

index

Index of assigned Bio

Implements SCR_IdentityBioGroupConfig.

ResetAvailable()

override void SCR_CharacterIdentityBioGroupConfig.ResetAvailable

(

)

Resets all available indexes. Including Unique (Server Only)

Implements SCR_IdentityBioGroupConfig.

SetAdditionalWeight()

override void SCR_CharacterIdentityBioGroupConfig.SetAdditionalWeight ( )

protected

Implements SCR_IdentityBioGroupConfig.

Member Data Documentation

m_aGenderSpecificIdentityLists

ref array<ref SCR_GenderSpecificIdentityBios> SCR_CharacterIdentityBioGroupConfig.m_aGenderSpecificIdentityLists

protected

m_eCharacterControlTypes

SCR_EIdentityCharacterControlType SCR_CharacterIdentityBioGroupConfig.m_eCharacterControlTypes

protected

m_eIdentityGroupType

SCR_ECharacterIdentityBioGroupType SCR_CharacterIdentityBioGroupConfig.m_eIdentityGroupType

protected

m_mAvailableGenderSpecificBioIndexLists

ref map<SCR_EIdentityGender, ref array<int> > SCR_CharacterIdentityBioGroupConfig.m_mAvailableGenderSpecificBioIndexLists

protected

m_mUnavailableGenderSpecificBioIndexLists

ref map<SCR_EIdentityGender, ref array<int> > SCR_CharacterIdentityBioGroupConfig.m_mUnavailableGenderSpecificBioIndexLists

protected

---

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

• Game/Identity/Containers/SCR_CharacterIdentityBioGroupConfig.c