SCR_AmbientVehicleSpawnPointComponent Interface Reference

Inheritance diagram for SCR_AmbientVehicleSpawnPointComponent:

Public Member Functions
int	GetRespawnPeriod ()
void	SetIsDepleted (bool depleted)
bool	GetIsDepleted ()
bool	GetIsFirstSpawnDone ()
bool	GetIsSpawnProcessed ()
bool	IsDespawnAllowed ()
void	SetAllowDespawn (bool allow)
void	SetDespawnTimestamp (WorldTimestamp time)
WorldTimestamp	GetDespawnTimestamp ()
void	SetRespawnTimestamp (WorldTimestamp timestamp)
WorldTimestamp	GetRespawnTimestamp ()
Vehicle	GetSpawnedVehicle ()
void	SetSpawnedVehicle (Vehicle vehicle)
Vehicle	SpawnVehicle ()
void	RemoveInteractionHandlers (notnull IEntity vehicle)
void	DespawnVehicle ()
void	OnFuelChanged (float newFuel)
void	OnDamageChanged (SCR_HitZone hitZone)
override void	OnPostInit (IEntity owner)
override void	OnDelete (IEntity owner)

Protected Member Functions
void	OnVehicleDestroyed (IEntity vehicle)
void	AddInteractionHandlers (notnull IEntity vehicle)
void	Update (SCR_Faction faction)

Protected Attributes
int	m_iRespawnPeriod
bool	m_bStopDespawnOnInteraction
ref array< EEditableEntityLabel >	m_aIncludedEditableEntityLabels
ref array< EEditableEntityLabel >	m_aExcludedEditableEntityLabels
bool	m_bRequireAllIncludedLabels
bool	m_bDepleted
bool	m_bFirstSpawnDone
bool	m_bSpawnProcessed
bool	m_bAllowDespawn = true
float	m_fSpawnTimestamp
WorldTimestamp	m_fRespawnTimestamp
WorldTimestamp	m_fDespawnTimestamp
ResourceName	m_sPrefab
Vehicle	m_Vehicle
Faction	m_SavedFaction

Static Protected Attributes
static const int	SPAWNING_RADIUS = 5
static const int	IGNORE_CHANGES_DELAY_MS = 1000

Member Function Documentation

AddInteractionHandlers()

void SCR_AmbientVehicleSpawnPointComponent.AddInteractionHandlers ( notnull IEntity vehicle )

protected

DespawnVehicle()

void SCR_AmbientVehicleSpawnPointComponent.DespawnVehicle

(

)

GetDespawnTimestamp()

WorldTimestamp SCR_AmbientVehicleSpawnPointComponent.GetDespawnTimestamp

(

)

Returns

GetIsDepleted()

bool SCR_AmbientVehicleSpawnPointComponent.GetIsDepleted

(

)

Returns

GetIsFirstSpawnDone()

bool SCR_AmbientVehicleSpawnPointComponent.GetIsFirstSpawnDone

(

)

Returns

GetIsSpawnProcessed()

bool SCR_AmbientVehicleSpawnPointComponent.GetIsSpawnProcessed

(

)

Returns

GetRespawnPeriod()

int SCR_AmbientVehicleSpawnPointComponent.GetRespawnPeriod

(

)

Returns

GetRespawnTimestamp()

WorldTimestamp SCR_AmbientVehicleSpawnPointComponent.GetRespawnTimestamp

(

)

Returns

GetSpawnedVehicle()

Vehicle SCR_AmbientVehicleSpawnPointComponent.GetSpawnedVehicle

(

)

Returns

IsDespawnAllowed()

bool SCR_AmbientVehicleSpawnPointComponent.IsDespawnAllowed

(

)

OnDamageChanged()

void SCR_AmbientVehicleSpawnPointComponent.OnDamageChanged

(

SCR_HitZone

hitZone

)

OnDelete()

override void SCR_AmbientVehicleSpawnPointComponent.OnDelete

(

IEntity

owner

)

OnFuelChanged()

void SCR_AmbientVehicleSpawnPointComponent.OnFuelChanged

(

float

newFuel

)

OnPostInit()

override void SCR_AmbientVehicleSpawnPointComponent.OnPostInit

(

IEntity

owner

)

OnVehicleDestroyed()

void SCR_AmbientVehicleSpawnPointComponent.OnVehicleDestroyed ( IEntity vehicle )

protected

Parameters

[in]

vehicle

RemoveInteractionHandlers()

void SCR_AmbientVehicleSpawnPointComponent.RemoveInteractionHandlers

(

notnull IEntity

vehicle

)

SetAllowDespawn()

void SCR_AmbientVehicleSpawnPointComponent.SetAllowDespawn

(

bool

allow

)

SetDespawnTimestamp()

void SCR_AmbientVehicleSpawnPointComponent.SetDespawnTimestamp

(

WorldTimestamp

time

)

Parameters

[in]

time

SetIsDepleted()

void SCR_AmbientVehicleSpawnPointComponent.SetIsDepleted

(

bool

depleted

)

Parameters

[in]

depleted

SetRespawnTimestamp()

void SCR_AmbientVehicleSpawnPointComponent.SetRespawnTimestamp

(

WorldTimestamp

timestamp

)

Parameters

[in]

timestamp

SetSpawnedVehicle()

void SCR_AmbientVehicleSpawnPointComponent.SetSpawnedVehicle

(

Vehicle

vehicle

)

SpawnVehicle()

Vehicle SCR_AmbientVehicleSpawnPointComponent.SpawnVehicle

(

)

Returns

the created vehicle

Update()

void SCR_AmbientVehicleSpawnPointComponent.Update ( SCR_Faction faction )

protected

Member Data Documentation

IGNORE_CHANGES_DELAY_MS

const int SCR_AmbientVehicleSpawnPointComponent.IGNORE_CHANGES_DELAY_MS = 1000

staticprotected

m_aExcludedEditableEntityLabels

ref array<EEditableEntityLabel> SCR_AmbientVehicleSpawnPointComponent.m_aExcludedEditableEntityLabels

protected

m_aIncludedEditableEntityLabels

ref array<EEditableEntityLabel> SCR_AmbientVehicleSpawnPointComponent.m_aIncludedEditableEntityLabels

protected

m_bAllowDespawn

bool SCR_AmbientVehicleSpawnPointComponent.m_bAllowDespawn = true

protected

m_bDepleted

bool SCR_AmbientVehicleSpawnPointComponent.m_bDepleted

protected

m_bFirstSpawnDone

bool SCR_AmbientVehicleSpawnPointComponent.m_bFirstSpawnDone

protected

m_bRequireAllIncludedLabels

bool SCR_AmbientVehicleSpawnPointComponent.m_bRequireAllIncludedLabels

protected

m_bSpawnProcessed

bool SCR_AmbientVehicleSpawnPointComponent.m_bSpawnProcessed

protected

m_bStopDespawnOnInteraction

bool SCR_AmbientVehicleSpawnPointComponent.m_bStopDespawnOnInteraction

protected

m_fDespawnTimestamp

WorldTimestamp SCR_AmbientVehicleSpawnPointComponent.m_fDespawnTimestamp

protected

m_fRespawnTimestamp

WorldTimestamp SCR_AmbientVehicleSpawnPointComponent.m_fRespawnTimestamp

protected

m_fSpawnTimestamp

float SCR_AmbientVehicleSpawnPointComponent.m_fSpawnTimestamp

protected

m_iRespawnPeriod

int SCR_AmbientVehicleSpawnPointComponent.m_iRespawnPeriod

protected

m_SavedFaction

Faction SCR_AmbientVehicleSpawnPointComponent.m_SavedFaction

protected

m_sPrefab

ResourceName SCR_AmbientVehicleSpawnPointComponent.m_sPrefab

protected

m_Vehicle

Vehicle SCR_AmbientVehicleSpawnPointComponent.m_Vehicle

protected

SPAWNING_RADIUS

const int SCR_AmbientVehicleSpawnPointComponent.SPAWNING_RADIUS = 5

staticprotected

---

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

• Game/Components/Locations/SCR_AmbientVehicleSpawnPointComponent.c