SCR_ExtendedIdentity Class Reference

Inheritance diagram for SCR_ExtendedIdentity:

Protected Member Functions
void	SetAge (int age)
int	GetAge ()
void	SetDayOfCreation (int day)
int	GetDayOfCreation ()
void	SetMonthOfCreation (int month)
int	GetMonthOfCreation ()
void	SetFactionOfOrigin (string factionKey)
void	SetFactionOfOrigin (int factionIndex)
string	GetFactionOfOriginKey ()
int	GetFactionOfOriginIndex ()
void	SetPlaceOfOrigin (SCR_UIInfo place, bool isOverwrite)
void	SetPlaceOfOriginIndex (int index)
SCR_UIInfo	GetPlaceOfOriginUIInfo ()
int	GetPlaceOfOriginIndex ()

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

Detailed Description

Definition at line 2 of file SCR_ExtendedIdentity.c.

Member Function Documentation

GetAge()

int SCR_ExtendedIdentity::GetAge ( )

inlineprotected

Get age of entity

Returns

Age of entity

Definition at line 34 of file SCR_ExtendedIdentity.c.

GetDayOfCreation()

int SCR_ExtendedIdentity::GetDayOfCreation ( )

inlineprotected

Get day entity is created or character is born

Returns

Day born/created

Definition at line 51 of file SCR_ExtendedIdentity.c.

GetFactionOfOriginIndex()

int SCR_ExtendedIdentity::GetFactionOfOriginIndex ( )

inlineprotected

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

Definition at line 130 of file SCR_ExtendedIdentity.c.

GetFactionOfOriginKey()

string SCR_ExtendedIdentity::GetFactionOfOriginKey ( )

inlineprotected

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

Definition at line 117 of file SCR_ExtendedIdentity.c.

GetMonthOfCreation()

int SCR_ExtendedIdentity::GetMonthOfCreation ( )

inlineprotected

Get month entity is created or character is born

Returns

Month born/created

Definition at line 68 of file SCR_ExtendedIdentity.c.

GetPlaceOfOriginIndex()

int SCR_ExtendedIdentity::GetPlaceOfOriginIndex ( )

inlineprotected

Get the place of creation index. Can be used with SCR_Faction to obtain the place of creation

Returns

Place of creation index

Definition at line 199 of file SCR_ExtendedIdentity.c.

GetPlaceOfOriginUIInfo()

SCR_UIInfo SCR_ExtendedIdentity::GetPlaceOfOriginUIInfo ( )

inlineprotected

Get the place of creation UI info

Returns

Place of creation UI info

Definition at line 191 of file SCR_ExtendedIdentity.c.

SetAge()

void SCR_ExtendedIdentity::SetAge ( int age )

inlineprotected

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

Parameters

[i]	age Age of entity

Definition at line 26 of file SCR_ExtendedIdentity.c.

SetDayOfCreation()

void SCR_ExtendedIdentity::SetDayOfCreation ( int day )

inlineprotected

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

Definition at line 43 of file SCR_ExtendedIdentity.c.

SetFactionOfOrigin() [1/2]

void SCR_ExtendedIdentity::SetFactionOfOrigin ( int factionIndex )

inlineprotected

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

Definition at line 98 of file SCR_ExtendedIdentity.c.

SetFactionOfOrigin() [2/2]

void SCR_ExtendedIdentity::SetFactionOfOrigin ( string factionKey )

inlineprotected

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

Definition at line 78 of file SCR_ExtendedIdentity.c.

SetMonthOfCreation()

void SCR_ExtendedIdentity::SetMonthOfCreation ( int month )

inlineprotected

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

Definition at line 60 of file SCR_ExtendedIdentity.c.

SetPlaceOfOrigin()

void SCR_ExtendedIdentity::SetPlaceOfOrigin ( SCR_UIInfo place, bool isOverwrite )

inlineprotected

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

Definition at line 145 of file SCR_ExtendedIdentity.c.

SetPlaceOfOriginIndex()

void SCR_ExtendedIdentity::SetPlaceOfOriginIndex ( int index )

inlineprotected

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.

Definition at line 158 of file SCR_ExtendedIdentity.c.

Member Data Documentation

m_iAge

int SCR_ExtendedIdentity::m_iAge

protected

Definition at line 5 of file SCR_ExtendedIdentity.c.

m_iDayOfCreation

int SCR_ExtendedIdentity::m_iDayOfCreation

protected

Definition at line 8 of file SCR_ExtendedIdentity.c.

m_iFactionOfOriginIndex

int SCR_ExtendedIdentity::m_iFactionOfOriginIndex = -1

protected

Definition at line 19 of file SCR_ExtendedIdentity.c.

m_iMonthOfCreation

int SCR_ExtendedIdentity::m_iMonthOfCreation

protected

Definition at line 11 of file SCR_ExtendedIdentity.c.

m_iPlaceOfOriginIndex

int SCR_ExtendedIdentity::m_iPlaceOfOriginIndex = -1

protected

Definition at line 20 of file SCR_ExtendedIdentity.c.

m_PlaceOfOrigin

ref SCR_UIInfo SCR_ExtendedIdentity::m_PlaceOfOrigin

protected

Definition at line 17 of file SCR_ExtendedIdentity.c.

m_sFactionOfOriginKey

string SCR_ExtendedIdentity::m_sFactionOfOriginKey

protected

Definition at line 14 of file SCR_ExtendedIdentity.c.

---

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

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