SCR_BarrageEffectsModule Interface Reference

Inheritance diagram for SCR_BarrageEffectsModule:

Public Member Functions
override void	Init (notnull IEntity owner, notnull SCR_EffectsModuleComponent effectModuleParent)
	Init the Module.
override void	OnModuleExecute ()
override bool	CanPause ()
	Get Can pause the effect module.
override void	SetPaused (bool paused)
	Pause the effect module.
override bool	CanLoop ()
	Get Can loop the effect module.
override void	SetLooping (bool loop)
	Set looping the effect module.
override void	CancelModule ()
	Cancel executing of the effect module (Server Only)
int	GetTotalProjectilesInBarrage ()
	Get the amount of projectiles set at the start of the barrage.
int	GetProjectilesLeftInBarrage ()
	Get the amount of projectiles set at the start of the barrage.
Public Member Functions inherited from SCR_EffectsModule
ResourceName	GetModuleEntityPrefab ()
	Get Module prefab to spawn.
SCR_BaseEffectsModulePositionData	GetEffectsModuleZoneData ()
vector	GetLocalSpawnOffset ()
	Get Module local spawn position vars.
EEffectsModuleType	GetType ()
	Get Module Type.
void	OnModulePreExecute ()
	Start the execution of the Effect module (Server Only) Will execute after a delay if any is set.
void	SetSpawnParams (notnull out EntitySpawnParams spawnParams, out vector targetPosition)
	Set the spawn params for effect module (Server Only)
void	OnEntitySpawned (notnull SCR_EffectsModuleChildComponent spawnedChild, vector targetPosition)
	Called by SCR_EffectsModuleComponent when the Module prefab is spawned (Server Only)
void	OnEntitySpawnedBroadcast (notnull SCR_EffectsModuleChildComponent spawnedChild, vector targetPosition)
	Called by SCR_EffectsModuleComponent and OnEntitySpawned() when the Module prefab is spawned.
void	CancelModuleBroadcast ()
	Cancel executing of the effect module Server and Client.
bool	IsPaused ()
	Get If effect module is paused.
bool	IsLooping ()
	Get If effect module is looping.
vector	GetLocalTargetOffset ()
	/return X and Y offset where the entity is spawned

Protected Member Functions
void	StartBarrage ()
void	BarrageUpdateLoop ()
void	BarrageDone ()

Protected Attributes
int	m_iMinProjectilesEachBarrage
int	m_iMaxProjectilesEachBarrage
float	m_fMinProjectileDelay
float	m_fMaxProjectileDelay
int	m_iBarrageAmount
float	m_fMinBarrageDelay
float	m_fMaxBarrageDelay
bool	m_bCanPause
bool	m_bCanLoop
bool	m_bIsLooping
int	m_iProjectilesLeftInBarrage = -1
int	m_iTotalProjectilesInBarrage = -1
float	m_fCurrentProjectileDelay
int	m_iBarragesLeft = -1
bool	m_bWaitingForNextBarrage
Protected Attributes inherited from SCR_EffectsModule
ResourceName	m_sModuleEntityPrefab
ref SCR_BaseEffectsModulePositionData	m_ModuleZoneData
EEffectsModuleType	m_eEffectsModuleType
vector	m_vLocalSpawnOffset
vector	m_vLocalTargetOffset
float	m_fStartDelay
bool	m_bExecuting
bool	m_bCheckForDelete
bool	m_bIsPaused

Static Protected Attributes
const float	UPDATE_TIME = 0.05
Static Protected Attributes inherited from SCR_EffectsModule
const float	CHECK_FOR_DELETE_DELAY = 0.5

Additional Inherited Members
Public Attributes inherited from SCR_EffectsModule
bool	m_bSnapToTerrain
IEntity	m_Owner
SCR_EffectsModuleComponent	m_EffectsModuleParent

Member Function Documentation

BarrageDone()

void SCR_BarrageEffectsModule.BarrageDone ( )

protected

BarrageUpdateLoop()

void SCR_BarrageEffectsModule.BarrageUpdateLoop ( )

protected

CancelModule()

override void SCR_BarrageEffectsModule.CancelModule

(

)

Cancel executing of the effect module (Server Only)

Implements SCR_EffectsModule.

CanLoop()

override bool SCR_BarrageEffectsModule.CanLoop

(

)

Get Can loop the effect module.

Returns

Can loop

Implements SCR_EffectsModule.

CanPause()

override bool SCR_BarrageEffectsModule.CanPause

(

)

Get Can pause the effect module.

Returns

Can pause

Implements SCR_EffectsModule.

GetProjectilesLeftInBarrage()

int SCR_BarrageEffectsModule.GetProjectilesLeftInBarrage

(

)

Get the amount of projectiles set at the start of the barrage.

Returns

Total Projectile Amount in the current barrage

GetTotalProjectilesInBarrage()

int SCR_BarrageEffectsModule.GetTotalProjectilesInBarrage

(

)

Get the amount of projectiles set at the start of the barrage.

Returns

Total Projectile Amount in the current barrage

Init()

override void SCR_BarrageEffectsModule.Init	(	notnull IEntity	owner,
		notnull SCR_EffectsModuleComponent	effectModuleParent )

Init the Module.

Called by SCR_EffectsModuleComponent both Server and Client

Parameters

owner	Owner of the SCR_EffectsModuleComponent this Effect Module is attached to
effectModuleParent	SCR_EffectsModuleComponent of the owner this Effect Module is attached to

Implements SCR_EffectsModule.

OnModuleExecute()

override void SCR_BarrageEffectsModule.OnModuleExecute

(

)

Implements SCR_EffectsModule.

SetLooping()

override void SCR_BarrageEffectsModule.SetLooping

(

bool

loop

)

Set looping the effect module.

Parameters

loop	If true than it will start looping

Implements SCR_EffectsModule.

SetPaused()

override void SCR_BarrageEffectsModule.SetPaused

(

bool

paused

)

Pause the effect module.

Parameters

paused.

If true then it is paused

Implements SCR_EffectsModule.

StartBarrage()

void SCR_BarrageEffectsModule.StartBarrage ( )

protected

Member Data Documentation

m_bCanLoop

bool SCR_BarrageEffectsModule.m_bCanLoop

protected

m_bCanPause

bool SCR_BarrageEffectsModule.m_bCanPause

protected

m_bIsLooping

bool SCR_BarrageEffectsModule.m_bIsLooping

protected

m_bWaitingForNextBarrage

bool SCR_BarrageEffectsModule.m_bWaitingForNextBarrage

protected

m_fCurrentProjectileDelay

float SCR_BarrageEffectsModule.m_fCurrentProjectileDelay

protected

m_fMaxBarrageDelay

float SCR_BarrageEffectsModule.m_fMaxBarrageDelay

protected

m_fMaxProjectileDelay

float SCR_BarrageEffectsModule.m_fMaxProjectileDelay

protected

m_fMinBarrageDelay

float SCR_BarrageEffectsModule.m_fMinBarrageDelay

protected

m_fMinProjectileDelay

float SCR_BarrageEffectsModule.m_fMinProjectileDelay

protected

m_iBarrageAmount

int SCR_BarrageEffectsModule.m_iBarrageAmount

protected

m_iBarragesLeft

int SCR_BarrageEffectsModule.m_iBarragesLeft = -1

protected

m_iMaxProjectilesEachBarrage

int SCR_BarrageEffectsModule.m_iMaxProjectilesEachBarrage

protected

m_iMinProjectilesEachBarrage

int SCR_BarrageEffectsModule.m_iMinProjectilesEachBarrage

protected

m_iProjectilesLeftInBarrage

int SCR_BarrageEffectsModule.m_iProjectilesLeftInBarrage = -1

protected

m_iTotalProjectilesInBarrage

int SCR_BarrageEffectsModule.m_iTotalProjectilesInBarrage = -1

protected

UPDATE_TIME

const float SCR_BarrageEffectsModule.UPDATE_TIME = 0.05

staticprotected

---

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

• Game/Components/EffectModules/Modules/SCR_BarrageEffectModule.c