Protected Member Functions
bool	HasAnyVictimKillerRelation (SCR_ECharacterDeathStatusRelations 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 ()
SCR_ECharacterDisguiseType	GetKillerDisguiseType ()
SCR_ECharacterDisguiseType	GetVictimDisguiseType ()
bool	DoesPlayerKillCountAsTeamKill (bool editorKillsCount=false, bool possessedKillsCount=false)
bool	IsEnemyKillPunished (SCR_EDisguisedKillingPunishment punishmentToCheck, bool editorKillsCount=false, bool checkIfAllFlagsValid=false)
void	SCR_InstigatorContextData (int victimPlayerID, IEntity victimEntity, IEntity killerEntity, notnull Instigator instigator, bool isDeleted=false)
void	CreateInstigatorData (int victimPlayerID, IEntity victimEntity, IEntity killerEntity, notnull Instigator instigator, bool isDeleted=false)
void	SetPerceivedFaction (int victimPlayerID, IEntity victimEntity, IEntity killerEntity, notnull Instigator instigator, bool isDeleted=false)
Faction	GetFaction (IEntity entity, int playerID)
Faction	GetFactionFromPlayerID (int playerID)

Detailed Description

Definition at line 1 of file SCR_InstigatorContextData.c.

Constructor & Destructor Documentation

◆ SCR_InstigatorContextData()

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

inlineprotected

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

Definition at line 187 of file SCR_InstigatorContextData.c.

Member Function Documentation

◆ CreateInstigatorData()

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

inlineprotected

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

Definition at line 199 of file SCR_InstigatorContextData.c.

◆ DoesPlayerKillCountAsTeamKill()

bool SCR_InstigatorContextData::DoesPlayerKillCountAsTeamKill	(	bool	editorKillsCount = false,
		bool	possessedKillsCount = false )

inlineprotected

Method to check wether or not the kill of this context action counts as team killing

Parameters

[in]	editorKillsCount	If true then admins, GMs and players on admin list are not ignored
[in]	possessedKillsCount	If true then Kills done while possessing an AI are not ignored

Returns: True if it counts as a team kill

Definition at line 119 of file SCR_InstigatorContextData.c.

◆ GetFaction()

Faction SCR_InstigatorContextData::GetFaction	(	IEntity	entity,
		int	playerID )

inlineprotected

Definition at line 372 of file SCR_InstigatorContextData.c.

◆ GetFactionFromPlayerID()

Faction SCR_InstigatorContextData::GetFactionFromPlayerID ( int playerID )

inlineprotected

Definition at line 386 of file SCR_InstigatorContextData.c.

◆ GetInstigator()

Instigator SCR_InstigatorContextData::GetInstigator ( )

inlineprotected

Returns: Returns instigator which holds additional information of the killer

Definition at line 95 of file SCR_InstigatorContextData.c.

◆ GetKillerCharacterControlType()

SCR_ECharacterControlType SCR_InstigatorContextData::GetKillerCharacterControlType ( )

inlineprotected

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

Definition at line 52 of file SCR_InstigatorContextData.c.

◆ GetKillerDisguiseType()

SCR_ECharacterDisguiseType SCR_InstigatorContextData::GetKillerDisguiseType ( )

inlineprotected

Returns: killer disguise type. Which is the relation between the perceived faction and affiliated faction. Will return DEFAULT_FACTION if disabled

Definition at line 102 of file SCR_InstigatorContextData.c.

◆ GetKillerEntity()

IEntity SCR_InstigatorContextData::GetKillerEntity ( )

inlineprotected

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

Definition at line 88 of file SCR_InstigatorContextData.c.

◆ GetKillerPlayerID()

int SCR_InstigatorContextData::GetKillerPlayerID ( )

inlineprotected

Returns: Returns player ID of killer

Definition at line 74 of file SCR_InstigatorContextData.c.

◆ GetVictimCharacterControlType()

SCR_ECharacterControlType SCR_InstigatorContextData::GetVictimCharacterControlType ( )

inlineprotected

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

Definition at line 37 of file SCR_InstigatorContextData.c.

◆ GetVictimDisguiseType()

SCR_ECharacterDisguiseType SCR_InstigatorContextData::GetVictimDisguiseType ( )

inlineprotected

Returns: victim disguise type. Which is the relation between the perceived faction and affiliated faction. Will return DEFAULT_FACTION if disabled

Definition at line 109 of file SCR_InstigatorContextData.c.

◆ GetVictimEntity()

IEntity SCR_InstigatorContextData::GetVictimEntity ( )

inlineprotected

Returns: Returns Controlled Entity of Victim

Definition at line 81 of file SCR_InstigatorContextData.c.

◆ GetVictimKillerRelation()

SCR_ECharacterDeathStatusRelations SCR_InstigatorContextData::GetVictimKillerRelation ( )

inlineprotected

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

Definition at line 30 of file SCR_InstigatorContextData.c.

◆ GetVictimPlayerID()

int SCR_InstigatorContextData::GetVictimPlayerID ( )

inlineprotected

Returns: Returns player ID of victim

Definition at line 67 of file SCR_InstigatorContextData.c.

◆ HasAnyKillerCharacterControlType()

bool SCR_InstigatorContextData::HasAnyKillerCharacterControlType ( SCR_ECharacterControlType controlType )

inlineprotected

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

Definition at line 60 of file SCR_InstigatorContextData.c.

◆ HasAnyVictimCharacterControlType()

bool SCR_InstigatorContextData::HasAnyVictimCharacterControlType ( SCR_ECharacterControlType controlType )

inlineprotected

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

Definition at line 45 of file SCR_InstigatorContextData.c.

◆ HasAnyVictimKillerRelation()

bool SCR_InstigatorContextData::HasAnyVictimKillerRelation ( SCR_ECharacterDeathStatusRelations relation )

inlineprotected

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

Definition at line 23 of file SCR_InstigatorContextData.c.

◆ IsEnemyKillPunished()

bool SCR_InstigatorContextData::IsEnemyKillPunished	(	SCR_EDisguisedKillingPunishment	punishmentToCheck,
		bool	editorKillsCount = false,
		bool	checkIfAllFlagsValid = false )

inlineprotected

Parameters

[in]	punishmentToCheck	Which flag(s) are checked to see if the enemy kill is punished
[in]	editorKillsCount	If true then admins, GMs and players on admin list are not ignored
[in]	checkIfAllFlagsValid	Will check all flags are equal to the setting if true. Otherwise if one of them is true the condition will return true

Returns: True if the enemy kill is punished

Definition at line 150 of file SCR_InstigatorContextData.c.

◆ SetPerceivedFaction()

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

inlineprotected

Definition at line 348 of file SCR_InstigatorContextData.c.

Member Data Documentation

◆ m_eKillerControlType

SCR_ECharacterControlType SCR_InstigatorContextData::m_eKillerControlType = SCR_ECharacterControlType.UNKNOWN

protected

Definition at line 14 of file SCR_InstigatorContextData.c.

◆ m_eKillerDisguiseType

SCR_ECharacterDisguiseType SCR_InstigatorContextData::m_eKillerDisguiseType = SCR_ECharacterDisguiseType.DEFAULT_FACTION

protected

Definition at line 16 of file SCR_InstigatorContextData.c.

◆ m_eVictimControlType

SCR_ECharacterControlType SCR_InstigatorContextData::m_eVictimControlType = SCR_ECharacterControlType.UNKNOWN

protected

Definition at line 13 of file SCR_InstigatorContextData.c.

◆ m_eVictimDisguiseType

SCR_ECharacterDisguiseType SCR_InstigatorContextData::m_eVictimDisguiseType = SCR_ECharacterDisguiseType.DEFAULT_FACTION

protected

Definition at line 17 of file SCR_InstigatorContextData.c.

◆ m_eVictimKillerRelation

SCR_ECharacterDeathStatusRelations SCR_InstigatorContextData::m_eVictimKillerRelation = SCR_ECharacterDeathStatusRelations.UNKNOWN

protected

Definition at line 11 of file SCR_InstigatorContextData.c.

◆ m_iKillerPlayerID

int SCR_InstigatorContextData::m_iKillerPlayerID

protected

Definition at line 4 of file SCR_InstigatorContextData.c.

◆ m_Instigator

ref Instigator SCR_InstigatorContextData::m_Instigator

protected

Definition at line 9 of file SCR_InstigatorContextData.c.

◆ m_iVictimPlayerID

int SCR_InstigatorContextData::m_iVictimPlayerID

protected

Definition at line 3 of file SCR_InstigatorContextData.c.

◆ m_KillerEntity

IEntity SCR_InstigatorContextData::m_KillerEntity

protected

Definition at line 7 of file SCR_InstigatorContextData.c.

◆ m_VictimEntity

IEntity SCR_InstigatorContextData::m_VictimEntity

protected

Definition at line 6 of file SCR_InstigatorContextData.c.

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

scripts/Game/Damage/SCR_InstigatorContextData.c

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
SCR_ECharacterDisguiseType	m_eKillerDisguiseType = SCR_ECharacterDisguiseType.DEFAULT_FACTION
SCR_ECharacterDisguiseType	m_eVictimDisguiseType = SCR_ECharacterDisguiseType.DEFAULT_FACTION

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCR_InstigatorContextData()

Member Function Documentation

◆ CreateInstigatorData()

◆ DoesPlayerKillCountAsTeamKill()

◆ GetFaction()

◆ GetFactionFromPlayerID()

◆ GetInstigator()

◆ GetKillerCharacterControlType()

◆ GetKillerDisguiseType()

◆ GetKillerEntity()

◆ GetKillerPlayerID()

◆ GetVictimCharacterControlType()

◆ GetVictimDisguiseType()

◆ GetVictimEntity()

◆ GetVictimKillerRelation()

◆ GetVictimPlayerID()

◆ HasAnyKillerCharacterControlType()

◆ HasAnyVictimCharacterControlType()

◆ HasAnyVictimKillerRelation()

◆ IsEnemyKillPunished()

◆ SetPerceivedFaction()

Member Data Documentation

◆ m_eKillerControlType

◆ m_eKillerDisguiseType

◆ m_eVictimControlType

◆ m_eVictimDisguiseType

◆ m_eVictimKillerRelation

◆ m_iKillerPlayerID

◆ m_Instigator

◆ m_iVictimPlayerID

◆ m_KillerEntity

◆ m_VictimEntity