SCR_BaseDeployableSpawnPointComponent Interface Reference

Base class which all deployable spawn points / radios inherit from. More...

Inheritance diagram for SCR_BaseDeployableSpawnPointComponent:

Public Member Functions
override void	Deploy (IEntity userEntity=null, bool reload=false)
	Spawns replacement composition and attaches owner entity to it - called from SCR_DeployItemBaseAction.PerformAction.
override void	Dismantle (IEntity userEntity=null, bool reload=false)
	Delete replacement composition and spawnpoint and set position of owner entity to it's original position - called from SCR_DismantleItemBaseAction.PerformAction.
SCR_SpawnPoint	GetSpawnPoint ()
void	Update (float timeSlice)
override void	EOnInit (IEntity owner)
override void	OnDelete (IEntity owner)
void	~SCR_BaseDeployableSpawnPointComponent ()
Public Member Functions inherited from SCR_BaseDeployableInventoryItemComponent
void	SetDeploying (bool isDeploying)
bool	IsDeploying ()
SCR_DeployableItemState	GetOnDeployedStateChanged ()
void	OnCompositionDestroyed (IEntity instigator)
	Callback method that is triggered when composition is destroyed.
void	SetItemOwner (int playerId)
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)

Static Public Member Functions
static ScriptInvokerInt	GetOnSpawnPointDismantled ()
static array< SCR_BaseDeployableSpawnPointComponent >	GetActiveDeployedSpawnPoints ()

Protected Member Functions
override void	OnRplDeployed ()
void	ToggleRadioChatter (bool enable)
SCR_DeployableSpawnPoint	CreateSpawnPoint ()
void	OnSpawnPointDeployingEnabledChanged (bool enabled)
void	ConnectToDeployableSpawnPointSystem ()
void	DisconnectFromDeployableSpawnPointSystem ()
Protected Member Functions inherited from SCR_BaseDeployableInventoryItemComponent
void	RPC_SetTransformBroadcast (vector transform[4])
void	RPC_PlaySoundOnDeployBroadcast (bool deploy)

Protected Attributes
ResourceName	m_sSpawnPointPrefab
FactionKey	m_FactionKey
SCR_DeployableSpawnPoint	m_SpawnPoint
bool	m_bDeployableSpawnPointsEnabled
Protected Attributes inherited from SCR_BaseDeployableInventoryItemComponent
bool	m_bEnableSounds
bool	m_bDeleteWhenDestroyed
bool	m_bIsDeployed
IEntity	m_ReplacementEntity
vector	m_aOriginalTransform [4]
RplComponent	m_RplComponent
bool	m_bIsDeploying
int	m_iItemOwnerID
ref SCR_DeployableItemState	m_OnDeployedStateChanged
bool	m_bWasDeployed
IEntity	m_PreviousOwner

Static Protected Attributes
static ref array< SCR_BaseDeployableSpawnPointComponent >	s_aActiveDeployedSpawnPoints = {}
static ref ScriptInvokerInt	s_OnSpawnPointDismantled

Detailed Description

Base class which all deployable spawn points / radios inherit from.

Constructor & Destructor Documentation

~SCR_BaseDeployableSpawnPointComponent()

void SCR_BaseDeployableSpawnPointComponent.~SCR_BaseDeployableSpawnPointComponent

(

)

Member Function Documentation

ConnectToDeployableSpawnPointSystem()

void SCR_BaseDeployableSpawnPointComponent.ConnectToDeployableSpawnPointSystem ( )

protected

CreateSpawnPoint()

SCR_DeployableSpawnPoint SCR_BaseDeployableSpawnPointComponent.CreateSpawnPoint ( )

protected

Implemented in SCR_RestrictedDeployableSpawnPointComponent.

Deploy()

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

Spawns replacement composition and attaches owner entity to it - called from SCR_DeployItemBaseAction.PerformAction.

Parameters

[in]

userEntity

Implements SCR_BaseDeployableInventoryItemComponent.

Implemented in SCR_RestrictedDeployableSpawnPointComponent.

DisconnectFromDeployableSpawnPointSystem()

void SCR_BaseDeployableSpawnPointComponent.DisconnectFromDeployableSpawnPointSystem ( )

protected

Dismantle()

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

Delete replacement composition and spawnpoint and set position of owner entity to it's original position - called from SCR_DismantleItemBaseAction.PerformAction.

Parameters

[in]

userEntity

Implements SCR_BaseDeployableInventoryItemComponent.

Implemented in SCR_RestrictedDeployableSpawnPointComponent.

EOnInit()

override void SCR_BaseDeployableSpawnPointComponent.EOnInit

(

IEntity

owner

)

Implemented in SCR_RestrictedDeployableSpawnPointComponent.

GetActiveDeployedSpawnPoints()

static array< SCR_BaseDeployableSpawnPointComponent > SCR_BaseDeployableSpawnPointComponent.GetActiveDeployedSpawnPoints ( )

static

Returns

GetOnSpawnPointDismantled()

static ScriptInvokerInt SCR_BaseDeployableSpawnPointComponent.GetOnSpawnPointDismantled ( )

static

GetSpawnPoint()

SCR_SpawnPoint SCR_BaseDeployableSpawnPointComponent.GetSpawnPoint

(

)

Returns

OnDelete()

override void SCR_BaseDeployableSpawnPointComponent.OnDelete

(

IEntity

owner

)

Implements SCR_BaseDeployableInventoryItemComponent.

Implemented in SCR_RestrictedDeployableSpawnPointComponent.

OnRplDeployed()

override void SCR_BaseDeployableSpawnPointComponent.OnRplDeployed ( )

protected

Implements SCR_BaseDeployableInventoryItemComponent.

OnSpawnPointDeployingEnabledChanged()

void SCR_BaseDeployableSpawnPointComponent.OnSpawnPointDeployingEnabledChanged ( bool enabled )

protected

ToggleRadioChatter()

void SCR_BaseDeployableSpawnPointComponent.ToggleRadioChatter ( bool enable )

protected

Update()

void SCR_BaseDeployableSpawnPointComponent.Update

(

float

timeSlice

)

Parameters

[in]

timeSlice

Implemented in SCR_RestrictedDeployableSpawnPointComponent.

Member Data Documentation

m_bDeployableSpawnPointsEnabled

bool SCR_BaseDeployableSpawnPointComponent.m_bDeployableSpawnPointsEnabled

protected

m_FactionKey

FactionKey SCR_BaseDeployableSpawnPointComponent.m_FactionKey

protected

m_SpawnPoint

SCR_DeployableSpawnPoint SCR_BaseDeployableSpawnPointComponent.m_SpawnPoint

protected

m_sSpawnPointPrefab

ResourceName SCR_BaseDeployableSpawnPointComponent.m_sSpawnPointPrefab

protected

s_aActiveDeployedSpawnPoints

ref array<SCR_BaseDeployableSpawnPointComponent> SCR_BaseDeployableSpawnPointComponent.s_aActiveDeployedSpawnPoints = {}

staticprotected

s_OnSpawnPointDismantled

ref ScriptInvokerInt SCR_BaseDeployableSpawnPointComponent.s_OnSpawnPointDismantled

staticprotected

---

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

• Game/DeployableInventoryItems/Components/SCR_BaseDeployableSpawnPointComponent.c