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()

void	DeployByGroup (notnull SCR_AIGroup group, IEntity userEntity=null, bool reload=false)

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 (IEntity userEntity=null)
	Toggles spawning with custom loadout.

void	SetSpawningWithLoadout (bool allow, IEntity userEntity=null)

bool	IsCustomLoadoutsAllowed ()

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)

int	GetRespawnCount ()

int	GetMaxRespawns ()

void	SetMaxRespawns (int maxRespawns)

void	SetBudgetType (SCR_ESpawnPointBudgetType budgetType)

SCR_ESpawnPointBudgetType	GetBudgetType ()

void	SetSuppliesValue (float value, bool refreshDeployedContainer=true)

float	GetSuppliesValue (bool refreshFromDeployedContainer=true)

override void	Update (float timeSlice)

override void	EOnInit (IEntity owner)

override void	OnDelete (IEntity owner)

Public Member Functions inherited from SCR_BaseDeployableSpawnPointComponent
SCR_SpawnPoint	GetSpawnPoint ()

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	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)

void	GenerateRespawns (int amount)
	Regenerates respawns for players /param[in] amount.

Protected Member Functions inherited from SCR_BaseDeployableSpawnPointComponent
override void	OnRplDeployed ()

void	ToggleRadioChatter (bool enable)

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_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

int	m_iRespawnGenerationTime

int	m_iRespawnGenerationAmount

float	m_fUpdateRate

bool	m_bQueryFactionRadioRange

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

float	m_fRespawnGenerationTimer = float.INFINITY

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_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< 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.

◆ DeployByGroup()

void SCR_RestrictedDeployableSpawnPointComponent.DeployByGroup	(	notnull SCR_AIGroup	group,
		IEntity	userEntity = null,
		bool	reload = false )

◆ 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.

◆ GenerateRespawns()

void SCR_RestrictedDeployableSpawnPointComponent.GenerateRespawns ( int amount )

protected

Regenerates respawns for players /param[in] amount.

◆ GetAllowAllGroupsToSpawn()

bool SCR_RestrictedDeployableSpawnPointComponent.GetAllowAllGroupsToSpawn ( )

Returns

◆ GetBudgetType()

SCR_ESpawnPointBudgetType SCR_RestrictedDeployableSpawnPointComponent.GetBudgetType ( )

◆ GetGroupID()

int SCR_RestrictedDeployableSpawnPointComponent.GetGroupID ( )

Returns

◆ GetIgnoreEnemyCharacters()

bool SCR_RestrictedDeployableSpawnPointComponent.GetIgnoreEnemyCharacters ( )

Returns

◆ GetMaxRespawns()

int SCR_RestrictedDeployableSpawnPointComponent.GetMaxRespawns ( )

◆ GetQueryRadiusCharacters()

float SCR_RestrictedDeployableSpawnPointComponent.GetQueryRadiusCharacters ( )

Returns

◆ GetRespawnCount()

int SCR_RestrictedDeployableSpawnPointComponent.GetRespawnCount ( )

◆ GetSuppliesValue()

float SCR_RestrictedDeployableSpawnPointComponent.GetSuppliesValue ( bool refreshFromDeployedContainer = true )

◆ IsCustomLoadoutsAllowed()

bool SCR_RestrictedDeployableSpawnPointComponent.IsCustomLoadoutsAllowed ( )

◆ IsDeployLimitReachedLocal()

bool SCR_RestrictedDeployableSpawnPointComponent.IsDeployLimitReachedLocal ( )

protected

◆ OnDelete()

override void SCR_RestrictedDeployableSpawnPointComponent.OnDelete ( IEntity owner )

Implements SCR_BaseDeployableSpawnPointComponent.

◆ 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

◆ SetSpawningWithLoadout()

void SCR_RestrictedDeployableSpawnPointComponent.SetSpawningWithLoadout	(	bool	allow,
		IEntity	userEntity = null )

◆ SetSuppliesValue()

void SCR_RestrictedDeployableSpawnPointComponent.SetSuppliesValue	(	float	value,
		bool	refreshDeployedContainer = true )

◆ ShowInfo()

void SCR_RestrictedDeployableSpawnPointComponent.ShowInfo ( notnull IEntity userEntity )

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

◆ ToggleSpawningWithLoadout()

void SCR_RestrictedDeployableSpawnPointComponent.ToggleSpawningWithLoadout ( IEntity userEntity = null )

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_bQueryFactionRadioRange

bool SCR_RestrictedDeployableSpawnPointComponent.m_bQueryFactionRadioRange

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_fRespawnGenerationTimer

float SCR_RestrictedDeployableSpawnPointComponent.m_fRespawnGenerationTimer = float.INFINITY

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_iRespawnGenerationAmount

int SCR_RestrictedDeployableSpawnPointComponent.m_iRespawnGenerationAmount

protected

◆ m_iRespawnGenerationTime

int SCR_RestrictedDeployableSpawnPointComponent.m_iRespawnGenerationTime

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

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CanActionBeShown()

◆ CanBeDeployedAtPosition()

◆ CanDeployBePerformed()

◆ CanDeployBeShown()

◆ CanDismantleBeShown()

◆ CanInfoBeShown()

◆ CanOpenStorageBeShown()

◆ CanToggleLoadoutSpawningBeShown()

◆ CreateSpawnPoint()

◆ Deploy()

◆ DeployByGroup()

◆ Dismantle()

◆ EntityQuery()

◆ EOnInit()

◆ GenerateRespawns()

◆ GetAllowAllGroupsToSpawn()

◆ GetBudgetType()

◆ GetGroupID()

◆ GetIgnoreEnemyCharacters()

◆ GetMaxRespawns()

◆ GetQueryRadiusCharacters()

◆ GetRespawnCount()

◆ GetSuppliesValue()

◆ IsCustomLoadoutsAllowed()

◆ IsDeployLimitReachedLocal()

◆ OnDelete()

◆ OnGroupChanged()

◆ OnGroupRemoved()

◆ OnSpawnPointBudgetTypeChanged()

◆ OnSpawnPointTicketAmountChanged()

◆ RPC_AddSpawnPointGroupBroadcast()

◆ RPC_PlaySoundOnZoneEnteredBroadcast()

◆ RPC_RemoveSpawnPointGroupBroadcast()

◆ SetBudgetType()

◆ SetMaxRespawns()

◆ SetRespawnCount()

◆ SetSpawningWithLoadout()

◆ SetSuppliesValue()

◆ ShowInfo()

◆ ToggleSpawningWithLoadout()

◆ Update()

Member Data Documentation

◆ m_bAllowAllGroupsToSpawn

◆ m_bAllowCustomLoadouts

◆ m_bIgnoreEnemyBases

◆ m_bIgnoreEnemyCharacters

◆ m_bIgnoreEnemySpawnPoints

◆ m_bIsGroupLimitReached

◆ m_bIsOutsideExclusionZone

◆ m_bIsWornByPlayer

◆ m_bNoGroupJoined

◆ m_bPlaySoundOnZoneEntered

◆ m_bQueryAllBases

◆ m_bQueryBases

◆ m_bQueryCharacters

◆ m_bQueryFactionRadioRange

◆ m_bQuerySpawnPoints

◆ m_bShowNotificationOnZoneEntered

◆ m_bSpawnLimitReached

◆ m_bUnlockActionsForAllGroups

◆ m_bUnlockActionsForEnemyFactions

◆ m_eRespawnBudgetType

◆ m_fQueryRadiusBases

◆ m_fQueryRadiusCharacters

◆ m_fQueryRadiusSpawnPoints

◆ m_fRespawnGenerationTimer

◆ m_fSuppliesValue

◆ m_fTimeSinceUpdate

◆ m_fUpdateRate

◆ m_iGroupID

◆ m_iMaxRespawns

◆ m_iMaxSpawnPointsPerGroup

◆ m_iRespawnCount