SCR_BaseDeployableInventoryItemComponent Interface Reference

Base class which all deployable inventory items inherit from. More...

Inheritance diagram for SCR_BaseDeployableInventoryItemComponent:

Public Member Functions
void	SetDeploying (bool isDeploying)
bool	IsDeploying ()
ScriptInvokerBool	GetOnDeployedStateChanged ()
void	OnCompositionDestroyed (IEntity instigator)
	Callback method that is triggered when composition is destroyed.
void	Deploy (IEntity userEntity=null, bool reload=false)
	Gets called when deploy action is executed by player.
void	Dismantle (IEntity userEntity=null, bool reload=false)
	Gets called when dismantle action is executed by player.
void	Reload ()
	Dismantle and redeploy to update settings.
bool	CanDeployBeShown (notnull IEntity userEntity)
bool	CanDismantleBeShown (notnull IEntity userEntity)
bool	IsDeployed ()
int	GetItemOwnerID ()
override void	OnPostInit (IEntity owner)

Protected Member Functions
void	RPC_SetTransformBroadcast (vector transform[4])
void	RPC_PlaySoundOnDeployBroadcast (bool deploy)
void	OnRplDeployed ()

Protected Attributes
bool	m_bEnableSounds
bool	m_bIsDeployed
IEntity	m_ReplacementEntity
vector	m_aOriginalTransform [4]
RplComponent	m_RplComponent
bool	m_bIsDeploying
int	m_iItemOwnerID = -1
ref ScriptInvokerBool	m_OnDeployedStateChanged
bool	m_bWasDeployed
IEntity	m_PreviousOwner

Detailed Description

Base class which all deployable inventory items inherit from.

Member Function Documentation

CanDeployBeShown()

bool SCR_BaseDeployableInventoryItemComponent.CanDeployBeShown

(

notnull IEntity

userEntity

)

Parameters

[in]

userEntity

Returns

Implemented in SCR_RestrictedDeployableSpawnPointComponent.

CanDismantleBeShown()

bool SCR_BaseDeployableInventoryItemComponent.CanDismantleBeShown

(

notnull IEntity

userEntity

)

Parameters

[in]

userEntity

Returns

Implemented in SCR_RestrictedDeployableSpawnPointComponent.

Deploy()

void SCR_BaseDeployableInventoryItemComponent.Deploy	(	IEntity	userEntity = null,
		bool	reload = false
	)

Gets called when deploy action is executed by player.

Parameters

[in]

userEntity

Implemented in SCR_RestrictedDeployableSpawnPointComponent, and SCR_BaseDeployableSpawnPointComponent.

Dismantle()

void SCR_BaseDeployableInventoryItemComponent.Dismantle	(	IEntity	userEntity = null,
		bool	reload = false
	)

Gets called when dismantle action is executed by player.

Parameters

[in]

userEntity

Implemented in SCR_BaseDeployableSpawnPointComponent, and SCR_RestrictedDeployableSpawnPointComponent.

GetItemOwnerID()

int SCR_BaseDeployableInventoryItemComponent.GetItemOwnerID

(

)

Returns

GetOnDeployedStateChanged()

ScriptInvokerBool SCR_BaseDeployableInventoryItemComponent.GetOnDeployedStateChanged

(

)

IsDeployed()

bool SCR_BaseDeployableInventoryItemComponent.IsDeployed

(

)

Returns

IsDeploying()

bool SCR_BaseDeployableInventoryItemComponent.IsDeploying

(

)

OnCompositionDestroyed()

void SCR_BaseDeployableInventoryItemComponent.OnCompositionDestroyed

(

IEntity

instigator

)

Callback method that is triggered when composition is destroyed.

OnPostInit()

override void SCR_BaseDeployableInventoryItemComponent.OnPostInit

(

IEntity

owner

)

OnRplDeployed()

void SCR_BaseDeployableInventoryItemComponent.OnRplDeployed ( )

protected

Implemented in SCR_BaseDeployableSpawnPointComponent.

Reload()

void SCR_BaseDeployableInventoryItemComponent.Reload

(

)

Dismantle and redeploy to update settings.

RPC_PlaySoundOnDeployBroadcast()

void SCR_BaseDeployableInventoryItemComponent.RPC_PlaySoundOnDeployBroadcast ( bool  deploy )

protected

RPC_SetTransformBroadcast()

void SCR_BaseDeployableInventoryItemComponent.RPC_SetTransformBroadcast ( vector  transform[4] )

protected

SetDeploying()

void SCR_BaseDeployableInventoryItemComponent.SetDeploying

(

bool

isDeploying

)

Member Data Documentation

m_aOriginalTransform

vector SCR_BaseDeployableInventoryItemComponent.m_aOriginalTransform[4]

protected

m_bEnableSounds

bool SCR_BaseDeployableInventoryItemComponent.m_bEnableSounds

protected

m_bIsDeployed

bool SCR_BaseDeployableInventoryItemComponent.m_bIsDeployed

protected

m_bIsDeploying

bool SCR_BaseDeployableInventoryItemComponent.m_bIsDeploying

protected

m_bWasDeployed

bool SCR_BaseDeployableInventoryItemComponent.m_bWasDeployed

protected

m_iItemOwnerID

int SCR_BaseDeployableInventoryItemComponent.m_iItemOwnerID = -1

protected

m_OnDeployedStateChanged

ref ScriptInvokerBool SCR_BaseDeployableInventoryItemComponent.m_OnDeployedStateChanged

protected

m_PreviousOwner

IEntity SCR_BaseDeployableInventoryItemComponent.m_PreviousOwner

protected

m_ReplacementEntity

IEntity SCR_BaseDeployableInventoryItemComponent.m_ReplacementEntity

protected

m_RplComponent

RplComponent SCR_BaseDeployableInventoryItemComponent.m_RplComponent

protected

---

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

• Game/DeployableInventoryItems/Components/SCR_BaseDeployableInventoryItemComponent.c