Inheritance diagram for SCR_AmbientPatrolSpawnPointComponent:

Public Member Functions
int	GetSpawnDistanceOverride ()

int	GetDespawnDistanceOverride ()

void	SetMembersAlive (int count)

int	GetMembersAlive ()

void	SetIsSpawned (bool spawned)

bool	GetIsSpawned ()

void	SetIsPaused (bool paused)
	Pause this spawnpoint so a group will not be spawned unless players leave and re-enter the area.

bool	GetIsPaused ()

float	GetAILimitThreshold ()

void	SetDespawnTimestamp (WorldTimestamp time)

WorldTimestamp	GetDespawnTimestamp ()

void	SetRespawnTimestamp (WorldTimestamp timestamp)

WorldTimestamp	GetRespawnTimestamp ()

SCR_AIGroup	GetSpawnedGroup ()

void	SetspawnedGroup (SCR_AIGroup group)

AIWaypoint	GetWaypoint ()

void	SetWaypoint (AIWaypoint wp)

void	PrepareWaypoints ()

void	SpawnPatrol ()

void	DespawnPatrol ()

void	ActivateGroup ()

void	DeactivateGroup ()

bool	IsGroupActive ()

void	OnAgentRemoved ()

override void	OnPostInit (IEntity owner)

override void	OnDelete (IEntity owner)

Protected Member Functions
ResourceName	GetRandomPrefabByProbability (notnull SCR_EntityCatalog entityCatalog, notnull array< SCR_EntityCatalogEntry > data)

void	Update (SCR_Faction faction)

AIWaypointCycle	SpawnCycleWaypoint (notnull EntitySpawnParams params)

Protected Attributes
SCR_EGroupType	m_eGroupType

bool	m_bPickRandomGroupType

int	m_iSpawnDistanceOverride

int	m_iDespawnDistanceOverride

int	m_iRespawnPeriod

float	m_fAILimitThreshold

bool	m_bSpawned

bool	m_bPaused

bool	m_bGroupActive

int	m_iMembersAlive = -1

AIWaypoint	m_Waypoint

ResourceName	m_sPrefab

SCR_AIGroup	m_Group

Faction	m_SavedFaction

WorldTimestamp	m_RespawnTimestamp

WorldTimestamp	m_DespawnTimestamp

Member Function Documentation

◆ ActivateGroup()

void SCR_AmbientPatrolSpawnPointComponent.ActivateGroup ( )

◆ DeactivateGroup()

void SCR_AmbientPatrolSpawnPointComponent.DeactivateGroup ( )

◆ DespawnPatrol()

void SCR_AmbientPatrolSpawnPointComponent.DespawnPatrol ( )

◆ GetAILimitThreshold()

float SCR_AmbientPatrolSpawnPointComponent.GetAILimitThreshold ( )

Returns

◆ GetDespawnDistanceOverride()

int SCR_AmbientPatrolSpawnPointComponent.GetDespawnDistanceOverride ( )

◆ GetDespawnTimestamp()

WorldTimestamp SCR_AmbientPatrolSpawnPointComponent.GetDespawnTimestamp ( )

Returns

◆ GetIsPaused()

bool SCR_AmbientPatrolSpawnPointComponent.GetIsPaused ( )

Returns

◆ GetIsSpawned()

bool SCR_AmbientPatrolSpawnPointComponent.GetIsSpawned ( )

Returns

◆ GetMembersAlive()

int SCR_AmbientPatrolSpawnPointComponent.GetMembersAlive ( )

Returns

◆ GetRandomPrefabByProbability()

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

protected

◆ GetRespawnTimestamp()

WorldTimestamp SCR_AmbientPatrolSpawnPointComponent.GetRespawnTimestamp ( )

Returns

◆ GetSpawnDistanceOverride()

int SCR_AmbientPatrolSpawnPointComponent.GetSpawnDistanceOverride ( )

◆ GetSpawnedGroup()

SCR_AIGroup SCR_AmbientPatrolSpawnPointComponent.GetSpawnedGroup ( )

Returns

◆ GetWaypoint()

AIWaypoint SCR_AmbientPatrolSpawnPointComponent.GetWaypoint ( )

Returns

◆ IsGroupActive()

bool SCR_AmbientPatrolSpawnPointComponent.IsGroupActive ( )

Returns

◆ OnAgentRemoved()

void SCR_AmbientPatrolSpawnPointComponent.OnAgentRemoved ( )

◆ OnDelete()

override void SCR_AmbientPatrolSpawnPointComponent.OnDelete ( IEntity owner )

◆ OnPostInit()

override void SCR_AmbientPatrolSpawnPointComponent.OnPostInit ( IEntity owner )

◆ PrepareWaypoints()

void SCR_AmbientPatrolSpawnPointComponent.PrepareWaypoints ( )

◆ SetDespawnTimestamp()

void SCR_AmbientPatrolSpawnPointComponent.SetDespawnTimestamp ( WorldTimestamp time )

Parameters

[in] time

◆ SetIsPaused()

void SCR_AmbientPatrolSpawnPointComponent.SetIsPaused ( bool paused )

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

Parameters

[in] paused

◆ SetIsSpawned()

void SCR_AmbientPatrolSpawnPointComponent.SetIsSpawned ( bool spawned )

Parameters

[in] spawned

◆ SetMembersAlive()

void SCR_AmbientPatrolSpawnPointComponent.SetMembersAlive ( int count )

Parameters

[in] count

◆ SetRespawnTimestamp()

void SCR_AmbientPatrolSpawnPointComponent.SetRespawnTimestamp ( WorldTimestamp timestamp )

Parameters

[in] timestamp

◆ SetspawnedGroup()

void SCR_AmbientPatrolSpawnPointComponent.SetspawnedGroup ( SCR_AIGroup group )

◆ SetWaypoint()

void SCR_AmbientPatrolSpawnPointComponent.SetWaypoint ( AIWaypoint wp )

◆ SpawnCycleWaypoint()

AIWaypointCycle SCR_AmbientPatrolSpawnPointComponent.SpawnCycleWaypoint ( notnull EntitySpawnParams params )

protected

◆ SpawnPatrol()

void SCR_AmbientPatrolSpawnPointComponent.SpawnPatrol ( )

◆ Update()

void SCR_AmbientPatrolSpawnPointComponent.Update ( SCR_Faction faction )

protected

Member Data Documentation

◆ m_bGroupActive

bool SCR_AmbientPatrolSpawnPointComponent.m_bGroupActive

protected

◆ m_bPaused

bool SCR_AmbientPatrolSpawnPointComponent.m_bPaused

protected

◆ m_bPickRandomGroupType

bool SCR_AmbientPatrolSpawnPointComponent.m_bPickRandomGroupType

protected

◆ m_bSpawned

bool SCR_AmbientPatrolSpawnPointComponent.m_bSpawned

protected

◆ m_DespawnTimestamp

WorldTimestamp SCR_AmbientPatrolSpawnPointComponent.m_DespawnTimestamp

protected

◆ m_eGroupType

SCR_EGroupType SCR_AmbientPatrolSpawnPointComponent.m_eGroupType

protected

◆ m_fAILimitThreshold

float SCR_AmbientPatrolSpawnPointComponent.m_fAILimitThreshold

protected

◆ m_Group

SCR_AIGroup SCR_AmbientPatrolSpawnPointComponent.m_Group

protected

◆ m_iDespawnDistanceOverride

int SCR_AmbientPatrolSpawnPointComponent.m_iDespawnDistanceOverride

protected

◆ m_iMembersAlive

int SCR_AmbientPatrolSpawnPointComponent.m_iMembersAlive = -1

protected

◆ m_iRespawnPeriod

int SCR_AmbientPatrolSpawnPointComponent.m_iRespawnPeriod

protected

◆ m_iSpawnDistanceOverride

int SCR_AmbientPatrolSpawnPointComponent.m_iSpawnDistanceOverride

protected

◆ m_RespawnTimestamp

WorldTimestamp SCR_AmbientPatrolSpawnPointComponent.m_RespawnTimestamp

protected

◆ m_SavedFaction

Faction SCR_AmbientPatrolSpawnPointComponent.m_SavedFaction

protected

◆ m_sPrefab

ResourceName SCR_AmbientPatrolSpawnPointComponent.m_sPrefab

protected

◆ m_Waypoint

AIWaypoint SCR_AmbientPatrolSpawnPointComponent.m_Waypoint

protected

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

Game/Components/Locations/SCR_AmbientPatrolSpawnPointComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ ActivateGroup()

◆ DeactivateGroup()

◆ DespawnPatrol()

◆ GetAILimitThreshold()

◆ GetDespawnDistanceOverride()

◆ GetDespawnTimestamp()

◆ GetIsPaused()

◆ GetIsSpawned()

◆ GetMembersAlive()

◆ GetRandomPrefabByProbability()

◆ GetRespawnTimestamp()

◆ GetSpawnDistanceOverride()

◆ GetSpawnedGroup()

◆ GetWaypoint()

◆ IsGroupActive()

◆ OnAgentRemoved()

◆ OnDelete()

◆ OnPostInit()

◆ PrepareWaypoints()

◆ SetDespawnTimestamp()

◆ SetIsPaused()

◆ SetIsSpawned()

◆ SetMembersAlive()

◆ SetRespawnTimestamp()

◆ SetspawnedGroup()

◆ SetWaypoint()

◆ SpawnCycleWaypoint()

◆ SpawnPatrol()

◆ Update()

Member Data Documentation

◆ m_bGroupActive

◆ m_bPaused

◆ m_bPickRandomGroupType

◆ m_bSpawned

◆ m_DespawnTimestamp

◆ m_eGroupType

◆ m_fAILimitThreshold

◆ m_Group

◆ m_iDespawnDistanceOverride

◆ m_iMembersAlive

◆ m_iRespawnPeriod

◆ m_iSpawnDistanceOverride

◆ m_RespawnTimestamp

◆ m_SavedFaction

◆ m_sPrefab

◆ m_Waypoint