SCR_RestrictedDeployableSpawnPointComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_RestrictedDeployableSpawnPointComponentClass

Functions
SCR_RestrictedDeployableSpawnPointComponentClass SCR_BaseDeployableSpawnPointComponentClass	Attribute (defvalue:"1")
	Deployable spawn point with configurable conditions. More...
protected void	RPC_AddSpawnPointGroupBroadcast (int groupID)
protected void	RPC_RemoveSpawnPointGroupBroadcast (int groupID)
protected void	RPC_PlaySoundOnZoneEnteredBroadcast (bool entered)
protected 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. More...
protected bool	CanActionBeShown (notnull IEntity userEntity, bool checkCanDeploy, bool checkFaction=true, bool checkGroupID=true)
protected bool	CanBeDeployedAtPosition (vector position, IEntity userEntity, out int notification=-1)
protected bool	IsDeployLimitReachedLocal ()
override void	Deploy (IEntity userEntity)
	Check if deploy is possible, then call super.Deploy() More...
override void	Dismantle (IEntity userEntity=null)
	Cache respawn count; then call super.Dismantle() More...
void	ShowInfo (notnull IEntity userEntity)
	Display amount of respawns left - called from SCR_ShowItemInfo.PerformAction. More...
bool	CanDeployBePerformed (out string reason)
override bool	CanDeployBeShown (notnull IEntity userEntity)
override bool	CanDismantleBeShown (notnull IEntity userEntity)
bool	CanInfoBeShown (notnull IEntity userEntity)
bool	GetAllowAllGroupsToSpawn ()
bool	GetIgnoreEnemyCharacters ()
int	GetGroupID ()
float	GetQueryRadiusCharacters ()
void	SetRespawnCount (int respawnCount)
protected void	OnGroupRemoved (SCR_AIGroup group)
override void	Update (float timeSlice)
override void	EOnInit (IEntity owner)
override void	OnDelete (IEntity owner)

Variables
protected int	m_iRespawnCount
protected bool	m_bSpawnLimitReached
protected bool	m_bIsWornByPlayer
protected float	m_fTimeSinceUpdate

Function Documentation

Attribute()

SCR_RestrictedDeployableSpawnPointComponentClass SCR_BaseDeployableSpawnPointComponentClass Attribute

(

defvalue:"1"

)

Deployable spawn point with configurable conditions.

Definition at line 10 of file SCR_RestrictedDeployableSpawnPointComponent.c.

CanActionBeShown()

protected bool CanActionBeShown	(	notnull IEntity	userEntity,
		bool	checkCanDeploy,
		bool	checkFaction = true,
		bool	checkGroupID = true
	)

Definition at line 199 of file SCR_RestrictedDeployableSpawnPointComponent.c.

CanBeDeployedAtPosition()

protected bool CanBeDeployedAtPosition	(	vector	position,
		IEntity	userEntity,
		out int	notification = -1
	)

Definition at line 238 of file SCR_RestrictedDeployableSpawnPointComponent.c.

CanDeployBePerformed()

bool CanDeployBePerformed

(

out string

reason

)

Parameters

[out]

reason

Returns

Definition at line 453 of file SCR_RestrictedDeployableSpawnPointComponent.c.

CanDeployBeShown()

override bool CanDeployBeShown

(

notnull IEntity

userEntity

)

Definition at line 466 of file SCR_RestrictedDeployableSpawnPointComponent.c.

CanDismantleBeShown()

override bool CanDismantleBeShown

(

notnull IEntity

userEntity

)

Definition at line 475 of file SCR_RestrictedDeployableSpawnPointComponent.c.

CanInfoBeShown()

bool CanInfoBeShown

(

notnull IEntity

userEntity

)

Parameters

[in]

userEntity

Returns

Definition at line 486 of file SCR_RestrictedDeployableSpawnPointComponent.c.

Deploy()

override void Deploy

(

IEntity

userEntity

)

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

Definition at line 349 of file SCR_RestrictedDeployableSpawnPointComponent.c.

Dismantle()

override void Dismantle

(

IEntity

userEntity = null

)

Cache respawn count; then call super.Dismantle()

Definition at line 391 of file SCR_RestrictedDeployableSpawnPointComponent.c.

EntityQuery()

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

Definition at line 125 of file SCR_RestrictedDeployableSpawnPointComponent.c.

GetAllowAllGroupsToSpawn()

bool GetAllowAllGroupsToSpawn

(

)

Returns

Definition at line 493 of file SCR_RestrictedDeployableSpawnPointComponent.c.

GetGroupID()

int GetGroupID

(

)

Returns

Definition at line 507 of file SCR_RestrictedDeployableSpawnPointComponent.c.

GetIgnoreEnemyCharacters()

bool GetIgnoreEnemyCharacters

(

)

Returns

Definition at line 500 of file SCR_RestrictedDeployableSpawnPointComponent.c.

GetQueryRadiusCharacters()

float GetQueryRadiusCharacters

(

)

Returns

Definition at line 514 of file SCR_RestrictedDeployableSpawnPointComponent.c.

IsDeployLimitReachedLocal()

protected bool IsDeployLimitReachedLocal

(

)

Definition at line 330 of file SCR_RestrictedDeployableSpawnPointComponent.c.

OnGroupRemoved()

protected void OnGroupRemoved

(

SCR_AIGroup

group

)

Definition at line 527 of file SCR_RestrictedDeployableSpawnPointComponent.c.

RPC_AddSpawnPointGroupBroadcast()

protected void RPC_AddSpawnPointGroupBroadcast

(

int

groupID

)

Definition at line 97 of file SCR_RestrictedDeployableSpawnPointComponent.c.

RPC_PlaySoundOnZoneEnteredBroadcast()

protected void RPC_PlaySoundOnZoneEnteredBroadcast

(

bool

entered

)

Definition at line 111 of file SCR_RestrictedDeployableSpawnPointComponent.c.

RPC_RemoveSpawnPointGroupBroadcast()

protected void RPC_RemoveSpawnPointGroupBroadcast

(

int

groupID

)

Definition at line 104 of file SCR_RestrictedDeployableSpawnPointComponent.c.

SetRespawnCount()

void SetRespawnCount

(

int

respawnCount

)

Parameters

[in]

respawnCount

Definition at line 521 of file SCR_RestrictedDeployableSpawnPointComponent.c.

ShowInfo()

void ShowInfo

(

notnull IEntity

userEntity

)

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

Definition at line 420 of file SCR_RestrictedDeployableSpawnPointComponent.c.

Update()

override void Update

(

float

timeSlice

)

Parameters

[in]

timeSlice

Definition at line 540 of file SCR_RestrictedDeployableSpawnPointComponent.c.

Variable Documentation

m_bIsWornByPlayer

protected bool m_bIsWornByPlayer

Definition at line 87 of file SCR_RestrictedDeployableSpawnPointComponent.c.

m_bSpawnLimitReached

protected bool m_bSpawnLimitReached

Definition at line 86 of file SCR_RestrictedDeployableSpawnPointComponent.c.

m_fTimeSinceUpdate

protected float m_fTimeSinceUpdate

Definition at line 89 of file SCR_RestrictedDeployableSpawnPointComponent.c.

m_iRespawnCount

protected int m_iRespawnCount

Definition at line 82 of file SCR_RestrictedDeployableSpawnPointComponent.c.