SCR_ItemPlacementComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_ItemPlacementComponentClass

Functions
SCR_ItemPlacementComponentClass ScriptComponentClass	Attribute ("{56EBF5038622AC95}Assets/Conflict/CanBuild.emat")
void	RPC_AskPlaceItem (vector right, vector up, vector forward, vector position, RplId id)
protected SCR_CharacterControllerComponent	GetCharacterController (IEntity from)
protected void	UnregisterEvents (IEntity from)
protected void	RegisterEvents (IEntity to)
protected void	OnControlledEntityChanged (IEntity from, IEntity to)
	Runs every time the controlled entity has been changed. More...
protected void	NotifyItemPlacementDone (IEntity item)
protected void	StartPlaceItem ()
void	OnPlacingEnded (IEntity item, bool successful, ItemUseParameters animParams)
protected void	DisablePreview ()
protected void	EnablePreview (IEntity weapon)
protected void	OnComparmentEntered (IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)
protected void	GetOnCompartmentLeft ()
IEntity	GetWeaponFromWeaponComponent (BaseWeaponComponent weaponComponent)
protected void	OnWeaponChangeEnded (BaseWeaponComponent newWeaponSlot)
protected void	OnWeaponChanged (BaseWeaponComponent newWeaponSlot)
protected void	OnCharacterDeath (SCR_CharacterControllerComponent characterController, IEntity killerEntity, notnull Instigator killer)
protected void	TogglePreview (IEntity weapon)
protected override void	EOnFrame (IEntity owner, float timeSlice)
void	UseXZFixedPlacement (IEntity owner, float maxPlacementDistance, vector cameraMat[4])
protected bool	ExcludeWaterCallback (IEntity e)
void	UseXYZPlacement (IEntity owner, float maxPlacementDistance, vector cameraMat[4])
bool	ValidateEntity (notnull IEntity entity)
bool	ValidatePlacement (vector up, IEntity tracedEntity, BaseWorld world, IEntity character)
bool	TraceEntitiesCallback (notnull IEntity e, vector start="0 0 0", vector dir="0 0 0")
void	OrientToNormal (vector normal)
protected void	OnEditorOpened ()
protected void	OnEditorClosed ()
protected void	RegisterToManagerInvokers (SCR_EditorManagerEntity manager)
protected override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...
protected void	InitEditorListeners ()
protected override void	EOnInit (IEntity owner)
void	SCR_ItemPlacementComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Variables
Assets Conflict CannotBuild emat ResourceName	m_sCannotBuildMaterial
int	m_iFramesBetweenChecks
protected int	m_iEquipComplete
protected bool	m_bCanPlace
protected bool	m_bInEditor
protected vector	m_vCurrentMat [4]
protected IEntity	m_EquippedItem
protected SCR_PlaceableItemComponent	m_PlaceableItem
protected IEntity	m_PreviewEntity
protected SCR_CompartmentAccessComponent	m_CompartmnetAccessComponent

Function Documentation

Attribute()

SCR_ItemPlacementComponentClass ScriptComponentClass Attribute

(

"{56EBF5038622AC95}Assets/Conflict/CanBuild.emat"

)

Definition at line 8 of file SCR_ItemPlacementComponent.c.

DisablePreview()

protected void DisablePreview

(

)

Definition at line 243 of file SCR_ItemPlacementComponent.c.

EnablePreview()

protected void EnablePreview

(

IEntity

weapon

)

Definition at line 251 of file SCR_ItemPlacementComponent.c.

EOnFrame()

protected override void EOnFrame	(	IEntity	owner,
		float	timeSlice
	)

Definition at line 335 of file SCR_ItemPlacementComponent.c.

ExcludeWaterCallback()

protected bool ExcludeWaterCallback

(

IEntity

e

)

Definition at line 414 of file SCR_ItemPlacementComponent.c.

GetCharacterController()

protected SCR_CharacterControllerComponent GetCharacterController

(

IEntity

from

)

Definition at line 50 of file SCR_ItemPlacementComponent.c.

GetOnCompartmentLeft()

protected void GetOnCompartmentLeft

(

)

Definition at line 285 of file SCR_ItemPlacementComponent.c.

GetWeaponFromWeaponComponent()

IEntity GetWeaponFromWeaponComponent

(

BaseWeaponComponent

weaponComponent

)

Parameters

[in]

weaponComponent

Returns

Definition at line 293 of file SCR_ItemPlacementComponent.c.

InitEditorListeners()

protected void InitEditorListeners

(

)

Definition at line 603 of file SCR_ItemPlacementComponent.c.

NotifyItemPlacementDone()

protected void NotifyItemPlacementDone

(

IEntity

item

)

Definition at line 136 of file SCR_ItemPlacementComponent.c.

OnCharacterDeath()

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

Definition at line 317 of file SCR_ItemPlacementComponent.c.

OnComparmentEntered()

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

Definition at line 279 of file SCR_ItemPlacementComponent.c.

OnEditorClosed()

protected void OnEditorClosed

(

)

Definition at line 583 of file SCR_ItemPlacementComponent.c.

OnEditorOpened()

protected void OnEditorOpened

(

)

Definition at line 576 of file SCR_ItemPlacementComponent.c.

OnPlacingEnded()

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

Definition at line 200 of file SCR_ItemPlacementComponent.c.

OnWeaponChanged()

protected void OnWeaponChanged

(

BaseWeaponComponent

newWeaponSlot

)

Definition at line 310 of file SCR_ItemPlacementComponent.c.

OnWeaponChangeEnded()

protected void OnWeaponChangeEnded

(

BaseWeaponComponent

newWeaponSlot

)

Definition at line 303 of file SCR_ItemPlacementComponent.c.

OrientToNormal()

void OrientToNormal

(

vector

normal

)

Parameters

[in]

normal

Definition at line 563 of file SCR_ItemPlacementComponent.c.

RegisterEvents()

protected void RegisterEvents

(

IEntity

to

)

Definition at line 88 of file SCR_ItemPlacementComponent.c.

RegisterToManagerInvokers()

protected void RegisterToManagerInvokers

(

SCR_EditorManagerEntity

manager

)

Definition at line 590 of file SCR_ItemPlacementComponent.c.

RPC_AskPlaceItem()

void RPC_AskPlaceItem	(	vector	right,
		vector	up,
		vector	forward,
		vector	position,
		RplId	id
	)

id = id of items rpl component

Parameters

[in]	right
[in]	up
[in]	forward
[in]	position
[in]	id

Definition at line 34 of file SCR_ItemPlacementComponent.c.

SCR_ItemPlacementComponent()

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

Parameters

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

Definition at line 640 of file SCR_ItemPlacementComponent.c.

StartPlaceItem()

protected void StartPlaceItem

(

)

Definition at line 150 of file SCR_ItemPlacementComponent.c.

TogglePreview()

protected void TogglePreview

(

IEntity

weapon

)

Definition at line 326 of file SCR_ItemPlacementComponent.c.

TraceEntitiesCallback()

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

Parameters

[in]

e

Returns

Definition at line 555 of file SCR_ItemPlacementComponent.c.

UnregisterEvents()

protected void UnregisterEvents

(

IEntity

from

)

Definition at line 63 of file SCR_ItemPlacementComponent.c.

UseXYZPlacement()

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

Parameters

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

Definition at line 428 of file SCR_ItemPlacementComponent.c.

UseXZFixedPlacement()

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

Parameters

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

Definition at line 385 of file SCR_ItemPlacementComponent.c.

ValidateEntity()

bool ValidateEntity

(

notnull IEntity

entity

)

Parameters

[in]

entity

Returns

Definition at line 490 of file SCR_ItemPlacementComponent.c.

ValidatePlacement()

bool ValidatePlacement	(	vector	up,
		IEntity	tracedEntity,
		BaseWorld	world,
		IEntity	character
	)

Parameters

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

Returns

Definition at line 515 of file SCR_ItemPlacementComponent.c.

Variable Documentation

m_bCanPlace

protected bool m_bCanPlace

Definition at line 18 of file SCR_ItemPlacementComponent.c.

m_bInEditor

protected bool m_bInEditor

Definition at line 19 of file SCR_ItemPlacementComponent.c.

m_CompartmnetAccessComponent

protected SCR_CompartmentAccessComponent m_CompartmnetAccessComponent

Definition at line 24 of file SCR_ItemPlacementComponent.c.

m_EquippedItem

protected IEntity m_EquippedItem

Definition at line 21 of file SCR_ItemPlacementComponent.c.

m_iEquipComplete

protected int m_iEquipComplete

Definition at line 17 of file SCR_ItemPlacementComponent.c.

m_iFramesBetweenChecks

int m_iFramesBetweenChecks

Definition at line 15 of file SCR_ItemPlacementComponent.c.

m_PlaceableItem

protected SCR_PlaceableItemComponent m_PlaceableItem

Definition at line 22 of file SCR_ItemPlacementComponent.c.

m_PreviewEntity

protected IEntity m_PreviewEntity

Definition at line 23 of file SCR_ItemPlacementComponent.c.

m_sCannotBuildMaterial

Assets Conflict CannotBuild emat ResourceName m_sCannotBuildMaterial

Definition at line 12 of file SCR_ItemPlacementComponent.c.

m_vCurrentMat

protected vector m_vCurrentMat[4]

Definition at line 20 of file SCR_ItemPlacementComponent.c.