SCR_AmbientPatrolSystem Interface Reference

Inheritance diagram for SCR_AmbientPatrolSystem:

Public Member Functions
override bool	ShouldBePaused ()
	Is this system should be paused while the simulation is paused?
void	RegisterPatrol (notnull SCR_AmbientPatrolSpawnPointComponent patrol)
void	UnregisterPatrol (notnull SCR_AmbientPatrolSpawnPointComponent patrol)
int	GetPatrols (notnull out array< SCR_AmbientPatrolSpawnPointComponent > patrols)
void	OnPlayerDisconnected (int playerId, KickCauseCode cause=KickCauseCode.NONE, int timeout=-1)
void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
Public Member Functions inherited from GameSystem
bool	ShouldBeEnabledInEditMode ()
	Is this system should be enabled inside the editor.

Static Public Member Functions
static override void	InitInfo (WorldSystemInfo outInfo)
static SCR_AmbientPatrolSystem	GetInstance ()

Protected Member Functions
override void	OnInit ()
override void	OnCleanup ()
override void	OnUpdatePoint (WorldUpdatePointArgs args)
int	ClampSpawnDistanceSq (int spawnDistanceSq)
int	ClampDespawnDistanceSq (int despawnDistanceSq)
void	UpdateCheckInterval ()
void	RefreshPlayerList ()
void	OnPlayerSpawnedOrDeleted (int playerId, IEntity player)
void	ProcessSpawnpoint (int spawnpointIndex)

Protected Attributes
int	m_iMinSpawnDistance
int	m_iMaxSpawnDistance
int	m_iDespawnBufferDistance
int	m_iMinDespawnDistance
int	m_iMaxDespawnDistance
int	m_iMinSpawnDistanceSq = m_iMinSpawnDistance * m_iMinSpawnDistance
int	m_iMaxSpawnDistanceSq = m_iMaxSpawnDistance * m_iMaxSpawnDistance
int	m_iDespawnBufferDistanceSq = m_iDespawnBufferDistance * m_iDespawnBufferDistance
int	m_iMinDespawnDistanceSq = m_iMinDespawnDistance * m_iMinDespawnDistance
int	m_iMaxDespawnDistanceSq = m_iMaxDespawnDistance * m_iMaxDespawnDistance
ref array< SCR_AmbientPatrolSpawnPointComponent >	m_aPatrols = {}
ref array< IEntity >	m_aPlayers = {}
int	m_iIndexToCheck
int	m_iSpawnDistanceSq
int	m_iDespawnDistanceSq
float	m_fTimer
float	m_fCheckInterval

Static Protected Attributes
static const int	CHECK_INTERVAL = 3
static const int	DESPAWN_TIMEOUT = 10000
static const int	SPAWN_RADIUS_BLOCK_SQ = 150 * 150

Member Function Documentation

ClampDespawnDistanceSq()

int SCR_AmbientPatrolSystem.ClampDespawnDistanceSq ( int despawnDistanceSq )

protected

ClampSpawnDistanceSq()

int SCR_AmbientPatrolSystem.ClampSpawnDistanceSq ( int spawnDistanceSq )

protected

GetInstance()

static SCR_AmbientPatrolSystem SCR_AmbientPatrolSystem.GetInstance ( )

static

GetPatrols()

int SCR_AmbientPatrolSystem.GetPatrols

(

notnull out array< SCR_AmbientPatrolSpawnPointComponent >

patrols

)

InitInfo()

static override void SCR_AmbientPatrolSystem.InitInfo ( WorldSystemInfo outInfo )

static

OnCleanup()

override void SCR_AmbientPatrolSystem.OnCleanup ( )

protected

OnInit()

override void SCR_AmbientPatrolSystem.OnInit ( )

protected

OnPlayerDisconnected()

void SCR_AmbientPatrolSystem.OnPlayerDisconnected	(	int	playerId,
		KickCauseCode	cause = KickCauseCode::NONE,
		int	timeout = -1 )

OnPlayerKilled()

void SCR_AmbientPatrolSystem.OnPlayerKilled

(

notnull SCR_InstigatorContextData

instigatorContextData

)

OnPlayerSpawnedOrDeleted()

void SCR_AmbientPatrolSystem.OnPlayerSpawnedOrDeleted ( int playerId, IEntity player )

protected

OnUpdatePoint()

override void SCR_AmbientPatrolSystem.OnUpdatePoint ( WorldUpdatePointArgs args )

protected

ProcessSpawnpoint()

void SCR_AmbientPatrolSystem.ProcessSpawnpoint ( int spawnpointIndex )

protected

RefreshPlayerList()

void SCR_AmbientPatrolSystem.RefreshPlayerList ( )

protected

RegisterPatrol()

void SCR_AmbientPatrolSystem.RegisterPatrol

(

notnull SCR_AmbientPatrolSpawnPointComponent

patrol

)

ShouldBePaused()

override bool SCR_AmbientPatrolSystem.ShouldBePaused

(

)

Is this system should be paused while the simulation is paused?

Implements GameSystem.

UnregisterPatrol()

void SCR_AmbientPatrolSystem.UnregisterPatrol

(

notnull SCR_AmbientPatrolSpawnPointComponent

patrol

)

UpdateCheckInterval()

void SCR_AmbientPatrolSystem.UpdateCheckInterval ( )

protected

Member Data Documentation

CHECK_INTERVAL

const int SCR_AmbientPatrolSystem.CHECK_INTERVAL = 3

staticprotected

DESPAWN_TIMEOUT

const int SCR_AmbientPatrolSystem.DESPAWN_TIMEOUT = 10000

staticprotected

m_aPatrols

ref array<SCR_AmbientPatrolSpawnPointComponent> SCR_AmbientPatrolSystem.m_aPatrols = {}

protected

m_aPlayers

ref array<IEntity> SCR_AmbientPatrolSystem.m_aPlayers = {}

protected

m_fCheckInterval

float SCR_AmbientPatrolSystem.m_fCheckInterval

protected

m_fTimer

float SCR_AmbientPatrolSystem.m_fTimer

protected

m_iDespawnBufferDistance

int SCR_AmbientPatrolSystem.m_iDespawnBufferDistance

protected

m_iDespawnBufferDistanceSq

int SCR_AmbientPatrolSystem.m_iDespawnBufferDistanceSq = m_iDespawnBufferDistance * m_iDespawnBufferDistance

protected

m_iDespawnDistanceSq

int SCR_AmbientPatrolSystem.m_iDespawnDistanceSq

protected

m_iIndexToCheck

int SCR_AmbientPatrolSystem.m_iIndexToCheck

protected

m_iMaxDespawnDistance

int SCR_AmbientPatrolSystem.m_iMaxDespawnDistance

protected

m_iMaxDespawnDistanceSq

int SCR_AmbientPatrolSystem.m_iMaxDespawnDistanceSq = m_iMaxDespawnDistance * m_iMaxDespawnDistance

protected

m_iMaxSpawnDistance

int SCR_AmbientPatrolSystem.m_iMaxSpawnDistance

protected

m_iMaxSpawnDistanceSq

int SCR_AmbientPatrolSystem.m_iMaxSpawnDistanceSq = m_iMaxSpawnDistance * m_iMaxSpawnDistance

protected

m_iMinDespawnDistance

int SCR_AmbientPatrolSystem.m_iMinDespawnDistance

protected

m_iMinDespawnDistanceSq

int SCR_AmbientPatrolSystem.m_iMinDespawnDistanceSq = m_iMinDespawnDistance * m_iMinDespawnDistance

protected

m_iMinSpawnDistance

int SCR_AmbientPatrolSystem.m_iMinSpawnDistance

protected

m_iMinSpawnDistanceSq

int SCR_AmbientPatrolSystem.m_iMinSpawnDistanceSq = m_iMinSpawnDistance * m_iMinSpawnDistance

protected

m_iSpawnDistanceSq

int SCR_AmbientPatrolSystem.m_iSpawnDistanceSq

protected

SPAWN_RADIUS_BLOCK_SQ

const int SCR_AmbientPatrolSystem.SPAWN_RADIUS_BLOCK_SQ = 150 * 150

staticprotected

---

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

• Game/Systems/SCR_AmbientPatrolSystem.c