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 | |
| protected 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, int pivot) |
| Set parent of the Effect. | |
| void | SetParent (Object parent_obj) |
| Set parent of the Effect. | |
| Object | GetParent () |
| Get parent of the Effect. | |
| int | GetPivotIndex () |
| Get parent pivot of the Effect, only valid when there is some GetParent. | |
| 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 | |
| protected 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
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 | |
| protected bool | m_IsAutodestroy |
| Whether the Effect cleans up after itself when stopped. | |
| protected bool | m_IsPendingDeletion |
| Whether the Destroy process has already been called. | |
| protected bool | m_IsPlaying |
| Whether the Effect is currently playing. | |
| protected Object | m_ParentObject |
| Cached parent. | |
| protected int | m_PivotIndex = -1 |
| Cached parent pivot id. | |
| protected vector | m_Position |
| Cached world position. | |
SEffectManager data | |
Data filled in by SEffectManager to identify it when it is registered | |
| protected int | m_ID |
| ID of effect, given by SEffectManager when registered (automatically done when playing through it) | |
| protected 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 | |
| protected vector | m_LocalPos |
| Cached local pos. | |
| protected vector | m_LocalOri |
| Local orientation set by SetAttachedLocalOri, only used by EffectParticle. | |
| void | Effect () |
| ctor | |
| void | ~Effect () |
| dtor | |
| void | InitEffect () |
| init | |
| enum EffectType |
Enum to determine what type of effect the Effect is.
| void Effect | ( | ) |
ctor
References ErrorEx, GetGame(), InitEffect(), and m_IsPlaying.
Referenced by SEffectManager::Cleanup(), Car::CleanupEffects(), SEffectManager::EffectUnregister(), AmmoEffects::PlayAmmoEffect(), and SEffectManager::Stop().
| void Event_OnFrameUpdate | ( | float | time_delta | ) |
Event called on frame when enabled by SetEnableEventFrame(true)
| time_delta | float Time passed since the previous frame |
Referenced by SetEnableEventFrame().
| void Event_OnRegistered | ( | int | id | ) |
Event called from SEffectManager when the Effect is registered.
| id | int ID registered in SEffectManager |
References m_IsRegistered, and SetID().
| void Event_OnUnregistered | ( | ) |
Event called from SEffectManager when the Effect is unregistered.
References SEffectManager::INVALID_ID, m_IsRegistered, and SetID().
| vector GetAttachedLocalOri | ( | ) |
Get the local orientation set by SetAttachedLocalOri.
vector The local orientation set by SetAttachedLocalOri References m_LocalOri.
Referenced by EffectParticle::ReAttach(), and EffectParticle::Start().
| vector GetAttachedLocalPos | ( | ) |
Get the local pos set by SetAttachedLocalPos.
vector The local pos set by SetAttachedLocalPos References GetLocalPosition().
| Object GetAttachmentParent | ( | ) |
Get the parent set by SetAttachmentParent.
Object The parent set by SetAttachmentParent References GetParent().
Referenced by EffEngineSmoke::Event_OnFrameUpdate(), EffExhaustSmoke::SetParticleStateLight(), and EffCoolantSteam::UpdateParticle().
| vector GetCurrentLocalPosition | ( | ) |
Get the current local position of the managed effect.
vector The current local position of the managed effect References vector::Zero.
| Object GetCurrentParent | ( | ) |
Get the current parent of the managed Effect.
Object The current parent of the managed Effect | vector GetCurrentPosition | ( | ) |
Get the current world position of the managed effect.
vector The current world position of the managed effect References vector::Zero.
| EffectType GetEffectType | ( | ) |
Get what type of effect the Effect is.
EffectType What type of effect the Effect is | int GetID | ( | ) |
Get the ID registered in SEffectManager.
int ID registered in SEffectManager, or 0 (SEffectManager.INVALID_ID) when not registered References m_ID.
Referenced by AnalyticsManagerClient::Event_OnEntityKilled(), CGame::GamepadCheck(), ManBase::InitEditor(), MissionBase::InputBufferCheck(), MissionBase::OnInputBufferEvent(), BiosUserManager::OnPartyHost(), MissionBase::Pause(), and ~Effect().
| vector GetLocalPosition | ( | ) |
Get the local position of the Effect.
vector The lcoal position of the Effect References m_LocalPos.
Referenced by GetAttachedLocalPos(), EffectSound::GetCurrentLocalPosition(), EffectParticle::ReAttach(), ParticleSource::SetWiggle(), EffectParticle::Start(), and Update().
| int GetPivotIndex | ( | ) |
Get parent pivot of the Effect, only valid when there is some GetParent.
int The parent pivot of the Effect References m_PivotIndex.
| void InitEffect | ( | ) |
init
References Event_OnEffectEnded, Event_OnEffectStarted, Event_OnStarted, Event_OnStopped, ScriptInvoker::Insert(), and ValidateStart().
Referenced by Effect().
| bool IsParticle | ( | ) |
Check whether the Effect is EffectParticle without casting.
bool Whether the Effect is EffectParticle | bool IsPlaying | ( | ) |
Returns true when the Effect is playing, false otherwise.
References m_IsPlaying.
Referenced by BoatScript::ClearWaterEffects(), Land_WarheadStorage_Main::OnDoorCloseFinish(), Land_WarheadStorage_Main::OnDoorCloseStart(), Land_WarheadStorage_Main::OnDoorOpenFinish(), SetParticle(), EffVehicleSmoke::SetParticleState(), EffectBoatWaterBase::SetParticleState(), EffWheelSmoke::SetParticleState(), Start(), Stop(), Update(), EffectBoatWaterBack::Update(), and EffectBoatWaterBase::Update().
| bool IsRegistered | ( | ) |
Get whether this Effect is registered in SEffectManager.
bool Whether this Effect is registered in SEffectManager References m_IsRegistered.
Referenced by BoatScript::CleanupEffects(), and ~Effect().
| bool IsSound | ( | ) |
Check whether the Effect is EffectSound without casting.
bool Whether the Effect is EffectSound | void OnCheckUpdate | ( | ) |
Event used when EffectParticle.CheckLifeSpan was called (DEPRECATED)
| void SetAttachedLocalOri | ( | vector | ori | ) |
Set local orientation for the Effectparticle to attach to when the Effect is started.
| ori | vector The local orientation to use on Start |
References m_LocalOri.
Referenced by EffectParticle::AttachTo().
| void SetAttachedLocalPos | ( | vector | pos | ) |
Set local pos for the Effect relative to the parent.
| pos | vector The local pos relative to the parent |
References SetLocalPosition().
| void SetAttachmentParent | ( | Object | obj | ) |
Set the current local position of the managed effect.
| pos | vector The current local position for the managed effect |
| updateCached | bool Whether to update the cached variable |
References SetLocalPosition().
Set current parent of the managed effect.
| parent_obj | Object The parent for the Effect |
| updateCached | bool Whether to update the cached variable |
References SetParent().
Set the current world position of the managed effect.
| pos | vector The current world position for the Effect |
| updateCached | bool Whether to update the cached variable |
References SetPosition().
| protected void SetID | ( | int | id | ) |
Set the ID registered in SEffectManager.
| id | int ID registered in SEffectManager |
References m_ID.
Referenced by Event_OnRegistered(), and Event_OnUnregistered().
| void SetLocalPosition | ( | vector | pos | ) |
Set the local position of the Effect.
| pos | vector The local position for the Effect |
References m_LocalPos.
Referenced by EffectParticle::AttachTo(), SetAttachedLocalPos(), and SetCurrentLocalPosition().
| void SetParent | ( | Object | parent_obj | ) |
Set parent of the Effect.
| parent_obj | Object The parent for the Effect |
References SetParent().
Set parent of the Effect.
| parent_obj | Object The parent |
| pivot | int The pivot index |
References m_ParentObject, and m_PivotIndex.
Referenced by EffectParticle::AttachTo(), Construction(), SetAttachmentParent(), SetCurrentParent(), and SetParent().
| void Start | ( | ) |
Plays all elements this effects consists of.
References Event_OnStarted, and IsPlaying().
Referenced by HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::LoadAndSetCurrentFSMState(), HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::OnStoreLoad(), HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::RandomizeFSMStateEx(), and HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::ValidateAndRepairHelper().
| void ValidateStart | ( | ) |
Validation whether an effect truly started playing or if the Effect should stop as none is present.
Referenced by InitEffect().
| void ~Effect | ( | ) |
dtor
References SEffectManager::EffectUnregister(), GetID(), IsRegistered(), SetEnableEventFrame(), and Stop().
| void Event_OnEffectEnded = new ScriptInvoker() |
Event used when the actual effect stopped playing.
Referenced by EffectSound::Event_OnSoundWaveEnded(), InitEffect(), EffectParticle::InitEffect(), EffectSound::InitEffect(), and EffectParticle::SetParticle().
| void Event_OnEffectStarted = new ScriptInvoker() |
Event used when the actual effect started playing.
Referenced by EffectSound::Event_OnSoundWaveStarted(), InitEffect(), EffectSound::InitEffect(), and EffectParticle::SetParticle().
| void Event_OnStarted = new ScriptInvoker() |
Event used when Start was called.
Referenced by InitEffect(), EffectSound::InitEffect(), and Start().
| void Event_OnStopped = new ScriptInvoker() |
Event used when Stop was called.
Referenced by InitEffect(), EffectParticle::InitEffect(), EffectSound::InitEffect(), and Stop().
| protected int m_ID |
ID of effect, given by SEffectManager when registered (automatically done when playing through it)
Referenced by Activate(), MindStateSoundEventBase::AlertedMoveSoundEvent(), MindStateSoundEventBase::CalmMoveSoundEvent(), CalmMoveSoundEvent(), CanPlay(), MindStateSoundEventBase::ChaseMoveSoundEvent(), ChaseMoveSoundEvent(), CleanHandsSoundEventBase::CleanHandsPrimarySoundEvent(), CleanHandsPrimarySoundEvent(), DamageSoundEvents::DamageHeavySoundEvent(), Deactivate(), DecreaseLifespan(), DigSoundEventBase::DigPrimarySoundEvent(), DigPrimarySoundEvent(), 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(), ForceConsumeSoundEvent(), ForceConsumeSoundEvent::ForceDrinkSoundEvent(), SymptomSoundEventBase::GaspSoundEvent(), GaspSoundEvent(), GestureMenuItem(), GetID(), GetModifierID(), HasPriorityOverCurrent(), HoldBreathSoundEventBase(), Init(), AntibioticsMdfr::Init(), BloodRegenMdfr::Init(), BoneRegenMdfr::Init(), ModifierBase::Init(), CharcoalMdfr::Init(), ChelationMdfr::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(), HeavyMetalMdfr::Init(), HeavyMetalPhase2Mdfr::Init(), InfluenzaMdfr::Init(), PneumoniaMdfr::Init(), SalmonellaMdfr::Init(), TestDiseaseMdfr::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(), Init(), InjuryMediumSoundEvent(), SymptomSoundEventBase::LaugherSoundEvent(), LaugherSoundEvent(), MeleeAttackSoundEvents::MeleeAttackHeavyEvent(), MeleeAttackSoundEvents(), SymptomBase::OnInit(), PlayerSoundEventBase::PickupHeavySoundEvent(), PickupHeavySoundEvent(), HeatComfortEventsBase::RattlingTeethSoundEvent(), RattlingTeethSoundEvent(), ReplaceSoundEventBase::SelectSoundID(), SetID(), StaminaSoundEventBase::StaminaDownHeavy(), StaminaDownHeavy(), StaminaLowFilterBase::StaminaLowFilterLower(), StaminaLowFilterBase::StaminaLowFilterUpper(), StaminaLowFilterUpper(), StaminaSoundEventBase::StaminaNormalDummy(), StaminaSoundEventBase::StaminaUpLight(), StaminaUpLight(), SymptomSoundEventBase(), and SyncedValueAgent().
| protected bool m_IsAutodestroy |
Whether the Effect cleans up after itself when stopped.
Referenced by IsAutodestroy(), and SetAutodestroy().
| protected bool m_IsPendingDeletion |
Whether the Destroy process has already been called.
Referenced by Destroy(), and IsPendingDeletion().
| protected bool m_IsPlaying |
Whether the Effect is currently playing.
Referenced by Particle::CreateParticleEffect(), Effect(), IsPlaying(), UIScriptedMenu::OnHide(), UIScriptedMenu::OnKeyPress(), UIScriptedMenu::OnMouseButtonDown(), OnParticleStart(), OnParticleStop(), UIScriptedMenu::OnShow(), SmptAnimMetaBase::Play(), UIScriptedMenu::Play(), EffectSound::SoundReset(), UIScriptedMenu::Stop(), UIScriptedMenu::Update(), Particle::UpdateState(), and UIScriptedMenu::~CameraToolsMenu().
| protected bool m_IsRegistered |
Whether the effect is registered in SEffectManager.
Referenced by Event_OnRegistered(), Event_OnUnregistered(), and IsRegistered().
| protected vector m_LocalOri |
Local orientation set by SetAttachedLocalOri, only used by EffectParticle.
Referenced by EntityLightSource::AttachOnObject(), EntityLightSource::DetachFromParent(), GetAttachedLocalOri(), and SetAttachedLocalOri().
| protected vector m_LocalPos |
| protected Object m_ParentObject |
Cached parent.
Referenced by AreaDamageManager(), AreaDamageBase::EvaluateDamage_Common(), EffectSound::GetCurrentPosition(), GetParent(), GetParentObject(), PostDamageActions(), PreDamageActions(), SetParent(), SetParentObject(), EffectSound::SoundLoadEx(), EffectSound::SoundPlayEx(), and EffectParticle::Start().
| protected int m_PivotIndex = -1 |
Cached parent pivot id.
Referenced by GetPivotIndex(), SetParent(), EffectSound::SoundLoadEx(), and EffectSound::SoundPlayEx().
| protected vector m_Position |
Cached world position.
Referenced by ScriptedWidgetEventHandler::CreateFollowedObject(), CTObjectFollower::CTActor(), ScriptedWidgetEventHandler::CTKeyframe(), DeferredInit(), PluginBase::GetPlayerPrefix(), GetPosition(), ScriptedWidgetEventHandler::GetPosition(), InitZoneClient(), SpookyArea::InitZoneClient(), HotSpringArea::InitZoneServer(), VolcanicArea::InitZoneServer(), KillEntitiesInArea(), SymptomBase::OnInit(), ScriptedWidgetEventHandler::SetPosition(), SetPosition(), ScriptedWidgetEventHandler::SetPosition(), SetupZoneData(), SpawnItems(), and ScriptedWidgetEventHandler::Update().
| @ NONE |
Plain Effect base.
| PARTICLE |
| SOUND |