SCR_BaseArsenalRefundEffect Interface Reference

Inheritance diagram for SCR_BaseArsenalRefundEffect:

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

Public Attributes
bool	m_bEnabled
int	m_iPriority

Protected Member Functions
bool	UsedFriendlyArsenal (notnull IEntity item, notnull PlayerController playerController, SCR_ArsenalComponent arsenal)
	Check if item was refunded at a friendly arsenal.

Protected Attributes
SCR_EArsenalTypes	m_eHandInArsenalTypes

Member Function Documentation

ExecuteRefundEffect()

bool SCR_BaseArsenalRefundEffect.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

Implemented in SCR_MultiExecuteListArsenalRefundEffect, SCR_ValuableIntelXPEffectEntry, and SCR_WeightedListArsenalRefundEffect.

Init()

void SCR_BaseArsenalRefundEffect.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

Implemented in SCR_MultiExecuteListArsenalRefundEffect, and SCR_WeightedListArsenalRefundEffect.

IsValid()

bool SCR_BaseArsenalRefundEffect.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

Implemented in SCR_MultiExecuteListArsenalRefundEffect, SCR_ValuableIntelArsenalRefundEffect, and SCR_WeightedListArsenalRefundEffect.

UsedFriendlyArsenal()

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

protected

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

Member Data Documentation

m_bEnabled

bool SCR_BaseArsenalRefundEffect.m_bEnabled

m_eHandInArsenalTypes

SCR_EArsenalTypes SCR_BaseArsenalRefundEffect.m_eHandInArsenalTypes

protected

m_iPriority

int SCR_BaseArsenalRefundEffect.m_iPriority

---

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

• Game/Inventory/ArsenalRefundEffects/SCR_BaseArsenalRefundEffect.c