SCR_ConsumableBandage Interface Reference

Bandage effect. More...

Inheritance diagram for SCR_ConsumableBandage:

Public Member Functions
override void	ApplyEffect (notnull IEntity target, notnull IEntity user, IEntity item, ItemUseParameters animParams)
	Apply consumable effect.
override bool	CanApplyEffect (notnull IEntity target, notnull IEntity user, out SCR_EConsumableFailReason failReason)
	Condition whether this effect can be applied.
override 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.
override ItemUseParameters	GetAnimationParameters (IEntity item, notnull IEntity target, ECharacterHitZoneGroup group=ECharacterHitZoneGroup.VIRTUAL)
	Optional param for specific hitzone, still will ensure external users don't have to create their own local animParams.
void	SCR_ConsumableBandage ()
Public Member Functions inherited from SCR_ConsumableEffectHealthItems
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	ActivateEffect (IEntity target, IEntity user, IEntity item, ItemUseParameters animParams=null)
void	ApplyEffect (notnull IEntity target, notnull IEntity user, IEntity item, ItemUseParameters animParams)
	Apply consumable effect.
bool	CanApplyEffect (notnull IEntity target, notnull IEntity user, out SCR_EConsumableFailReason failReason=SCR_EConsumableFailReason.NONE)
	Condition whether this effect can be applied.
bool	UpdateAnimationCommands (IEntity user)
	Update the animCommands for all animations related to consumable.
ItemUseParameters	GetAnimationParameters (IEntity item, notnull IEntity target, ECharacterHitZoneGroup group=ECharacterHitZoneGroup.VIRTUAL)
bool	GetDeleteOnUse ()
float	GetApplyToOtherDuraction ()
TAnimGraphCommand	GetApplyToSelfAnimCmnd (IEntity user)
TAnimGraphCommand	GetApplyToOtherAnimCmnd (IEntity user)

Additional Inherited Members
Public Attributes inherited from SCR_ConsumableEffectBase
SCR_EConsumableType	m_eConsumableType
Protected Attributes inherited from SCR_ConsumableEffectHealthItems
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

Detailed Description

Bandage effect.

Constructor & Destructor Documentation

SCR_ConsumableBandage()

void SCR_ConsumableBandage.SCR_ConsumableBandage

(

)

Member Function Documentation

ApplyEffect()

override void SCR_ConsumableBandage.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_ConsumableEffectHealthItems.

CanApplyEffect()

override bool SCR_ConsumableBandage.CanApplyEffect	(	notnull IEntity	target,
		notnull IEntity	user,
		out SCR_EConsumableFailReason	failReason
	)

Condition whether this effect can be applied.

Parameters

[in]	target	is the character who is having the effect applied
[in]	user
[in]	failReason	is reason why CanApplyEffect returned false

Returns

Implements SCR_ConsumableEffectBase.

CanApplyEffectToHZ()

override bool SCR_ConsumableBandage.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

Implements SCR_ConsumableEffectHealthItems.

GetAnimationParameters()

override ItemUseParameters SCR_ConsumableBandage.GetAnimationParameters	(	IEntity	item,
		notnull IEntity	target,
		ECharacterHitZoneGroup	group = ECharacterHitZoneGroup::VIRTUAL
	)

Optional param for specific hitzone, still will ensure external users don't have to create their own local animParams.

Implements SCR_ConsumableEffectBase.

---

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

• Game/Components/Gadgets/SCR_ConsumableBandage.c