SCR_ExtendedCharacterIdentityComponent Interface Reference

Inheritance diagram for SCR_ExtendedCharacterIdentityComponent:

Public Member Functions
SCR_EIdentityGender	GetGender ()
	Get gender of character.
override void	OverwriteExtendedIdentity (SCR_ExtendedIdentity newExtendedIdentity)
	Called when a bio is overwriting the extended Identity Note that only values that where set in the new identity will be overwritten on the entity.
bool	WasIdentityItemAddedOnce_S ()
int	OnIdentityItemAdded_S (SCR_IdentityInventoryItemComponent item, bool generateValuableIntel)
	When identity item is added to the character.
void	OnCharacterDeath ()
	Called by SCR_CharacterIdentityManagerComponent when character dies (Server Only)
void	SetPlayerID (int playerId)
	Set this character player ID. Handled in the preparing of this character by the SCR_IdentityManagerComponent.
int	GetPlayerID ()
override void	DelayedInit (IEntity owner)
override void	OnDelete (IEntity owner)
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
Public Member Functions inherited from SCR_ExtendedIdentityComponent
int	GetRandomizeSeed ()
	Returns the assigned randomize seed of the identity.
void	RandomizeIdentityServer ()
	Randomize the identity of the entity.
SCR_ExtendedIdentity	GetExtendedIdentity ()
	Get Extended Identity Holding information from age to place of creation.
SCR_IdentityBio	GetIdentityBio ()
	Get Identity Bio Bio contains flavor text.
void	GetBioIndexes (out int bioGroupIndex, out int bioIndex)
void	AssignBio (int combinedBioIndex)
	Assign given bio using combined bio index.
void	SetRandomDayOfCreation (int month=-1)
	Set random day of birth of character.
SCR_EIdentityType	GetIdentityType ()
override void	OnPostInit (IEntity owner)
override void	EOnInit (IEntity owner)

Protected Member Functions
override void	RandomizeIdentity (int combinedBioIndex)
void	OverwriteCharacterName (string overwriteName, string overwriteAlias, string overwriteSurname)
	Overwrite names specific for characters Called when Bio overwrites names.
void	OnCharacterDeathBroadCast (int totalDeathDateMinutes)
override void	AssignBio (SCR_IdentityBio identityBio)
	Assign given bio.
override void	RandomizePlaceOfOrigin ()
void	SetPlaceOfOriginIndex (int index)
void	SetCharacterPlaceOfOriginBroadcast (int index)
void	OnCharacterLifeStateChanged (ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState)
Protected Member Functions inherited from SCR_ExtendedIdentityComponent
void	RandomizeIdentityBroadcast (int seed, int combinedBioIndex)
void	DelayedRandomizeIdentity ()
void	DeleteRandomizer ()
void	InitFactionOfOrigin ()
void	AssignRandomBioServer ()
	Assign random bio (Server Only)
void	RandomizeAge ()
	Set controlled random age of entity in years.
void	SetRandomMonthOfCreation ()
	Set random month of birth of character.

Protected Attributes
SCR_EIdentityGender	m_eGender
float	m_fChanceOfIdentityDocumentBeingValuable
int	m_iPlayerId
bool	m_bIdentityItemAdded
Protected Attributes inherited from SCR_ExtendedIdentityComponent
SCR_EIdentityType	m_eIdentityType
ref SCR_ExtendedIdentity	m_ExtendedIdentity
ref SCR_IdentityBio	m_IdentityBio
int	m_iMinRandomAge
int	m_iMaxRandomAge
bool	m_bRandomizeIdentityOnInit
int	m_iBioGroupIndex = -1
int	m_iBioIndex = -1
int	m_RandomizeSeed = -1
ref RandomGenerator	m_Randomizer
bool	m_bDelayedInitCalled

Member Function Documentation

AssignBio()

override void SCR_ExtendedCharacterIdentityComponent.AssignBio ( SCR_IdentityBio identityBio )

protected

Assign given bio.

(Local only is not replicated) Will also overwrite any indentity values taken from the bio

Parameters

identityBio

New bio to assign

Implements SCR_ExtendedIdentityComponent.

DelayedInit()

override void SCR_ExtendedCharacterIdentityComponent.DelayedInit

(

IEntity

owner

)

Implements SCR_ExtendedIdentityComponent.

GetGender()

SCR_EIdentityGender SCR_ExtendedCharacterIdentityComponent.GetGender

(

)

Get gender of character.

Returns

Gender

GetPlayerID()

int SCR_ExtendedCharacterIdentityComponent.GetPlayerID

(

)

Returns

Player ID of the character (Can be 0 if AI)

OnCharacterDeath()

void SCR_ExtendedCharacterIdentityComponent.OnCharacterDeath

(

)

Called by SCR_CharacterIdentityManagerComponent when character dies (Server Only)

OnCharacterDeathBroadCast()

void SCR_ExtendedCharacterIdentityComponent.OnCharacterDeathBroadCast ( int totalDeathDateMinutes )

protected

OnCharacterLifeStateChanged()

void SCR_ExtendedCharacterIdentityComponent.OnCharacterLifeStateChanged ( ECharacterLifeState previousLifeState, ECharacterLifeState newLifeState )

protected

OnDelete()

override void SCR_ExtendedCharacterIdentityComponent.OnDelete

(

IEntity

owner

)

OnIdentityItemAdded_S()

int SCR_ExtendedCharacterIdentityComponent.OnIdentityItemAdded_S	(	SCR_IdentityInventoryItemComponent	item,
		bool	generateValuableIntel )

When identity item is added to the character.

If generate valuable intel is true it will also try to set the randomized valuable intel on the identity item if no other identity item was added

Parameters

[in]	item	The item added to the character's inventory
[in]	generateValuableIntel	If it should try generating valuable intel for the character if the item was not added at least once

Returns

-1 if not valuable intel, otherwise it will return faction index of which faction the valuable intel is

OverwriteCharacterName()

void SCR_ExtendedCharacterIdentityComponent.OverwriteCharacterName ( string overwriteName, string overwriteAlias, string overwriteSurname )

protected

Overwrite names specific for characters Called when Bio overwrites names.

Parameters

[in]	overwriteName	Overwrite Name (Ignored if empty)
[in]	overwriteAlias	Overwrite Alias (Ignored if empty)
[in]	overwriteSurname	Overwrite Surname (Ignored if empty)

OverwriteExtendedIdentity()

override void SCR_ExtendedCharacterIdentityComponent.OverwriteExtendedIdentity

(

SCR_ExtendedIdentity

newExtendedIdentity

)

Called when a bio is overwriting the extended Identity Note that only values that where set in the new identity will be overwritten on the entity.

Parameters

[in]

newExtendedIdentity

new Extended Identity to get values from

Implements SCR_ExtendedIdentityComponent.

RandomizeIdentity()

override void SCR_ExtendedCharacterIdentityComponent.RandomizeIdentity ( int combinedBioIndex )

protected

Implements SCR_ExtendedIdentityComponent.

RandomizePlaceOfOrigin()

override void SCR_ExtendedCharacterIdentityComponent.RandomizePlaceOfOrigin ( )

protected

Implements SCR_ExtendedIdentityComponent.

RplLoad()

override bool SCR_ExtendedCharacterIdentityComponent.RplLoad

(

ScriptBitReader

reader

)

Implements SCR_ExtendedIdentityComponent.

RplSave()

override bool SCR_ExtendedCharacterIdentityComponent.RplSave

(

ScriptBitWriter

writer

)

Implements SCR_ExtendedIdentityComponent.

SetCharacterPlaceOfOriginBroadcast()

void SCR_ExtendedCharacterIdentityComponent.SetCharacterPlaceOfOriginBroadcast ( int index )

protected

SetPlaceOfOriginIndex()

void SCR_ExtendedCharacterIdentityComponent.SetPlaceOfOriginIndex ( int index )

protected

SetPlayerID()

void SCR_ExtendedCharacterIdentityComponent.SetPlayerID

(

int

playerId

)

Set this character player ID. Handled in the preparing of this character by the SCR_IdentityManagerComponent.

WasIdentityItemAddedOnce_S()

bool SCR_ExtendedCharacterIdentityComponent.WasIdentityItemAddedOnce_S

(

)

Returns

True if at least once an identity item was added (Server only)

Member Data Documentation

m_bIdentityItemAdded

bool SCR_ExtendedCharacterIdentityComponent.m_bIdentityItemAdded

protected

m_eGender

SCR_EIdentityGender SCR_ExtendedCharacterIdentityComponent.m_eGender

protected

m_fChanceOfIdentityDocumentBeingValuable

float SCR_ExtendedCharacterIdentityComponent.m_fChanceOfIdentityDocumentBeingValuable

protected

m_iPlayerId

int SCR_ExtendedCharacterIdentityComponent.m_iPlayerId

protected

---

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

• Game/Identity/SCR_ExtendedCharacterIdentityComponent.c