SCR_EffectsModule Interface Reference

Inheritance diagram for SCR_EffectsModule:

Public Member Functions
ResourceName	GetModuleEntityPrefab ()
	Get Module prefab to spawn.
SCR_BaseEffectsModulePositionData	GetEffectsModuleZoneData ()
vector	GetLocalSpawnOffset ()
	Get Module local spawn position vars.
EEffectsModuleType	GetType ()
	Get Module Type.
void	Init (notnull IEntity owner, notnull SCR_EffectsModuleComponent effectModuleParent)
	Init the Module.
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	CancelModule ()
	Cancel executing of the effect module (Server Only)
void	CancelModuleBroadcast ()
	Cancel executing of the effect module Server and Client.
bool	CanPause ()
	Get Can pause the effect module.
bool	IsPaused ()
	Get If effect module is paused.
void	SetPaused (bool paused)
	Pause the effect module.
bool	CanLoop ()
	Get Can loop the effect module.
bool	IsLooping ()
	Get If effect module is looping.
void	SetLooping (bool loop)
	Set looping the effect module.
vector	GetLocalTargetOffset ()
	/return X and Y offset where the entity is spawned

Public Attributes
bool	m_bSnapToTerrain
IEntity	m_Owner
SCR_EffectsModuleComponent	m_EffectsModuleParent

Protected Member Functions
void	OnModuleExecute ()

Protected Attributes
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	CHECK_FOR_DELETE_DELAY = 0.5

Member Function Documentation

CancelModule()

void SCR_EffectsModule.CancelModule

(

)

Cancel executing of the effect module (Server Only)

Implemented in SCR_BarrageEffectsModule.

CancelModuleBroadcast()

void SCR_EffectsModule.CancelModuleBroadcast

(

)

Cancel executing of the effect module Server and Client.

CanLoop()

bool SCR_EffectsModule.CanLoop

(

)

Get Can loop the effect module.

Returns

Can loop

Implemented in SCR_BarrageEffectsModule.

CanPause()

bool SCR_EffectsModule.CanPause

(

)

Get Can pause the effect module.

Returns

Can pause

Implemented in SCR_BarrageEffectsModule.

GetEffectsModuleZoneData()

SCR_BaseEffectsModulePositionData SCR_EffectsModule.GetEffectsModuleZoneData

(

)

GetLocalSpawnOffset()

vector SCR_EffectsModule.GetLocalSpawnOffset

(

)

Get Module local spawn position vars.

Returns

Local spawn postion

GetLocalTargetOffset()

vector SCR_EffectsModule.GetLocalTargetOffset

(

)

/return X and Y offset where the entity is spawned

GetModuleEntityPrefab()

ResourceName SCR_EffectsModule.GetModuleEntityPrefab

(

)

Get Module prefab to spawn.

Returns

Module prefab

GetType()

EEffectsModuleType SCR_EffectsModule.GetType

(

)

Get Module Type.

Types dictate how the entity is spawned and what happens after spawning

Returns

Module type

Init()

void SCR_EffectsModule.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

Implemented in SCR_BarrageEffectsModule.

IsLooping()

bool SCR_EffectsModule.IsLooping

(

)

Get If effect module is looping.

Returns

Is looping

IsPaused()

bool SCR_EffectsModule.IsPaused

(

)

Get If effect module is paused.

Returns

Is paused

OnEntitySpawned()

void SCR_EffectsModule.OnEntitySpawned	(	notnull SCR_EffectsModuleChildComponent	spawnedChild,
		vector	targetPosition )

Called by SCR_EffectsModuleComponent when the Module prefab is spawned (Server Only)

OnEntitySpawnedBroadcast()

void SCR_EffectsModule.OnEntitySpawnedBroadcast	(	notnull SCR_EffectsModuleChildComponent	spawnedChild,
		vector	targetPosition )

Called by SCR_EffectsModuleComponent and OnEntitySpawned() when the Module prefab is spawned.

On Server and Client. Has one frame delay before called

OnModuleExecute()

void SCR_EffectsModule.OnModuleExecute ( )

protected

Implemented in SCR_BarrageEffectsModule.

OnModulePreExecute()

void SCR_EffectsModule.OnModulePreExecute ( )

sealed

Start the execution of the Effect module (Server Only) Will execute after a delay if any is set.

SetLooping()

void SCR_EffectsModule.SetLooping

(

bool

loop

)

Set looping the effect module.

Parameters

loop	If true than it will start looping

Implemented in SCR_BarrageEffectsModule.

SetPaused()

void SCR_EffectsModule.SetPaused

(

bool

paused

)

Pause the effect module.

Parameters

paused.

If true then it is paused

Implemented in SCR_BarrageEffectsModule.

SetSpawnParams()

void SCR_EffectsModule.SetSpawnParams	(	notnull out EntitySpawnParams	spawnParams,
		out vector	targetPosition )

Set the spawn params for effect module (Server Only)

Parameters

[out]

spawnParams

Spawn params

Member Data Documentation

CHECK_FOR_DELETE_DELAY

const float SCR_EffectsModule.CHECK_FOR_DELETE_DELAY = 0.5

staticprotected

m_bCheckForDelete

bool SCR_EffectsModule.m_bCheckForDelete

protected

m_bExecuting

bool SCR_EffectsModule.m_bExecuting

protected

m_bIsPaused

bool SCR_EffectsModule.m_bIsPaused

protected

m_bSnapToTerrain

bool SCR_EffectsModule.m_bSnapToTerrain

m_eEffectsModuleType

EEffectsModuleType SCR_EffectsModule.m_eEffectsModuleType

protected

m_EffectsModuleParent

SCR_EffectsModuleComponent SCR_EffectsModule.m_EffectsModuleParent

m_fStartDelay

float SCR_EffectsModule.m_fStartDelay

protected

m_ModuleZoneData

ref SCR_BaseEffectsModulePositionData SCR_EffectsModule.m_ModuleZoneData

protected

m_Owner

IEntity SCR_EffectsModule.m_Owner

m_sModuleEntityPrefab

ResourceName SCR_EffectsModule.m_sModuleEntityPrefab

protected

m_vLocalSpawnOffset

vector SCR_EffectsModule.m_vLocalSpawnOffset

protected

m_vLocalTargetOffset

vector SCR_EffectsModule.m_vLocalTargetOffset

protected

---

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

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