SCR_PositionalInsectType Class Reference

Base class that handles different insects based on their type. More...

Inheritance diagram for SCR_PositionalInsectType:

Protected Member Functions
void	Init (notnull SCR_AmbientSoundsComponent ambientSoundsComponent, notnull SCR_ObjectPositionalInsects objectPositionalInsects, notnull SCR_AmbientInsectsComponent ambientInsectsComponent)
void	Update (vector cameraPos)
void	RandomizeAnimation (IEntity entity)
	Randomises animation for Insect.
void	SpawnParticle (ParticleEffectEntitySpawnParams spawnParams, int chance=100)
void	RemoveDistantInsects ()
	Deletes Insects that are too far away.
set< BaseContainer >	GetPrefabContainerSet ()
void	AddClosestEntity (IEntity entity)
void	ClearClosestEntities ()
	Clears closest entities array for selected insect type.

Protected Attributes
ref array< ref SCR_InsectDef >	m_aInsectDef
ResourceName	m_sSpawnDef
int	m_iSpawnChance
vector	m_vOffset
SCR_AmbientSoundsComponent	m_AmbientSoundsComponent
SignalsManagerComponent	m_LocalSignalsManager
ref array< IEntity >	m_aClosestEntities = {}
ref array< IEntity >	m_aActiveEntities = {}
ref array< ref SCR_InsectParticle >	m_aParticles = {}
ref set< ref Resource >	m_ResourceSet = new set<ref Resource>()
ref set< BaseContainer >	m_PrefabContainerSet = new set<BaseContainer>()
ref SCR_InsectSpawnDef	m_SpawnDef
float	m_fDayTimeCurve = 1
float	m_fRainIntensityCurve = 1

Static Protected Attributes
static const int	INVALID = -1

Detailed Description

Base class that handles different insects based on their type.

Definition at line 3 of file SCR_PositionalInsectType.c.

Member Function Documentation

AddClosestEntity()

void SCR_PositionalInsectType::AddClosestEntity ( IEntity entity )

inlineprotected

Adds entity to the closest entities array for selected insect type

Parameters

[in]

entity

Definition at line 157 of file SCR_PositionalInsectType.c.

ClearClosestEntities()

void SCR_PositionalInsectType::ClearClosestEntities ( )

inlineprotected

Clears closest entities array for selected insect type.

Definition at line 164 of file SCR_PositionalInsectType.c.

GetPrefabContainerSet()

set< BaseContainer > SCR_PositionalInsectType::GetPrefabContainerSet ( )

inlineprotected

Get prefab container set

Returns

prefab container set

Definition at line 149 of file SCR_PositionalInsectType.c.

Init()

void SCR_PositionalInsectType::Init ( notnull SCR_AmbientSoundsComponent ambientSoundsComponent, notnull SCR_ObjectPositionalInsects objectPositionalInsects, notnull SCR_AmbientInsectsComponent ambientInsectsComponent )

inlineprotected

Initialises necessary things for Insect type

Parameters

[in]	ambientSoundsComponent
[in]	objectPositionalInsects
[in]	ambientInsectsComponent

Definition at line 38 of file SCR_PositionalInsectType.c.

RandomizeAnimation()

void SCR_PositionalInsectType::RandomizeAnimation ( IEntity entity )

inlineprotected

Randomises animation for Insect.

Definition at line 63 of file SCR_PositionalInsectType.c.

RemoveDistantInsects()

void SCR_PositionalInsectType::RemoveDistantInsects ( )

inlineprotected

Deletes Insects that are too far away.

Definition at line 130 of file SCR_PositionalInsectType.c.

SpawnParticle()

void SCR_PositionalInsectType::SpawnParticle ( ParticleEffectEntitySpawnParams spawnParams, int chance = 100 )

inlineprotected

Spawns particle with sound based on spawnParams and randomized chance

Parameters

[in]	spawnParams
[in]	chance

Definition at line 81 of file SCR_PositionalInsectType.c.

Update()

void SCR_PositionalInsectType::Update ( vector cameraPos )

protected

Performs updates to the Insect type

Parameters

[in]

cameraPos

Member Data Documentation

INVALID

const int SCR_PositionalInsectType::INVALID = -1

staticprotected

Definition at line 31 of file SCR_PositionalInsectType.c.

m_aActiveEntities

ref array<IEntity> SCR_PositionalInsectType::m_aActiveEntities = {}

protected

Definition at line 21 of file SCR_PositionalInsectType.c.

m_aClosestEntities

ref array<IEntity> SCR_PositionalInsectType::m_aClosestEntities = {}

protected

Definition at line 20 of file SCR_PositionalInsectType.c.

m_aInsectDef

ref array<ref SCR_InsectDef> SCR_PositionalInsectType::m_aInsectDef

protected

Definition at line 6 of file SCR_PositionalInsectType.c.

m_AmbientSoundsComponent

SCR_AmbientSoundsComponent SCR_PositionalInsectType::m_AmbientSoundsComponent

protected

Definition at line 17 of file SCR_PositionalInsectType.c.

m_aParticles

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

protected

Definition at line 22 of file SCR_PositionalInsectType.c.

m_fDayTimeCurve

float SCR_PositionalInsectType::m_fDayTimeCurve = 1

protected

Definition at line 28 of file SCR_PositionalInsectType.c.

m_fRainIntensityCurve

float SCR_PositionalInsectType::m_fRainIntensityCurve = 1

protected

Definition at line 29 of file SCR_PositionalInsectType.c.

m_iSpawnChance

int SCR_PositionalInsectType::m_iSpawnChance

protected

Definition at line 12 of file SCR_PositionalInsectType.c.

m_LocalSignalsManager

SignalsManagerComponent SCR_PositionalInsectType::m_LocalSignalsManager

protected

Definition at line 18 of file SCR_PositionalInsectType.c.

m_PrefabContainerSet

ref set<BaseContainer> SCR_PositionalInsectType::m_PrefabContainerSet = new set<BaseContainer>()

protected

Definition at line 25 of file SCR_PositionalInsectType.c.

m_ResourceSet

ref set<ref Resource> SCR_PositionalInsectType::m_ResourceSet = new set<ref Resource>()

protected

Definition at line 24 of file SCR_PositionalInsectType.c.

m_SpawnDef

ref SCR_InsectSpawnDef SCR_PositionalInsectType::m_SpawnDef

protected

Definition at line 27 of file SCR_PositionalInsectType.c.

m_sSpawnDef

ResourceName SCR_PositionalInsectType::m_sSpawnDef

protected

Definition at line 9 of file SCR_PositionalInsectType.c.

m_vOffset

vector SCR_PositionalInsectType::m_vOffset

protected

Definition at line 15 of file SCR_PositionalInsectType.c.

---

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

• scripts/Game/Components/SCR_PositionalInsectType.c