SCR_AmbientPatrolSpawnPointComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_AmbientPatrolSpawnPointComponentClass

Functions
SCR_AmbientPatrolSpawnPointComponentClass ScriptComponentClass	Attribute ("0", UIWidgets.ComboBox, enums:ParamEnumArray.FromEnum(SCR_EGroupType))] protected SCR_EGroupType m_eGroupType
ResourceName	GetCycleWaypointPrefab ()
ResourceName	GetDefaultWaypointPrefab ()
void	SetID (int ID)
int	GetID ()
void	SetMembersAlive (int count)
int	GetMembersAlive ()
void	SetIsSpawned (bool spawned)
bool	GetIsSpawned ()
void	SetIsPaused (bool paused)
bool	GetIsPaused ()
float	GetAILimitThreshold ()
void	SetDespawnTimer (WorldTimestamp time)
WorldTimestamp	GetDespawnTimer ()
void	SetRespawnTimestamp (WorldTimestamp timestamp)
WorldTimestamp	GetRespawnTimestamp ()
SCR_AIGroup	GetSpawnedGroup ()
AIWaypoint	GetWaypoint ()
protected ResourceName	GetRandomPrefabByProbability (notnull SCR_EntityCatalog entityCatalog, notnull array< SCR_EntityCatalogEntry > data)
protected void	Update (SCR_Faction faction)
protected AIWaypointCycle	SpawnCycleWaypoint (notnull EntitySpawnParams params)
void	PrepareWaypoints ()
void	SpawnPatrol ()
void	DespawnPatrol ()
void	ActivateGroup ()
void	DeactivateGroup ()
bool	IsGroupActive ()
void	OnAgentRemoved ()
override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...
override void	EOnInit (IEntity owner)
void	~SCR_AmbientPatrolSpawnPointComponent ()

Variables
protected ResourceName	m_sCycleWaypointPrefab
protected ResourceName	m_sDefaultWaypointPrefab
protected bool	m_bPickRandomGroupType
protected int	m_iRespawnPeriod
protected float	m_fAILimitThreshold
protected bool	m_bSpawned
protected bool	m_bActive = false
protected bool	m_bPaused
protected int	m_iID
protected int	m_iMembersAlive = -1
protected WorldTimestamp	m_fRespawnTimestamp
protected WorldTimestamp	m_fDespawnTimer
protected AIWaypoint	m_Waypoint
protected ResourceName	m_sPrefab
protected SCR_AIGroup	m_Group
protected Faction	m_SavedFaction

Function Documentation

ActivateGroup()

void ActivateGroup

(

)

Definition at line 446 of file SCR_AmbientPatrolSpawnPointComponent.c.

Attribute()

SCR_AmbientPatrolSpawnPointComponentClass ScriptComponentClass Attribute	(	"0"	,
		UIWidgets.	ComboBox,
		enums:ParamEnumArray.	FromEnumSCR_EGroupType
	)

DeactivateGroup()

void DeactivateGroup

(

)

Definition at line 456 of file SCR_AmbientPatrolSpawnPointComponent.c.

DespawnPatrol()

void DespawnPatrol

(

)

Definition at line 426 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetAILimitThreshold()

float GetAILimitThreshold

(

)

Returns

Definition at line 115 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetCycleWaypointPrefab()

ResourceName Attribute::GetCycleWaypointPrefab

(

)

Returns

Definition at line 10 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetDefaultWaypointPrefab()

ResourceName Attribute::GetDefaultWaypointPrefab

(

)

Returns

Definition at line 17 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetDespawnTimer()

WorldTimestamp GetDespawnTimer

(

)

Returns

Definition at line 129 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetID()

int GetID

(

)

Returns

Definition at line 65 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetIsPaused()

bool GetIsPaused

(

)

Returns

Definition at line 108 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetIsSpawned()

bool GetIsSpawned

(

)

Returns

Definition at line 93 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetMembersAlive()

int GetMembersAlive

(

)

Returns

Definition at line 79 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetRandomPrefabByProbability()

protected ResourceName GetRandomPrefabByProbability	(	notnull SCR_EntityCatalog	entityCatalog,
		notnull array< SCR_EntityCatalogEntry >	data
	)

Definition at line 163 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetRespawnTimestamp()

WorldTimestamp GetRespawnTimestamp

(

)

Returns

Definition at line 143 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetSpawnedGroup()

SCR_AIGroup GetSpawnedGroup

(

)

Returns

Definition at line 150 of file SCR_AmbientPatrolSpawnPointComponent.c.

GetWaypoint()

AIWaypoint GetWaypoint

(

)

Returns

Definition at line 157 of file SCR_AmbientPatrolSpawnPointComponent.c.

IsGroupActive()

bool IsGroupActive

(

)

Returns

Definition at line 467 of file SCR_AmbientPatrolSpawnPointComponent.c.

OnAgentRemoved()

void OnAgentRemoved

(

)

Definition at line 473 of file SCR_AmbientPatrolSpawnPointComponent.c.

PrepareWaypoints()

void PrepareWaypoints

(

)

Definition at line 324 of file SCR_AmbientPatrolSpawnPointComponent.c.

SetDespawnTimer()

void SetDespawnTimer

(

WorldTimestamp

time

)

Parameters

[in]

time

Definition at line 122 of file SCR_AmbientPatrolSpawnPointComponent.c.

SetID()

void SetID

(

int

ID

)

Parameters

[in]

ID

Definition at line 58 of file SCR_AmbientPatrolSpawnPointComponent.c.

SetIsPaused()

void SetIsPaused

(

bool

paused

)

Pause this spawnpoint so a group will not be spawned unless players leave and re-enter the area

Parameters

[in]

paused

Definition at line 101 of file SCR_AmbientPatrolSpawnPointComponent.c.

SetIsSpawned()

void SetIsSpawned

(

bool

spawned

)

Parameters

[in]

spawned

Definition at line 86 of file SCR_AmbientPatrolSpawnPointComponent.c.

SetMembersAlive()

void SetMembersAlive

(

int

count

)

Parameters

[in]

count

Definition at line 72 of file SCR_AmbientPatrolSpawnPointComponent.c.

SetRespawnTimestamp()

void SetRespawnTimestamp

(

WorldTimestamp

timestamp

)

Parameters

[in]

timestamp

Definition at line 136 of file SCR_AmbientPatrolSpawnPointComponent.c.

SpawnCycleWaypoint()

protected AIWaypointCycle SpawnCycleWaypoint

(

notnull EntitySpawnParams

params

)

Definition at line 263 of file SCR_AmbientPatrolSpawnPointComponent.c.

SpawnPatrol()

void SpawnPatrol

(

)

Definition at line 362 of file SCR_AmbientPatrolSpawnPointComponent.c.

Update()

protected void Update

(

SCR_Faction

faction

)

Definition at line 214 of file SCR_AmbientPatrolSpawnPointComponent.c.

~SCR_AmbientPatrolSpawnPointComponent()

void ~SCR_AmbientPatrolSpawnPointComponent

(

)

Definition at line 515 of file SCR_AmbientPatrolSpawnPointComponent.c.

Variable Documentation

m_bActive

protected bool m_bActive = false

Definition at line 39 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_bPaused

protected bool m_bPaused

Definition at line 40 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_bPickRandomGroupType

protected bool m_bPickRandomGroupType

Definition at line 30 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_bSpawned

protected bool m_bSpawned

Definition at line 38 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_fAILimitThreshold

protected float m_fAILimitThreshold

Definition at line 36 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_fDespawnTimer

protected WorldTimestamp m_fDespawnTimer

Definition at line 46 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_fRespawnTimestamp

protected WorldTimestamp m_fRespawnTimestamp

Definition at line 45 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_Group

protected SCR_AIGroup m_Group

Definition at line 52 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_iID

protected int m_iID

Definition at line 42 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_iMembersAlive

protected int m_iMembersAlive = -1

Definition at line 43 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_iRespawnPeriod

protected int m_iRespawnPeriod

Definition at line 33 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_SavedFaction

protected Faction m_SavedFaction

Definition at line 54 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_sCycleWaypointPrefab

protected ResourceName m_sCycleWaypointPrefab

Definition at line 3 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_sDefaultWaypointPrefab

protected ResourceName m_sDefaultWaypointPrefab

Definition at line 6 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_sPrefab

protected ResourceName m_sPrefab

Definition at line 50 of file SCR_AmbientPatrolSpawnPointComponent.c.

m_Waypoint

protected AIWaypoint m_Waypoint

Definition at line 48 of file SCR_AmbientPatrolSpawnPointComponent.c.