SCR_ArsenalRefundEffectComponentClass Interface Reference

Inheritance diagram for SCR_ArsenalRefundEffectComponentClass:

Public Member Functions
void	SCR_ArsenalRefundEffectComponentClass (IEntityComponentSource componentSource, IEntitySource parentSource, IEntitySource prefabSource)
int	GetOrderedRefundEffects (notnull inout array< SCR_BaseArsenalRefundEffect > refundEffects)
	Get all refund effects in order.
SCR_BaseArsenalRefundEffect	GetValidEffect (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
	Returns first valid refund effect.
SCR_BaseArsenalRefundEffect	ExecuteFirstValidRefundEffect (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
	Executes the first valid refund effect.

Protected Member Functions
void	InitClass (IEntityComponentSource componentSource, IEntitySource parentSource, IEntitySource prefabSource)

Protected Attributes
ref array< ref SCR_BaseArsenalRefundEffect >	m_aArsenalRefundEffects
ref array< ref SCR_BaseArsenalRefundEffect >	m_aOrderedArsenalRefundEffects

Constructor & Destructor Documentation

SCR_ArsenalRefundEffectComponentClass()

void SCR_ArsenalRefundEffectComponentClass.SCR_ArsenalRefundEffectComponentClass	(	IEntityComponentSource	componentSource,
		IEntitySource	parentSource,
		IEntitySource	prefabSource )

Member Function Documentation

ExecuteFirstValidRefundEffect()

SCR_BaseArsenalRefundEffect SCR_ArsenalRefundEffectComponentClass.ExecuteFirstValidRefundEffect	(	notnull IEntity	item,
		notnull PlayerController	playerController,
		SCR_ArsenalComponent	arsenal )

Executes the first valid refund effect.

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

Returns the effect that was executed

GetOrderedRefundEffects()

int SCR_ArsenalRefundEffectComponentClass.GetOrderedRefundEffects

(

notnull inout array< SCR_BaseArsenalRefundEffect >

refundEffects

)

Get all refund effects in order.

Weither they are valid or not

Parameters

[in,out]

refundEffects

All refund effects

Returns

Refund effect array count

GetValidEffect()

SCR_BaseArsenalRefundEffect SCR_ArsenalRefundEffectComponentClass.GetValidEffect	(	notnull IEntity	item,
		notnull PlayerController	playerController,
		SCR_ArsenalComponent	arsenal )

Returns first valid refund effect.

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

Refund effect (Can be null)

InitClass()

void SCR_ArsenalRefundEffectComponentClass.InitClass ( IEntityComponentSource componentSource, IEntitySource parentSource, IEntitySource prefabSource )

protected

Member Data Documentation

m_aArsenalRefundEffects

ref array<ref SCR_BaseArsenalRefundEffect> SCR_ArsenalRefundEffectComponentClass.m_aArsenalRefundEffects

protected

m_aOrderedArsenalRefundEffects

ref array<ref SCR_BaseArsenalRefundEffect> SCR_ArsenalRefundEffectComponentClass.m_aOrderedArsenalRefundEffects

protected

---

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

• Game/Inventory/ArsenalRefundEffects/SCR_ArsenalRefundEffectComponent.c