Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_IdentityInventoryItemComponent Interface Reference
Inheritance diagram for SCR_IdentityInventoryItemComponent:
InventoryItemComponent GameComponent

Public Member Functions

void SCR_IdentityInventoryItemComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
 
SCR_ExtendedIdentityComponent GetLinkedExtendedIdentity ()
 
bool HasValuableIntel (bool forceCheckForFaction=false, PlayerController playerController=null)
 Check if Identity item is valuable intel for given (or local) player.
 
bool ShouldCheckIfItemIsHostileFaction ()
 
int GetValuableIntelFactionID ()
 
Faction GetValuableIntelFaction ()
 
SCR_CallsignBaseComponent GetLinkedCallsignComponent ()
 
- Public Member Functions inherited from InventoryItemComponent
proto external IEntity GetOwner ()
 Returns Entity owner of current component instance.
 
proto external bool IsLocked ()
 Returns locked state of item (for both user and system locks)
 
proto external bool IsUserLocked ()
 
proto external bool IsSystemLocked ()
 
proto external InventoryStorageSlot GetParentSlot ()
 
proto external ItemAttributeCollection GetAttributes ()
 
proto external void HideOwner ()
 Hide owner entity.
 
proto external void ShowOwner ()
 Show owner entity.
 
proto external void SetTraceable (bool traceable)
 Set the entity to be traceable or not.
 
proto external void DisablePhysics ()
 Disable owners physical interactions.
 
proto external void EnablePhysics ()
 Enable owners physical interactions.
 
proto external void ActivateOwner (bool active)
 Enable/Disable entity active state.
 
proto external float GetAdditionalWeight ()
 Returns the current additional weight.
 
proto external void SetAdditionalWeight (float additionalWeight)
 IMPORTANT* Could only be called on the master.
 
proto external float GetTotalWeight ()
 Returns the weight + the additional weight.
 
proto external float GetAdditionalVolume ()
 Returns the current additional volume.
 
proto external void SetAdditionalVolume (float additionalVolume)
 IMPORTANT* Could only be called on the master.
 
proto external float GetTotalVolume ()
 Returns the volume + the additional volume.
 
proto external void PlaceOnGround (IEntity callerEntity=null)
 IMPORTANT* This function is heavy in performance because of the multiple traces used inside the function.
 
proto external bool IsHiddenInVicnity ()
 returns true if item should be hidden
 
proto external UIInfo GetUIInfo ()
 Returns UI info of this item.
 
proto external bool RequestUserLock (IEntity caller, bool locked)
 Set external lock on item optional caller is entity that manipulates with item and has inventory manager present (usually character)
 
proto external BaseItemAttributeData FindAttribute (TypeName typeName)
 Convinience method Finds first occurance of the coresponding attribute data object in owned PrefabData AttributeCollection.
 
proto external IEntity CreatePreviewEntity (BaseWorld world, int camera)
 Creates preview entity in the provided world.
 
void OnDelete (IEntity owner)
 
- Public Member Functions inherited from GameComponent
bool OnTicksOnRemoteProxy ()
 

Protected Member Functions

override bool ShouldChangeVisibilityOfHierarchy ()
 
void DelayedInit (IEntity owner)
 
void OnIntelFactionSet ()
 
- Protected Member Functions inherited from InventoryItemComponent
bool ShouldHideInVicinity ()
 implement custom visibility behavior in vicinity
 
bool OverridePlacementTransform (IEntity caller, out vector computedTransform[4])
 Override final transformation of dropped item, return true in case transformation should be applied.
 

Protected Attributes

bool m_bCheckIfItemIsHostileFaction
 
RplId m_RplIdLinkedIdentity = -1
 
int m_iValuableIntelFaction = -1
 
Faction m_IntelFaction
 

Additional Inherited Members

- Public Attributes inherited from InventoryItemComponent
ref ScriptInvoker< bool > m_OnLockedStateChangedInvoker = new ScriptInvoker<bool>()
 
ref ScriptInvoker< InventoryStorageSlot, InventoryStorageSlotm_OnParentSlotChangedInvoker = new ScriptInvoker<InventoryStorageSlot, InventoryStorageSlot>()
 

Constructor & Destructor Documentation

◆ SCR_IdentityInventoryItemComponent()

void SCR_IdentityInventoryItemComponent.SCR_IdentityInventoryItemComponent ( IEntityComponentSource src,
IEntity ent,
IEntity parent )

Member Function Documentation

◆ DelayedInit()

void SCR_IdentityInventoryItemComponent.DelayedInit ( IEntity owner)
protected

◆ GetLinkedCallsignComponent()

SCR_CallsignBaseComponent SCR_IdentityInventoryItemComponent.GetLinkedCallsignComponent ( )

◆ GetLinkedExtendedIdentity()

SCR_ExtendedIdentityComponent SCR_IdentityInventoryItemComponent.GetLinkedExtendedIdentity ( )

◆ GetValuableIntelFaction()

Faction SCR_IdentityInventoryItemComponent.GetValuableIntelFaction ( )

◆ GetValuableIntelFactionID()

int SCR_IdentityInventoryItemComponent.GetValuableIntelFactionID ( )

◆ HasValuableIntel()

bool SCR_IdentityInventoryItemComponent.HasValuableIntel ( bool forceCheckForFaction = false,
PlayerController playerController = null )

Check if Identity item is valuable intel for given (or local) player.

Parameters
[in]forceCheckForFactionIf true will check if the faction of the player is friendly even if OnlyShowIntilIfHostileFaction is false
[in]playerControllerPlayer controller to check for faction. If null will use local player controller
Returns
True if the Identity Item has valuable intel for the character

◆ OnIntelFactionSet()

void SCR_IdentityInventoryItemComponent.OnIntelFactionSet ( )
protected

◆ ShouldChangeVisibilityOfHierarchy()

override bool SCR_IdentityInventoryItemComponent.ShouldChangeVisibilityOfHierarchy ( )
protected

◆ ShouldCheckIfItemIsHostileFaction()

bool SCR_IdentityInventoryItemComponent.ShouldCheckIfItemIsHostileFaction ( )
Returns
Should it check if the identity item is of a hostile faction?

Member Data Documentation

◆ m_bCheckIfItemIsHostileFaction

bool SCR_IdentityInventoryItemComponent.m_bCheckIfItemIsHostileFaction
protected

◆ m_IntelFaction

Faction SCR_IdentityInventoryItemComponent.m_IntelFaction
protected

◆ m_iValuableIntelFaction

int SCR_IdentityInventoryItemComponent.m_iValuableIntelFaction = -1
protected

◆ m_RplIdLinkedIdentity

RplId SCR_IdentityInventoryItemComponent.m_RplIdLinkedIdentity = -1
protected

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