DayZ 1.26
DayZ Explorer by KGB
|
Перечисления | |
enum | EffectType |
Enum to determine what type of effect the Effect is. Подробнее... | |
Функции | |
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. | |
Переменные | |
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 | |
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 | |
|
protected |
ctor
Перекрестные ссылки ErrorEx, GetGame(), InitEffect() и m_IsPlaying.
Event called on frame when enabled by SetEnableEventFrame(true)
time_delta | float Time passed since the previous frame |
Используется в SetEnableEventFrame().
Event called from SEffectManager when the Effect is registered.
id | int ID registered in SEffectManager |
Перекрестные ссылки m_IsRegistered и SetID().
|
protected |
Event called from SEffectManager when the Effect is unregistered.
Перекрестные ссылки SEffectManager::INVALID_ID, m_IsRegistered и SetID().
|
protected |
Get the local orientation set by SetAttachedLocalOri.
vector
The local orientation set by SetAttachedLocalOri Перекрестные ссылки m_LocalOri.
Используется в EffectParticle::ReAttach() и EffectParticle::Start().
|
protected |
Get the local pos set by SetAttachedLocalPos.
vector
The local pos set by SetAttachedLocalPos Перекрестные ссылки GetLocalPosition().
|
protected |
Get the parent set by SetAttachmentParent.
Object
The parent set by SetAttachmentParent Перекрестные ссылки GetParent().
Используется в EffEngineSmoke::Event_OnFrameUpdate(), EffExhaustSmoke::SetParticleStateLight() и EffCoolantSteam::UpdateParticle().
|
protected |
Get the current local position of the managed effect.
vector
The current local position of the managed effect Перекрестные ссылки vector::Zero.
|
protected |
|
protected |
Get the current world position of the managed effect.
vector
The current world position of the managed effect Перекрестные ссылки vector::Zero.
|
protected |
Get what type of effect the Effect is.
EffectType
What type of effect the Effect is
|
protected |
Get the ID registered in SEffectManager.
int
ID registered in SEffectManager, or 0 (SEffectManager.INVALID_ID) when not registered Перекрестные ссылки m_ID.
Используется в AnalyticsManagerClient::Event_OnEntityKilled(), CGame::GamepadCheck(), ManBase::InitEditor(), BiosUserManager::OnPartyHost(), MissionBase::Pause() и ~Effect().
|
protected |
Get the local position of the Effect.
vector
The lcoal position of the Effect Перекрестные ссылки m_LocalPos.
Используется в GetAttachedLocalPos(), EffectSound::GetCurrentLocalPosition(), EffectParticle::ReAttach(), ParticleSource::SetWiggle(), EffectParticle::Start() и Update().
|
protected |
Get the world position of the Effect.
vector
The world position of the Effect Перекрестные ссылки m_Position.
|
protected |
init
Перекрестные ссылки Event_OnEffectEnded, Event_OnEffectStarted, Event_OnStarted, Event_OnStopped и ValidateStart().
Используется в Effect().
|
protected |
Check whether the Effect is EffectParticle without casting.
bool
Whether the Effect is EffectParticle
|
protected |
Returns true when the Effect is playing, false otherwise.
Перекрестные ссылки m_IsPlaying.
Используется в BoatScript::ClearWaterEffects(), Land_WarheadStorage_Main::OnDoorCloseFinish(), Land_WarheadStorage_Main::OnDoorOpenFinish(), SetParticle(), EffVehicleSmoke::SetParticleState(), EffectBoatWaterBase::SetParticleState(), EffWheelSmoke::SetParticleState(), Start(), Stop(), Update(), EffectBoatWaterBack::Update() и EffectBoatWaterBase::Update().
|
protected |
Get whether this Effect is registered in SEffectManager.
bool
Whether this Effect is registered in SEffectManager Перекрестные ссылки m_IsRegistered.
Используется в BoatScript::CleanupEffects() и ~Effect().
|
protected |
Check whether the Effect is EffectSound without casting.
bool
Whether the Effect is EffectSound
|
protected |
Event used when EffectParticle.CheckLifeSpan was called (DEPRECATED)
Set local orientation for the Effectparticle to attach to when the Effect is started.
ori | vector The local orientation to use on Start |
Перекрестные ссылки m_LocalOri.
Используется в EffectParticle::AttachTo().
Set local pos for the Effect relative to the parent.
pos | vector The local pos relative to the parent |
Перекрестные ссылки SetLocalPosition().
Set parent for the Effect.
obj | Object The parent for the Effect |
Перекрестные ссылки SetParent().
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 |
Перекрестные ссылки SetLocalPosition().
Set current parent of the managed effect.
parent_obj | Object The parent for the Effect |
updateCached | bool Whether to update the cached variable |
Перекрестные ссылки 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 |
Перекрестные ссылки SetPosition().
Set the ID registered in SEffectManager.
id | int ID registered in SEffectManager |
Перекрестные ссылки m_ID.
Используется в Event_OnRegistered() и Event_OnUnregistered().
Set the local position of the Effect.
pos | vector The local position for the Effect |
Перекрестные ссылки m_LocalPos.
Используется в EffectParticle::AttachTo(), SetAttachedLocalPos() и SetCurrentLocalPosition().
Set parent of the Effect.
parent_obj | Object The parent for the Effect |
Перекрестные ссылки m_ParentObject.
Используется в EffectParticle::AttachTo(), Construction(), SetAttachmentParent() и SetCurrentParent().
|
protected |
Plays all elements this effects consists of.
Перекрестные ссылки Event_OnStarted и IsPlaying().
Используется в HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::LoadAndSetCurrentFSMState(), HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::OnStoreLoad(), HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::RandomizeFSMStateEx() и HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::ValidateAndRepairHelper().
|
protected |
Stops all elements this effect consists of.
Перекрестные ссылки Event_OnStopped и IsPlaying().
Используется в Destroy(), UIScriptedMenu::OnClick(), UIScriptedMenu::OnKeyPress(), PPERequester_GameplayBase::OnUpdate(), UIScriptedMenu::Update() и ~Effect().
|
protected |
Validation whether an effect truly started playing or if the Effect should stop as none is present.
Используется в InitEffect().
dtor
Перекрестные ссылки SEffectManager::EffectUnregister(), GetID(), IsRegistered(), SetEnableEventFrame() и Stop().
void Event_OnEffectEnded = new ScriptInvoker() |
Event used when the actual effect stopped playing.
Используется в EffectSound::Event_OnSoundWaveEnded(), InitEffect(), EffectParticle::InitEffect(), EffectSound::InitEffect() и EffectParticle::SetParticle().
void Event_OnEffectStarted = new ScriptInvoker() |
Event used when the actual effect started playing.
Используется в EffectSound::Event_OnSoundWaveStarted(), InitEffect(), EffectSound::InitEffect() и EffectParticle::SetParticle().
void Event_OnStarted = new ScriptInvoker() |
Event used when Start was called.
Используется в InitEffect(), EffectSound::InitEffect() и Start().
void Event_OnStopped = new ScriptInvoker() |
Event used when Stop was called.
Используется в InitEffect(), EffectParticle::InitEffect(), EffectSound::InitEffect() и Stop().
|
protected |
ID of effect, given by SEffectManager when registered (automatically done when playing through it)
Используется в 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(), HeatComfortEventsBase::HotSoundEvent(), 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(), ReplaceSoundEventBase::SelectSoundID(), SetID(), StaminaSoundEventBase::StaminaDownHeavy(), StaminaDownHeavy(), StaminaLowFilterBase::StaminaLowFilterLower(), StaminaLowFilterBase::StaminaLowFilterUpper(), StaminaLowFilterUpper(), StaminaSoundEventBase::StaminaNormalDummy(), StaminaSoundEventBase::StaminaUpLight(), StaminaUpLight(), SymptomSoundEventBase() и SyncedValueAgent().
|
protected |
Whether the Effect cleans up after itself when stopped.
Используется в IsAutodestroy() и SetAutodestroy().
|
protected |
Whether the Destroy process has already been called.
Используется в Destroy() и IsPendingDeletion().
|
protected |
Whether the Effect is currently playing.
Используется в 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().
|
protected |
Whether the effect is registered in SEffectManager.
Используется в Event_OnRegistered(), Event_OnUnregistered() и IsRegistered().
|
protected |
Local orientation set by SetAttachedLocalOri, only used by EffectParticle.
Используется в EntityLightSource::AttachOnObject(), EntityLightSource::DetachFromParent(), GetAttachedLocalOri() и SetAttachedLocalOri().
|
protected |
|
protected |
Cached parent.
Используется в AreaDamageManager(), AreaDamageBase::EvaluateDamage_Common(), EffectSound::GetCurrentPosition(), GetParent(), GetParentObject(), PostDamageActions(), PreDamageActions(), SetParent(), SetParentObject(), EffectSound::SoundLoadEx(), EffectSound::SoundPlayEx() и EffectParticle::Start().
|
protected |
Cached world position.
Используется в ScriptedWidgetEventHandler::CreateFollowedObject(), CTObjectFollower::CTActor(), ScriptedWidgetEventHandler::CTKeyframe(), PluginBase::GetPlayerPrefix(), GetPosition(), ScriptedWidgetEventHandler::GetPosition(), InitZoneServer(), ContaminatedArea_Dynamic::InitZoneServer(), HotSpringArea::InitZoneServer(), SpookyArea::InitZoneServer(), VolcanicArea::InitZoneServer(), KillEntitiesInArea(), SymptomBase::OnInit(), ScriptedWidgetEventHandler::SetPosition(), SetPosition(), ScriptedWidgetEventHandler::SetPosition(), ContaminatedArea_Dynamic::SpawnItems() и ScriptedWidgetEventHandler::Update().
@ NONE |
Plain Effect base.
PARTICLE |
SOUND |