SCR_InstigatorContextData Interface Reference

Public Member Functions
bool	HasAnyVictimKillerRelation (SCR_ECharacterDeathStatusRelations relation)
	If the relation ship between the killer and victim is the given relation.
SCR_ECharacterDeathStatusRelations	GetVictimKillerRelation ()
SCR_ECharacterControlType	GetVictimCharacterControlType ()
bool	HasAnyVictimCharacterControlType (SCR_ECharacterControlType controlType)
SCR_ECharacterControlType	GetKillerCharacterControlType ()
bool	HasAnyKillerCharacterControlType (SCR_ECharacterControlType controlType)
int	GetVictimPlayerID ()
int	GetKillerPlayerID ()
IEntity	GetVictimEntity ()
IEntity	GetKillerEntity ()
Instigator	GetInstigator ()
void	SCR_InstigatorContextData (int victimPlayerID, IEntity victimEntity, IEntity killerEntity, notnull Instigator instigator, bool isDeleted=false)
	This method sets death relation and status based on victim, killer, and instigator entities, considering their control types, faction and if GM or not.

Protected Member Functions
Faction	GetFaction (IEntity entity, int playerID)
Faction	GetFactionFromPlayerID (int playerID)

Protected Attributes
int	m_iVictimPlayerID
int	m_iKillerPlayerID
IEntity	m_VictimEntity
IEntity	m_KillerEntity
ref Instigator	m_Instigator
SCR_ECharacterDeathStatusRelations	m_eVictimKillerRelation = SCR_ECharacterDeathStatusRelations.UNKNOWN
SCR_ECharacterControlType	m_eVictimControlType = SCR_ECharacterControlType.UNKNOWN
SCR_ECharacterControlType	m_eKillerControlType = SCR_ECharacterControlType.UNKNOWN

Constructor & Destructor Documentation

SCR_InstigatorContextData()

void SCR_InstigatorContextData.SCR_InstigatorContextData	(	int	victimPlayerID,
		IEntity	victimEntity,
		IEntity	killerEntity,
		notnull Instigator	instigator,
		bool	isDeleted = false
	)

This method sets death relation and status based on victim, killer, and instigator entities, considering their control types, faction and if GM or not.

Parameters

[in]	victimPlayerID	Represents the ID of the player who is the victim in the context of this method.
[in]	victimEntity	The victimEntity represents the entity killed in the context, which can be a player or an AI character.
[in]	killerEntity	Killer entity represents the killer in the context of this method, which is used to determine the relationship between the killer and victim
[in]	instigator	Instigator To obtain the actual killer and other information about the killer
[in]	isDeleted	If isDeleted is true, it represents that the victim entity has been deleted by the editor or other function

Member Function Documentation

GetFaction()

Faction SCR_InstigatorContextData.GetFaction ( IEntity  entity, int  playerID  )

protected

GetFactionFromPlayerID()

Faction SCR_InstigatorContextData.GetFactionFromPlayerID ( int  playerID )

protected

GetInstigator()

Instigator SCR_InstigatorContextData.GetInstigator

(

)

Returns

Returns instigator which holds additional information of the killer

GetKillerCharacterControlType()

SCR_ECharacterControlType SCR_InstigatorContextData.GetKillerCharacterControlType

(

)

Returns

The control type of killer. Eg: AI, Player, Possessed AI, GM/Admin

GetKillerEntity()

IEntity SCR_InstigatorContextData.GetKillerEntity

(

)

Returns

Returns Controlled Entity of killer (Might change if entity was player and changes character)

GetKillerPlayerID()

int SCR_InstigatorContextData.GetKillerPlayerID

(

)

Returns

Returns player ID of killer

GetVictimCharacterControlType()

SCR_ECharacterControlType SCR_InstigatorContextData.GetVictimCharacterControlType

(

)

Returns

The control type of victim. Eg: AI, Player, Possessed AI, GM/Admin

GetVictimEntity()

IEntity SCR_InstigatorContextData.GetVictimEntity

(

)

Returns

Returns Controlled Entity of Victim

GetVictimKillerRelation()

SCR_ECharacterDeathStatusRelations SCR_InstigatorContextData.GetVictimKillerRelation

(

)

Returns

The relation type between victim and killer. Eg: Suicide, Killed by enemy, killed by GM etc

GetVictimPlayerID()

int SCR_InstigatorContextData.GetVictimPlayerID

(

)

Returns

Returns player ID of victim

HasAnyKillerCharacterControlType()

bool SCR_InstigatorContextData.HasAnyKillerCharacterControlType

(

SCR_ECharacterControlType

controlType

)

Parameters

[in]

controlType

Control type to check

Returns

Returns true if killer has any of the give control type flags. Eg: AI, Player, Possessed AI, GM/Admin

HasAnyVictimCharacterControlType()

bool SCR_InstigatorContextData.HasAnyVictimCharacterControlType

(

SCR_ECharacterControlType

controlType

)

Parameters

[in]

controlType

Control type to check

Returns

Returns true if victim has any of the give control type flags. Eg: AI, Player, Possessed AI, GM/Admin

HasAnyVictimKillerRelation()

bool SCR_InstigatorContextData.HasAnyVictimKillerRelation

(

SCR_ECharacterDeathStatusRelations

relation

)

If the relation ship between the killer and victim is the given relation.

Note that this is a flag and it can check multiple relation types at the same time

Parameters

[in]

relation

Relation (or relations as it is a flag) to check for

Returns

Will return true if any of the given relations is true

Member Data Documentation

m_eKillerControlType

SCR_ECharacterControlType SCR_InstigatorContextData.m_eKillerControlType = SCR_ECharacterControlType.UNKNOWN

protected

m_eVictimControlType

SCR_ECharacterControlType SCR_InstigatorContextData.m_eVictimControlType = SCR_ECharacterControlType.UNKNOWN

protected

m_eVictimKillerRelation

SCR_ECharacterDeathStatusRelations SCR_InstigatorContextData.m_eVictimKillerRelation = SCR_ECharacterDeathStatusRelations.UNKNOWN

protected

m_iKillerPlayerID

int SCR_InstigatorContextData.m_iKillerPlayerID

protected

m_Instigator

ref Instigator SCR_InstigatorContextData.m_Instigator

protected

m_iVictimPlayerID

int SCR_InstigatorContextData.m_iVictimPlayerID

protected

m_KillerEntity

IEntity SCR_InstigatorContextData.m_KillerEntity

protected

m_VictimEntity

IEntity SCR_InstigatorContextData.m_VictimEntity

protected

---

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

• Game/Damage/SCR_InstigatorContextData.c