SCR_PositionalInsectType Interface Reference

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

Inheritance diagram for SCR_PositionalInsectType:

Public Member Functions
void	Init (notnull SCR_AmbientSoundsComponent ambientSoundsComponent, notnull SCR_ObjectPositionalInsects objectPositionalInsects, notnull SCR_AmbientInsectsComponent ambientInsectsComponent)
	Initialises necessary things for Insect type.
void	Update (vector cameraPos)
	Performs updates to the Insect type.
set< BaseContainer >	GetPrefabContainerSet ()
	Get prefab container set.
void	AddClosestEntity (IEntity entity)
	Adds entity to the closest entities array for selected insect type.
void	ClearClosestEntities ()
	Clears closest entities array for selected insect type.

Public Attributes
ResourceName	m_sSpawnDef
ref SCR_InsectSpawnDef	m_SpawnDef
float	m_fDayTimeCurve = 1
float	m_fRainIntensityCurve = 1

Protected Member Functions
void	RandomizeAnimation (IEntity entity)
	Randomises animation for Insect.
void	SpawnParticle (ParticleEffectEntitySpawnParams spawnParams, int chance=100)
	Spawns particle with sound based on spawnParams and randomized chance.
void	RemoveDistantInsects ()
	Deletes Insects that are too far away.

Protected Attributes
ref array< ref SCR_InsectDef >	m_aInsectDef
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>()

Static Protected Attributes
static const int	INVALID = -1

Detailed Description

Base class that handles different insects based on their type.

Member Function Documentation

AddClosestEntity()

void SCR_PositionalInsectType.AddClosestEntity

(

IEntity

entity

)

Adds entity to the closest entities array for selected insect type.

Parameters

[in]

entity

ClearClosestEntities()

void SCR_PositionalInsectType.ClearClosestEntities

(

)

Clears closest entities array for selected insect type.

GetPrefabContainerSet()

set< BaseContainer > SCR_PositionalInsectType.GetPrefabContainerSet

(

)

Get prefab container set.

Returns

prefab container set

Init()

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

Initialises necessary things for Insect type.

Parameters

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

Implemented in SCR_PositionalLightSourceInsect, and SCR_PositionalGenericInsect.

RandomizeAnimation()

void SCR_PositionalInsectType.RandomizeAnimation ( IEntity  entity )

protected

Randomises animation for Insect.

RemoveDistantInsects()

void SCR_PositionalInsectType.RemoveDistantInsects ( )

protected

Deletes Insects that are too far away.

SpawnParticle()

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

protected

Spawns particle with sound based on spawnParams and randomized chance.

Parameters

[in]	spawnParams
[in]	chance

Update()

void SCR_PositionalInsectType.Update

(

vector

cameraPos

)

Performs updates to the Insect type.

Parameters

[in]

cameraPos

Implemented in SCR_PositionalLightSourceInsect, SCR_PositionalAmbientLeafParticles, and SCR_PositionalGenericInsect.

Member Data Documentation

INVALID

const int SCR_PositionalInsectType.INVALID = -1

staticprotected

m_aActiveEntities

ref array<IEntity> SCR_PositionalInsectType.m_aActiveEntities = {}

protected

m_aClosestEntities

ref array<IEntity> SCR_PositionalInsectType.m_aClosestEntities = {}

protected

m_aInsectDef

ref array<ref SCR_InsectDef> SCR_PositionalInsectType.m_aInsectDef

protected

m_AmbientSoundsComponent

SCR_AmbientSoundsComponent SCR_PositionalInsectType.m_AmbientSoundsComponent

protected

m_aParticles

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

protected

m_fDayTimeCurve

float SCR_PositionalInsectType.m_fDayTimeCurve = 1

m_fRainIntensityCurve

float SCR_PositionalInsectType.m_fRainIntensityCurve = 1

m_iSpawnChance

int SCR_PositionalInsectType.m_iSpawnChance

protected

m_LocalSignalsManager

SignalsManagerComponent SCR_PositionalInsectType.m_LocalSignalsManager

protected

m_PrefabContainerSet

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

protected

m_ResourceSet

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

protected

m_SpawnDef

ref SCR_InsectSpawnDef SCR_PositionalInsectType.m_SpawnDef

m_sSpawnDef

ResourceName SCR_PositionalInsectType.m_sSpawnDef

m_vOffset

vector SCR_PositionalInsectType.m_vOffset

protected

---

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

• Game/Components/SCR_PositionalInsectType.c