Inheritance diagram for SCR_ItemPlacementComponent:

Public Member Functions
void	RPC_AskSetPlacementPosition (vector right, vector up, vector forward, vector position, RplId placeableId, RplId characterId)
	Client side method for informing the authority about where item should be placed upon removal from their inventory.

void	RPC_AskPlaceItem (RplId placeableId)
	placeableId = id of items rpl component

void	RPC_AskPlaceItemWithParentChange (RplId placeableId, RplId targetId, int nodeId)
	placeableId = id of items rpl component

void	AskPlaceItem (RplId placeableId, RplId targetId, int nodeId, bool isBeingAttachedToEntity)
	Client side method for finishing item placement when that item was successfully removed from their inventory.

void	ValidateTargetEntityExistance ()

void	SetPlacedItem (IEntity item)

void	SetPreviewEntity (IEntity preview, bool deleteOldPreview=true)

void	SetPlaceableItemComponent (SCR_PlaceableItemComponent placeableItemComp)

SCR_PlaceableItemComponent	GetPlaceableItemComponent ()

void	EnablePlacement (bool enabled)
	Enable listening for actions and position validation.

void	DisablePreview ()

IEntity	GetWeaponFromWeaponComponent (BaseWeaponComponent weaponComponent)

void	UseXZFixedPlacement (IEntity owner, float maxPlacementDistance, vector cameraMat[4])

void	UseXYZPlacement (IEntity owner, float maxPlacementDistance, vector cameraMat[4])

void	ValidatePlacement (vector up, IEntity tracedEntity, BaseWorld world, IEntity character, out ENotification cantPlaceReason)

bool	TraceEntitiesCallback (notnull IEntity e, vector start="0 0 0", vector dir="0 0 0")

void	SCR_ItemPlacementComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Static Public Attributes
static const string	ACTION_CONTEXT_PLACEMENT = "CharacterPlacementContext"

static const string	ACTION_NAME_PLACEMENT = "CharacterPlaceItem"

static const string	ACTION_NAME_FORCE_PLACEMENT = "CharacterForcePlaceItem"

static const string	ACTION_NAME_CHANGE_ITEM = "ChangePlacedItem"

static const string	ACTION_NAME_CHANGE_VARIANT = "ChangedPlacedVariant"

Protected Member Functions
void	UnregisterEvents (IEntity from)

void	RegisterEvents (IEntity to)

void	OnControlledEntityChanged (IEntity from, IEntity to)

void	ForcePlaceItem ()
	Callback method triggered by button press.

void	StartPlaceItem ()
	Callback method triggered by button press.

void	OnPlacingEnded (IEntity item, bool successful, ItemUseParameters animParams)

void	EnablePreview (IEntity weapon)

void	OnComparmentEntered (IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)

void	GetOnCompartmentLeft ()

void	OnWeaponChangeEnded (BaseWeaponComponent newWeaponSlot)

void	OnWeaponChanged (BaseWeaponComponent newWeaponSlot)

void	OnCharacterDeath (SCR_CharacterControllerComponent characterController, IEntity killerEntity, notnull Instigator killer)

void	TogglePreview (IEntity weapon)

override void	EOnFrame (IEntity owner, float timeSlice)

bool	FilterCallback (IEntity e)

bool	ValidateEntity (notnull IEntity entity)

void	OnEditorOpened ()

void	OnEditorClosed ()

void	RegisterToManagerInvokers (SCR_EditorManagerEntity manager)

override void	OnPostInit (IEntity owner)

void	InitEditorListeners ()

override void	EOnInit (IEntity owner)

Protected Attributes
ResourceName	m_sCanBuildMaterial

ResourceName	m_sCannotBuildMaterial

ResourceName	m_sTransparentMaterial

int	m_iEquipComplete

int	m_iTargetEntityNodeID

bool	m_bInEditor

bool	m_bIsBeingAttachedToEntity

vector	m_vCurrentMat [4]

vector	m_aCamDeploymentPosition [4]

IEntity	m_PlacedItem

ENotification	m_eCantPlaceReason

SCR_PlaceableItemComponent	m_PlaceableItem

IEntity	m_PreviewEntity

SCR_CompartmentAccessComponent	m_CompartmnetAccessComponent

RplId	m_TargetId

IEntity	m_TargetEntity

Constructor & Destructor Documentation

◆ SCR_ItemPlacementComponent()

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

Parameters

[in]	src
[in]	ent
[in]	parent

Member Function Documentation

◆ AskPlaceItem()

void SCR_ItemPlacementComponent.AskPlaceItem	(	RplId	placeableId,
		RplId	targetId,
		int	nodeId,
		bool	isBeingAttachedToEntity )

Client side method for finishing item placement when that item was successfully removed from their inventory.

Parameters

[in]	placeableId	replication id of placed item
[in]	targetId	replication id of object to which this item is being attached to
[in]	nodeId	node of the target object to which placed item will be attached to
[in]	isBeingAttachedToEntity

◆ DisablePreview()

void SCR_ItemPlacementComponent.DisablePreview ( )

◆ EnablePlacement()

void SCR_ItemPlacementComponent.EnablePlacement ( bool enabled )

Enable listening for actions and position validation.

Parameters

[in] enabled true when placement should be enabled, otherwise false

◆ EnablePreview()

void SCR_ItemPlacementComponent.EnablePreview ( IEntity weapon )

protected

◆ EOnFrame()

override void SCR_ItemPlacementComponent.EOnFrame	(	IEntity	owner,
		float	timeSlice )

protected

◆ EOnInit()

override void SCR_ItemPlacementComponent.EOnInit ( IEntity owner )

protected

◆ FilterCallback()

bool SCR_ItemPlacementComponent.FilterCallback ( IEntity e )

protected

◆ ForcePlaceItem()

void SCR_ItemPlacementComponent.ForcePlaceItem ( )

protected

Callback method triggered by button press.

◆ GetOnCompartmentLeft()

void SCR_ItemPlacementComponent.GetOnCompartmentLeft ( )

protected

◆ GetPlaceableItemComponent()

SCR_PlaceableItemComponent SCR_ItemPlacementComponent.GetPlaceableItemComponent ( )

Returns: currently used component for placing an item

◆ GetWeaponFromWeaponComponent()

IEntity SCR_ItemPlacementComponent.GetWeaponFromWeaponComponent ( BaseWeaponComponent weaponComponent )

Parameters

[in] weaponComponent

Returns

◆ InitEditorListeners()

void SCR_ItemPlacementComponent.InitEditorListeners ( )

protected

◆ OnCharacterDeath()

void SCR_ItemPlacementComponent.OnCharacterDeath	(	SCR_CharacterControllerComponent	characterController,
		IEntity	killerEntity,
		notnull Instigator	killer )

protected

◆ OnComparmentEntered()

void SCR_ItemPlacementComponent.OnComparmentEntered	(	IEntity	targetEntity,
		BaseCompartmentManagerComponent	manager,
		int	mgrID,
		int	slotID,
		bool	move )

protected

◆ OnControlledEntityChanged()

void SCR_ItemPlacementComponent.OnControlledEntityChanged	(	IEntity	from,
		IEntity	to )

protected

◆ OnEditorClosed()

void SCR_ItemPlacementComponent.OnEditorClosed ( )

protected

◆ OnEditorOpened()

void SCR_ItemPlacementComponent.OnEditorOpened ( )

protected

◆ OnPlacingEnded()

void SCR_ItemPlacementComponent.OnPlacingEnded	(	IEntity	item,
		bool	successful,
		ItemUseParameters	animParams )

protected

◆ OnPostInit()

override void SCR_ItemPlacementComponent.OnPostInit ( IEntity owner )

protected

◆ OnWeaponChanged()

void SCR_ItemPlacementComponent.OnWeaponChanged ( BaseWeaponComponent newWeaponSlot )

protected

◆ OnWeaponChangeEnded()

void SCR_ItemPlacementComponent.OnWeaponChangeEnded ( BaseWeaponComponent newWeaponSlot )

protected

◆ RegisterEvents()

void SCR_ItemPlacementComponent.RegisterEvents ( IEntity to )

protected

◆ RegisterToManagerInvokers()

void SCR_ItemPlacementComponent.RegisterToManagerInvokers ( SCR_EditorManagerEntity manager )

protected

◆ RPC_AskPlaceItem()

void SCR_ItemPlacementComponent.RPC_AskPlaceItem ( RplId placeableId )

placeableId = id of items rpl component

Parameters

[in] placeableId

◆ RPC_AskPlaceItemWithParentChange()

void SCR_ItemPlacementComponent.RPC_AskPlaceItemWithParentChange	(	RplId	placeableId,
		RplId	targetId,
		int	nodeId )

placeableId = id of items rpl component

Parameters

[in]	placeableId
[in]	targetId	is an RplId of the owner of the surface to which this item is meant to be attached to
[in]	nodeId	is an node id of the surface to which this object is meant to be attached to

◆ RPC_AskSetPlacementPosition()

void SCR_ItemPlacementComponent.RPC_AskSetPlacementPosition	(	vector	right,
		vector	up,
		vector	forward,
		vector	position,
		RplId	placeableId,
		RplId	characterId )

Client side method for informing the authority about where item should be placed upon removal from their inventory.

Parameters

[in]	right
[in]	up
[in]	forward
[in]	position
[in]	placeableId	replication id of placed item
[in]	characterId	replication id of the character that placed it there

◆ SetPlaceableItemComponent()

void SCR_ItemPlacementComponent.SetPlaceableItemComponent ( SCR_PlaceableItemComponent placeableItemComp )

Parameters

[in] placeableItemComp

◆ SetPlacedItem()

void SCR_ItemPlacementComponent.SetPlacedItem ( IEntity item )

Parameters

[in] item

◆ SetPreviewEntity()

void SCR_ItemPlacementComponent.SetPreviewEntity	(	IEntity	preview,
		bool	deleteOldPreview = true )

Parameters

[in]	preview
[in]	deleteOldPreview	true if previous preview should be deleted

◆ StartPlaceItem()

void SCR_ItemPlacementComponent.StartPlaceItem ( )

protected

Callback method triggered by button press.

◆ TogglePreview()

void SCR_ItemPlacementComponent.TogglePreview ( IEntity weapon )

protected

◆ TraceEntitiesCallback()

bool SCR_ItemPlacementComponent.TraceEntitiesCallback	(	notnull IEntity	e,
		vector	start = "0 0 0",
		vector	dir = "0 0 0" )

Parameters

[in] e

Returns

◆ UnregisterEvents()

void SCR_ItemPlacementComponent.UnregisterEvents ( IEntity from )

protected

◆ UseXYZPlacement()

void SCR_ItemPlacementComponent.UseXYZPlacement	(	IEntity	owner,
		float	maxPlacementDistance,
		vector	cameraMat[4] )

Parameters

[in]	owner
[in]	maxPlacementDistance
[in]	cameraMat

◆ UseXZFixedPlacement()

void SCR_ItemPlacementComponent.UseXZFixedPlacement	(	IEntity	owner,
		float	maxPlacementDistance,
		vector	cameraMat[4] )

Parameters

[in]	owner
[in]	maxPlacementDistance
[in]	cameraMat

◆ ValidateEntity()

bool SCR_ItemPlacementComponent.ValidateEntity ( notnull IEntity entity )

protected

Parameters

[in] entity

Returns

◆ ValidatePlacement()

void SCR_ItemPlacementComponent.ValidatePlacement	(	vector	up,
		IEntity	tracedEntity,
		BaseWorld	world,
		IEntity	character,
		out ENotification	cantPlaceReason )

Parameters

[in]	up
[in]	tracedEntity
[in]	world
[in]	character

Returns

◆ ValidateTargetEntityExistance()

void SCR_ItemPlacementComponent.ValidateTargetEntityExistance ( )

Member Data Documentation

◆ ACTION_CONTEXT_PLACEMENT

const string SCR_ItemPlacementComponent.ACTION_CONTEXT_PLACEMENT = "CharacterPlacementContext"

static

◆ ACTION_NAME_CHANGE_ITEM

const string SCR_ItemPlacementComponent.ACTION_NAME_CHANGE_ITEM = "ChangePlacedItem"

static

◆ ACTION_NAME_CHANGE_VARIANT

const string SCR_ItemPlacementComponent.ACTION_NAME_CHANGE_VARIANT = "ChangedPlacedVariant"

static

◆ ACTION_NAME_FORCE_PLACEMENT

const string SCR_ItemPlacementComponent.ACTION_NAME_FORCE_PLACEMENT = "CharacterForcePlaceItem"

static

◆ ACTION_NAME_PLACEMENT

const string SCR_ItemPlacementComponent.ACTION_NAME_PLACEMENT = "CharacterPlaceItem"

static

◆ m_aCamDeploymentPosition

vector SCR_ItemPlacementComponent.m_aCamDeploymentPosition[4]

protected

◆ m_bInEditor

bool SCR_ItemPlacementComponent.m_bInEditor

protected

◆ m_bIsBeingAttachedToEntity

bool SCR_ItemPlacementComponent.m_bIsBeingAttachedToEntity

protected

◆ m_CompartmnetAccessComponent

SCR_CompartmentAccessComponent SCR_ItemPlacementComponent.m_CompartmnetAccessComponent

protected

◆ m_eCantPlaceReason

ENotification SCR_ItemPlacementComponent.m_eCantPlaceReason

protected

◆ m_iEquipComplete

int SCR_ItemPlacementComponent.m_iEquipComplete

protected

◆ m_iTargetEntityNodeID

int SCR_ItemPlacementComponent.m_iTargetEntityNodeID

protected

◆ m_PlaceableItem

SCR_PlaceableItemComponent SCR_ItemPlacementComponent.m_PlaceableItem

protected

◆ m_PlacedItem

IEntity SCR_ItemPlacementComponent.m_PlacedItem

protected

◆ m_PreviewEntity

IEntity SCR_ItemPlacementComponent.m_PreviewEntity

protected

◆ m_sCanBuildMaterial

ResourceName SCR_ItemPlacementComponent.m_sCanBuildMaterial

protected

◆ m_sCannotBuildMaterial

ResourceName SCR_ItemPlacementComponent.m_sCannotBuildMaterial

protected

◆ m_sTransparentMaterial

ResourceName SCR_ItemPlacementComponent.m_sTransparentMaterial

protected

◆ m_TargetEntity

IEntity SCR_ItemPlacementComponent.m_TargetEntity

protected

◆ m_TargetId

RplId SCR_ItemPlacementComponent.m_TargetId

protected

◆ m_vCurrentMat

vector SCR_ItemPlacementComponent.m_vCurrentMat[4]

protected

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

Game/Components/SCR_ItemPlacementComponent.c

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ SCR_ItemPlacementComponent()

Member Function Documentation

◆ AskPlaceItem()

◆ DisablePreview()

◆ EnablePlacement()

◆ EnablePreview()

◆ EOnFrame()

◆ EOnInit()

◆ FilterCallback()

◆ ForcePlaceItem()

◆ GetOnCompartmentLeft()

◆ GetPlaceableItemComponent()

◆ GetWeaponFromWeaponComponent()

◆ InitEditorListeners()

◆ OnCharacterDeath()

◆ OnComparmentEntered()

◆ OnControlledEntityChanged()

◆ OnEditorClosed()

◆ OnEditorOpened()

◆ OnPlacingEnded()

◆ OnPostInit()

◆ OnWeaponChanged()

◆ OnWeaponChangeEnded()

◆ RegisterEvents()

◆ RegisterToManagerInvokers()

◆ RPC_AskPlaceItem()

◆ RPC_AskPlaceItemWithParentChange()

◆ RPC_AskSetPlacementPosition()

◆ SetPlaceableItemComponent()

◆ SetPlacedItem()

◆ SetPreviewEntity()

◆ StartPlaceItem()

◆ TogglePreview()

◆ TraceEntitiesCallback()

◆ UnregisterEvents()

◆ UseXYZPlacement()

◆ UseXZFixedPlacement()

◆ ValidateEntity()

◆ ValidatePlacement()

◆ ValidateTargetEntityExistance()

Member Data Documentation

◆ ACTION_CONTEXT_PLACEMENT

◆ ACTION_NAME_CHANGE_ITEM

◆ ACTION_NAME_CHANGE_VARIANT

◆ ACTION_NAME_FORCE_PLACEMENT

◆ ACTION_NAME_PLACEMENT

◆ m_aCamDeploymentPosition

◆ m_bInEditor

◆ m_bIsBeingAttachedToEntity

◆ m_CompartmnetAccessComponent

◆ m_eCantPlaceReason

◆ m_iEquipComplete

◆ m_iTargetEntityNodeID

◆ m_PlaceableItem

◆ m_PlacedItem

◆ m_PreviewEntity

◆ m_sCanBuildMaterial

◆ m_sCannotBuildMaterial

◆ m_sTransparentMaterial

◆ m_TargetEntity

◆ m_TargetId

◆ m_vCurrentMat