SCR_ArsenalDisplayComponent Interface Reference

Inheritance diagram for SCR_ArsenalDisplayComponent:

Public Member Functions
override void	SetSupportedArsenalItemTypes (SCR_EArsenalItemType types)
override void	SetSupportedArsenalItemModes (SCR_EArsenalItemMode modes)
override void	OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction newFaction)
override void	OnArsenalGameModeTypeChanged (SCR_EArsenalGameModeType newArsenalGameModeType)
override void	ClearArsenal ()
	Remove every slot's item.
override void	RefreshArsenal (SCR_Faction faction=null)
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
Public Member Functions inherited from SCR_ArsenalComponent
SCR_EArsenalTypes	GetArsenalType ()
bool	IsArsenalEnabledByType ()
bool	IsArsenalEnabled ()
void	SetArsenalEnabled (bool enable, bool isOverwrite=true)
SCR_EArsenalSupplyCostType	GetSupplyCostType ()
bool	IsArsenalUsingSupplies ()
SCR_EArsenalSaveType	GetArsenalSaveType ()
bool	IsArsenalSavingDisplayedIfDisabled ()
void	SetHasSaveArsenalAction (bool hasSaveArsenalAction)
	Set if arsenal save action is on the action manager.
bool	HasSaveArsenalAction ()
	Check if Arsenal has an arsenal action attached to it.
void	SetArsenalSaveType (SCR_EArsenalSaveType saveType)
	Set Arsenal Save type (Server Only)
void	RPL_SetArsenalSaveType (SCR_EArsenalSaveType saveType)
SCR_EArsenalItemType	GetSupportedArsenalItemTypes ()
void	SetSupportedArsenalItemTypes (SCR_EArsenalItemType types)
SCR_EArsenalItemMode	GetSupportedArsenalItemModes ()
void	SetSupportedArsenalItemModes (SCR_EArsenalItemMode modes)
SCR_EArsenalAttributeGroup	GetEditableAttributeGroups ()
SCR_ArsenalInventoryStorageManagerComponent	GetArsenalInventoryComponent ()
SCR_ArsenalItemListConfig	GetOverwriteArsenalConfig ()
	Get overwrite Arsenal config.
bool	GetAvailablePrefabs (out notnull array< ResourceName > availablePrefabs)
SCR_Faction	GetAssignedFaction ()
bool	GetFilteredArsenalItems (out notnull array< SCR_ArsenalItem > filteredArsenalItems, EArsenalItemDisplayType requiresDisplayType=-1)
bool	GetFilteredOverwriteArsenalItems (out notnull array< SCR_ArsenalItem > filteredArsenalItems, EArsenalItemDisplayType requiresDisplayType=-1)
	Get filtered overwrite Arsenal EWorkshopItemState.
void	ClearArsenal ()
void	RefreshArsenal (SCR_Faction faction=null)
ScriptInvokerArsenalUpdated	GetOnArsenalUpdated ()
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)

Protected Member Functions
void	RegisterSlot (SCR_WeaponRackSlotEntity slot)
void	RefreshUpdate ()
	Refresh arsenal after m_fRefreshDelay delay.
bool	GetSlotValid (SCR_WeaponRackSlotEntity slotEntity, out bool isEmpty=true)
bool	GetItemValidForSlot (SCR_EArsenalItemType itemType, SCR_EArsenalItemMode itemMode, SCR_EArsenalItemType supportedSlotTypes, SCR_EArsenalItemMode supportedSlotModes)
override void	OnDelete (IEntity owner)
Protected Member Functions inherited from SCR_ArsenalComponent
void	OnArsenalTypeEnabledChanged (SCR_EArsenalTypes typesEnabled)
void	UpdateArsenalEnabledState ()
void	SetArsenalEnabledBroadcast (bool enable)
void	RPC_OnArsenalUpdated (SCR_EArsenalItemType itemTypes, SCR_EArsenalItemMode itemModes)
void	DelayedOnArsenalUpdatedClient (SCR_EArsenalItemType itemTypes, SCR_EArsenalItemMode itemModes)
bool	GetItemValid (SCR_EArsenalItemType arsenalItemType, SCR_EArsenalItemMode arsenalItemMode)
bool	GetItemValid (SCR_Faction faction, int index, out bool isEmpty=true)
void	OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction newFaction)
void	OnArsenalGameModeTypeChanged (SCR_EArsenalGameModeType newArsenalGameModeType)
override void	OnPostInit (IEntity owner)
override void	EOnInit (IEntity owner)
void	FactionInit (IEntity owner)
override void	OnDelete (IEntity owner)

Protected Attributes
EArsenalItemDisplayType	m_eArsenalItemDisplayType
float	m_fRefreshDelay
ref array< SCR_WeaponRackSlotEntity >	m_aSlots = {}
Protected Attributes inherited from SCR_ArsenalComponent
SCR_EArsenalSupplyCostType	m_eSupplyCostType
SCR_EArsenalItemType	m_eSupportedArsenalItemTypes
SCR_EArsenalItemMode	m_eSupportedArsenalItemModes
SCR_EArsenalAttributeGroup	m_eEditableAttributeGroups
ref SCR_ArsenalItemListConfig	m_OverwriteArsenalConfig
bool	m_bGetDefaultIfNoFaction
bool	m_bAllowGetFactionFromParent
SCR_EArsenalSaveType	m_eArsenalSaveType
SCR_EArsenalTypes	m_eArsenalTypes
bool	m_bAlwaysUseDefaultFaction
bool	m_bArsenalEnabled
bool	m_bArsenalEnabledOverwritten
SCR_EArsenalItemMode	m_eOnDisableArsenalModes
bool	m_bArsenalSavingDisplayedIfDisabled = true
	This is auto set on init and when arsenal save type is changed.
bool	m_bHasSaveArsenalAction = false
	Set by action in action manager for the editor to know if the Arsenal save action exists on this arsenal.
SCR_ArsenalInventoryStorageManagerComponent	m_InventoryComponent
UniversalInventoryStorageComponent	m_StorageComponent
FactionManager	m_FactionManager
SCR_FactionAffiliationComponent	m_FactionComponent
ref ScriptInvokerArsenalUpdated	m_OnArsenalUpdated
bool	m_bIsClearingInventory

Additional Inherited Members
Static Public Member Functions inherited from SCR_ArsenalComponent
static SCR_ArsenalComponent	FindArsenalComponent (notnull IEntity entity, bool getFromSlotted=true)
	Returns the first arsenal component found on the children of the given parent.

Member Function Documentation

ClearArsenal()

override void SCR_ArsenalDisplayComponent.ClearArsenal

(

)

Remove every slot's item.

Implements SCR_ArsenalComponent.

EOnInit()

override void SCR_ArsenalDisplayComponent.EOnInit

(

IEntity

owner

)

Implements SCR_ArsenalComponent.

GetItemValidForSlot()

bool SCR_ArsenalDisplayComponent.GetItemValidForSlot ( SCR_EArsenalItemType  itemType, SCR_EArsenalItemMode  itemMode, SCR_EArsenalItemType  supportedSlotTypes, SCR_EArsenalItemMode  supportedSlotModes  )

protected

GetSlotValid()

bool SCR_ArsenalDisplayComponent.GetSlotValid ( SCR_WeaponRackSlotEntity  slotEntity, out bool  isEmpty = true  )

protected

OnArsenalGameModeTypeChanged()

override void SCR_ArsenalDisplayComponent.OnArsenalGameModeTypeChanged

(

SCR_EArsenalGameModeType

newArsenalGameModeType

)

Implements SCR_ArsenalComponent.

OnDelete()

override void SCR_ArsenalDisplayComponent.OnDelete ( IEntity  owner )

protected

Implements SCR_ArsenalComponent.

OnFactionChanged()

override void SCR_ArsenalDisplayComponent.OnFactionChanged	(	FactionAffiliationComponent	owner,
		Faction	previousFaction,
		Faction	newFaction
	)

Implements SCR_ArsenalComponent.

OnPostInit()

override void SCR_ArsenalDisplayComponent.OnPostInit

(

IEntity

owner

)

Implements SCR_ArsenalComponent.

RefreshArsenal()

override void SCR_ArsenalDisplayComponent.RefreshArsenal

(

SCR_Faction

faction = null

)

Parameters

[in]

faction

unused parameter

Implements SCR_ArsenalComponent.

RefreshUpdate()

void SCR_ArsenalDisplayComponent.RefreshUpdate ( )

protected

Refresh arsenal after m_fRefreshDelay delay.

RegisterSlot()

void SCR_ArsenalDisplayComponent.RegisterSlot ( SCR_WeaponRackSlotEntity  slot )

protected

SetSupportedArsenalItemModes()

override void SCR_ArsenalDisplayComponent.SetSupportedArsenalItemModes

(

SCR_EArsenalItemMode

modes

)

Parameters

[in]

modes

Implements SCR_ArsenalComponent.

SetSupportedArsenalItemTypes()

override void SCR_ArsenalDisplayComponent.SetSupportedArsenalItemTypes

(

SCR_EArsenalItemType

types

)

Parameters

[in]

types

Implements SCR_ArsenalComponent.

Member Data Documentation

m_aSlots

ref array<SCR_WeaponRackSlotEntity> SCR_ArsenalDisplayComponent.m_aSlots = {}

protected

m_eArsenalItemDisplayType

EArsenalItemDisplayType SCR_ArsenalDisplayComponent.m_eArsenalItemDisplayType

protected

m_fRefreshDelay

float SCR_ArsenalDisplayComponent.m_fRefreshDelay

protected

---

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

• Game/Components/Arsenal/SCR_ArsenalDisplayComponent.c