SCR_MultiPartDeployableItemComponentClass Interface Reference

Inheritance diagram for SCR_MultiPartDeployableItemComponentClass:

Public Member Functions
array< ref SCR_DeployableVariantContainer >	GetVariants ()
SCR_DeployableVariantContainer	GetVariantContainer (int variantId)
SCR_ESurfaceMonitoringBehaviour	GetMonitoringBehaviour ()
int	GetSearchRadius ()
float	GetIndoorsCheckHeight ()
float	IsDeletedWhenDeployed ()
bool	MustDropLoadedMagazines ()
bool	MustDropAllStoredItems ()
void	SetPreviewEntity (notnull IEntity ent, int variantId)
IEntity	GetPreviewEntity ()
int	GetPreviewVariantId ()
SCR_EPreviewState	GetPreviewState ()
void	SetPreviewState (SCR_EPreviewState newState)
LocalizedString	GetSpaceValidationFailureReason (notnull IEntity collidingBody)
void	~SCR_MultiPartDeployableItemComponentClass ()
Public Member Functions inherited from SCR_BaseDeployableInventoryItemComponentClass
ResourceName	GetReplacementPrefab ()

Protected Attributes
int	m_iSearchRadius
float	m_fIndoorsCheckHeight
bool	m_bDeleteThisPartOnDeployment
bool	m_bRemoveLoadedMagazineWhenDeleted
bool	m_bRemoveAllItemsWhenDeleted
ref array< ref SCR_DeployableVariantContainer >	m_aVariants
SCR_ESurfaceMonitoringBehaviour	m_eSurfaceObservationBehaviour
IEntity	m_PreviewEntity
int	m_iPreviewVariant = -1
SCR_EPreviewState	m_ePreviewState
Protected Attributes inherited from SCR_BaseDeployableInventoryItemComponentClass
ResourceName	m_sReplacementPrefab

Static Protected Attributes
const LocalizedString	REASON_NO_SPACE = "#AR-UserAction_Assemble_NoSpace"
const LocalizedString	REASON_NO_SPACE_TERRAIN = "#AR-UserAction_Assemble_NoSpaceTerrain"
const LocalizedString	REASON_OBSTRUCTED_BY = "#AR-UserAction_Assemble_ObstructedBy"

Constructor & Destructor Documentation

~SCR_MultiPartDeployableItemComponentClass()

void SCR_MultiPartDeployableItemComponentClass.~SCR_MultiPartDeployableItemComponentClass

(

)

Member Function Documentation

GetIndoorsCheckHeight()

float SCR_MultiPartDeployableItemComponentClass.GetIndoorsCheckHeight

(

)

Returns

GetMonitoringBehaviour()

SCR_ESurfaceMonitoringBehaviour SCR_MultiPartDeployableItemComponentClass.GetMonitoringBehaviour

(

)

Returns

GetPreviewEntity()

IEntity SCR_MultiPartDeployableItemComponentClass.GetPreviewEntity

(

)

Returns

GetPreviewState()

SCR_EPreviewState SCR_MultiPartDeployableItemComponentClass.GetPreviewState

(

)

Returns

Current preview state

GetPreviewVariantId()

int SCR_MultiPartDeployableItemComponentClass.GetPreviewVariantId

(

)

Returns

GetSearchRadius()

int SCR_MultiPartDeployableItemComponentClass.GetSearchRadius

(

)

Returns

GetSpaceValidationFailureReason()

LocalizedString SCR_MultiPartDeployableItemComponentClass.GetSpaceValidationFailureReason

(

notnull IEntity

collidingBody

)

Parameters

[in]

collidingBody

which was detected during space validation

Returns

localized string with a reason that coresponds to the provided object

GetVariantContainer()

SCR_DeployableVariantContainer SCR_MultiPartDeployableItemComponentClass.GetVariantContainer

(

int

variantId

)

Parameters

[in]

variantId

of requested variant

Returns

pointer to the variant container that is shared by all instances of this prefab or null if such variant is not found

GetVariants()

array< ref SCR_DeployableVariantContainer > SCR_MultiPartDeployableItemComponentClass.GetVariants

(

)

Returns

pointer to the array with all variants

IsDeletedWhenDeployed()

float SCR_MultiPartDeployableItemComponentClass.IsDeletedWhenDeployed

(

)

Returns

MustDropAllStoredItems()

bool SCR_MultiPartDeployableItemComponentClass.MustDropAllStoredItems

(

)

Returns

MustDropLoadedMagazines()

bool SCR_MultiPartDeployableItemComponentClass.MustDropLoadedMagazines

(

)

Returns

SetPreviewEntity()

void SCR_MultiPartDeployableItemComponentClass.SetPreviewEntity	(	notnull IEntity	ent,
		int	variantId )

Parameters

[in]

ent

SetPreviewState()

void SCR_MultiPartDeployableItemComponentClass.SetPreviewState

(

SCR_EPreviewState

newState

)

Returns

Member Data Documentation

m_aVariants

ref array<ref SCR_DeployableVariantContainer> SCR_MultiPartDeployableItemComponentClass.m_aVariants

protected

m_bDeleteThisPartOnDeployment

bool SCR_MultiPartDeployableItemComponentClass.m_bDeleteThisPartOnDeployment

protected

m_bRemoveAllItemsWhenDeleted

bool SCR_MultiPartDeployableItemComponentClass.m_bRemoveAllItemsWhenDeleted

protected

m_bRemoveLoadedMagazineWhenDeleted

bool SCR_MultiPartDeployableItemComponentClass.m_bRemoveLoadedMagazineWhenDeleted

protected

m_ePreviewState

SCR_EPreviewState SCR_MultiPartDeployableItemComponentClass.m_ePreviewState

protected

m_eSurfaceObservationBehaviour

SCR_ESurfaceMonitoringBehaviour SCR_MultiPartDeployableItemComponentClass.m_eSurfaceObservationBehaviour

protected

m_fIndoorsCheckHeight

float SCR_MultiPartDeployableItemComponentClass.m_fIndoorsCheckHeight

protected

m_iPreviewVariant

int SCR_MultiPartDeployableItemComponentClass.m_iPreviewVariant = -1

protected

m_iSearchRadius

int SCR_MultiPartDeployableItemComponentClass.m_iSearchRadius

protected

m_PreviewEntity

IEntity SCR_MultiPartDeployableItemComponentClass.m_PreviewEntity

protected

REASON_NO_SPACE

const LocalizedString SCR_MultiPartDeployableItemComponentClass.REASON_NO_SPACE = "#AR-UserAction_Assemble_NoSpace"

staticprotected

REASON_NO_SPACE_TERRAIN

const LocalizedString SCR_MultiPartDeployableItemComponentClass.REASON_NO_SPACE_TERRAIN = "#AR-UserAction_Assemble_NoSpaceTerrain"

staticprotected

REASON_OBSTRUCTED_BY

const LocalizedString SCR_MultiPartDeployableItemComponentClass.REASON_OBSTRUCTED_BY = "#AR-UserAction_Assemble_ObstructedBy"

staticprotected

---

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

• Game/Components/SCR_MultiPartDeployableItemComponent.c