SCR_MineInventoryItemComponent Interface Reference

Inheritance diagram for SCR_MineInventoryItemComponent:

Public Member Functions
override bool	ShouldHideInVicinity ()
	implement custom visibility behavior in vicinity
Public Member Functions inherited from SCR_PlaceableInventoryItemComponent
RplId	GetParentRplId ()
int	GetParentNodeId ()
void	PlaceItem ()
void	SetPlacementPosition (vector right, vector up, vector forward, vector position, RplId characterRplId)
	Authority method used to change the position at which item will placed when removed from the inventory.
override bool	OverridePlacementTransform (IEntity caller, out vector computedTransform[4])
	Override final transformation of dropped item, return true in case transformation should be applied.
void	PlaceItemWithParentChange (RplId newParentRplId, int nodeId=-1)
	Same as PlaceItem but with params that allow attaching the object to new parent entity.
void	SetNewParent (RplId parentId=RplId.Invalid(), int nodeId=-1)
	Method for updating parent when proxy streams in placeable item.
override void	OnDelete (IEntity owner)
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 ()

Static Public Member Functions
static ScriptInvokerInt	GetOnMinePlaced ()
Static Public Member Functions inherited from SCR_PlaceableInventoryItemComponent
static ScriptInvokerItemPlaced	GetOnPlacementDoneInvoker ()

Protected Member Functions
override void	PlacementDone (notnull ChimeraCharacter user)
Protected Member Functions inherited from SCR_PlaceableInventoryItemComponent
void	PlacementDone (notnull ChimeraCharacter user)
void	RPC_DoPlaceItem (RplId placingCharacterRplId)
bool	ValidateEntity (notnull IEntity entity)
bool	FilterCallback (notnull IEntity e)
void	PlayPlacedSound (vector up, vector position)
void	RPC_DoPlaceItemWithParentChange (RplId newParentRplId, int nodeId, RplId placingCharacterRplId)
void	AttachToNewParentWhenUnlocked (bool nowLocked)
	Method that will try to find new parent entity and make this entity a child of it.
void	AttachToNewParent ()
	Method that will try to find new parent entity and make this entity a child of it.
void	OnParentDamageStateChanged (SCR_HitZone hitZone)
	Method that is meant to be added to the parent default hit zone in order to detect when it is destroyed.
void	DetachFromParent ()
	Removes this entity from its parent hierarchy and places it on the ground.
void	StartWatchingParentSlots ()
	Callback method triggered when item will finish its transfer to new parent when it is being attached to it.
void	StopWatchingParentSlots ()
	Callback method when item is being transfered (f.e. picked up) after it was attached to some object.
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.

Static Protected Attributes
static ref ScriptInvokerInt	s_onMinePlaced
	called locally for character that placed it
Static Protected Attributes inherited from SCR_PlaceableInventoryItemComponent
static ref ScriptInvokerItemPlaced	s_OnPlacementDoneInvoker

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 Attributes inherited from SCR_PlaceableInventoryItemComponent
vector	m_vMat [4]
bool	m_bUseTransform = false
RplId	m_ParentRplId = RplId.Invalid()
RplId	m_PlacingCharacterRplId = RplId.Invalid()
int	m_iParentNodeId
IEntity	m_Parent
IEntity	m_RootParent

Member Function Documentation

GetOnMinePlaced()

static ScriptInvokerInt SCR_MineInventoryItemComponent.GetOnMinePlaced ( )

static

Returns

PlacementDone()

override void SCR_MineInventoryItemComponent.PlacementDone ( notnull ChimeraCharacter  user )

protected

Parameters

[in]

user

that placed this item

Implements SCR_PlaceableInventoryItemComponent.

ShouldHideInVicinity()

override bool SCR_MineInventoryItemComponent.ShouldHideInVicinity

(

)

implement custom visibility behavior in vicinity

Implements InventoryItemComponent.

Member Data Documentation

s_onMinePlaced

ref ScriptInvokerInt SCR_MineInventoryItemComponent.s_onMinePlaced

staticprotected

called locally for character that placed it

---

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

• Game/Inventory/Items/SCR_MineInventoryItemComponent.c