SCR_BaseArsenalRefundEffect Class Reference

Inheritance diagram for SCR_BaseArsenalRefundEffect:

Protected Member Functions
void	Init (SCR_ArsenalRefundEffectComponentClass arsenalRefundEffectClass)
bool	IsValid (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
bool	ExecuteRefundEffect (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
bool	UsedFriendlyArsenal (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)

Protected Attributes
SCR_EArsenalTypes	m_eHandInArsenalTypes

Detailed Description

Definition at line 2 of file SCR_BaseArsenalRefundEffect.c.

Member Function Documentation

ExecuteRefundEffect()

bool SCR_BaseArsenalRefundEffect::ExecuteRefundEffect ( notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal )

protected

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

Init()

void SCR_BaseArsenalRefundEffect::Init ( SCR_ArsenalRefundEffectComponentClass arsenalRefundEffectClass )

protected

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

Parameters

[in]

arsenalRefundEffectClass

Class it is attached to

IsValid()

bool SCR_BaseArsenalRefundEffect::IsValid ( notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal )

inlineprotected

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

Definition at line 24 of file SCR_BaseArsenalRefundEffect.c.

UsedFriendlyArsenal()

bool SCR_BaseArsenalRefundEffect::UsedFriendlyArsenal ( notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal )

inlineprotected

Check if item was refunded at a friendly arsenal

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 item was handed in at a friendly arsenal. If there was no arsenal, if arsenal has no faction or if it is hostile faction it will return false

Definition at line 44 of file SCR_BaseArsenalRefundEffect.c.

Member Data Documentation

m_eHandInArsenalTypes

SCR_EArsenalTypes SCR_BaseArsenalRefundEffect::m_eHandInArsenalTypes

protected

Definition at line 11 of file SCR_BaseArsenalRefundEffect.c.

---

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

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