SCR_ConsumableEffectHealthItems Interface Reference

Inheritance diagram for SCR_ConsumableEffectHealthItems:

Public Member Functions
override bool	ActivateEffect (IEntity target, IEntity user, IEntity item, ItemUseParameters animParams=null)
override void	ApplyEffect (notnull IEntity target, notnull IEntity user, IEntity item, ItemUseParameters animParams)
	Apply consumable effect.
void	AddConsumableDamageEffects (notnull ChimeraCharacter char, IEntity instigator)
float	GetItemRegenSpeed ()
override bool	UpdateAnimationCommands (IEntity user)
	Update the animCommands for all animations related to consumable.
bool	CanApplyEffectToHZ (notnull IEntity target, notnull IEntity user, ECharacterHitZoneGroup group, out SCR_EConsumableFailReason failReason=SCR_EConsumableFailReason.NONE)
	Condition whether this effect can be applied to the specific hit zone.
TAnimGraphCommand	GetReviveAnimCmnd (IEntity user)
ECharacterHitZoneGroup	GetTargetHitZoneGroup ()
Public Member Functions inherited from SCR_ConsumableEffectBase
bool	CanApplyEffect (notnull IEntity target, notnull IEntity user, out SCR_EConsumableFailReason failReason=SCR_EConsumableFailReason.NONE)
	Condition whether this effect can be applied.
ItemUseParameters	GetAnimationParameters (IEntity item, notnull IEntity target, ECharacterHitZoneGroup group=ECharacterHitZoneGroup.VIRTUAL)
bool	GetDeleteOnUse ()
float	GetApplyToOtherDuraction ()
TAnimGraphCommand	GetApplyToSelfAnimCmnd (IEntity user)
TAnimGraphCommand	GetApplyToOtherAnimCmnd (IEntity user)

Protected Attributes
float	m_fItemRegenerationSpeed
float	m_fItemRegenerationDuration
float	m_fItemAbsoluteRegenerationAmount
ref array< ref SCR_DamageEffect >	m_aDamageEffectsToLoad
ECharacterHitZoneGroup	m_eTargetHZGroup
Protected Attributes inherited from SCR_ConsumableEffectBase
TAnimGraphCommand	m_iPlayerApplyToSelfCmdId = -1
TAnimGraphCommand	m_iPlayerApplyToOtherCmdId = -1
TAnimGraphCommand	m_iPlayerReviveCmdId = -1
bool	m_bDeleteOnUse
float	m_fApplyToSelfDuration
float	m_fApplyToOtherDuration

Additional Inherited Members
Public Attributes inherited from SCR_ConsumableEffectBase
SCR_EConsumableType	m_eConsumableType

Member Function Documentation

ActivateEffect()

override bool SCR_ConsumableEffectHealthItems.ActivateEffect	(	IEntity	target,
		IEntity	user,
		IEntity	item,
		ItemUseParameters	animParams = null )

Parameters

[in]	target
[in]	user
[in]	item
[in]	animParams

Returns

Implements SCR_ConsumableEffectBase.

AddConsumableDamageEffects()

void SCR_ConsumableEffectHealthItems.AddConsumableDamageEffects	(	notnull ChimeraCharacter char	,
		IEntity	instigator )

ApplyEffect()

override void SCR_ConsumableEffectHealthItems.ApplyEffect	(	notnull IEntity	target,
		notnull IEntity	user,
		IEntity	item,
		ItemUseParameters	animParams )

Apply consumable effect.

Parameters

[in]	target	is the character who is having the effect applied
[in]	user
[in]	item
[in]	animParams

Implements SCR_ConsumableEffectBase.

Implemented in SCR_ConsumableBandage, SCR_ConsumableSalineBag, and SCR_ConsumableTourniquet.

CanApplyEffectToHZ()

bool SCR_ConsumableEffectHealthItems.CanApplyEffectToHZ	(	notnull IEntity	target,
		notnull IEntity	user,
		ECharacterHitZoneGroup	group,
		out SCR_EConsumableFailReason	failReason = SCR_EConsumableFailReason.NONE )

Condition whether this effect can be applied to the specific hit zone.

Parameters

[in]	target	is the character who is having the effect applied
[in]	user
[in]	group	the hitzonegroup which is having the effect applied
[in]	failReason

Implemented in SCR_ConsumableBandage, SCR_ConsumableMorphine, SCR_ConsumableSalineBag, and SCR_ConsumableTourniquet.

GetItemRegenSpeed()

float SCR_ConsumableEffectHealthItems.GetItemRegenSpeed

(

)

GetReviveAnimCmnd()

TAnimGraphCommand SCR_ConsumableEffectHealthItems.GetReviveAnimCmnd

(

IEntity

user

)

Parameters

[in]

user

Returns

GetTargetHitZoneGroup()

ECharacterHitZoneGroup SCR_ConsumableEffectHealthItems.GetTargetHitZoneGroup

(

)

UpdateAnimationCommands()

override bool SCR_ConsumableEffectHealthItems.UpdateAnimationCommands

(

IEntity

user

)

Update the animCommands for all animations related to consumable.

Implements SCR_ConsumableEffectBase.

Member Data Documentation

m_aDamageEffectsToLoad

ref array<ref SCR_DamageEffect> SCR_ConsumableEffectHealthItems.m_aDamageEffectsToLoad

protected

m_eTargetHZGroup

ECharacterHitZoneGroup SCR_ConsumableEffectHealthItems.m_eTargetHZGroup

protected

m_fItemAbsoluteRegenerationAmount

float SCR_ConsumableEffectHealthItems.m_fItemAbsoluteRegenerationAmount

protected

m_fItemRegenerationDuration

float SCR_ConsumableEffectHealthItems.m_fItemRegenerationDuration

protected

m_fItemRegenerationSpeed

float SCR_ConsumableEffectHealthItems.m_fItemRegenerationSpeed

protected

---

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

• Game/Components/Gadgets/SCR_ConsumableEffectHealthItems.c