SCR_WeightedListArsenalRefundEffect Interface Reference

Holds an array of effects that are executed using a weighted randomization. More...

Inheritance diagram for SCR_WeightedListArsenalRefundEffect:

Public Member Functions
override void	Init (SCR_ArsenalRefundEffectComponentClass arsenalRefundEffectClass)
	Init of effect before adding them to the order array in SCR_ArsenalRefundEffectComponentClass.
override bool	IsValid (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
	Returns if effect is valid always called before ExecuteRefundEffect_S.
override bool	ExecuteRefundEffect (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
	Execute refund effect (Called on server only)

Protected Member Functions
bool	HasValidEntries (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
int	GetValidEntries (notnull inout array< SCR_BaseWeightedArsenalRefundEffectEntry > validEntries, notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
Protected Member Functions inherited from SCR_BaseArsenalRefundEffect
bool	UsedFriendlyArsenal (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
	Check if item was refunded at a friendly arsenal.

Protected Attributes
ref array< ref SCR_BaseWeightedArsenalRefundEffectEntry >	m_aWeightedEffectEntries
Protected Attributes inherited from SCR_BaseArsenalRefundEffect
SCR_EArsenalTypes	m_eHandInArsenalTypes

Additional Inherited Members
Public Attributes inherited from SCR_BaseArsenalRefundEffect
bool	m_bEnabled
int	m_iPriority

Detailed Description

Holds an array of effects that are executed using a weighted randomization.

Member Function Documentation

ExecuteRefundEffect()

override bool SCR_WeightedListArsenalRefundEffect.ExecuteRefundEffect	(	notnull IEntity	item,
		notnull PlayerController	playerController,
		SCR_ArsenalComponent	arsenal )

Execute refund effect (Called on server only)

Parameters

[in]	item	Item that is being refunded
[in]	playerController	Player controller of player that refunds the item
[in]	arsenal	Arsenal the item was refunded at (Can potentially be null)

Returns

True if effect was succesfully executed

Implements SCR_BaseArsenalRefundEffect.

GetValidEntries()

int SCR_WeightedListArsenalRefundEffect.GetValidEntries ( notnull inout array< SCR_BaseWeightedArsenalRefundEffectEntry > validEntries, notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal )

protected

HasValidEntries()

bool SCR_WeightedListArsenalRefundEffect.HasValidEntries ( notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal )

protected

Init()

override void SCR_WeightedListArsenalRefundEffect.Init

(

SCR_ArsenalRefundEffectComponentClass

arsenalRefundEffectClass

)

Init of effect before adding them to the order array in SCR_ArsenalRefundEffectComponentClass.

Parameters

[in]

arsenalRefundEffectClass

Class it is attached to

Implements SCR_BaseArsenalRefundEffect.

IsValid()

override bool SCR_WeightedListArsenalRefundEffect.IsValid	(	notnull IEntity	item,
		notnull PlayerController	playerController,
		SCR_ArsenalComponent	arsenal )

Returns if effect is valid always called before ExecuteRefundEffect_S.

Parameters

[in]	item	Item that is being refunded
[in]	playerController	Player controller of player that refunds the item
[in]	arsenal	Arsenal the item was refunded at (Can potentially be null)

Returns

If the refund effect is valid

Check if handed in at arsenal and if the arsenal type is supported

Implements SCR_BaseArsenalRefundEffect.

Implemented in SCR_ValuableIntelArsenalRefundEffect.

Member Data Documentation

m_aWeightedEffectEntries

ref array<ref SCR_BaseWeightedArsenalRefundEffectEntry> SCR_WeightedListArsenalRefundEffect.m_aWeightedEffectEntries

protected

---

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

• Game/Inventory/ArsenalRefundEffects/SCR_WeightedListArsenalRefundEffect.c