Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_RestrictedDeployableSpawnPointComponent Class Reference

Deployable spawn point with configurable conditions. More...

Inheritance diagram for SCR_RestrictedDeployableSpawnPointComponent:

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 ()
SCR_DeployableSpawnPoint CreateSpawnPoint ()
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)
void OnGroupChanged (int groupID)
void OnGroupRemoved (SCR_AIGroup group)
void OnSpawnPointBudgetTypeChanged (SCR_ESpawnPointBudgetType budgetType)
void OnSpawnPointTicketAmountChanged (int tickets)
void GenerateRespawns (int amount)
override void Update (float timeSlice)
override void EOnInit (IEntity owner)
override void OnDelete (IEntity owner)

Protected Attributes

ResourceName m_sSpawnPointPrefabSupplies
bool m_bRestrictDeploy
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
bool m_bNotifyDismantle
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

Static Protected Attributes

static ref array< ints_aActiveDeployedSpawnPointGroupIDs = {}

Detailed Description

Deployable spawn point with configurable conditions.

Definition at line 15 of file SCR_RestrictedDeployableSpawnPointComponent.c.

Member Function Documentation

◆ CanActionBeShown()

bool SCR_RestrictedDeployableSpawnPointComponent::CanActionBeShown ( notnull IEntity userEntity,
bool checkFaction,
bool checkGroupID )
inlineprotected

◆ CanBeDeployedAtPosition()

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

◆ CanDeployBePerformed()

bool SCR_RestrictedDeployableSpawnPointComponent::CanDeployBePerformed ( out string reason)
inlineprotected
Parameters
[out]reason
Returns

Definition at line 609 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ CanDeployBeShown()

override bool SCR_RestrictedDeployableSpawnPointComponent::CanDeployBeShown ( notnull IEntity userEntity)
inlineprotected

◆ CanDismantleBeShown()

override bool SCR_RestrictedDeployableSpawnPointComponent::CanDismantleBeShown ( notnull IEntity userEntity)
inlineprotected

◆ CanInfoBeShown()

bool SCR_RestrictedDeployableSpawnPointComponent::CanInfoBeShown ( notnull IEntity userEntity)
inlineprotected
Parameters
[in]userEntity
Returns

Definition at line 644 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ CanOpenStorageBeShown()

bool SCR_RestrictedDeployableSpawnPointComponent::CanOpenStorageBeShown ( notnull IEntity userEntity)
inlineprotected
Parameters
[in]userEntity
Returns

Definition at line 652 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ CanToggleLoadoutSpawningBeShown()

bool SCR_RestrictedDeployableSpawnPointComponent::CanToggleLoadoutSpawningBeShown ( notnull IEntity userEntity)
inlineprotected
Parameters
[in]userEntity
Returns

Definition at line 663 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ CreateSpawnPoint()

SCR_DeployableSpawnPoint SCR_RestrictedDeployableSpawnPointComponent::CreateSpawnPoint ( )
inlineprotected

◆ Deploy()

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

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

Definition at line 422 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ DeployByGroup()

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

◆ Dismantle()

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

Cache respawn count; then call super.Dismantle().

Definition at line 484 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ EntityQuery()

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

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

Definition at line 165 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ EOnInit()

override void SCR_RestrictedDeployableSpawnPointComponent::EOnInit ( IEntity owner)
inlineprotected

◆ GenerateRespawns()

void SCR_RestrictedDeployableSpawnPointComponent::GenerateRespawns ( int amount)
inlineprotected

Regenerates respawns for players /param[in] amount

Definition at line 821 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ GetAllowAllGroupsToSpawn()

bool SCR_RestrictedDeployableSpawnPointComponent::GetAllowAllGroupsToSpawn ( )
inlineprotected
Returns

Definition at line 677 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ GetBudgetType()

SCR_ESpawnPointBudgetType SCR_RestrictedDeployableSpawnPointComponent::GetBudgetType ( )
inlineprotected

◆ GetGroupID()

int SCR_RestrictedDeployableSpawnPointComponent::GetGroupID ( )
inlineprotected
Returns

Definition at line 691 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ GetIgnoreEnemyCharacters()

bool SCR_RestrictedDeployableSpawnPointComponent::GetIgnoreEnemyCharacters ( )
inlineprotected
Returns

Definition at line 684 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ GetMaxRespawns()

int SCR_RestrictedDeployableSpawnPointComponent::GetMaxRespawns ( )
inlineprotected

◆ GetQueryRadiusCharacters()

float SCR_RestrictedDeployableSpawnPointComponent::GetQueryRadiusCharacters ( )
inlineprotected
Returns

Definition at line 698 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ GetRespawnCount()

int SCR_RestrictedDeployableSpawnPointComponent::GetRespawnCount ( )
inlineprotected

◆ GetSuppliesValue()

float SCR_RestrictedDeployableSpawnPointComponent::GetSuppliesValue ( bool refreshFromDeployedContainer = true)
inlineprotected

◆ IsCustomLoadoutsAllowed()

bool SCR_RestrictedDeployableSpawnPointComponent::IsCustomLoadoutsAllowed ( )
inlineprotected

◆ IsDeployLimitReachedLocal()

bool SCR_RestrictedDeployableSpawnPointComponent::IsDeployLimitReachedLocal ( )
inlineprotected

◆ OnDelete()

override void SCR_RestrictedDeployableSpawnPointComponent::OnDelete ( IEntity owner)
inlineprotected

◆ OnGroupChanged()

void SCR_RestrictedDeployableSpawnPointComponent::OnGroupChanged ( int groupID)
inlineprotected

◆ OnGroupRemoved()

void SCR_RestrictedDeployableSpawnPointComponent::OnGroupRemoved ( SCR_AIGroup group)
inlineprotected

◆ OnSpawnPointBudgetTypeChanged()

void SCR_RestrictedDeployableSpawnPointComponent::OnSpawnPointBudgetTypeChanged ( SCR_ESpawnPointBudgetType budgetType)
inlineprotected

◆ OnSpawnPointTicketAmountChanged()

void SCR_RestrictedDeployableSpawnPointComponent::OnSpawnPointTicketAmountChanged ( int tickets)
inlineprotected

◆ RPC_AddSpawnPointGroupBroadcast()

void SCR_RestrictedDeployableSpawnPointComponent::RPC_AddSpawnPointGroupBroadcast ( int groupID)
inlineprotected

◆ RPC_PlaySoundOnZoneEnteredBroadcast()

void SCR_RestrictedDeployableSpawnPointComponent::RPC_PlaySoundOnZoneEnteredBroadcast ( bool entered)
inlineprotected

◆ RPC_RemoveSpawnPointGroupBroadcast()

void SCR_RestrictedDeployableSpawnPointComponent::RPC_RemoveSpawnPointGroupBroadcast ( int groupID)
inlineprotected

◆ SetBudgetType()

void SCR_RestrictedDeployableSpawnPointComponent::SetBudgetType ( SCR_ESpawnPointBudgetType budgetType)
inlineprotected
Parameters
[in]budgetType

Definition at line 735 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ SetMaxRespawns()

void SCR_RestrictedDeployableSpawnPointComponent::SetMaxRespawns ( int maxRespawns)
inlineprotected
Parameters
[in]maxRespawns

Definition at line 724 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ SetRespawnCount()

void SCR_RestrictedDeployableSpawnPointComponent::SetRespawnCount ( int respawnCount)
inlineprotected
Parameters
[in]respawnCount

Definition at line 705 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ SetSpawningWithLoadout()

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

◆ SetSuppliesValue()

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

◆ ShowInfo()

void SCR_RestrictedDeployableSpawnPointComponent::ShowInfo ( notnull IEntity userEntity)
inlineprotected

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

Definition at line 536 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ ToggleSpawningWithLoadout()

void SCR_RestrictedDeployableSpawnPointComponent::ToggleSpawningWithLoadout ( IEntity userEntity = null)
inlineprotected

Toggles spawning with custom loadout.

Definition at line 567 of file SCR_RestrictedDeployableSpawnPointComponent.c.

◆ Update()

override void SCR_RestrictedDeployableSpawnPointComponent::Update ( float timeSlice)
inlineprotected

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_bNotifyDismantle

bool SCR_RestrictedDeployableSpawnPointComponent::m_bNotifyDismantle
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_bRestrictDeploy

bool SCR_RestrictedDeployableSpawnPointComponent::m_bRestrictDeploy
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 class was generated from the following file: