SCR_AlternativeRequirementsDeployablePart Interface Reference

Inheritance diagram for SCR_AlternativeRequirementsDeployablePart:

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 int	GetNumberOfFoundEntities ()
override array< IEntity >	GetFoundEntities ()
override bool	DeleteFoundEntity (int id, notnull IEntity user)
	Attempts to delete one of the found entities and remove it from the array.
override 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.
void	AlternativeRequirementOverride (SCR_RequiredDeployablePart newRequirement)
void	SCR_AlternativeRequirementsDeployablePart ()
Public Member Functions inherited from SCR_RequiredDeployablePart
ResourceName	GetPrefab ()
void	SetNumberOfRequiredPrefabs (int newValue)
int	GetNumberOfRequiredPrefabs ()
LocalizedString	GetPartName ()
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.

Protected Attributes
ref SCR_RequiredDeployablePart	m_AlternativeRequirement
bool	m_bCanMix
bool	m_bRequirementMet
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

Constructor & Destructor Documentation

SCR_AlternativeRequirementsDeployablePart()

void SCR_AlternativeRequirementsDeployablePart.SCR_AlternativeRequirementsDeployablePart

(

)

Member Function Documentation

AlternativeRequirementOverride()

void SCR_AlternativeRequirementsDeployablePart.AlternativeRequirementOverride

(

SCR_RequiredDeployablePart

newRequirement

)

DeepClone()

override SCR_RequiredDeployablePart SCR_AlternativeRequirementsDeployablePart.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.

Implements SCR_RequiredDeployablePart.

DeleteFoundEntity()

override bool SCR_AlternativeRequirementsDeployablePart.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_AlternativeRequirementsDeployablePart.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_AlternativeRequirementsDeployablePart.GetFoundEntities

(

)

Returns

Implements SCR_RequiredDeployablePart.

GetMissingPartName()

override LocalizedString SCR_AlternativeRequirementsDeployablePart.GetMissingPartName

(

)

Returns

Implements SCR_RequiredDeployablePart.

GetNumberOfFoundEntities()

override int SCR_AlternativeRequirementsDeployablePart.GetNumberOfFoundEntities

(

)

Returns

Implements SCR_RequiredDeployablePart.

IsRequirementMet()

override bool SCR_AlternativeRequirementsDeployablePart.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_AlternativeRequirement

ref SCR_RequiredDeployablePart SCR_AlternativeRequirementsDeployablePart.m_AlternativeRequirement

protected

m_bCanMix

bool SCR_AlternativeRequirementsDeployablePart.m_bCanMix

protected

m_bRequirementMet

bool SCR_AlternativeRequirementsDeployablePart.m_bRequirementMet

protected

---

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

• Game/Components/SCR_AlternativeRequirementsDeployablePart.c