class VehicleVFXComponent

Constructors 1

void VehicleVFXComponent(notnull EntityAI parent)

References m_EffectGroupsMap, m_EffectsMap, and m_Parent

Referenced by CarScript.InitializeParticles(), and MotorbikeScript.InitializeParticles()

Members 5

private bool m_SurfaceInfoOverriden

Referenced by PlayEffectData(), and SetSurfaceInfo()

private EntityAI m_Parent

Referenced by ConvertMemPointToPosition(), PlayEffect(), PlayEffectGroup()

Show 1 more

, VehicleVFXComponent()

private SurfaceInfo m_SurfaceInfo

Referenced by PlayEffectData(), and SetSurfaceInfo()

protected ref map<int, ref VehicleVFXData> m_EffectsMap

keyed by EVehicleVFXEffect

Referenced by CanPlayEffect(), GetEffectRemainingCooldown(), GetParticleParamsOverrideData()

Show 11 more

, IsEffectPlayed(), ListCooldowns(), PlayEffect(), RegisterEffect(), ResetEffectCooldown(), SetEffectCooldown(), SetEffectParticleState(), SetEffectPosition(), StopAllEffects(), StopEffect(), and VehicleVFXComponent()

protected ref map<int, ref array<ref VehicleVFXData>> m_EffectGroupsMap

keyed by EVehicleVFXEffectGroup

Referenced by CanPlayEffectGroup(), GetEffectGroupParticleParamsOverrideData(), GetEffectGroupRemainingCooldown()

Show 12 more

, IsEffectGroupPlayed(), ListCooldowns(), ListGroups(), PlayEffectGroup(), RegisterEffectGroup(), ResetEffectGroupCooldown(), SetEffectGroupCooldown(), SetEffectGroupParticleState(), SetEffectGroupPositions(), StopAllEffects(), StopEffectGroup(), and VehicleVFXComponent()

Methods 33

vector ConvertMemPointToPosition(string memoryPointName)

References Object.GetMemoryPointPos(), Object.MemoryPointExists(), m_Parent

Show 1 more

, vector.Zero

Referenced by CarScript.InitializeParticles(), and MotorbikeScript.InitializeParticles()

void RegisterEffect(EVehicleVFXEffect effectId, typename effectTypename, VehicleVFXDataParams params)

References map.Contains(), CreateEffectData(), EnumTools.EnumToString()

Show 4 more

, ErrorEx(), string.Format(), map.Set(), and m_EffectsMap

Referenced by CarScript.InitializeParticles(), and MotorbikeScript.InitializeParticles()

void RegisterEffectGroup(EVehicleVFXEffectGroup groupId, typename effectTypename, int count, VehicleVFXDataParams params)

References map.Contains(), CreateEffectData(), EnumTools.EnumToString()

Show 5 more

, ErrorEx(), string.Format(), array.Insert(), map.Insert(), and m_EffectGroupsMap

Referenced by CarScript.InitializeParticles(), and MotorbikeScript.InitializeParticles()

protected VehicleVFXData CreateEffectData(typename effectTypename, VehicleVFXDataParams params)

References Class.Cast(), VehicleVFXData.SetCooldown(), typename.Spawn()

Show 7 more

, new VehicleVFXData(), VehicleVFXDataParams.m_CooldownSec, VehicleVFXData.m_Effect, VehicleVFXData.m_Orientation, VehicleVFXDataParams.m_Orientation, VehicleVFXData.m_Position, and VehicleVFXDataParams.m_Position

Referenced by RegisterEffect(), and RegisterEffectGroup()

protected void PlayEffectData(notnull VehicleVFXData data, EntityAI parent)

References VehicleVFXData.CanPlay(), Class.Cast(), ParticleParamsOverrideData.ClearAll()

Show 21 more

, EffectParticle.GetParticle(), Object.GetPosition(), CGame.GetSurface(), Effect.IsPlaying(), VehicleVFXData.MarkPlayed(), EffectParticle.ParticleParamsOverride(), SEffectManager.PlayOnObject(), EffectParticle.SelectFromSurface(), EffectParticle.Start(), new SurfaceDetectionParameters(), new SurfaceDetectionResult(), VehicleVFXData.m_Effect, VehicleVFXData.m_EffectId, VehicleVFXData.m_Orientation, VehicleVFXData.m_ParticleParamsData, VehicleVFXData.m_Position, m_SurfaceInfo, m_SurfaceInfoOverriden, SurfaceDetectionParameters.position, SurfaceDetectionResult.surface, and SurfaceDetectionParameters.syncMode

Referenced by PlayEffect(), and PlayEffectGroup()

protected void StopEffectData(VehicleVFXData data)

stamp on restart too

References ParticleParamsOverrideData.ClearAll(), EffectParticle.Stop(), VehicleVFXData.m_Effect

Show 2 more

, VehicleVFXData.m_EffectId, and VehicleVFXData.m_ParticleParamsData

Referenced by StopAllEffects(), StopEffect(), and StopEffectGroup()

protected bool IsEffectDataPlaying(VehicleVFXData data)

References Effect.IsPlaying(), and VehicleVFXData.m_Effect

Referenced by IsEffectGroupPlayed(), and IsEffectPlayed()

protected bool CanPlayEffectData(VehicleVFXData data)

References VehicleVFXData.CanPlay()

Referenced by CanPlayEffect(), and CanPlayEffectGroup()

protected void SetEffectDataPosition(VehicleVFXData data, vector position)

References EffectParticle.SetCurrentLocalPosition(), VehicleVFXData.m_Effect, and VehicleVFXData.m_Position

Referenced by SetEffectGroupPositions(), and SetEffectPosition()

void PlayEffect(EVehicleVFXEffect effectId, EntityAI parent = null)

single effect API

References map.Get(), PlayEffectData(), m_EffectsMap

Show 1 more

, m_Parent

Referenced by CarScript.CreateCarDestroyedEffect(), CarScript.EOnPostFrame(), MotorbikeScript.EEHealthLevelChanged()

Show 1 more

, MotorbikeScript.EOnPostFrame()

void StopEffect(EVehicleVFXEffect effectId)

References map.Get(), StopEffectData(), and m_EffectsMap

Referenced by CarScript.EOnPostFrame(), CarScript.FixEntity(), MotorbikeScript.EOnPostFrame()

Show 1 more

, MotorbikeScript.FixEntity()

void StopAllEffects()

References StopEffectData(), m_EffectGroupsMap, and m_EffectsMap

Referenced by CarScript.CleanupEffects()

void SetEffectCooldown(EVehicleVFXEffect effectId, float seconds)

References EnumTools.EnumToString(), ErrorEx(), string.Format()

Show 3 more

, map.Get(), VehicleVFXData.SetCooldown(), and m_EffectsMap

bool CanPlayEffect(EVehicleVFXEffect effectId)

References CanPlayEffectData(), map.Get(), and m_EffectsMap

float GetEffectRemainingCooldown(EVehicleVFXEffect effectId)

References map.Get(), VehicleVFXData.GetRemainingCooldown(), and m_EffectsMap

void ResetEffectCooldown(EVehicleVFXEffect effectId)

References map.Get(), VehicleVFXData.ResetCooldown(), and m_EffectsMap

bool IsEffectPlayed(EVehicleVFXEffect effectId)

References map.Get(), IsEffectDataPlaying(), and m_EffectsMap

Referenced by CarScript.EOnPostFrame(), and MotorbikeScript.EOnPostFrame()

void SetEffectPosition(EVehicleVFXEffect effectId, vector position)

References EnumTools.EnumToString(), ErrorEx(), string.Format()

Show 3 more

, map.Get(), SetEffectDataPosition(), and m_EffectsMap

void SetEffectParticleState(EVehicleVFXEffect effectId, int particleId)

References map.Get(), EffectParticle.SetParticleState(), VehicleVFXData.m_Effect

Show 1 more

, m_EffectsMap

Referenced by CarScript.CreateCarDestroyedEffect(), CarScript.EOnPostFrame(), MotorbikeScript.EEHealthLevelChanged()

Show 1 more

, MotorbikeScript.EOnPostFrame()

ref ParticleParamsOverrideData GetParticleParamsOverrideData(EVehicleVFXEffect effectId)

References EnumTools.EnumToString(), ErrorEx(), string.Format()

Show 3 more

, map.Get(), m_EffectsMap, and VehicleVFXData.m_ParticleParamsData

Referenced by CarScript.EOnPostFrame(), and MotorbikeScript.EOnPostFrame()

void PlayEffectGroup(EVehicleVFXEffectGroup groupId, EntityAI parent = null)

effect group API

References map.Get(), PlayEffectData(), m_EffectGroupsMap

Show 1 more

, m_Parent

Referenced by CarScript.EOnPostFrame(), and MotorbikeScript.EOnPostFrame()

void StopEffectGroup(EVehicleVFXEffectGroup groupId)

References map.Get(), StopEffectData(), and m_EffectGroupsMap

Referenced by CarScript.EOnPostFrame(), and MotorbikeScript.EOnPostFrame()

void SetEffectGroupCooldown(EVehicleVFXEffectGroup groupId, float seconds)

References EnumTools.EnumToString(), ErrorEx(), string.Format()

Show 3 more

, map.Get(), VehicleVFXData.SetCooldown(), and m_EffectGroupsMap

bool CanPlayEffectGroup(EVehicleVFXEffectGroup groupId)

true only when every member of the group can play

References CanPlayEffectData(), map.Get(), and m_EffectGroupsMap

Referenced by CarScript.EOnPostFrame(), and MotorbikeScript.EOnPostFrame()

float GetEffectGroupRemainingCooldown(EVehicleVFXEffectGroup groupId)

longest remaining cooldown across the group members

References map.Get(), VehicleVFXData.GetRemainingCooldown(), and m_EffectGroupsMap

void ResetEffectGroupCooldown(EVehicleVFXEffectGroup groupId)

References map.Get(), VehicleVFXData.ResetCooldown(), and m_EffectGroupsMap

bool IsEffectGroupPlayed(EVehicleVFXEffectGroup groupId)

true when any member of the group is playing

References map.Get(), IsEffectDataPlaying(), and m_EffectGroupsMap

void SetEffectGroupPositions(EVehicleVFXEffectGroup groupId, TVectorArray positions)

References array.Count(), array.Count(), map.Get()

Show 3 more

, Math.Min(), SetEffectDataPosition(), and m_EffectGroupsMap

Referenced by CarScript.EOnPostFrame(), and MotorbikeScript.EOnPostFrame()

void SetEffectGroupParticleState(EVehicleVFXEffectGroup groupId, int particleId)

References map.Get(), EffectParticle.SetParticleState(), VehicleVFXData.m_Effect

Show 1 more

, m_EffectGroupsMap

ref ParticleParamsOverrideData GetEffectGroupParticleParamsOverrideData(EVehicleVFXEffectGroup groupId)

References EnumTools.EnumToString(), ErrorEx(), string.Format()

Show 3 more

, map.Get(), m_EffectGroupsMap, and VehicleVFXData.m_ParticleParamsData

Referenced by CarScript.EOnPostFrame(), and MotorbikeScript.EOnPostFrame()

void SetSurfaceInfo(SurfaceInfo surfaceInfo)

References m_SurfaceInfo, and m_SurfaceInfoOverriden

Referenced by CarScript.EOnPostFrame(), and MotorbikeScript.EOnPostFrame()

void ListGroups()DIAG_DEVELOPER

References array.Count(), EnumTools.EnumToString(), string.Format()

Show 2 more

, Print(), and m_EffectGroupsMap

void ListCooldowns()DIAG_DEVELOPER

Dumps the cooldown state of every registered effect to the log.

References VehicleVFXData.CanPlay(), VehicleVFXData.CanPlay(), EnumTools.EnumToString()

Show 8 more

, string.Format(), VehicleVFXData.GetCooldown(), VehicleVFXData.GetCooldown(), VehicleVFXData.GetRemainingCooldown(), VehicleVFXData.GetRemainingCooldown(), Print(), m_EffectGroupsMap, and m_EffectsMap