SCR_VisibleInventoryItemComponent Interface Reference

Inheritance diagram for SCR_VisibleInventoryItemComponent:

Public Member Functions
void	SetHiddenInVicinity (bool hidden)
	Setter for property that determines if item will be hidden in vicinity view of the inventory.
override bool	ShouldHideInVicinity ()
	implement custom visibility behavior in vicinity
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.
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Protected Attributes
bool	m_bHideInVicinity

Additional Inherited Members
Public Attributes inherited from InventoryItemComponent
ref ScriptInvoker< bool >	m_OnLockedStateChangedInvoker = new ScriptInvoker<bool>()
ref ScriptInvoker< InventoryStorageSlot, InventoryStorageSlot >	m_OnParentSlotChangedInvoker = new ScriptInvoker<InventoryStorageSlot, InventoryStorageSlot>()
Protected Member Functions inherited from InventoryItemComponent
bool	ShouldChangeVisibilityOfHierarchy ()
bool	OverridePlacementTransform (IEntity caller, out vector computedTransform[4])
	Override final transformation of dropped item, return true in case transformation should be applied.
void	OnPlacedOnGround ()
	Override this function if for example physics should be enabled or item's owner should be activated when an item is placed on ground.
void	OnPostInit (IEntity owner)
void	OnDelete (IEntity owner)

Member Function Documentation

SetHiddenInVicinity()

void SCR_VisibleInventoryItemComponent.SetHiddenInVicinity

(

bool

hidden

)

Setter for property that determines if item will be hidden in vicinity view of the inventory.

ShouldHideInVicinity()

override bool SCR_VisibleInventoryItemComponent.ShouldHideInVicinity

(

)

implement custom visibility behavior in vicinity

Implements InventoryItemComponent.

Member Data Documentation

m_bHideInVicinity

bool SCR_VisibleInventoryItemComponent.m_bHideInVicinity

protected

---

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

• Game/Inventory/SCR_VisibleInventoryItemComponent.c