SCR_ConsumableItemComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_ConsumableItemComponentClass

Functions
SCR_ConsumableItemComponentClass SCR_GadgetComponentClass	Attribute ("", UIWidgets.Object, category:"Consumable")] protected ref SCR_ConsumableEffectBase m_ConsumableEffect
void	ApplyItemEffect (IEntity target, ItemUseParameters animParams, IEntity item, bool deleteItem=true)
protected void	OnUseBegan (IEntity item, ItemUseParameters animParams)
	OnItemUseBegan event from SCR_CharacterControllerComponent. More...
protected void	OnApplyToCharacter (IEntity item, bool successful, ItemUseParameters animParams)
	OnItemUseComplete event from SCR_CharacterControllerComponent. More...
protected void	SetHealedGroup (EBandagingAnimationBodyParts group, bool healed)
void	SetAlternativeModel (bool useAlternative)
override bool	IsVisibleEquipped ()
override void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
override void	ModeClear (EGadgetMode mode)
override void	ActivateAction ()
protected void	ClearInvokers (int targetGroup=-1)
SCR_EConsumableType	GetConsumableType ()
SCR_ConsumableEffectBase	GetConsumableEffect ()
override EGadgetType	GetType ()
override bool	CanBeToggled ()
void	SetTargetCharacter (IEntity target)
IEntity	GetTargetCharacter ()

Variables
protected bool	m_bAlternativeModelOnAction
protected bool	m_bVisibleEquipped
protected SCR_CharacterControllerComponent	m_CharController
protected IEntity	m_TargetCharacter
	Target character is the target set when it's not m_CharacterOwner. More...
protected int	m_iStoredHealedGroup

Function Documentation

ActivateAction()

override void ActivateAction

(

)

Definition at line 188 of file SCR_ConsumableItemComponent.c.

ApplyItemEffect()

void ApplyItemEffect	(	IEntity	target,
		ItemUseParameters	animParams,
		IEntity	item,
		bool	deleteItem = true
	)

Apply consumable effect

Parameters

[in]	target	is the target entity
[in]	animParams
[in]	item
[in]	deleteItem

Definition at line 31 of file SCR_ConsumableItemComponent.c.

Attribute()

SCR_ConsumableItemComponentClass SCR_GadgetComponentClass Attribute	(	""	,
		UIWidgets.	Object,
		category:"Consumable"
	)

CanBeToggled()

override bool CanBeToggled

(

)

Definition at line 239 of file SCR_ConsumableItemComponent.c.

ClearInvokers()

protected void ClearInvokers

(

int

targetGroup = -1

)

Definition at line 197 of file SCR_ConsumableItemComponent.c.

GetConsumableEffect()

SCR_ConsumableEffectBase GetConsumableEffect

(

)

Get consumable effect

Returns

consumable effect

Definition at line 227 of file SCR_ConsumableItemComponent.c.

GetConsumableType()

SCR_EConsumableType GetConsumableType

(

)

Get consumable type

Returns

consumable type

Definition at line 216 of file SCR_ConsumableItemComponent.c.

GetTargetCharacter()

IEntity GetTargetCharacter

(

)

Returns

Definition at line 253 of file SCR_ConsumableItemComponent.c.

GetType()

override EGadgetType GetType

(

)

Definition at line 233 of file SCR_ConsumableItemComponent.c.

IsVisibleEquipped()

override bool IsVisibleEquipped

(

)

Definition at line 156 of file SCR_ConsumableItemComponent.c.

ModeClear()

override void ModeClear

(

EGadgetMode

mode

)

Definition at line 175 of file SCR_ConsumableItemComponent.c.

ModeSwitch()

override void ModeSwitch	(	EGadgetMode	mode,
		IEntity	charOwner
	)

Definition at line 162 of file SCR_ConsumableItemComponent.c.

OnApplyToCharacter()

protected void OnApplyToCharacter	(	IEntity	item,
		bool	successful,
		ItemUseParameters	animParams
	)

OnItemUseComplete event from SCR_CharacterControllerComponent.

Definition at line 59 of file SCR_ConsumableItemComponent.c.

OnUseBegan()

protected void OnUseBegan	(	IEntity	item,
		ItemUseParameters	animParams
	)

OnItemUseBegan event from SCR_CharacterControllerComponent.

Definition at line 46 of file SCR_ConsumableItemComponent.c.

SetAlternativeModel()

void SetAlternativeModel

(

bool

useAlternative

)

Switch item model

Parameters

[in]

useAlternative

determines whether alternative or base model is used

Definition at line 119 of file SCR_ConsumableItemComponent.c.

SetHealedGroup()

protected void SetHealedGroup	(	EBandagingAnimationBodyParts	group,
		bool	healed
	)

Definition at line 91 of file SCR_ConsumableItemComponent.c.

SetTargetCharacter()

void SetTargetCharacter

(

IEntity

target

)

Parameters

[in]

target

Definition at line 246 of file SCR_ConsumableItemComponent.c.

Variable Documentation

m_bAlternativeModelOnAction

protected bool m_bAlternativeModelOnAction

Definition at line 13 of file SCR_ConsumableItemComponent.c.

m_bVisibleEquipped

protected bool m_bVisibleEquipped

Definition at line 16 of file SCR_ConsumableItemComponent.c.

m_CharController

protected SCR_CharacterControllerComponent m_CharController

Definition at line 18 of file SCR_ConsumableItemComponent.c.

m_iStoredHealedGroup

protected int m_iStoredHealedGroup

Definition at line 23 of file SCR_ConsumableItemComponent.c.

m_TargetCharacter

protected IEntity m_TargetCharacter

Target character is the target set when it's not m_CharacterOwner.

Definition at line 21 of file SCR_ConsumableItemComponent.c.