SCR_DeployableVariantContainer Class Reference

Inheritance diagram for SCR_DeployableVariantContainer:

Protected Member Functions
int	GetVariantId ()
ResourceName	GetReplacementPrefab ()
int	GetRequiredElements (out notnull array< ref SCR_RequiredDeployablePart > output)
array< ref SCR_RequiredDeployablePart >	GetRequiredElementsRaw ()
	Returns pointer to a shared array of requirements.
array< ref SCR_AdditionalDeployablePart >	GetAdditionalPrefabList ()
bool	GetReplacementPrefabBoundingBox (out vector mins, out vector maxs)
bool	IsUsingPartPositionAndRotation ()
bool	IsSurfaceValid (IEntity surfaceEnt, vector worldPosition, vector surfaceNorm, int nodeIndex, int colliderIndex, SurfaceProperties surfaceProps, string surfaceMaterial, string colliderName)
vector	GetAdditionaPlacementOffset ()
vector	GetAdditionaPlacementRotation ()
float	GetMaxAllowedTilt ()
ResourceName	GetPreviewResource ()
void	SCR_DeployableVariantContainer ()

Protected Attributes
int	m_iVariantId
ResourceName	m_sReplacementPrefab
ResourceName	m_sPreviewObject
ref array< ref SCR_RequiredDeployablePart >	m_aRequiredElements
ref array< ref SCR_AdditionalDeployablePart >	m_aAdditionalPrefabs
vector	m_vReplacementPrefabBoundingBoxMins
vector	m_vReplacementPrefabBoundingBoxMaxs
bool	m_bUsePartRotationAndPosition
vector	m_vAdditionalPlacementOffset
vector	m_vAdditionalPlacementRotation
float	m_fMaxAllowedTilt
ref SCR_DeployableSurfaceValidation	m_SurfaceValidator

Detailed Description

Definition at line 1 of file SCR_DeployableVariantContainer.c.

Constructor & Destructor Documentation

SCR_DeployableVariantContainer()

void SCR_DeployableVariantContainer::SCR_DeployableVariantContainer ( )

inlineprotected

Definition at line 195 of file SCR_DeployableVariantContainer.c.

Member Function Documentation

GetAdditionalPrefabList()

array< ref SCR_AdditionalDeployablePart > SCR_DeployableVariantContainer::GetAdditionalPrefabList ( )

inlineprotected

Returns

Definition at line 79 of file SCR_DeployableVariantContainer.c.

GetAdditionaPlacementOffset()

vector SCR_DeployableVariantContainer::GetAdditionaPlacementOffset ( )

inlineprotected

Returns

Definition at line 167 of file SCR_DeployableVariantContainer.c.

GetAdditionaPlacementRotation()

vector SCR_DeployableVariantContainer::GetAdditionaPlacementRotation ( )

inlineprotected

Returns

Definition at line 174 of file SCR_DeployableVariantContainer.c.

GetMaxAllowedTilt()

float SCR_DeployableVariantContainer::GetMaxAllowedTilt ( )

inlineprotected

Returns

Definition at line 181 of file SCR_DeployableVariantContainer.c.

GetPreviewResource()

ResourceName SCR_DeployableVariantContainer::GetPreviewResource ( )

inlineprotected

Returns

Definition at line 188 of file SCR_DeployableVariantContainer.c.

GetReplacementPrefab()

ResourceName SCR_DeployableVariantContainer::GetReplacementPrefab ( )

inlineprotected

Returns

Definition at line 48 of file SCR_DeployableVariantContainer.c.

GetReplacementPrefabBoundingBox()

bool SCR_DeployableVariantContainer::GetReplacementPrefabBoundingBox ( out vector mins, out vector maxs )

inlineprotected

Parameters

[out]	mins
[out]	maxs

Returns

true if system was able to fetch valid data

Definition at line 97 of file SCR_DeployableVariantContainer.c.

GetRequiredElements()

int SCR_DeployableVariantContainer::GetRequiredElements ( out notnull array< ref SCR_RequiredDeployablePart > output )

inlineprotected

Returns a copy of the list of required prefabs

Parameters

[out]

output

is not cleared before it is filled

Returns

number of elements in the output array

Definition at line 57 of file SCR_DeployableVariantContainer.c.

GetRequiredElementsRaw()

array< ref SCR_RequiredDeployablePart > SCR_DeployableVariantContainer::GetRequiredElementsRaw ( )

inlineprotected

Returns pointer to a shared array of requirements.

Definition at line 72 of file SCR_DeployableVariantContainer.c.

GetVariantId()

int SCR_DeployableVariantContainer::GetVariantId ( )

inlineprotected

Returns

Definition at line 41 of file SCR_DeployableVariantContainer.c.

IsSurfaceValid()

bool SCR_DeployableVariantContainer::IsSurfaceValid ( IEntity surfaceEnt, vector worldPosition, vector surfaceNorm, int nodeIndex, int colliderIndex, SurfaceProperties surfaceProps, string surfaceMaterial, string colliderName )

inlineprotected

Validates if provided entity can be considered as a valid surface for deployment

Parameters

[in]	surfaceEnt	entity on which the item is going to be deployed
[in]	worldPosition	position in world space
[in]	surfaceNorm	normal of the face on which the item is going to be deployed
[in]	nodeIndex	bone id to which is attached the collider on which the item is going to be deployed
[in]	colliderIndex	collider id on which the item is going to be deployed
[in]	surfaceProps	properties of the surface on which the item is going to be deployed
[in]	surfaceMaterial	name of the material of the surface on which the item is going to be deployed
[in]	colliderName	name of the collider on which the item is going to be deployed

Returns

true if item can be deployed on this surface, otherwise false

Definition at line 157 of file SCR_DeployableVariantContainer.c.

IsUsingPartPositionAndRotation()

bool SCR_DeployableVariantContainer::IsUsingPartPositionAndRotation ( )

inlineprotected

Returns

Definition at line 141 of file SCR_DeployableVariantContainer.c.

Member Data Documentation

m_aAdditionalPrefabs

ref array<ref SCR_AdditionalDeployablePart> SCR_DeployableVariantContainer::m_aAdditionalPrefabs

protected

Definition at line 16 of file SCR_DeployableVariantContainer.c.

m_aRequiredElements

ref array<ref SCR_RequiredDeployablePart> SCR_DeployableVariantContainer::m_aRequiredElements

protected

Definition at line 13 of file SCR_DeployableVariantContainer.c.

m_bUsePartRotationAndPosition

bool SCR_DeployableVariantContainer::m_bUsePartRotationAndPosition

protected

Definition at line 25 of file SCR_DeployableVariantContainer.c.

m_fMaxAllowedTilt

float SCR_DeployableVariantContainer::m_fMaxAllowedTilt

protected

Definition at line 34 of file SCR_DeployableVariantContainer.c.

m_iVariantId

int SCR_DeployableVariantContainer::m_iVariantId

protected

Definition at line 4 of file SCR_DeployableVariantContainer.c.

m_sPreviewObject

ResourceName SCR_DeployableVariantContainer::m_sPreviewObject

protected

Definition at line 10 of file SCR_DeployableVariantContainer.c.

m_sReplacementPrefab

ResourceName SCR_DeployableVariantContainer::m_sReplacementPrefab

protected

Definition at line 7 of file SCR_DeployableVariantContainer.c.

m_SurfaceValidator

ref SCR_DeployableSurfaceValidation SCR_DeployableVariantContainer::m_SurfaceValidator

protected

Definition at line 37 of file SCR_DeployableVariantContainer.c.

m_vAdditionalPlacementOffset

vector SCR_DeployableVariantContainer::m_vAdditionalPlacementOffset

protected

Definition at line 28 of file SCR_DeployableVariantContainer.c.

m_vAdditionalPlacementRotation

vector SCR_DeployableVariantContainer::m_vAdditionalPlacementRotation

protected

Definition at line 31 of file SCR_DeployableVariantContainer.c.

m_vReplacementPrefabBoundingBoxMaxs

vector SCR_DeployableVariantContainer::m_vReplacementPrefabBoundingBoxMaxs

protectedbound

Definition at line 22 of file SCR_DeployableVariantContainer.c.

m_vReplacementPrefabBoundingBoxMins

vector SCR_DeployableVariantContainer::m_vReplacementPrefabBoundingBoxMins

protectedbound

Definition at line 19 of file SCR_DeployableVariantContainer.c.

---

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

• scripts/Game/Components/SCR_DeployableVariantContainer.c