Effect.c File Reference

Go to the source code of this file.

Enumerations
enum	EffectType
	Enum to determine what type of effect the Effect is. More...

Functions
EffectType
Information about what type of effect the Effect is, without the need for casting
EffectType	GetEffectType ()
	Get what type of effect the Effect is.
bool	IsSound ()
	Check whether the Effect is EffectSound without casting.
bool	IsParticle ()
	Check whether the Effect is EffectParticle without casting.
Playback
Methods to Play/Stop Effect Generally, SEffectManager.Play methods are used instead of Start
void	Start ()
	Plays all elements this effects consists of.
void	ValidateStart ()
	Validation whether an effect truly started playing or if the Effect should stop as none is present.
void	Stop ()
	Stops all elements this effect consists of.
bool	IsPlaying ()
	Returns true when the Effect is playing, false otherwise.
Destroy
Methods regarding automatic cleanup
void	Destroy ()
	Cleans up the Effect, including unregistering if needed.
void	SetAutodestroy (bool auto_destroy)
	Sets whether Effect automatically cleans up when it stops.
bool	IsAutodestroy ()
	Get whether Effect automatically cleans up when it stops.
bool	IsPendingDeletion ()
	Get whether the Effect is queued up for being cleaned up.
bool	CanDestroy ()
	Get whether the Effect can be destroyed right now.
void	SetEnableEventFrame (bool enable)
	Enable Event_OnFrameUpdate for the effect.
Events
Various events that can be overriden for custom behaviour
void	Event_OnFrameUpdate (float time_delta)
	Event called on frame when enabled by SetEnableEventFrame(true)
void	Event_OnRegistered (int id)
	Event called from SEffectManager when the Effect is registered.
void	Event_OnUnregistered ()
	Event called from SEffectManager when the Effect is unregistered.
void	OnCheckUpdate ()
	Event used when EffectParticle.CheckLifeSpan was called (DEPRECATED)
Generic API
Setters and getters for generic data and properties
void	SetParent (Object parent_obj)
	Set parent of the Effect.
Object	GetParent ()
	Get parent of the Effect.
void	SetCurrentParent (Object parent_obj, bool updateCached=true)
	Set current parent of the managed effect.
Object	GetCurrentParent ()
	Get the current parent of the managed Effect.
void	SetPosition (vector pos)
	Set the world position of the Effect.
vector	GetPosition ()
	Get the world position of the Effect.
void	SetCurrentPosition (vector pos, bool updateCached=true)
	Set the current world position of the managed effect.
vector	GetCurrentPosition ()
	Get the current world position of the managed effect.
void	SetLocalPosition (vector pos)
	Set the local position of the Effect.
vector	GetLocalPosition ()
	Get the local position of the Effect.
void	SetCurrentLocalPosition (vector pos, bool updateCached=true)
	Set the current local position of the managed effect.
vector	GetCurrentLocalPosition ()
	Get the current local position of the managed effect.
Effect ID
The ID of the effect when registered in SEffectManager
void	SetID (int id)
	Set the ID registered in SEffectManager.
int	GetID ()
	Get the ID registered in SEffectManager.
bool	IsRegistered ()
	Get whether this Effect is registered in SEffectManager.
Attachment API
Data to attach an Effect to a parent Mostly replaced by equivalents without 'Attachment' in name Mildly deprecated, exist for backwards compatibility
void	SetAttachmentParent (Object obj)
	Set parent for the Effect.
Object	GetAttachmentParent ()
	Get the parent set by SetAttachmentParent.
void	SetAttachedLocalPos (vector pos)
	Set local pos for the Effect relative to the parent.
vector	GetAttachedLocalPos ()
	Get the local pos set by SetAttachedLocalPos.
void	SetAttachedLocalOri (vector ori)
	Set local orientation for the Effectparticle to attach to when the Effect is started.
vector	GetAttachedLocalOri ()
	Get the local orientation set by SetAttachedLocalOri.

Variables
	NONE
	Plain Effect base.
	SOUND
	EffectSound.
	PARTICLE
	EffectParticle.
Event invokers
Base wrapper class for managing effects (Particles, Sound) through SEffectManager Note This is just a base class, not intended for direct usage ScriptInvonkers for certain events
	Event_OnStarted () = new ScriptInvoker()
	Event used when Start was called.
ref ScriptInvoker	Event_OnStopped () = new ScriptInvoker()
	Event used when Stop was called.
ref ScriptInvoker	Event_OnEffectStarted () = new ScriptInvoker()
	Event used when the actual effect started playing.
ref ScriptInvoker	Event_OnEffectEnded () = new ScriptInvoker()
	Event used when the actual effect stopped playing.
Generic data
Generic data for the Effect
bool	m_IsAutodestroy
	Whether the Effect cleans up after itself when stopped.
bool	m_IsPendingDeletion
	Whether the Destroy process has already been called.
bool	m_IsPlaying
	Whether the Effect is currently playing.
Object	m_ParentObject
	Cached parent.
vector	m_Position
	Cached world position.
SEffectManager data
Data filled in by SEffectManager to identify it when it is registered
int	m_ID
	ID of effect, given by SEffectManager when registered (automatically done when playing through it)
bool	m_IsRegistered
	Whether the effect is registered in SEffectManager.

Attachment data
Cached settings set through 'SetAttachment...' methods Does not necessarily reflect the current state when EffectParticle
vector	m_LocalPos
	Cached local pos.
vector	m_LocalOri
	Local orientation set by SetAttachedLocalOri, only used by EffectParticle.
void	Effect ()
	ctor
void	~Effect ()
	dtor
void	InitEffect ()
	init

Enumeration Type Documentation

EffectType

enum EffectType

Enum to determine what type of effect the Effect is.

Definition at line 2 of file Effect.c.

{
  NONE,
  SOUND,
  PARTICLE,
}

Function Documentation

Effect()

void Effect ( )

protected

ctor

Definition at line 69 of file Effect.c.

  {
    if (GetGame().IsDedicatedServer())
      ErrorEx("Created Effect on server.", ErrorExSeverity.WARNING);
 
    InitEffect();
  }

References ErrorEx, GetGame(), and InitEffect().

Event_OnFrameUpdate()

void Event_OnFrameUpdate ( float time_delta )

protected

Event called on frame when enabled by SetEnableEventFrame(true)

Note

Called from SEffectManager.Event_OnFrameUpdate in MissionGameplay.OnUpdate

Parameters

time_delta

float Time passed since the previous frame

Definition at line 328 of file Effect.c.

  {
    // Override this method for own use
  }

Referenced by SetEnableEventFrame().

Event_OnRegistered()

void Event_OnRegistered ( int id )

protected

Event called from SEffectManager when the Effect is registered.

Note

Should only ever be called by SEffectManager!

Parameters

id	int ID registered in SEffectManager

Definition at line 338 of file Effect.c.

  {
    SetID(id);
    m_IsRegistered = true;
  }

References m_IsRegistered, and SetID().

Event_OnUnregistered()

void Event_OnUnregistered ( )

protected

Event called from SEffectManager when the Effect is unregistered.

Note

Should only ever be called by SEffectManager!

Definition at line 348 of file Effect.c.

  {
    SetID(SEffectManager.INVALID_ID);
    m_IsRegistered = false;
  }

References SEffectManager::INVALID_ID, m_IsRegistered, and SetID().

GetAttachedLocalOri()

vector GetAttachedLocalOri ( )

protected

Get the local orientation set by SetAttachedLocalOri.

Warning

Is not necessarily the current local orientation

Returns

vector The local orientation set by SetAttachedLocalOri

Definition at line 593 of file Effect.c.

  {
    return m_LocalOri;
  }

References m_LocalOri.

Referenced by EffectParticle::ReAttach(), and EffectParticle::Start().

GetAttachedLocalPos()

vector GetAttachedLocalPos ( )

protected

Get the local pos set by SetAttachedLocalPos.

Returns

vector The local pos set by SetAttachedLocalPos

Definition at line 572 of file Effect.c.

  {
    return GetLocalPosition();
  }

References GetLocalPosition().

GetAttachmentParent()

Object GetAttachmentParent ( )

protected

Get the parent set by SetAttachmentParent.

Returns

Object The parent set by SetAttachmentParent

Definition at line 554 of file Effect.c.

  {
    return GetParent();
  }

References GetParent().

Referenced by EffEngineSmoke::Event_OnFrameUpdate(), EffExhaustSmoke::SetParticleStateLight(), and EffCoolantSteam::UpdateParticle().

GetCurrentLocalPosition()

vector GetCurrentLocalPosition ( )

protected

Get the current local position of the managed effect.

Returns

vector The current local position of the managed effect

Definition at line 490 of file Effect.c.

  {
    return vector.Zero;
  }

References vector::Zero.

GetCurrentParent()

Object GetCurrentParent ( )

protected

Get the current parent of the managed Effect.

Returns

Object The current parent of the managed Effect

Definition at line 410 of file Effect.c.

  {
    return null;
  }

GetCurrentPosition()

vector GetCurrentPosition ( )

protected

Get the current world position of the managed effect.

Returns

vector The current world position of the managed effect

Definition at line 450 of file Effect.c.

  {
    return vector.Zero;
  }

References vector::Zero.

GetEffectType()

EffectType GetEffectType ( )

protected

Get what type of effect the Effect is.

Returns

EffectType What type of effect the Effect is

Definition at line 113 of file Effect.c.

  {
    return EffectType.NONE;
  }

GetID()

int GetID ( )

protected

Get the ID registered in SEffectManager.

Returns

int ID registered in SEffectManager, or 0 (SEffectManager.INVALID_ID) when not registered

Definition at line 517 of file Effect.c.

  {
    return m_ID;
  }

References m_ID.

Referenced by AnalyticsManagerClient::Event_OnEntityKilled(), CGame::GamepadCheck(), ManBase::InitEditor(), BiosUserManager::OnPartyHost(), MissionBase::Pause(), and ~Effect().

GetLocalPosition()

vector GetLocalPosition ( )

protected

Get the local position of the Effect.

Warning

Only gets the cached variable, for immediate effect use GetCurrent variant

Returns

vector The lcoal position of the Effect

Definition at line 470 of file Effect.c.

  {
    return m_LocalPos;
  }

References m_LocalPos.

Referenced by GetAttachedLocalPos(), EffectSound::GetCurrentLocalPosition(), EffectParticle::ReAttach(), ParticleSource::SetWiggle(), and EffectParticle::Start().

GetPosition()

vector GetPosition ( )

protected

Get the world position of the Effect.

Warning

Only gets the cached variable, for immediate effect use GetCurrent variant

Returns

vector The world position of the Effect

Definition at line 430 of file Effect.c.

  {
    return m_Position;
  }

References m_Position.

InitEffect()

void InitEffect ( )

protected

init

Definition at line 96 of file Effect.c.

  {
    Event_OnStarted.Insert(Event_OnEffectStarted);
    Event_OnStarted.Insert(ValidateStart);
    Event_OnStopped.Insert(Event_OnEffectEnded);
  }

References Event_OnEffectEnded, Event_OnEffectStarted, Event_OnStarted, Event_OnStopped, and ValidateStart().

Referenced by Effect().

IsParticle()

bool IsParticle ( )

protected

Check whether the Effect is EffectParticle without casting.

Returns

bool Whether the Effect is EffectParticle

Definition at line 131 of file Effect.c.

  {
    return false;
  }

IsPlaying()

bool IsPlaying ( )

protected

Returns true when the Effect is playing, false otherwise.

Definition at line 189 of file Effect.c.

  {
    return m_IsPlaying;
  }

References m_IsPlaying.

Referenced by EffVehicleSmoke::SetParticleState(), Start(), and Stop().

IsRegistered()

bool IsRegistered ( )

protected

Get whether this Effect is registered in SEffectManager.

Returns

bool Whether this Effect is registered in SEffectManager

Definition at line 526 of file Effect.c.

  {
    return m_IsRegistered;
  }

References m_IsRegistered.

Referenced by ~Effect().

IsSound()

bool IsSound ( )

protected

Check whether the Effect is EffectSound without casting.

Returns

bool Whether the Effect is EffectSound

Definition at line 122 of file Effect.c.

  {
    return false;
  }

OnCheckUpdate()

void OnCheckUpdate ( )

protected

Event used when EffectParticle.CheckLifeSpan was called (DEPRECATED)

Note

So this is EffectParticle specific...

EffectParticle.CheckLifeSpan is currently not in use

Definition at line 359 of file Effect.c.

  {
 
  }

SetAttachedLocalOri()

void SetAttachedLocalOri ( vector ori )

protected

Set local orientation for the Effectparticle to attach to when the Effect is started.

Warning

Only caches it into a variable to be used by Start, does not live update when called afterwards

Note

Overrides the orientation set by EffectParticle.SetOrientation

Parameters

ori	vector The local orientation to use on Start

Definition at line 583 of file Effect.c.

  {
    m_LocalOri = ori;
  }

References m_LocalOri.

Referenced by EffectParticle::AttachTo().

SetAttachedLocalPos()

void SetAttachedLocalPos ( vector pos )

protected

Set local pos for the Effect relative to the parent.

Parameters

pos	vector The local pos relative to the parent

Definition at line 563 of file Effect.c.

  {
    SetLocalPosition(pos);
  }

References SetLocalPosition().

SetAttachmentParent()

void SetAttachmentParent ( Object obj )

protected

Set parent for the Effect.

Parameters

obj	Object The parent for the Effect

Definition at line 545 of file Effect.c.

  {
    SetParent(obj);
  }

References SetParent().

SetCurrentLocalPosition()

void SetCurrentLocalPosition ( vector pos, bool updateCached = true )

protected

Set the current local position of the managed effect.

Parameters

pos	vector The current local position for the managed effect
updateCached	bool Whether to update the cached variable

Definition at line 480 of file Effect.c.

  {
    if (updateCached)
      SetLocalPosition(pos);
  }

References SetLocalPosition().

SetCurrentParent()

void SetCurrentParent ( Object parent_obj, bool updateCached = true )

protected

Set current parent of the managed effect.

Note

Same as SetAttachmentParent, but more generic name

Parameters

parent_obj	Object The parent for the Effect
updateCached	bool Whether to update the cached variable

Definition at line 400 of file Effect.c.

  {
    if (updateCached)
      SetParent(parent_obj);
  }

References SetParent().

SetCurrentPosition()

void SetCurrentPosition ( vector pos, bool updateCached = true )

protected

Set the current world position of the managed effect.

Parameters

pos	vector The current world position for the Effect
updateCached	bool Whether to update the cached variable

Definition at line 440 of file Effect.c.

  {
    if (updateCached)
      SetPosition(pos);
  }

References SetPosition().

SetID()

void SetID ( int id )

protected

Set the ID registered in SEffectManager.

Note

Should only ever be called by Event_OnRegistered!

Parameters

id	int ID registered in SEffectManager

Definition at line 508 of file Effect.c.

  {
    m_ID = id;
  }

References m_ID.

Referenced by Event_OnRegistered(), and Event_OnUnregistered().

SetLocalPosition()

void SetLocalPosition ( vector pos )

protected

Set the local position of the Effect.

Warning

Only sets the cached variable, for immediate effect use SetCurrent variant

Parameters

pos	vector The local position for the Effect

Definition at line 460 of file Effect.c.

  {
    m_LocalPos = pos;
  }

References m_LocalPos.

Referenced by EffectParticle::AttachTo(), SetAttachedLocalPos(), and SetCurrentLocalPosition().

SetParent()

void SetParent ( Object parent_obj )

protected

Set parent of the Effect.

Note

Same as SetAttachmentParent, but more generic name

Warning

Only sets the cached variable, for immediate effect use SetCurrent variant

Parameters

parent_obj

Object The parent for the Effect

Definition at line 378 of file Effect.c.

  {
    m_ParentObject = parent_obj;
  }

References m_ParentObject.

Referenced by EffectParticle::AttachTo(), Construction(), SetAttachmentParent(), and SetCurrentParent().

Start()

void Start ( )

protected

Plays all elements this effects consists of.

Note

Is called by SEffectManager.Play methods

Definition at line 149 of file Effect.c.

  {
    // It is already playing!
    if (IsPlaying())
      return;
 
    Event_OnStarted();
    // I can't call this from inside the method with same name
    // because that method is often overriden without super......
    Event_OnStarted.Invoke(this);
  }

References Event_OnStarted, and IsPlaying().

Referenced by HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::LoadAndSetCurrentFSMState(), Bot::OnDelayedStart(), HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::OnStoreLoad(), HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::RandomizeFSMStateEx(), and HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::ValidateAndRepairHelper().

Stop()

void Stop ( )

protected

Stops all elements this effect consists of.

Note

Alternatively use SEffectManager.Stop( effect_id )

Definition at line 175 of file Effect.c.

  {
    // It is not playing!
    if (!IsPlaying())
      return;
 
    Event_OnStopped();
    // Yes, that event is new, but let's keep up some consistency
    Event_OnStopped.Invoke(this);
  }

References Event_OnStopped, and IsPlaying().

Referenced by Destroy(), UIScriptedMenu::OnClick(), UIScriptedMenu::OnKeyPress(), PPERequester_GameplayBase::OnUpdate(), UIScriptedMenu::Update(), and ~Effect().

ValidateStart()

void ValidateStart ( )

protected

Validation whether an effect truly started playing or if the Effect should stop as none is present.

Note

Override this when inheriting to create own validation check

Is called from Event_OnStarted invoker after Event_OnStarted has been performed

Definition at line 166 of file Effect.c.

  {
 
  }

Referenced by InitEffect().

~Effect()

void ~Effect ( )

protected

dtor

Definition at line 80 of file Effect.c.

  {
    // Safety
    if (IsRegistered())
      SEffectManager.EffectUnregister(GetID());
 
    // Certain effects need to be stopped to clean up properly
    Stop();
 
    // Another safety
    SetEnableEventFrame(false);
  }

References SEffectManager::EffectUnregister(), GetID(), IsRegistered(), SetEnableEventFrame(), and Stop().

Variable Documentation

Event_OnEffectEnded

void Event_OnEffectEnded = new ScriptInvoker()

Event used when the actual effect stopped playing.

Definition at line 25 of file Effect.c.

Referenced by EffectSound::Event_OnSoundWaveEnded(), InitEffect(), EffectParticle::InitEffect(), EffectSound::InitEffect(), and EffectParticle::SetParticle().

Event_OnEffectStarted

void Event_OnEffectStarted = new ScriptInvoker()

Event used when the actual effect started playing.

Definition at line 24 of file Effect.c.

Referenced by EffectSound::Event_OnSoundWaveStarted(), InitEffect(), EffectSound::InitEffect(), and EffectParticle::SetParticle().

Event_OnStarted

void Event_OnStarted = new ScriptInvoker()

Event used when Start was called.

Definition at line 287 of file Effect.c.

  {
    // Override this method for own use
  }

Referenced by InitEffect(), EffectSound::InitEffect(), and Start().

Event_OnStopped

void Event_OnStopped = new ScriptInvoker()

Event used when Stop was called.

Definition at line 23 of file Effect.c.

Referenced by InitEffect(), EffectParticle::InitEffect(), EffectSound::InitEffect(), and Stop().

m_ID

int m_ID

protected

ID of effect, given by SEffectManager when registered (automatically done when playing through it)

Definition at line 49 of file Effect.c.

Referenced by MindStateSoundEventBase::AlertedMoveSoundEvent(), MindStateSoundEventBase::CalmMoveSoundEvent(), CalmMoveSoundEvent(), CanPlay(), MindStateSoundEventBase::ChaseMoveSoundEvent(), ChaseMoveSoundEvent(), DamageSoundEvents::DamageHeavySoundEvent(), DrowningSoundEventBase::DrowningEvent2(), DrowningEvents(), EmoteBase::EmoteCampfireSit(), EmoteCampfireSit(), EmoteBase::EmoteClap(), EmoteClap(), EmoteBase::EmoteCome(), EmoteCome(), EmoteBase::EmoteDabbing(), EmoteDabbing(), EmoteBase::EmoteGreeting(), EmoteGreeting(), EmoteBase::EmoteHeart(), EmoteHeart(), EmoteBase::EmoteListening(), EmoteListening(), EmoteBase::EmoteLookAtMe(), EmoteLookAtMe(), EmoteBase::EmoteLyingDown(), EmoteBase::EmoteMove(), EmoteMove(), EmoteBase::EmotePoint(), EmotePoint(), EmoteBase::EmoteRPSRock(), EmoteRPSRock(), EmoteBase::EmoteRPSScisors(), EmoteRPSScisors(), EmoteBase::EmoteSalute(), EmoteSalute(), EmoteBase::EmoteShake(), EmoteShake(), EmoteBase::EmoteSitB(), EmoteSitB(), EmoteBase::EmoteSuicide(), EmoteSuicide(), EmoteBase::EmoteThroat(), EmoteThroat(), EmoteBase::EmoteThumb(), EmoteThumb(), EmoteBase::EmoteWatching(), EmoteWatching(), HoldBreathSoundEventBase::ExhaustedBreathSoundEvent(), ExhaustedBreathSoundEvent(), SymptomSoundEventBase::FatigueSoundEvent(), GestureMenuItem(), GetID(), GetModifierID(), HasPriorityOverCurrent(), HoldBreathSoundEventBase(), HeatComfortEventsBase::HotSoundEvent(), AntibioticsMdfr::Init(), BloodRegenMdfr::Init(), BoneRegenMdfr::Init(), ModifierBase::Init(), CharcoalMdfr::Init(), AreaExposureMdfr::Init(), BleedingCheckMdfr::Init(), BlindedMdfr::Init(), BrokenArmsMdfr::Init(), BrokenLegsMdfr::Init(), BurningMdfr::Init(), FatigueMdfr::Init(), FeverMdfr::Init(), HeartAttackMdfr::Init(), HeatBufferMdfr::Init(), HemolyticReactionMdfr::Init(), PoisoningMdfr::Init(), StuffedStomachMdfr::Init(), TremorMdfr::Init(), VomitStuffedMdfr::Init(), WetMdfr::Init(), BrainDiseaseMdfr::Init(), CholeraMdfr::Init(), CommonColdMdfr::Init(), ContaminationStage1Mdfr::Init(), ContaminationStage2Mdfr::Init(), ContaminationStage3Mdfr::Init(), InfluenzaMdfr::Init(), SalmonellaMdfr::Init(), TestDiseaseMdfr::Init(), WoundInfectStage1Mdfr::Init(), WoundInfectStage2Mdfr::Init(), DisinfectionMdfr::Init(), DrowningMdfr::Init(), EpinephrineMdfr::Init(), FliesMdfr::Init(), HealthMdfr::Init(), HealthRegenMdfr::Init(), HeatComfortMdfr::Init(), HungerMdfr::Init(), ImmuneSystemMdfr::Init(), ImmunityBoost::Init(), MaskMdfr::Init(), MorphineMdfr::Init(), PainKillersMdfr::Init(), SalineMdfr::Init(), ShockMdfr::Init(), ShockDamageMdfr::Init(), StomachMdfr::Init(), TestingMdfr::Init(), ThirstMdfr::Init(), ToxicityMdfr::Init(), UnconsciousnessMdfr::Init(), InjuryMediumSoundEvent(), SymptomSoundEventBase::LaugherSoundEvent(), LaugherSoundEvent(), MeleeAttackSoundEvents::MeleeAttackHeavyEvent(), MeleeAttackSoundEvents(), SymptomBase::OnInit(), PlayerSoundEventBase::PickupHeavySoundEvent(), PickupHeavySoundEvent(), SetID(), StaminaSoundEventBase::StaminaDownHeavy(), StaminaDownHeavy(), StaminaLowFilterBase::StaminaLowFilterLower(), StaminaLowFilterBase::StaminaLowFilterUpper(), StaminaLowFilterUpper(), StaminaSoundEventBase::StaminaNormalDummy(), StaminaSoundEventBase::StaminaUpLight(), StaminaUpLight(), SymptomSoundEventBase(), and SyncedValueAgent().

m_IsAutodestroy

bool m_IsAutodestroy

protected

Whether the Effect cleans up after itself when stopped.

Definition at line 33 of file Effect.c.

Referenced by IsAutodestroy(), and SetAutodestroy().

m_IsPendingDeletion

bool m_IsPendingDeletion

protected

Whether the Destroy process has already been called.

Definition at line 35 of file Effect.c.

Referenced by Destroy(), and IsPendingDeletion().

m_IsPlaying

bool m_IsPlaying

protected

Whether the Effect is currently playing.

Definition at line 37 of file Effect.c.

Referenced by Particle::CreateParticleEffect(), IsPlaying(), UIScriptedMenu::OnHide(), UIScriptedMenu::OnKeyPress(), UIScriptedMenu::OnMouseButtonDown(), OnParticleStart(), OnParticleStop(), UIScriptedMenu::OnShow(), SmptAnimMetaBase::Play(), UIScriptedMenu::Play(), EffectSound::SoundReset(), UIScriptedMenu::Stop(), UIScriptedMenu::Update(), and Particle::UpdateState().

m_IsRegistered

bool m_IsRegistered

protected

Whether the effect is registered in SEffectManager.

Definition at line 51 of file Effect.c.

Referenced by Event_OnRegistered(), Event_OnUnregistered(), and IsRegistered().

m_LocalOri

vector m_LocalOri

protected

Local orientation set by SetAttachedLocalOri, only used by EffectParticle.

Definition at line 62 of file Effect.c.

Referenced by EntityLightSource::AttachOnObject(), EntityLightSource::DetachFromParent(), GetAttachedLocalOri(), and SetAttachedLocalOri().

m_LocalPos

vector m_LocalPos

protected

Cached local pos.

Definition at line 60 of file Effect.c.

Referenced by EntityLightSource::AttachOnMemoryPoint(), EntityLightSource::AttachOnObject(), EntityLightSource::DetachFromParent(), GetLocalPosition(), EntityLightSource::HandleDancingShadows(), and SetLocalPosition().

m_ParentObject

Object m_ParentObject

protected

Cached parent.

Definition at line 39 of file Effect.c.

Referenced by AreaDamageManager(), AreaDamageBase::EvaluateDamage_Common(), EffectSound::GetCurrentPosition(), GetParent(), GetParentObject(), PostDamageActions(), PreDamageActions(), SetParent(), SetParentObject(), EffectSound::SoundLoadEx(), EffectSound::SoundPlayEx(), and EffectParticle::Start().

m_Position

vector m_Position

protected

Cached world position.

Definition at line 41 of file Effect.c.

Referenced by ScriptedWidgetEventHandler::CreateFollowedObject(), CTObjectFollower::CTActor(), ScriptedWidgetEventHandler::CTKeyframe(), PluginBase::GetPlayerPrefix(), GetPosition(), ScriptedWidgetEventHandler::GetPosition(), InitZoneServer(), SymptomBase::OnInit(), ScriptedWidgetEventHandler::SetPosition(), SetPosition(), ScriptedWidgetEventHandler::SetPosition(), and ScriptedWidgetEventHandler::Update().

NONE

@ NONE

Plain Effect base.

Definition at line 5 of file Effect.c.

PARTICLE

PARTICLE

EffectParticle.

Definition at line 9 of file Effect.c.

SOUND

SOUND

EffectSound.

Definition at line 7 of file Effect.c.