SCR_ArsenalRefundEffectComponentClass Class Reference

Inheritance diagram for SCR_ArsenalRefundEffectComponentClass:

Protected Member Functions
void	SCR_ArsenalRefundEffectComponentClass (IEntityComponentSource componentSource, IEntitySource parentSource, IEntitySource prefabSource)
void	InitClass (IEntityComponentSource componentSource, IEntitySource parentSource, IEntitySource prefabSource)
int	GetOrderedRefundEffects (notnull inout array< SCR_BaseArsenalRefundEffect > refundEffects)
SCR_BaseArsenalRefundEffect	GetValidEffect (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
SCR_BaseArsenalRefundEffect	ExecuteFirstValidRefundEffect (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)

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

Detailed Description

Definition at line 2 of file SCR_ArsenalRefundEffectComponent.c.

Constructor & Destructor Documentation

SCR_ArsenalRefundEffectComponentClass()

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

inlineprotected

Definition at line 10 of file SCR_ArsenalRefundEffectComponent.c.

Member Function Documentation

ExecuteFirstValidRefundEffect()

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

inlineprotected

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

Definition at line 110 of file SCR_ArsenalRefundEffectComponent.c.

GetOrderedRefundEffects()

int SCR_ArsenalRefundEffectComponentClass::GetOrderedRefundEffects ( notnull inout array< SCR_BaseArsenalRefundEffect > refundEffects )

inlineprotected

Get all refund effects in order. Weither they are valid or not

Parameters

[in,out]

refundEffects

All refund effects

Returns

Refund effect array count

Definition at line 64 of file SCR_ArsenalRefundEffectComponent.c.

GetValidEffect()

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

inlineprotected

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)

Definition at line 85 of file SCR_ArsenalRefundEffectComponent.c.

InitClass()

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

inlineprotected

Definition at line 16 of file SCR_ArsenalRefundEffectComponent.c.

Member Data Documentation

m_aArsenalRefundEffects

ref array<ref SCR_BaseArsenalRefundEffect> SCR_ArsenalRefundEffectComponentClass::m_aArsenalRefundEffects

protected

Definition at line 5 of file SCR_ArsenalRefundEffectComponent.c.

m_aOrderedArsenalRefundEffects

ref array<ref SCR_BaseArsenalRefundEffect> SCR_ArsenalRefundEffectComponentClass::m_aOrderedArsenalRefundEffects

protected

Definition at line 7 of file SCR_ArsenalRefundEffectComponent.c.

---

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

• scripts/Game/Inventory/ArsenalRefundEffects/SCR_ArsenalRefundEffectComponent.c