SCR_ExtendedIdentity Interface Reference

Inheritance diagram for SCR_ExtendedIdentity:

Public Member Functions
void	SetAge (int age)
	Set age of entity Use SCR_ExtendedIdentityComponent to set to make sure it is replicated!
int	GetAge ()
	Get age of entity.
void	SetDayOfCreation (int day)
	Set day entity is created or character is born Use SCR_ExtendedIdentityComponent to set to make sure it is replicated!
int	GetDayOfCreation ()
	Get day entity is created or character is born.
void	SetMonthOfCreation (int month)
	Set month entity is created or character is born Use SCR_ExtendedIdentityComponent to set to make sure it is replicated!
int	GetMonthOfCreation ()
	Get month entity is created or character is born.
void	SetFactionOfOrigin (string factionKey)
	Set faction of origin.
void	SetFactionOfOrigin (int factionIndex)
	Set faction of origin.
string	GetFactionOfOriginKey ()
	Get faction of origin key.
int	GetFactionOfOriginIndex ()
	Get faction of origin index.
void	SetPlaceOfOrigin (SCR_UIInfo place, bool isOverwrite)
	Set place of creation.
void	SetPlaceOfOriginIndex (int index)
	Set place of creation.
SCR_UIInfo	GetPlaceOfOriginUIInfo ()
	Get the place of creation UI info.
int	GetPlaceOfOriginIndex ()
	Get the place of creation index.

Protected Attributes
int	m_iAge
int	m_iDayOfCreation
int	m_iMonthOfCreation
string	m_sFactionOfOriginKey
ref SCR_UIInfo	m_PlaceOfOrigin
int	m_iFactionOfOriginIndex = -1
int	m_iPlaceOfOriginIndex = -1

Member Function Documentation

GetAge()

int SCR_ExtendedIdentity.GetAge

(

)

Get age of entity.

Returns

Age of entity

GetDayOfCreation()

int SCR_ExtendedIdentity.GetDayOfCreation

(

)

Get day entity is created or character is born.

Returns

Day born/created

GetFactionOfOriginIndex()

int SCR_ExtendedIdentity.GetFactionOfOriginIndex

(

)

Get faction of origin index.

Used to get random place of creation/birth This should never change once set even if faction is changed

Returns

Faction of origin index

GetFactionOfOriginKey()

string SCR_ExtendedIdentity.GetFactionOfOriginKey

(

)

Get faction of origin key.

Used to get random place of creation/birth This should never change once set even if faction is changed

Returns

Faction of origin key

GetMonthOfCreation()

int SCR_ExtendedIdentity.GetMonthOfCreation

(

)

Get month entity is created or character is born.

Returns

Month born/created

GetPlaceOfOriginIndex()

int SCR_ExtendedIdentity.GetPlaceOfOriginIndex

(

)

Get the place of creation index.

Can be used with SCR_Faction to obtain the place of creation

Returns

Place of creation index

GetPlaceOfOriginUIInfo()

SCR_UIInfo SCR_ExtendedIdentity.GetPlaceOfOriginUIInfo

(

)

Get the place of creation UI info.

Returns

Place of creation UI info

SetAge()

void SCR_ExtendedIdentity.SetAge

(

int

age

)

Set age of entity Use SCR_ExtendedIdentityComponent to set to make sure it is replicated!

Parameters

[i]	age Age of entity

SetDayOfCreation()

void SCR_ExtendedIdentity.SetDayOfCreation

(

int

day

)

Set day entity is created or character is born Use SCR_ExtendedIdentityComponent to set to make sure it is replicated!

Parameters

[in]

day

Day born/created

SetFactionOfOrigin() [1/2]

void SCR_ExtendedIdentity.SetFactionOfOrigin

(

int

factionIndex

)

Set faction of origin.

Used to get random place of creation/birth This should never change once set even if faction is changed Use SCR_ExtendedIdentityComponent to set to make sure it is replicated!

Parameters

[in]

factionIndex

Faction index

SetFactionOfOrigin() [2/2]

void SCR_ExtendedIdentity.SetFactionOfOrigin

(

string

factionKey

)

Set faction of origin.

Used to get random place of creation/birth This should never change once set even if faction is changed Use SCR_ExtendedIdentityComponent to set to make sure it is replicated!

Parameters

[in]

factionKey

Faction key

SetMonthOfCreation()

void SCR_ExtendedIdentity.SetMonthOfCreation

(

int

month

)

Set month entity is created or character is born Use SCR_ExtendedIdentityComponent to set to make sure it is replicated!

Parameters

[in]

month

Day born/created

SetPlaceOfOrigin()

void SCR_ExtendedIdentity.SetPlaceOfOrigin	(	SCR_UIInfo	place,
		bool	isOverwrite )

Set place of creation.

This is the birth place of a character or place of creation of an entity Use SCR_ExtendedIdentityComponent to set to make sure it is replicated! FactionOfOrigin needs to be set to use index.

Parameters

[in]	place	UIInfo to directly set. Is only set when provided.
[in]	isOverwrite	If true will set m_iPlaceOfOriginIndex to -1

SetPlaceOfOriginIndex()

void SCR_ExtendedIdentity.SetPlaceOfOriginIndex

(

int

index

)

Set place of creation.

This is the birth place of a character or place of creation of an entity Use SCR_ExtendedIdentityComponent to set to make sure it is replicated! FactionOfOrigin needs to be set to use index.

Parameters

[in]

index

index to get place of creation from faction.

Member Data Documentation

m_iAge

int SCR_ExtendedIdentity.m_iAge

protected

m_iDayOfCreation

int SCR_ExtendedIdentity.m_iDayOfCreation

protected

m_iFactionOfOriginIndex

int SCR_ExtendedIdentity.m_iFactionOfOriginIndex = -1

protected

m_iMonthOfCreation

int SCR_ExtendedIdentity.m_iMonthOfCreation

protected

m_iPlaceOfOriginIndex

int SCR_ExtendedIdentity.m_iPlaceOfOriginIndex = -1

protected

m_PlaceOfOrigin

ref SCR_UIInfo SCR_ExtendedIdentity.m_PlaceOfOrigin

protected

m_sFactionOfOriginKey

string SCR_ExtendedIdentity.m_sFactionOfOriginKey

protected

---

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

• Game/Identity/Containers/SCR_ExtendedIdentity.c