SCR_ConsumableItemComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_ConsumableItemComponentClass

Functions
SCR_ConsumableItemComponentClass SCR_GadgetComponentClass	Attribute ("", UIWidgets.Object, category:"Consumable")] protected ref SCR_ConsumableEffectBase m_ConsumableEffect
void	ApplyItemEffect (IEntity target, IEntity user, ItemUseParameters animParams, IEntity item, bool deleteItem=true)
void	OnUseBegan (IEntity item, ItemUseParameters animParams)
	OnItemUseBegan event from SCR_CharacterControllerComponent.
void	OnApplyToCharacter (IEntity item, bool successful, ItemUseParameters animParams)
	OnItemUseComplete event from SCR_CharacterControllerComponent.
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 ()
void	ClearInvokers (int targetGroup=-1)
override void	OnDelete (IEntity owner)
SCR_EConsumableType	GetConsumableType ()
SCR_ConsumableEffectBase	GetConsumableEffect ()
override EGadgetType	GetType ()
void	SetTargetCharacter (IEntity target)
IEntity	GetTargetCharacter ()

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

Function Documentation

ActivateAction()

override void ActivateAction ( )

protected

Definition at line 186 of file SCR_ConsumableItemComponent.c.

ApplyItemEffect()

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

protected

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"	)

ClearInvokers()

void ClearInvokers ( int targetGroup = -1 )

protected

Definition at line 195 of file SCR_ConsumableItemComponent.c.

GetConsumableEffect()

SCR_ConsumableEffectBase GetConsumableEffect ( )

protected

Get consumable effect

Returns

consumable effect

Definition at line 235 of file SCR_ConsumableItemComponent.c.

GetConsumableType()

SCR_EConsumableType GetConsumableType ( )

protected

Get consumable type

Returns

consumable type

Definition at line 224 of file SCR_ConsumableItemComponent.c.

GetTargetCharacter()

IEntity GetTargetCharacter ( )

protected

Returns

Definition at line 255 of file SCR_ConsumableItemComponent.c.

GetType()

override EGadgetType GetType ( )

protected

Definition at line 241 of file SCR_ConsumableItemComponent.c.

IsVisibleEquipped()

override bool IsVisibleEquipped ( )

protected

Definition at line 154 of file SCR_ConsumableItemComponent.c.

ModeClear()

override void ModeClear ( EGadgetMode mode )

protected

Definition at line 173 of file SCR_ConsumableItemComponent.c.

ModeSwitch()

override void ModeSwitch ( EGadgetMode mode, IEntity charOwner )

protected

Definition at line 160 of file SCR_ConsumableItemComponent.c.

OnApplyToCharacter()

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

protected

OnItemUseComplete event from SCR_CharacterControllerComponent.

Definition at line 62 of file SCR_ConsumableItemComponent.c.

OnDelete()

override void OnDelete ( IEntity owner )

protected

Definition at line 212 of file SCR_ConsumableItemComponent.c.

OnUseBegan()

void OnUseBegan ( IEntity item, ItemUseParameters animParams )

protected

OnItemUseBegan event from SCR_CharacterControllerComponent.

Definition at line 46 of file SCR_ConsumableItemComponent.c.

SetAlternativeModel()

void SetAlternativeModel ( bool useAlternative )

protected

Switch item model

Parameters

[in]

useAlternative

determines whether alternative or base model is used

Definition at line 117 of file SCR_ConsumableItemComponent.c.

SetHealedGroup()

void SetHealedGroup ( EBandagingAnimationBodyParts group, bool healed )

protected

Definition at line 94 of file SCR_ConsumableItemComponent.c.

SetTargetCharacter()

void SetTargetCharacter ( IEntity target )

protected

Parameters

[in]

target

Definition at line 248 of file SCR_ConsumableItemComponent.c.

Variable Documentation

m_bAlternativeModelOnAction

bool m_bAlternativeModelOnAction

protected

Definition at line 13 of file SCR_ConsumableItemComponent.c.

m_bVisibleEquipped

bool m_bVisibleEquipped

protected

Definition at line 16 of file SCR_ConsumableItemComponent.c.

m_CharController

SCR_CharacterControllerComponent m_CharController

protected

Definition at line 18 of file SCR_ConsumableItemComponent.c.

m_iStoredHealedGroup

int m_iStoredHealedGroup

protected

Definition at line 23 of file SCR_ConsumableItemComponent.c.

m_TargetCharacter

IEntity m_TargetCharacter

protected

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

Definition at line 21 of file SCR_ConsumableItemComponent.c.