SCR_ConsumableEffectBase Interface Reference

Effect assigned to the consumable gadget. More...

Inheritance diagram for SCR_ConsumableEffectBase:

Public Member Functions
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)

Public Attributes
SCR_EConsumableType	m_eConsumableType

Protected Attributes
TAnimGraphCommand	m_iPlayerApplyToSelfCmdId = -1
TAnimGraphCommand	m_iPlayerApplyToOtherCmdId = -1
TAnimGraphCommand	m_iPlayerReviveCmdId = -1
bool	m_bDeleteOnUse
float	m_fApplyToSelfDuration
float	m_fApplyToOtherDuration

Detailed Description

Effect assigned to the consumable gadget.

Member Function Documentation

ActivateEffect()

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

Parameters

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

Returns

Implemented in SCR_ConsumableEffectHealthItems.

ApplyEffect()

void SCR_ConsumableEffectBase.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

Implemented in SCR_ConsumableBandage, SCR_ConsumableEffectHealthItems, SCR_ConsumableSalineBag, and SCR_ConsumableTourniquet.

CanApplyEffect()

bool SCR_ConsumableEffectBase.CanApplyEffect	(	notnull IEntity	target,
		notnull IEntity	user,
		out SCR_EConsumableFailReason	failReason = SCR_EConsumableFailReason.NONE
	)

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

Implemented in SCR_ConsumableBandage, SCR_ConsumableMorphine, SCR_ConsumableSalineBag, and SCR_ConsumableTourniquet.

GetAnimationParameters()

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

Parameters

[in]	target
[in]	group

Returns

Implemented in SCR_ConsumableBandage, and SCR_ConsumableTourniquet.

GetApplyToOtherAnimCmnd()

TAnimGraphCommand SCR_ConsumableEffectBase.GetApplyToOtherAnimCmnd

(

IEntity

user

)

Parameters

[in]

user

Returns

GetApplyToOtherDuraction()

float SCR_ConsumableEffectBase.GetApplyToOtherDuraction

(

)

Returns

GetApplyToSelfAnimCmnd()

TAnimGraphCommand SCR_ConsumableEffectBase.GetApplyToSelfAnimCmnd

(

IEntity

user

)

Parameters

[in]

user

Returns

GetDeleteOnUse()

bool SCR_ConsumableEffectBase.GetDeleteOnUse

(

)

Returns

UpdateAnimationCommands()

bool SCR_ConsumableEffectBase.UpdateAnimationCommands

(

IEntity

user

)

Update the animCommands for all animations related to consumable.

Implemented in SCR_ConsumableEffectHealthItems.

Member Data Documentation

m_bDeleteOnUse

bool SCR_ConsumableEffectBase.m_bDeleteOnUse

protected

m_eConsumableType

SCR_EConsumableType SCR_ConsumableEffectBase.m_eConsumableType

m_fApplyToOtherDuration

float SCR_ConsumableEffectBase.m_fApplyToOtherDuration

protected

m_fApplyToSelfDuration

float SCR_ConsumableEffectBase.m_fApplyToSelfDuration

protected

m_iPlayerApplyToOtherCmdId

TAnimGraphCommand SCR_ConsumableEffectBase.m_iPlayerApplyToOtherCmdId = -1

protected

m_iPlayerApplyToSelfCmdId

TAnimGraphCommand SCR_ConsumableEffectBase.m_iPlayerApplyToSelfCmdId = -1

protected

m_iPlayerReviveCmdId

TAnimGraphCommand SCR_ConsumableEffectBase.m_iPlayerReviveCmdId = -1

protected

---

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

• Game/Components/Gadgets/SCR_ConsumableEffectBase.c