Inheritance diagram for SCR_RequiredDeployablePart:

Protected Member Functions
ResourceName	GetPrefab ()
void	SetNumberOfRequiredPrefabs (int newValue)
int	GetNumberOfRequiredPrefabs ()
LocalizedString	GetPartName ()
LocalizedString	GetMissingPartName ()
bool	IsRequirementMet (out int difference)
int	GetNumberOfFoundEntities ()
bool	ShouldDeleteFoundEntities ()
array< IEntity >	GetFoundEntities ()
bool	EvaluateFoundEntity (vector origin, float distanceSqToFoundEntity, notnull BaseContainer foundPrefab, notnull IEntity foundEntity)
bool	DeleteFoundEntity (int id, notnull IEntity user)
void	AddFoundEntity (notnull IEntity entity)
void	ReplaceFoundEntity (notnull IEntity entity, int id)
SCR_RequiredDeployablePart	DeepClone ()

Protected Attributes
ResourceName	m_sPrefab
int	m_iNumberOfRequiredPrefabs
LocalizedString	m_sPartName
bool	m_bDeletePartsOnDeployment
bool	m_bDetachMagazinesWhenUsed
ref array< IEntity >	m_aFoundEntities

Detailed Description

Definition at line 1 of file SCR_RequiredDeployablePart.c.

Member Function Documentation

◆ AddFoundEntity()

void SCR_RequiredDeployablePart::AddFoundEntity ( notnull IEntity entity )

inlineprotected

Attempts to add entity to the list of found elements as long as its not already on that list

Parameters

[in] entity

Definition at line 156 of file SCR_RequiredDeployablePart.c.

◆ DeepClone()

SCR_RequiredDeployablePart SCR_RequiredDeployablePart::DeepClone ( )

inlineprotected

Returns deep copy of this instance Normal Clone does a shallow copy, thus if you need to clone content of a child class then override this and do it manually

Definition at line 182 of file SCR_RequiredDeployablePart.c.

◆ DeleteFoundEntity()

bool SCR_RequiredDeployablePart::DeleteFoundEntity	(	int	id,
		notnull IEntity	user )

inlineprotected

Attempts to delete one of the found entities and remove it from the array

Note: NOTICE: When entry in the array is deleted, then in its place will be moved last element of the array

Parameters

[in] id of the entity that should be deleted

Returns: false if deletion failed as there is no entity to delete

Definition at line 136 of file SCR_RequiredDeployablePart.c.

◆ EvaluateFoundEntity()

bool SCR_RequiredDeployablePart::EvaluateFoundEntity	(	vector	origin,
		float	distanceSqToFoundEntity,
		notnull BaseContainer	foundPrefab,
		notnull IEntity	foundEntity )

inlineprotected

Evaluates found entity against requirements and if it meets them, then it is stored as found entity If max number of required elements is already reached, then it will check if this new entity is closer than others, and in such case replace one of them

Parameters

[in]	origin	position from which search is being done
[in]	distanceSqToFoundEntity	distance from the origin to the position of the found entity
[in]	foundPrefab
[in]	foundEntity