SCR_RestrictedDeployableSpawnPointComponent Interface Reference

Deployable spawn point with configurable conditions. More...

Inheritance diagram for SCR_RestrictedDeployableSpawnPointComponent:

Public Member Functions
override void	Deploy (IEntity userEntity, bool reload=false)
	Check if deploy is possible, then call super.Deploy()
override void	Dismantle (IEntity userEntity=null, bool reload=false)
	Cache respawn count; then call super.Dismantle()
void	ShowInfo (notnull IEntity userEntity)
	Display amount of respawns left - called from SCR_ShowDeployableSpawnPointInfo.PerformAction.
void	ToggleSpawningWithLoadout (notnull IEntity userEntity)
	Toggles spawning with custom loadout.
bool	CanDeployBePerformed (out string reason)
override bool	CanDeployBeShown (notnull IEntity userEntity)
override bool	CanDismantleBeShown (notnull IEntity userEntity)
bool	CanInfoBeShown (notnull IEntity userEntity)
bool	CanOpenStorageBeShown (notnull IEntity userEntity)
bool	CanToggleLoadoutSpawningBeShown (notnull IEntity userEntity)
bool	GetAllowAllGroupsToSpawn ()
bool	GetIgnoreEnemyCharacters ()
int	GetGroupID ()
float	GetQueryRadiusCharacters ()
void	SetRespawnCount (int respawnCount)
void	SetMaxRespawns (int maxRespawns)
void	SetBudgetType (SCR_ESpawnPointBudgetType budgetType)
override void	Update (float timeSlice)
override void	EOnInit (IEntity owner)
override void	OnDelete (IEntity owner)
Public Member Functions inherited from SCR_BaseDeployableSpawnPointComponent
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)
void	~SCR_BaseDeployableSpawnPointComponent ()
Public Member Functions inherited from SCR_BaseDeployableInventoryItemComponent
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_AddSpawnPointGroupBroadcast (int groupID)
void	RPC_RemoveSpawnPointGroupBroadcast (int groupID)
void	RPC_PlaySoundOnZoneEnteredBroadcast (bool entered)
bool	EntityQuery (notnull array< IEntity > entities, notnull Faction spawnPointFaction, vector spawnPointOrigin)
	Returns true when there are no entities in the specified area that could prevent deploying.
bool	CanActionBeShown (notnull IEntity userEntity, bool checkFaction, bool checkGroupID)
bool	CanBeDeployedAtPosition (vector position, notnull IEntity userEntity, out int notification=-1)
bool	IsDeployLimitReachedLocal ()
override SCR_DeployableSpawnPoint	CreateSpawnPoint ()
void	OnGroupChanged (int groupID)
void	OnGroupRemoved (SCR_AIGroup group)
void	OnSpawnPointBudgetTypeChanged (SCR_ESpawnPointBudgetType budgetType)
void	OnSpawnPointTicketAmountChanged (int tickets)
Protected Member Functions inherited from SCR_BaseDeployableSpawnPointComponent
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)
void	OnRplDeployed ()

Protected Attributes
ResourceName	m_sSpawnPointPrefabSupplies
bool	m_bPlaySoundOnZoneEntered
bool	m_bShowNotificationOnZoneEntered
int	m_iMaxSpawnPointsPerGroup
SCR_ESpawnPointBudgetType	m_eRespawnBudgetType
float	m_fSuppliesValue
int	m_iMaxRespawns
bool	m_bAllowAllGroupsToSpawn
bool	m_bAllowCustomLoadouts
float	m_fUpdateRate
bool	m_bQueryBases
bool	m_bQuerySpawnPoints
bool	m_bQueryCharacters
float	m_fQueryRadiusBases
float	m_fQueryRadiusSpawnPoints
float	m_fQueryRadiusCharacters
bool	m_bQueryAllBases
bool	m_bIgnoreEnemyBases
bool	m_bIgnoreEnemySpawnPoints
bool	m_bIgnoreEnemyCharacters
bool	m_bUnlockActionsForEnemyFactions
bool	m_bUnlockActionsForAllGroups
string	m_sOutsideDeployAreaMessage
string	m_sDeployLimitReachedMessage
string	m_sNoGroupJoinedMessage
int	m_iGroupID = -1
bool	m_bIsOutsideExclusionZone
SCR_AIGroup	m_LocalPlayerGroup
bool	m_bIsGroupLimitReached
bool	m_bNoGroupJoined
bool	m_bSpawnLimitReached
bool	m_bIsWornByPlayer
int	m_iRespawnCount
float	m_fTimeSinceUpdate
Protected Attributes inherited from SCR_BaseDeployableSpawnPointComponent
ResourceName	m_sSpawnPointPrefab
FactionKey	m_FactionKey
SCR_DeployableSpawnPoint	m_SpawnPoint
bool	m_bDeployableSpawnPointsEnabled
Protected Attributes inherited from SCR_BaseDeployableInventoryItemComponent
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

Static Protected Attributes
static ref array< int >	s_aActiveDeployedSpawnPointGroupIDs = {}
Static Protected Attributes inherited from SCR_BaseDeployableSpawnPointComponent
static ref array< SCR_BaseDeployableSpawnPointComponent >	s_aActiveDeployedSpawnPoints = {}
static ref ScriptInvokerInt	s_OnSpawnPointDismantled

Additional Inherited Members
Static Public Member Functions inherited from SCR_BaseDeployableSpawnPointComponent
static ScriptInvokerInt	GetOnSpawnPointDismantled ()
static array< SCR_BaseDeployableSpawnPointComponent >	GetActiveDeployedSpawnPoints ()

Detailed Description

Deployable spawn point with configurable conditions.

Member Function Documentation

CanActionBeShown()

bool SCR_RestrictedDeployableSpawnPointComponent.CanActionBeShown ( notnull IEntity  userEntity, bool  checkFaction, bool  checkGroupID  )

protected

CanBeDeployedAtPosition()

bool SCR_RestrictedDeployableSpawnPointComponent.CanBeDeployedAtPosition ( vector  position, notnull IEntity  userEntity, out int  notification = -1  )

protected

CanDeployBePerformed()

bool SCR_RestrictedDeployableSpawnPointComponent.CanDeployBePerformed

(

out string

reason

)

Parameters

[out]

reason

Returns

CanDeployBeShown()

override bool SCR_RestrictedDeployableSpawnPointComponent.CanDeployBeShown

(

notnull IEntity

userEntity

)

Parameters

[in]

userEntity

Returns

Implements SCR_BaseDeployableInventoryItemComponent.

CanDismantleBeShown()

override bool SCR_RestrictedDeployableSpawnPointComponent.CanDismantleBeShown

(

notnull IEntity

userEntity

)

Parameters

[in]

userEntity

Returns

Implements SCR_BaseDeployableInventoryItemComponent.

CanInfoBeShown()

bool SCR_RestrictedDeployableSpawnPointComponent.CanInfoBeShown

(

notnull IEntity

userEntity

)

Parameters

[in]

userEntity

Returns

CanOpenStorageBeShown()

bool SCR_RestrictedDeployableSpawnPointComponent.CanOpenStorageBeShown

(

notnull IEntity

userEntity

)

Parameters

[in]

userEntity

Returns

CanToggleLoadoutSpawningBeShown()

bool SCR_RestrictedDeployableSpawnPointComponent.CanToggleLoadoutSpawningBeShown

(

notnull IEntity

userEntity

)

Parameters

[in]

userEntity

Returns

CreateSpawnPoint()

override SCR_DeployableSpawnPoint SCR_RestrictedDeployableSpawnPointComponent.CreateSpawnPoint ( )

protected

Implements SCR_BaseDeployableSpawnPointComponent.

Deploy()

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

Check if deploy is possible, then call super.Deploy()

Implements SCR_BaseDeployableSpawnPointComponent.

Dismantle()

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

Cache respawn count; then call super.Dismantle()

Implements SCR_BaseDeployableSpawnPointComponent.

EntityQuery()

bool SCR_RestrictedDeployableSpawnPointComponent.EntityQuery ( notnull array< IEntity >  entities, notnull Faction  spawnPointFaction, vector  spawnPointOrigin  )

protected

Returns true when there are no entities in the specified area that could prevent deploying.

EOnInit()

override void SCR_RestrictedDeployableSpawnPointComponent.EOnInit

(

IEntity

owner

)

Implements SCR_BaseDeployableSpawnPointComponent.

GetAllowAllGroupsToSpawn()

bool SCR_RestrictedDeployableSpawnPointComponent.GetAllowAllGroupsToSpawn

(

)

Returns

GetGroupID()

int SCR_RestrictedDeployableSpawnPointComponent.GetGroupID

(

)

Returns

GetIgnoreEnemyCharacters()

bool SCR_RestrictedDeployableSpawnPointComponent.GetIgnoreEnemyCharacters

(

)

Returns

GetQueryRadiusCharacters()

float SCR_RestrictedDeployableSpawnPointComponent.GetQueryRadiusCharacters

(

)

Returns

IsDeployLimitReachedLocal()

bool SCR_RestrictedDeployableSpawnPointComponent.IsDeployLimitReachedLocal ( )

protected

OnDelete()

override void SCR_RestrictedDeployableSpawnPointComponent.OnDelete

(

IEntity

owner

)

OnGroupChanged()

void SCR_RestrictedDeployableSpawnPointComponent.OnGroupChanged ( int  groupID )

protected

OnGroupRemoved()

void SCR_RestrictedDeployableSpawnPointComponent.OnGroupRemoved ( SCR_AIGroup  group )

protected

OnSpawnPointBudgetTypeChanged()

void SCR_RestrictedDeployableSpawnPointComponent.OnSpawnPointBudgetTypeChanged ( SCR_ESpawnPointBudgetType  budgetType )

protected

OnSpawnPointTicketAmountChanged()

void SCR_RestrictedDeployableSpawnPointComponent.OnSpawnPointTicketAmountChanged ( int  tickets )

protected

RPC_AddSpawnPointGroupBroadcast()

void SCR_RestrictedDeployableSpawnPointComponent.RPC_AddSpawnPointGroupBroadcast ( int  groupID )

protected

RPC_PlaySoundOnZoneEnteredBroadcast()

void SCR_RestrictedDeployableSpawnPointComponent.RPC_PlaySoundOnZoneEnteredBroadcast ( bool  entered )

protected

RPC_RemoveSpawnPointGroupBroadcast()

void SCR_RestrictedDeployableSpawnPointComponent.RPC_RemoveSpawnPointGroupBroadcast ( int  groupID )

protected

SetBudgetType()

void SCR_RestrictedDeployableSpawnPointComponent.SetBudgetType

(

SCR_ESpawnPointBudgetType

budgetType

)

Parameters

[in]

budgetType

SetMaxRespawns()

void SCR_RestrictedDeployableSpawnPointComponent.SetMaxRespawns

(

int

maxRespawns

)

Parameters

[in]

maxRespawns

SetRespawnCount()

void SCR_RestrictedDeployableSpawnPointComponent.SetRespawnCount

(

int

respawnCount

)

Parameters

[in]

respawnCount

ShowInfo()

void SCR_RestrictedDeployableSpawnPointComponent.ShowInfo

(

notnull IEntity

userEntity

)

Display amount of respawns left - called from SCR_ShowDeployableSpawnPointInfo.PerformAction.

ToggleSpawningWithLoadout()

void SCR_RestrictedDeployableSpawnPointComponent.ToggleSpawningWithLoadout

(

notnull IEntity

userEntity

)

Toggles spawning with custom loadout.

Update()

override void SCR_RestrictedDeployableSpawnPointComponent.Update

(

float

timeSlice

)

Parameters

[in]

timeSlice

Implements SCR_BaseDeployableSpawnPointComponent.

Member Data Documentation

m_bAllowAllGroupsToSpawn

bool SCR_RestrictedDeployableSpawnPointComponent.m_bAllowAllGroupsToSpawn

protected

m_bAllowCustomLoadouts

bool SCR_RestrictedDeployableSpawnPointComponent.m_bAllowCustomLoadouts

protected

m_bIgnoreEnemyBases

bool SCR_RestrictedDeployableSpawnPointComponent.m_bIgnoreEnemyBases

protected

m_bIgnoreEnemyCharacters

bool SCR_RestrictedDeployableSpawnPointComponent.m_bIgnoreEnemyCharacters

protected

m_bIgnoreEnemySpawnPoints

bool SCR_RestrictedDeployableSpawnPointComponent.m_bIgnoreEnemySpawnPoints

protected

m_bIsGroupLimitReached

bool SCR_RestrictedDeployableSpawnPointComponent.m_bIsGroupLimitReached

protected

m_bIsOutsideExclusionZone

bool SCR_RestrictedDeployableSpawnPointComponent.m_bIsOutsideExclusionZone

protected

m_bIsWornByPlayer

bool SCR_RestrictedDeployableSpawnPointComponent.m_bIsWornByPlayer

protected

m_bNoGroupJoined

bool SCR_RestrictedDeployableSpawnPointComponent.m_bNoGroupJoined

protected

m_bPlaySoundOnZoneEntered

bool SCR_RestrictedDeployableSpawnPointComponent.m_bPlaySoundOnZoneEntered

protected

m_bQueryAllBases

bool SCR_RestrictedDeployableSpawnPointComponent.m_bQueryAllBases

protected

m_bQueryBases

bool SCR_RestrictedDeployableSpawnPointComponent.m_bQueryBases

protected

m_bQueryCharacters

bool SCR_RestrictedDeployableSpawnPointComponent.m_bQueryCharacters

protected

m_bQuerySpawnPoints

bool SCR_RestrictedDeployableSpawnPointComponent.m_bQuerySpawnPoints

protected

m_bShowNotificationOnZoneEntered

bool SCR_RestrictedDeployableSpawnPointComponent.m_bShowNotificationOnZoneEntered

protected

m_bSpawnLimitReached

bool SCR_RestrictedDeployableSpawnPointComponent.m_bSpawnLimitReached

protected

m_bUnlockActionsForAllGroups

bool SCR_RestrictedDeployableSpawnPointComponent.m_bUnlockActionsForAllGroups

protected

m_bUnlockActionsForEnemyFactions

bool SCR_RestrictedDeployableSpawnPointComponent.m_bUnlockActionsForEnemyFactions

protected

m_eRespawnBudgetType

SCR_ESpawnPointBudgetType SCR_RestrictedDeployableSpawnPointComponent.m_eRespawnBudgetType

protected

m_fQueryRadiusBases

float SCR_RestrictedDeployableSpawnPointComponent.m_fQueryRadiusBases

protected

m_fQueryRadiusCharacters

float SCR_RestrictedDeployableSpawnPointComponent.m_fQueryRadiusCharacters

protected

m_fQueryRadiusSpawnPoints

float SCR_RestrictedDeployableSpawnPointComponent.m_fQueryRadiusSpawnPoints

protected

m_fSuppliesValue

float SCR_RestrictedDeployableSpawnPointComponent.m_fSuppliesValue

protected

m_fTimeSinceUpdate

float SCR_RestrictedDeployableSpawnPointComponent.m_fTimeSinceUpdate

protected

m_fUpdateRate

float SCR_RestrictedDeployableSpawnPointComponent.m_fUpdateRate

protected

m_iGroupID

int SCR_RestrictedDeployableSpawnPointComponent.m_iGroupID = -1

protected

m_iMaxRespawns

int SCR_RestrictedDeployableSpawnPointComponent.m_iMaxRespawns

protected

m_iMaxSpawnPointsPerGroup

int SCR_RestrictedDeployableSpawnPointComponent.m_iMaxSpawnPointsPerGroup

protected

m_iRespawnCount

int SCR_RestrictedDeployableSpawnPointComponent.m_iRespawnCount

protected

m_LocalPlayerGroup

SCR_AIGroup SCR_RestrictedDeployableSpawnPointComponent.m_LocalPlayerGroup

protected

m_sDeployLimitReachedMessage

string SCR_RestrictedDeployableSpawnPointComponent.m_sDeployLimitReachedMessage

protected

m_sNoGroupJoinedMessage

string SCR_RestrictedDeployableSpawnPointComponent.m_sNoGroupJoinedMessage

protected

m_sOutsideDeployAreaMessage

string SCR_RestrictedDeployableSpawnPointComponent.m_sOutsideDeployAreaMessage

protected

m_sSpawnPointPrefabSupplies

ResourceName SCR_RestrictedDeployableSpawnPointComponent.m_sSpawnPointPrefabSupplies

protected

s_aActiveDeployedSpawnPointGroupIDs

ref array<int> SCR_RestrictedDeployableSpawnPointComponent.s_aActiveDeployedSpawnPointGroupIDs = {}

staticprotected

---

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

• Game/DeployableInventoryItems/Components/SCR_RestrictedDeployableSpawnPointComponent.c