SCR_RandomPositionalInsects Class Reference

Spawns Insect particles around camera based on define behaviour. More...

Inheritance diagram for SCR_RandomPositionalInsects:

Protected Member Functions
override void	Update (float worldTime, vector cameraPos, float timeOfDay, float rainIntensity)
void	UpdateGlobalModifiers (float timeOfDay, float rainIntensity)
int	GetDensityMax (int insectGroup, int soundMapType)
void	RemoveOutOfRangeParticles (vector cameraPos)
void	RemoveParticlesBasedOnTimeAndWeather (float timeOfDay, float rainIntensity)
void	RandomizeAnimation (IEntity entity)
void	UpdateInsectGroup (float worldTime, vector camPos, int insectGroup)
vector	GenerateRandomPosition (int insectGroup, vector camPos)
SCR_InsectDef	GetRandomInsectDef (SCR_InsectType insectType)
int	GetSoundMapTypeFromTerrain (inout vector worldPos, vector camPos)
void	UpdateDensity ()
	Updates insect density per group and active particles.
void	LoadConfigs ()
	Loads configs where necessary values are stored.
override void	OnPostInit (SCR_AmbientSoundsComponent ambientSoundsComponent, SCR_AmbientInsectsComponent ambientInsectsComponent, SignalsManagerComponent signalsManagerComponent)

Protected Attributes
int	m_iDespawnDistanceSq
ref array< ref SCR_RandomPositionalInsectsDef >	m_aRandomPositionalInsectsDef
ResourceName	m_sDayTimeCurve
ResourceName	m_sWindCurve
ref array< ref SCR_InsectGroup >	m_aInsectGroup = {}
ref array< ref SCR_InsectSpawnDef >	m_aSpawnDef = {}
ref array< ref SCR_DayTimeCurveDef >	m_aDayTimeCurve = {}
ref array< ref SCR_WindCurveDef >	m_aWindModifier = {}
SoundWorld	m_SoundWorld
const int	INVALID = -1
int	m_iUpdatedInsectGroupIdx
ref array< int >	m_aDensity = {}
ref array< float >	m_aDensityModifier = {}
ref array< int >	m_aAngleOffset = {}
float	m_aDayTimeCurveValue [DAY_TIME_CURVE_COUNT]
float	m_aWindCurveValue [WIND_CURVE_COUNT]
ref array< ref SCR_InsectParticle >	m_aParticles = {}

Detailed Description

Spawns Insect particles around camera based on define behaviour.

Definition at line 3 of file SCR_RandomPositionalInsects.c.

Member Function Documentation

GenerateRandomPosition()

vector SCR_RandomPositionalInsects::GenerateRandomPosition ( int insectGroup, vector camPos )

inlineprotected

Generates random position for the selected insect group around camera position

Parameters

[in]	insectGroup
[in]	camPos

Returns

Definition at line 248 of file SCR_RandomPositionalInsects.c.

GetDensityMax()

int SCR_RandomPositionalInsects::GetDensityMax ( int insectGroup, int soundMapType )

inlineprotected

Get maximal density per insect group and sound map type

Returns

density

Definition at line 90 of file SCR_RandomPositionalInsects.c.

GetRandomInsectDef()

SCR_InsectDef SCR_RandomPositionalInsects::GetRandomInsectDef ( SCR_InsectType insectType )

inlineprotected

Gets random insect def from the insect group

Parameters

[in]

insectType

Definition at line 265 of file SCR_RandomPositionalInsects.c.

GetSoundMapTypeFromTerrain()

int SCR_RandomPositionalInsects::GetSoundMapTypeFromTerrain ( inout vector worldPos, vector camPos )

inlineprotected

Gets sound map type from terrain

Parameters

[in]	worldPos
[in]	camPos

Definition at line 293 of file SCR_RandomPositionalInsects.c.

LoadConfigs()

void SCR_RandomPositionalInsects::LoadConfigs ( )

inlineprotected

Loads configs where necessary values are stored.

Definition at line 376 of file SCR_RandomPositionalInsects.c.

OnPostInit()

override void SCR_RandomPositionalInsects::OnPostInit ( SCR_AmbientSoundsComponent ambientSoundsComponent, SCR_AmbientInsectsComponent ambientInsectsComponent, SignalsManagerComponent signalsManagerComponent )

inlineprotected

Definition at line 459 of file SCR_RandomPositionalInsects.c.

RandomizeAnimation()

void SCR_RandomPositionalInsects::RandomizeAnimation ( IEntity entity )

inlineprotected

Randomizes animation for Insect

Parameters

[in]

entity

Definition at line 150 of file SCR_RandomPositionalInsects.c.

RemoveOutOfRangeParticles()

void SCR_RandomPositionalInsects::RemoveOutOfRangeParticles ( vector cameraPos )

inlineprotected

Deletes Insects that are too far away

Parameters

[in]

cameraPos

Definition at line 113 of file SCR_RandomPositionalInsects.c.

RemoveParticlesBasedOnTimeAndWeather()

void SCR_RandomPositionalInsects::RemoveParticlesBasedOnTimeAndWeather ( float timeOfDay, float rainIntensity )

inlineprotected

Deletes Insects that are not supposed to be spawned based on time and weather conditions

Parameters

[in]	timeOfDay
[in]	rainIntensity

Definition at line 131 of file SCR_RandomPositionalInsects.c.

Update()

override void SCR_RandomPositionalInsects::Update ( float worldTime, vector cameraPos, float timeOfDay, float rainIntensity )

inlineprotected

Definition at line 38 of file SCR_RandomPositionalInsects.c.

UpdateDensity()

void SCR_RandomPositionalInsects::UpdateDensity ( )

inlineprotected

Updates insect density per group and active particles.

Definition at line 364 of file SCR_RandomPositionalInsects.c.

UpdateGlobalModifiers()

void SCR_RandomPositionalInsects::UpdateGlobalModifiers ( float timeOfDay, float rainIntensity )

inlineprotected

Updates time and weather for respective Insect groups

Parameters

[in]	timeOfDay
[in]	rainIntensity

Definition at line 58 of file SCR_RandomPositionalInsects.c.

UpdateInsectGroup()

void SCR_RandomPositionalInsects::UpdateInsectGroup ( float worldTime, vector camPos, int insectGroup )

inlineprotected

Attempts to find new position to play sound based on defined ESpawnMethod

Parameters

[in]	worldTime
[in]	camPos
[in]	insectGroup

Definition at line 169 of file SCR_RandomPositionalInsects.c.

Member Data Documentation

INVALID

const int SCR_RandomPositionalInsects::INVALID = -1

protected

Definition at line 26 of file SCR_RandomPositionalInsects.c.

m_aAngleOffset

ref array<int> SCR_RandomPositionalInsects::m_aAngleOffset = {}

protected

Definition at line 30 of file SCR_RandomPositionalInsects.c.

m_aDayTimeCurve

ref array<ref SCR_DayTimeCurveDef> SCR_RandomPositionalInsects::m_aDayTimeCurve = {}

protected

Definition at line 20 of file SCR_RandomPositionalInsects.c.

m_aDayTimeCurveValue

float SCR_RandomPositionalInsects::m_aDayTimeCurveValue[DAY_TIME_CURVE_COUNT]

protected

Definition at line 31 of file SCR_RandomPositionalInsects.c.

m_aDensity

ref array<int> SCR_RandomPositionalInsects::m_aDensity = {}

protected

Definition at line 28 of file SCR_RandomPositionalInsects.c.

m_aDensityModifier

ref array<float> SCR_RandomPositionalInsects::m_aDensityModifier = {}

protected

Definition at line 29 of file SCR_RandomPositionalInsects.c.

m_aInsectGroup

ref array<ref SCR_InsectGroup> SCR_RandomPositionalInsects::m_aInsectGroup = {}

protected

Definition at line 18 of file SCR_RandomPositionalInsects.c.

m_aParticles

ref array<ref SCR_InsectParticle> SCR_RandomPositionalInsects::m_aParticles = {}

protected

Definition at line 34 of file SCR_RandomPositionalInsects.c.

m_aRandomPositionalInsectsDef

ref array<ref SCR_RandomPositionalInsectsDef> SCR_RandomPositionalInsects::m_aRandomPositionalInsectsDef

protected

Definition at line 9 of file SCR_RandomPositionalInsects.c.

m_aSpawnDef

ref array<ref SCR_InsectSpawnDef> SCR_RandomPositionalInsects::m_aSpawnDef = {}

protected

Definition at line 19 of file SCR_RandomPositionalInsects.c.

m_aWindCurveValue

float SCR_RandomPositionalInsects::m_aWindCurveValue[WIND_CURVE_COUNT]

protected

Definition at line 32 of file SCR_RandomPositionalInsects.c.

m_aWindModifier

ref array<ref SCR_WindCurveDef> SCR_RandomPositionalInsects::m_aWindModifier = {}

protected

Definition at line 21 of file SCR_RandomPositionalInsects.c.

m_iDespawnDistanceSq

int SCR_RandomPositionalInsects::m_iDespawnDistanceSq

protected

Definition at line 6 of file SCR_RandomPositionalInsects.c.

m_iUpdatedInsectGroupIdx

int SCR_RandomPositionalInsects::m_iUpdatedInsectGroupIdx

protected

Definition at line 27 of file SCR_RandomPositionalInsects.c.

m_sDayTimeCurve

ResourceName SCR_RandomPositionalInsects::m_sDayTimeCurve

protected

Definition at line 12 of file SCR_RandomPositionalInsects.c.

m_SoundWorld

SoundWorld SCR_RandomPositionalInsects::m_SoundWorld

protected

Definition at line 24 of file SCR_RandomPositionalInsects.c.

m_sWindCurve

ResourceName SCR_RandomPositionalInsects::m_sWindCurve

protected

Definition at line 15 of file SCR_RandomPositionalInsects.c.

---

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

• scripts/Game/Components/SCR_RandomPositionalInsects.c