SCR_EffectsModule Class Reference

Inheritance diagram for SCR_EffectsModule:

Protected Member Functions
ResourceName	GetModuleEntityPrefab ()
SCR_BaseEffectsModulePositionData	GetEffectsModuleZoneData ()
vector	GetLocalSpawnOffset ()
EEffectsModuleType	GetType ()
void	Init (notnull IEntity owner, notnull SCR_EffectsModuleComponent effectModuleParent)
sealed void	OnModulePreExecute ()
void	OnModuleExecute ()
void	SetSpawnParams (notnull out EntitySpawnParams spawnParams, out vector targetPosition)
void	OnEntitySpawned (notnull SCR_EffectsModuleChildComponent spawnedChild, vector targetPosition)
void	OnEntitySpawnedBroadcast (notnull SCR_EffectsModuleChildComponent spawnedChild, vector targetPosition)
void	CancelModule ()
void	CancelModuleBroadcast ()
bool	CanPause ()
bool	IsPaused ()
void	SetPaused (bool paused)
bool	CanLoop ()
bool	IsLooping ()
void	SetLooping (bool loop)
vector	GetLocalTargetOffset ()

Protected Attributes
ResourceName	m_sModuleEntityPrefab
ref SCR_BaseEffectsModulePositionData	m_ModuleZoneData
EEffectsModuleType	m_eEffectsModuleType
vector	m_vLocalSpawnOffset
vector	m_vLocalTargetOffset
float	m_fStartDelay
bool	m_bSnapToTerrain
bool	m_bExecuting
bool	m_bCheckForDelete
bool	m_bIsPaused
IEntity	m_Owner
SCR_EffectsModuleComponent	m_EffectsModuleParent
const float	CHECK_FOR_DELETE_DELAY = 0.5

Detailed Description

Definition at line 2 of file SCR_EffectModule.c.

Member Function Documentation

CancelModule()

void SCR_EffectsModule::CancelModule ( )

protected

Cancel executing of the effect module (Server Only)

CancelModuleBroadcast()

void SCR_EffectsModule::CancelModuleBroadcast ( )

protected

Cancel executing of the effect module Server and Client

CanLoop()

bool SCR_EffectsModule::CanLoop ( )

inlineprotected

Get Can loop the effect module

Returns

Can loop

Definition at line 290 of file SCR_EffectModule.c.

CanPause()

bool SCR_EffectsModule::CanPause ( )

inlineprotected

Get Can pause the effect module

Returns

Can pause

Definition at line 257 of file SCR_EffectModule.c.

GetEffectsModuleZoneData()

SCR_BaseEffectsModulePositionData SCR_EffectsModule::GetEffectsModuleZoneData ( )

inlineprotected

Definition at line 55 of file SCR_EffectModule.c.

GetLocalSpawnOffset()

vector SCR_EffectsModule::GetLocalSpawnOffset ( )

inlineprotected

Get Module local spawn position vars

Returns

Local spawn postion

Definition at line 65 of file SCR_EffectModule.c.

GetLocalTargetOffset()

vector SCR_EffectsModule::GetLocalTargetOffset ( )

inlineprotected

/return X and Y offset where the entity is spawned

Definition at line 316 of file SCR_EffectModule.c.

GetModuleEntityPrefab()

ResourceName SCR_EffectsModule::GetModuleEntityPrefab ( )

inlineprotected

Get Module prefab to spawn

Returns

Module prefab

Definition at line 50 of file SCR_EffectModule.c.

GetType()

EEffectsModuleType SCR_EffectsModule::GetType ( )

inlineprotected

Get Module Type. Types dictate how the entity is spawned and what happens after spawning

Returns

Module type

Definition at line 75 of file SCR_EffectModule.c.

Init()

void SCR_EffectsModule::Init ( notnull IEntity owner, notnull SCR_EffectsModuleComponent effectModuleParent )

inlineprotected

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

Definition at line 87 of file SCR_EffectModule.c.

IsLooping()

bool SCR_EffectsModule::IsLooping ( )

inlineprotected

Get If effect module is looping

Returns

Is looping

Definition at line 300 of file SCR_EffectModule.c.

IsPaused()

bool SCR_EffectsModule::IsPaused ( )

inlineprotected

Get If effect module is paused

Returns

Is paused

Definition at line 267 of file SCR_EffectModule.c.

OnEntitySpawned()

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

inlineprotected

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

Definition at line 187 of file SCR_EffectModule.c.

OnEntitySpawnedBroadcast()

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

protected

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 ( )

inlineprotected

Definition at line 117 of file SCR_EffectModule.c.

OnModulePreExecute()

sealed void SCR_EffectsModule::OnModulePreExecute ( )

inlineprotected

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

Definition at line 102 of file SCR_EffectModule.c.

SetLooping()

void SCR_EffectsModule::SetLooping ( bool loop )

protected

Set looping the effect module

Parameters

loop	If true than it will start looping

SetPaused()

void SCR_EffectsModule::SetPaused ( bool paused )

inlineprotected

Pause the effect module

Parameters

paused.

If true then it is paused

Definition at line 277 of file SCR_EffectModule.c.

SetSpawnParams()

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

inlineprotected

Set the spawn params for effect module (Server Only)

Parameters

[out]

spawnParams

Spawn params

Definition at line 131 of file SCR_EffectModule.c.

Member Data Documentation

CHECK_FOR_DELETE_DELAY

const float SCR_EffectsModule::CHECK_FOR_DELETE_DELAY = 0.5

protected

Definition at line 42 of file SCR_EffectModule.c.

m_bCheckForDelete

bool SCR_EffectsModule::m_bCheckForDelete

protected

Definition at line 32 of file SCR_EffectModule.c.

m_bExecuting

bool SCR_EffectsModule::m_bExecuting

protected

Definition at line 26 of file SCR_EffectModule.c.

m_bIsPaused

bool SCR_EffectsModule::m_bIsPaused

protected

Definition at line 35 of file SCR_EffectModule.c.

m_bSnapToTerrain

bool SCR_EffectsModule::m_bSnapToTerrain

protected

Definition at line 23 of file SCR_EffectModule.c.

m_eEffectsModuleType

EEffectsModuleType SCR_EffectsModule::m_eEffectsModuleType

protected

Definition at line 11 of file SCR_EffectModule.c.

m_EffectsModuleParent

SCR_EffectsModuleComponent SCR_EffectsModule::m_EffectsModuleParent

protected

Definition at line 39 of file SCR_EffectModule.c.

m_fStartDelay

float SCR_EffectsModule::m_fStartDelay

protected

Definition at line 20 of file SCR_EffectModule.c.

m_ModuleZoneData

ref SCR_BaseEffectsModulePositionData SCR_EffectsModule::m_ModuleZoneData

protected

Definition at line 8 of file SCR_EffectModule.c.

m_Owner

IEntity SCR_EffectsModule::m_Owner

protected

Definition at line 38 of file SCR_EffectModule.c.

m_sModuleEntityPrefab

ResourceName SCR_EffectsModule::m_sModuleEntityPrefab

protected

Definition at line 5 of file SCR_EffectModule.c.

m_vLocalSpawnOffset

vector SCR_EffectsModule::m_vLocalSpawnOffset

protected

Definition at line 14 of file SCR_EffectModule.c.

m_vLocalTargetOffset

vector SCR_EffectsModule::m_vLocalTargetOffset

protected

Definition at line 17 of file SCR_EffectModule.c.

---

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

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