SCR_DeployableVariantContainer Interface Reference

Inheritance diagram for SCR_DeployableVariantContainer:

Public Member Functions
int	GetVariantId ()
ResourceName	GetReplacementPrefab ()
int	GetRequiredElements (out notnull array< ref SCR_RequiredDeployablePart > output)
	Returns a copy of the list of required prefabs.
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)
	Validates if provided entity can be considered as a valid surface for deployment.
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

Constructor & Destructor Documentation

SCR_DeployableVariantContainer()

void SCR_DeployableVariantContainer.SCR_DeployableVariantContainer

(

)

Member Function Documentation

GetAdditionalPrefabList()

array< ref SCR_AdditionalDeployablePart > SCR_DeployableVariantContainer.GetAdditionalPrefabList

(

)

Returns

GetAdditionaPlacementOffset()

vector SCR_DeployableVariantContainer.GetAdditionaPlacementOffset

(

)

Returns

GetAdditionaPlacementRotation()

vector SCR_DeployableVariantContainer.GetAdditionaPlacementRotation

(

)

Returns

GetMaxAllowedTilt()

float SCR_DeployableVariantContainer.GetMaxAllowedTilt

(

)

Returns

GetPreviewResource()

ResourceName SCR_DeployableVariantContainer.GetPreviewResource

(

)

Returns

GetReplacementPrefab()

ResourceName SCR_DeployableVariantContainer.GetReplacementPrefab

(

)

Returns

GetReplacementPrefabBoundingBox()

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

Parameters

[out]	mins
[out]	maxs

Returns

true if system was able to fetch valid data

GetRequiredElements()

int SCR_DeployableVariantContainer.GetRequiredElements

(

out notnull array< ref SCR_RequiredDeployablePart >

output

)

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

GetRequiredElementsRaw()

array< ref SCR_RequiredDeployablePart > SCR_DeployableVariantContainer.GetRequiredElementsRaw

(

)

Returns pointer to a shared array of requirements.

GetVariantId()

int SCR_DeployableVariantContainer.GetVariantId

(

)

Returns

IsSurfaceValid()

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

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

IsUsingPartPositionAndRotation()

bool SCR_DeployableVariantContainer.IsUsingPartPositionAndRotation

(

)

Returns

Member Data Documentation

m_aAdditionalPrefabs

ref array<ref SCR_AdditionalDeployablePart> SCR_DeployableVariantContainer.m_aAdditionalPrefabs

protected

m_aRequiredElements

ref array<ref SCR_RequiredDeployablePart> SCR_DeployableVariantContainer.m_aRequiredElements

protected

m_bUsePartRotationAndPosition

bool SCR_DeployableVariantContainer.m_bUsePartRotationAndPosition

protected

m_fMaxAllowedTilt

float SCR_DeployableVariantContainer.m_fMaxAllowedTilt

protected

m_iVariantId

int SCR_DeployableVariantContainer.m_iVariantId

protected

m_sPreviewObject

ResourceName SCR_DeployableVariantContainer.m_sPreviewObject

protected

m_sReplacementPrefab

ResourceName SCR_DeployableVariantContainer.m_sReplacementPrefab

protected

m_SurfaceValidator

ref SCR_DeployableSurfaceValidation SCR_DeployableVariantContainer.m_SurfaceValidator

protected

m_vAdditionalPlacementOffset

vector SCR_DeployableVariantContainer.m_vAdditionalPlacementOffset

protected

m_vAdditionalPlacementRotation

vector SCR_DeployableVariantContainer.m_vAdditionalPlacementRotation

protected

m_vReplacementPrefabBoundingBoxMaxs

vector SCR_DeployableVariantContainer.m_vReplacementPrefabBoundingBoxMaxs

protected

m_vReplacementPrefabBoundingBoxMins

vector SCR_DeployableVariantContainer.m_vReplacementPrefabBoundingBoxMins

protected

---

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

• Game/Components/SCR_DeployableVariantContainer.c