Inheritance diagram for SCR_ConsumableItemComponent:

[legend]

Public Member Functions
void	ApplyItemEffect (IEntity target, IEntity user, ItemUseParameters animParams, IEntity item, bool deleteItem=true)
	Apply consumable effect.

void	SetAlternativeModel (bool useAlternative)
	Switch item model.

override bool	IsVisibleEquipped ()
	Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.

override void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
	Set gadget mode.

override void	ModeClear (EGadgetMode mode)
	Clear gadget mode.

override void	ActivateAction ()
	Action listener callback.

SCR_EConsumableType	GetConsumableType ()
	Get consumable type.

SCR_ConsumableEffectBase	GetConsumableEffect ()
	Get consumable effect.

override EGadgetType	GetType ()
	Get gadget type.

void	SetTargetCharacter (IEntity target)

IEntity	GetTargetCharacter ()

Public Member Functions inherited from SCR_GadgetComponent
EGadgetAnimVariable	GetAnimVariable ()

float	GetWeaponNoFireTime ()

bool	IsToggledOn ()
	Is gadget toggled on/off.

void	OnToggleActive (bool state)
	Event called from SCR_GadgetManagerComponent through RPC request.

void	OnParentSlotChanged (InventoryStorageSlot oldSlot, InventoryStorageSlot newSlot)
	InventoryItemComponent event.

void	OnModeChanged (EGadgetMode mode, IEntity charOwner)
	Gadget mode change event.

void	OnSlotOccludedStateChanged (bool occluded)
	Method called when slot to which item is attached to changed its occlusion state.

void	ActivateGadgetUpdate ()
	Activate gadget frame update.

void	DeactivateGadgetUpdate ()
	Deactivate gadget frame flag.

void	UpdateVisibility (EGadgetMode mode)
	Set visibility when show/hide hand animation starts/finishes.

void	ToggleActive (bool state, SCR_EUseContext context)
	Synchronise gadget state.

void	ActivateAction ()
	Action listener callback.

void	ToggleFocused (bool enable)
	Toggle gadget focus state.

IEntity	GetCharacterOwner ()
	Get IEntity in possession of this Gadget.

EGadgetType	GetType ()
	Get gadget type.

EGadgetMode	GetMode ()
	Get gadget mode.

bool	CanBeHeld ()
	Can be held in hand.

SCR_EUseContext	GetUseMask ()
	Provides value that contains mask of contexts from which this gadget can be toggled.

bool	CanBeRaised ()
	Gadget has a raised animation version.

bool	IsUsingADSControls ()
	Gadget uses ADS controls from gadget raisable context.

bool	IsVisibleEquipped ()
	Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.

void	Update (float timeSlice)

override bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

override void	OnDelete (IEntity owner)

override void	OnPostInit (IEntity owner)

Protected Member Functions
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	ClearInvokers (int targetGroup=-1)

Protected Member Functions inherited from SCR_GadgetComponent
void	ModeSwitch (EGadgetMode mode, IEntity charOwner)
	Set gadget mode.

void	ModeClear (EGadgetMode mode)
	Clear gadget mode.

void	ConnectToGadgetsSystem ()
	Starts on frame update event.

void	DisconnectFromGadgetsSystem ()

Protected Member Functions inherited from ScriptGameComponent
bool	OnTicksOnRemoteProxy ()

Protected Attributes
ref SCR_ConsumableEffectBase	m_ConsumableEffect

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

Protected Attributes inherited from SCR_GadgetComponent
EGadgetAnimVariable	m_eAnimVariable

SCR_EUseContext	m_eUseMask

vector	m_vEquipmentSlotOffset

float	m_fWeaponNoFireTime

bool	m_bActivated = false

EGadgetMode	m_iMode = EGadgetMode.ON_GROUND

IEntity	m_CharacterOwner

Additional Inherited Members
Public Attributes inherited from SCR_GadgetComponent
bool	m_bFocused

Member Function Documentation

◆ ActivateAction()

override void SCR_ConsumableItemComponent.ActivateAction ( )

Action listener callback.

Implements SCR_GadgetComponent.

◆ ApplyItemEffect()

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

Apply consumable effect.

Parameters

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

◆ ClearInvokers()

void SCR_ConsumableItemComponent.ClearInvokers ( int targetGroup = -1 )

protected

◆ GetConsumableEffect()

SCR_ConsumableEffectBase SCR_ConsumableItemComponent.GetConsumableEffect ( )

Get consumable effect.

Returns: consumable effect

◆ GetConsumableType()

SCR_EConsumableType SCR_ConsumableItemComponent.GetConsumableType ( )

Get consumable type.

Returns: consumable type

◆ GetTargetCharacter()

IEntity SCR_ConsumableItemComponent.GetTargetCharacter ( )

Returns

◆ GetType()

override EGadgetType SCR_ConsumableItemComponent.GetType ( )

Get gadget type.

Returns: Returns gadget type

Implements SCR_GadgetComponent.

◆ IsVisibleEquipped()

override bool SCR_ConsumableItemComponent.IsVisibleEquipped ( )

Visible when attached to character gear, further condition may determine visibility, such as if the equipment slot is obstructed by something else.

Returns: Returns true if visible in equipment slot

Implements SCR_GadgetComponent.

◆ ModeClear()

override void SCR_ConsumableItemComponent.ModeClear ( EGadgetMode mode )

Clear gadget mode.

Parameters

[in] mode is the mode being cleared

Implements SCR_GadgetComponent.

◆ ModeSwitch()

override void SCR_ConsumableItemComponent.ModeSwitch	(	EGadgetMode	mode,
		IEntity	charOwner
	)

Set gadget mode.

Parameters

[in]	mode	is the target mode being switched to
[in]	charOwner

Implements SCR_GadgetComponent.

◆ OnApplyToCharacter()

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

protected

OnItemUseComplete event from SCR_CharacterControllerComponent.

◆ OnUseBegan()

void SCR_ConsumableItemComponent.OnUseBegan	(	IEntity	item,
		ItemUseParameters	animParams
	)

protected

OnItemUseBegan event from SCR_CharacterControllerComponent.

◆ SetAlternativeModel()

void SCR_ConsumableItemComponent.SetAlternativeModel ( bool useAlternative )

Switch item model.

Parameters

[in] useAlternative determines whether alternative or base model is used

◆ SetHealedGroup()

void SCR_ConsumableItemComponent.SetHealedGroup	(	EBandagingAnimationBodyParts	group,
		bool	healed
	)

protected

◆ SetTargetCharacter()

void SCR_ConsumableItemComponent.SetTargetCharacter ( IEntity target )

Parameters

[in] target

Member Data Documentation

◆ m_bAlternativeModelOnAction

bool SCR_ConsumableItemComponent.m_bAlternativeModelOnAction

protected

◆ m_bVisibleEquipped

bool SCR_ConsumableItemComponent.m_bVisibleEquipped

protected

◆ m_CharController

SCR_CharacterControllerComponent SCR_ConsumableItemComponent.m_CharController

protected

◆ m_ConsumableEffect

ref SCR_ConsumableEffectBase SCR_ConsumableItemComponent.m_ConsumableEffect

protected

◆ m_iStoredHealedGroup

int SCR_ConsumableItemComponent.m_iStoredHealedGroup

protected

◆ m_TargetCharacter

IEntity SCR_ConsumableItemComponent.m_TargetCharacter

protected

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

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

Game/Components/Gadgets/SCR_ConsumableItemComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ ActivateAction()

◆ ApplyItemEffect()

◆ ClearInvokers()

◆ GetConsumableEffect()

◆ GetConsumableType()

◆ GetTargetCharacter()

◆ GetType()

◆ IsVisibleEquipped()

◆ ModeClear()

◆ ModeSwitch()

◆ OnApplyToCharacter()

◆ OnUseBegan()

◆ SetAlternativeModel()

◆ SetHealedGroup()

◆ SetTargetCharacter()

Member Data Documentation

◆ m_bAlternativeModelOnAction

◆ m_bVisibleEquipped

◆ m_CharController

◆ m_ConsumableEffect

◆ m_iStoredHealedGroup

◆ m_TargetCharacter