Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_ArsenalComponent Class Reference
Inheritance diagram for SCR_ArsenalComponent:
ScriptComponent

Protected Member Functions

SCR_EArsenalTypes GetArsenalType ()
bool IsArsenalEnabledByType ()
void OnArsenalTypeEnabledChanged (SCR_EArsenalTypes typesEnabled)
bool IsArsenalEnabled ()
void SetArsenalEnabled (bool enable, bool isOverwrite=true)
void UpdateArsenalEnabledState ()
void SetArsenalEnabledBroadcast (bool enable)
SCR_EArsenalSupplyCostType GetSupplyCostType ()
bool IsArsenalUsingSupplies ()
SCR_EArsenalSaveType GetArsenalSaveType ()
bool IsArsenalSavingDisplayedIfDisabled ()
void SetHasSaveArsenalAction (bool hasSaveArsenalAction)
bool HasSaveArsenalAction ()
void SetArsenalSaveType (SCR_EArsenalSaveType saveType)
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 ()
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)
void ClearArsenal ()
void RefreshArsenal (bool init=false, SCR_Faction faction=null)
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)
ScriptInvokerArsenalUpdated GetOnArsenalUpdated ()
void OnFactionChanged (FactionAffiliationComponent owner, Faction previousFaction, Faction newFaction)
void OnArsenalGameModeTypeChanged (SCR_EArsenalGameModeType newArsenalGameModeType)
void OnPostInit (IEntity owner)
void EOnInit (IEntity owner)
void FactionInit (IEntity owner)
void OnDelete (IEntity owner)
override bool RplSave (ScriptBitWriter writer)
override bool RplLoad (ScriptBitReader reader)

Static Protected Member Functions

static SCR_ArsenalComponent FindArsenalComponent (notnull IEntity entity, bool getFromSlotted=true)

Protected Attributes

SCR_EArsenalSupplyCostType m_eSupplyCostType
SCR_EArsenalItemType m_eSupportedArsenalItemTypes
SCR_EArsenalItemMode m_eSupportedArsenalItemModes
SCR_EArsenalAttributeGroup m_eEditableAttributeGroups
ref SCR_ArsenalItemListConfig m_OverwriteArsenalConfig
bool m_bCheckFactionForOverwriteArsenalConfig
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. If the prefab has saving disabled than the arsenal save action will never show unless saving has been changed in runtime.
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

Detailed Description

Definition at line 9 of file SCR_ArsenalComponent.c.

Member Function Documentation

◆ ClearArsenal()

void SCR_ArsenalComponent::ClearArsenal ( )
inlineprotected

Definition at line 379 of file SCR_ArsenalComponent.c.

◆ DelayedOnArsenalUpdatedClient()

void SCR_ArsenalComponent::DelayedOnArsenalUpdatedClient ( SCR_EArsenalItemType itemTypes,
SCR_EArsenalItemMode itemModes )
inlineprotected

Definition at line 426 of file SCR_ArsenalComponent.c.

◆ EOnInit()

void SCR_ArsenalComponent::EOnInit ( IEntity owner)
inlineprotected

Definition at line 497 of file SCR_ArsenalComponent.c.

◆ FactionInit()

void SCR_ArsenalComponent::FactionInit ( IEntity owner)
inlineprotected

Definition at line 509 of file SCR_ArsenalComponent.c.

◆ FindArsenalComponent()

SCR_ArsenalComponent SCR_ArsenalComponent::FindArsenalComponent ( notnull IEntity entity,
bool getFromSlotted = true )
inlinestaticprotected

Returns the first arsenal component found on the children of the given parent

Parameters
[in]parentTo check children for arsenal component
Returns
Arsenal Component if any is found, null otherwise

Definition at line 232 of file SCR_ArsenalComponent.c.

◆ GetArsenalInventoryComponent()

SCR_ArsenalInventoryStorageManagerComponent SCR_ArsenalComponent::GetArsenalInventoryComponent ( )
inlineprotected
Returns

Definition at line 276 of file SCR_ArsenalComponent.c.

◆ GetArsenalSaveType()

SCR_EArsenalSaveType SCR_ArsenalComponent::GetArsenalSaveType ( )
inlineprotected
Returns
Get Current Arsenal save type

Definition at line 164 of file SCR_ArsenalComponent.c.

◆ GetArsenalType()

SCR_EArsenalTypes SCR_ArsenalComponent::GetArsenalType ( )
inlineprotected
Returns
The arsenal type

Definition at line 67 of file SCR_ArsenalComponent.c.

◆ GetAssignedFaction()

SCR_Faction SCR_ArsenalComponent::GetAssignedFaction ( )
inlineprotected
Returns

Definition at line 313 of file SCR_ArsenalComponent.c.

◆ GetAvailablePrefabs()

bool SCR_ArsenalComponent::GetAvailablePrefabs ( out notnull array< ResourceName > availablePrefabs)
inlineprotected
Parameters
[out]availablePrefabs
Returns

Definition at line 292 of file SCR_ArsenalComponent.c.

◆ GetEditableAttributeGroups()

SCR_EArsenalAttributeGroup SCR_ArsenalComponent::GetEditableAttributeGroups ( )
inlineprotected
Returns

Definition at line 269 of file SCR_ArsenalComponent.c.

◆ GetFilteredArsenalItems()

bool SCR_ArsenalComponent::GetFilteredArsenalItems ( out notnull array< SCR_ArsenalItem > filteredArsenalItems,
EArsenalItemDisplayType requiresDisplayType = -1 )
inlineprotected
Parameters
[out]filteredArsenalItems
[in]requiresDisplayType
Returns

Definition at line 341 of file SCR_ArsenalComponent.c.

◆ GetFilteredOverwriteArsenalItems()

bool SCR_ArsenalComponent::GetFilteredOverwriteArsenalItems ( out notnull array< SCR_ArsenalItem > filteredArsenalItems,
EArsenalItemDisplayType requiresDisplayType = -1 )
inlineprotected

Get filtered overwrite Arsenal EWorkshopItemState

Parameters
[out]Listof all filtered arsenal items
Returns
true if any filtered items were found

Definition at line 364 of file SCR_ArsenalComponent.c.

◆ GetItemValid() [1/2]

bool SCR_ArsenalComponent::GetItemValid ( SCR_EArsenalItemType arsenalItemType,
SCR_EArsenalItemMode arsenalItemMode )
inlineprotected

Definition at line 444 of file SCR_ArsenalComponent.c.

◆ GetItemValid() [2/2]

bool SCR_ArsenalComponent::GetItemValid ( SCR_Faction faction,
int index,
out bool isEmpty = true )
inlineprotected

Definition at line 451 of file SCR_ArsenalComponent.c.

◆ GetOnArsenalUpdated()

ScriptInvokerArsenalUpdated SCR_ArsenalComponent::GetOnArsenalUpdated ( )
inlineprotected
Returns
Get scriptinvoker called when arsenal is updated

Definition at line 458 of file SCR_ArsenalComponent.c.

◆ GetOverwriteArsenalConfig()

SCR_ArsenalItemListConfig SCR_ArsenalComponent::GetOverwriteArsenalConfig ( )
inlineprotected

Get overwrite Arsenal config

Returns
Config of overwrite arsenal. Can be null if not overwritten

Definition at line 284 of file SCR_ArsenalComponent.c.

◆ GetSupplyCostType()

SCR_EArsenalSupplyCostType SCR_ArsenalComponent::GetSupplyCostType ( )
inlineprotected
Returns
Supply cost type which will be used to get the cost of items in the arsenal. Default is used if the item does not have the specific supply cost type

Definition at line 144 of file SCR_ArsenalComponent.c.

◆ GetSupportedArsenalItemModes()

SCR_EArsenalItemMode SCR_ArsenalComponent::GetSupportedArsenalItemModes ( )
inlineprotected
Returns

Definition at line 254 of file SCR_ArsenalComponent.c.

◆ GetSupportedArsenalItemTypes()

SCR_EArsenalItemType SCR_ArsenalComponent::GetSupportedArsenalItemTypes ( )
inlineprotected
Returns

Definition at line 223 of file SCR_ArsenalComponent.c.

◆ HasSaveArsenalAction()

bool SCR_ArsenalComponent::HasSaveArsenalAction ( )
inlineprotected

Check if Arsenal has an arsenal action attached to it. If true it will allow the editor to set if saving is allowed

Returns
True if Arsenal action is available

Definition at line 188 of file SCR_ArsenalComponent.c.

◆ IsArsenalEnabled()

bool SCR_ArsenalComponent::IsArsenalEnabled ( )
inlineprotected
Returns
If arsenal is enabled and the arsenal type is enabled by the Arsenal Manager

Definition at line 95 of file SCR_ArsenalComponent.c.

◆ IsArsenalEnabledByType()

bool SCR_ArsenalComponent::IsArsenalEnabledByType ( )
inlineprotected
Returns
If the arsenal type is enabled by the Arsenal Manager

Definition at line 74 of file SCR_ArsenalComponent.c.

◆ IsArsenalSavingDisplayedIfDisabled()

bool SCR_ArsenalComponent::IsArsenalSavingDisplayedIfDisabled ( )
inlineprotected
Returns
If arsenal action can be displayed if disabled. This is auto set on init and when arsenal save type is changed. If the prefab has saving disabled than the arsenal save action will never show unless saving has been changed in runtime

Definition at line 171 of file SCR_ArsenalComponent.c.

◆ IsArsenalUsingSupplies()

bool SCR_ArsenalComponent::IsArsenalUsingSupplies ( )
inlineprotected
Returns

Definition at line 151 of file SCR_ArsenalComponent.c.

◆ OnArsenalGameModeTypeChanged()

void SCR_ArsenalComponent::OnArsenalGameModeTypeChanged ( SCR_EArsenalGameModeType newArsenalGameModeType)
inlineprotected

Definition at line 473 of file SCR_ArsenalComponent.c.

◆ OnArsenalTypeEnabledChanged()

void SCR_ArsenalComponent::OnArsenalTypeEnabledChanged ( SCR_EArsenalTypes typesEnabled)
inlineprotected

Definition at line 81 of file SCR_ArsenalComponent.c.

◆ OnDelete()

void SCR_ArsenalComponent::OnDelete ( IEntity owner)
inlineprotected

Definition at line 560 of file SCR_ArsenalComponent.c.

◆ OnFactionChanged()

void SCR_ArsenalComponent::OnFactionChanged ( FactionAffiliationComponent owner,
Faction previousFaction,
Faction newFaction )
inlineprotected

Definition at line 467 of file SCR_ArsenalComponent.c.

◆ OnPostInit()

void SCR_ArsenalComponent::OnPostInit ( IEntity owner)
inlineprotected

Definition at line 479 of file SCR_ArsenalComponent.c.

◆ RefreshArsenal()

void SCR_ArsenalComponent::RefreshArsenal ( bool init = false,
SCR_Faction faction = null )
inlineprotected
Parameters
[in]factionunused parameter

Definition at line 386 of file SCR_ArsenalComponent.c.

◆ RPC_OnArsenalUpdated()

void SCR_ArsenalComponent::RPC_OnArsenalUpdated ( SCR_EArsenalItemType itemTypes,
SCR_EArsenalItemMode itemModes )
inlineprotected

Definition at line 419 of file SCR_ArsenalComponent.c.

◆ RPL_SetArsenalSaveType()

void SCR_ArsenalComponent::RPL_SetArsenalSaveType ( SCR_EArsenalSaveType saveType)
inlineprotected
Parameters
[in]saveType

Definition at line 209 of file SCR_ArsenalComponent.c.

◆ RplLoad()

override bool SCR_ArsenalComponent::RplLoad ( ScriptBitReader reader)
inlineprotected

Definition at line 592 of file SCR_ArsenalComponent.c.

◆ RplSave()

override bool SCR_ArsenalComponent::RplSave ( ScriptBitWriter writer)
inlineprotected

Definition at line 582 of file SCR_ArsenalComponent.c.

◆ SetArsenalEnabled()

void SCR_ArsenalComponent::SetArsenalEnabled ( bool enable,
bool isOverwrite = true )
inlineprotected
Parameters
[in]enableSets the arsenal enabled true or false. Both the arsenal Type needs to be enabled in the manager and the arsenal entity for arsenal items to show up

Definition at line 102 of file SCR_ArsenalComponent.c.

◆ SetArsenalEnabledBroadcast()

void SCR_ArsenalComponent::SetArsenalEnabledBroadcast ( bool enable)
inlineprotected

Definition at line 137 of file SCR_ArsenalComponent.c.

◆ SetArsenalSaveType()

void SCR_ArsenalComponent::SetArsenalSaveType ( SCR_EArsenalSaveType saveType)
inlineprotected

Set Arsenal Save type (Server Only)

Parameters
[in]saveTypeNew Save type to set

Definition at line 196 of file SCR_ArsenalComponent.c.

◆ SetHasSaveArsenalAction()

void SCR_ArsenalComponent::SetHasSaveArsenalAction ( bool hasSaveArsenalAction)
inlineprotected

Set if arsenal save action is on the action manager. Set by the save action on init

Parameters
[in]Settrue if action is available

Definition at line 180 of file SCR_ArsenalComponent.c.

◆ SetSupportedArsenalItemModes()

void SCR_ArsenalComponent::SetSupportedArsenalItemModes ( SCR_EArsenalItemMode modes)
inlineprotected
Parameters
[in]modes

Definition at line 261 of file SCR_ArsenalComponent.c.

◆ SetSupportedArsenalItemTypes()

void SCR_ArsenalComponent::SetSupportedArsenalItemTypes ( SCR_EArsenalItemType types)
inlineprotected
Parameters
[in]types

Definition at line 246 of file SCR_ArsenalComponent.c.

◆ UpdateArsenalEnabledState()

void SCR_ArsenalComponent::UpdateArsenalEnabledState ( )
inlineprotected

Definition at line 121 of file SCR_ArsenalComponent.c.

Member Data Documentation

◆ m_bAllowGetFactionFromParent

bool SCR_ArsenalComponent::m_bAllowGetFactionFromParent
protected

Definition at line 33 of file SCR_ArsenalComponent.c.

◆ m_bAlwaysUseDefaultFaction

bool SCR_ArsenalComponent::m_bAlwaysUseDefaultFaction
protected

Definition at line 42 of file SCR_ArsenalComponent.c.

◆ m_bArsenalEnabled

bool SCR_ArsenalComponent::m_bArsenalEnabled
protected

Definition at line 45 of file SCR_ArsenalComponent.c.

◆ m_bArsenalEnabledOverwritten

bool SCR_ArsenalComponent::m_bArsenalEnabledOverwritten
protected

Definition at line 48 of file SCR_ArsenalComponent.c.

◆ m_bArsenalSavingDisplayedIfDisabled

bool SCR_ArsenalComponent::m_bArsenalSavingDisplayedIfDisabled = true
protected

This is auto set on init and when arsenal save type is changed. If the prefab has saving disabled than the arsenal save action will never show unless saving has been changed in runtime.

Definition at line 52 of file SCR_ArsenalComponent.c.

◆ m_bCheckFactionForOverwriteArsenalConfig

bool SCR_ArsenalComponent::m_bCheckFactionForOverwriteArsenalConfig
protected

Definition at line 27 of file SCR_ArsenalComponent.c.

◆ m_bGetDefaultIfNoFaction

bool SCR_ArsenalComponent::m_bGetDefaultIfNoFaction
protected

Definition at line 30 of file SCR_ArsenalComponent.c.

◆ m_bHasSaveArsenalAction

bool SCR_ArsenalComponent::m_bHasSaveArsenalAction = false
protected

Set by action in action manager for the editor to know if the Arsenal save action exists on this arsenal.

Definition at line 53 of file SCR_ArsenalComponent.c.

◆ m_bIsClearingInventory

bool SCR_ArsenalComponent::m_bIsClearingInventory
protected

Definition at line 63 of file SCR_ArsenalComponent.c.

◆ m_eArsenalSaveType

SCR_EArsenalSaveType SCR_ArsenalComponent::m_eArsenalSaveType
protected

Definition at line 36 of file SCR_ArsenalComponent.c.

◆ m_eArsenalTypes

SCR_EArsenalTypes SCR_ArsenalComponent::m_eArsenalTypes
protected

Definition at line 39 of file SCR_ArsenalComponent.c.

◆ m_eEditableAttributeGroups

SCR_EArsenalAttributeGroup SCR_ArsenalComponent::m_eEditableAttributeGroups
protectedattribute

Definition at line 21 of file SCR_ArsenalComponent.c.

◆ m_eOnDisableArsenalModes

SCR_EArsenalItemMode SCR_ArsenalComponent::m_eOnDisableArsenalModes
protected

Definition at line 50 of file SCR_ArsenalComponent.c.

◆ m_eSupplyCostType

SCR_EArsenalSupplyCostType SCR_ArsenalComponent::m_eSupplyCostType
protected

Definition at line 12 of file SCR_ArsenalComponent.c.

◆ m_eSupportedArsenalItemModes

SCR_EArsenalItemMode SCR_ArsenalComponent::m_eSupportedArsenalItemModes
protected

Definition at line 18 of file SCR_ArsenalComponent.c.

◆ m_eSupportedArsenalItemTypes

SCR_EArsenalItemType SCR_ArsenalComponent::m_eSupportedArsenalItemTypes
protected

Definition at line 15 of file SCR_ArsenalComponent.c.

◆ m_FactionComponent

SCR_FactionAffiliationComponent SCR_ArsenalComponent::m_FactionComponent
protected

Definition at line 59 of file SCR_ArsenalComponent.c.

◆ m_FactionManager

FactionManager SCR_ArsenalComponent::m_FactionManager
protected

Definition at line 58 of file SCR_ArsenalComponent.c.

◆ m_InventoryComponent

SCR_ArsenalInventoryStorageManagerComponent SCR_ArsenalComponent::m_InventoryComponent
protected

Definition at line 55 of file SCR_ArsenalComponent.c.

◆ m_OnArsenalUpdated

ref ScriptInvokerArsenalUpdated SCR_ArsenalComponent::m_OnArsenalUpdated
protected

Definition at line 61 of file SCR_ArsenalComponent.c.

◆ m_OverwriteArsenalConfig

ref SCR_ArsenalItemListConfig SCR_ArsenalComponent::m_OverwriteArsenalConfig
protected

Definition at line 24 of file SCR_ArsenalComponent.c.

◆ m_StorageComponent

UniversalInventoryStorageComponent SCR_ArsenalComponent::m_StorageComponent
protected

Definition at line 56 of file SCR_ArsenalComponent.c.

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