SCR_ComboRequiredDeployableParts Interface Reference

Inheritance diagram for SCR_ComboRequiredDeployableParts:

Public Member Functions
override bool	EvaluateFoundEntity (vector origin, float distanceSqToFoundEntity, notnull BaseContainer foundPrefab, notnull IEntity foundEntity)
	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.
override bool	IsRequirementMet (out int difference)
override LocalizedString	GetMissingPartName ()
override bool	DeleteFoundEntity (int id, notnull IEntity user)
	Attempts to delete one of the found entities and remove it from the array.
override array< IEntity >	GetFoundEntities ()
Public Member Functions inherited from SCR_RequiredDeployablePart
ResourceName	GetPrefab ()
void	SetNumberOfRequiredPrefabs (int newValue)
int	GetNumberOfRequiredPrefabs ()
LocalizedString	GetPartName ()
int	GetNumberOfFoundEntities ()
bool	ShouldDeleteFoundEntities ()
void	AddFoundEntity (notnull IEntity entity)
	Attempts to add entity to the list of found elements as long as its not already on that list.
void	ReplaceFoundEntity (notnull IEntity entity, int id)
	Attempts to replace entity which is in specified place of the array with provided entity.
SCR_RequiredDeployablePart	DeepClone ()
	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.

Protected Attributes
ResourceName	m_sOtherPrefab
int	m_iNumberOfOtherRequiredPrefabs
LocalizedString	m_sOtherPartName
ref array< IEntity >	m_aOtherFoundEntities
Protected Attributes inherited from SCR_RequiredDeployablePart
ResourceName	m_sPrefab
int	m_iNumberOfRequiredPrefabs
LocalizedString	m_sPartName
bool	m_bDeletePartsOnDeployment
bool	m_bDetachMagazinesWhenUsed
ref array< IEntity >	m_aFoundEntities

Member Function Documentation

DeleteFoundEntity()

override bool SCR_ComboRequiredDeployableParts.DeleteFoundEntity	(	int	id,
		notnull IEntity	user )

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

Implements SCR_RequiredDeployablePart.

EvaluateFoundEntity()

override bool SCR_ComboRequiredDeployableParts.EvaluateFoundEntity	(	vector	origin,
		float	distanceSqToFoundEntity,
		notnull BaseContainer	foundPrefab,
		notnull IEntity	foundEntity )

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

Returns

false if found entity doesnt meet the requirements, otherwise true

Implements SCR_RequiredDeployablePart.

GetFoundEntities()

override array< IEntity > SCR_ComboRequiredDeployableParts.GetFoundEntities

(

)

Returns

Implements SCR_RequiredDeployablePart.

GetMissingPartName()

override LocalizedString SCR_ComboRequiredDeployableParts.GetMissingPartName

(

)

Returns

Implements SCR_RequiredDeployablePart.

IsRequirementMet()

override bool SCR_ComboRequiredDeployableParts.IsRequirementMet

(

out int

difference

)

Parameters

[out]

difference

between number of found entities and required amount

Returns

true if requirement is fulfilled

Implements SCR_RequiredDeployablePart.

Member Data Documentation

m_aOtherFoundEntities

ref array<IEntity> SCR_ComboRequiredDeployableParts.m_aOtherFoundEntities

protected

m_iNumberOfOtherRequiredPrefabs

int SCR_ComboRequiredDeployableParts.m_iNumberOfOtherRequiredPrefabs

protected

m_sOtherPartName

LocalizedString SCR_ComboRequiredDeployableParts.m_sOtherPartName

protected

m_sOtherPrefab

ResourceName SCR_ComboRequiredDeployableParts.m_sOtherPrefab

protected

---

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

• Game/Components/SCR_ComboRequiredDeployableParts.c