FireworksLauncherClientEvent Class Reference

Private Member Functions
protected int	GetSoundDelay ()
protected int	GetLightDelay ()
protected float	GetExplosionDistance ()
protected float	GetShotDispersionAngle ()
protected string	GetExplosionSoundSet ()
protected float	GetExplosionDelay ()
void	FireworksLauncherClientEvent (FireworksLauncher item, int index)
void	~FireworksLauncherClientEvent ()
override protected void	OnFired ()
protected vector	GetShotPos ()
protected void	CalculateExplosionPosition ()
protected vector	GetExplosionPosition ()
int	GetSecondaryExplosionCount ()
protected void	OnExplode ()
protected void	RequestSecondaryExplosion ()
protected void	SpawnSecondaryExplosion ()
protected int	GetSecondaryExplosionDelay ()
protected int	GetExplParticleFromSequence ()
protected void	SetupLight (PointLightBase light)
protected void	SpawnLight ()
protected void	PlayExplosionSound ()

Private Attributes
protected ref Timer	m_Timer = new Timer()
protected FireworksLauncher	m_Item
protected int	m_Index
protected vector	m_ExplosionPos
protected EffectSound	m_FireSound
protected EffectSound	m_ExplosionSound
protected ParticleSource	m_ParticleShot
protected ParticleSource	m_ParticleExplosion
protected vector	m_ShotDir
protected ExplosionLight	m_ExplosionLight
protected ParticleSource	m_ParticleAfterBurnEnd
protected string	m_Color
protected int	m_RemainingExplosions = GetSecondaryExplosionCount()
protected ref array< ref FireworksLauncherClientEventBase >	m_Events = new array<ref FireworksLauncherClientEventBase>

Constructor & Destructor Documentation

FireworksLauncherClientEvent()

void FireworksLauncherClientEvent ( FireworksLauncher  item, int  index  )

inlineprivate

References string::Get(), FireworksLauncher::GetColorSequence(), string::Length(), Debug::LogError(), m_Color, m_Index, and m_Item.

~FireworksLauncherClientEvent()

void ~FireworksLauncherClientEvent ( )

inlineprivate

References SEffectManager::DestroyEffect(), m_ExplosionSound, m_FireSound, m_ParticleAfterBurnEnd, and ParticleSource::StopParticle().

Member Function Documentation

CalculateExplosionPosition()

protected void CalculateExplosionPosition ( )

inlineprivate

References GetExplosionDistance(), GetShotPos(), m_ExplosionPos, and m_ShotDir.

Referenced by GetExplosionPosition().

GetExplosionDelay()

protected float GetExplosionDelay ( )

inlineprivate

References Math::RandomFloatInclusive().

Referenced by OnFired().

GetExplosionDistance()

protected float GetExplosionDistance ( )

inlineprivate

References Math::RandomFloatInclusive().

Referenced by CalculateExplosionPosition(), GetExplosionPosition(), and OnFired().

GetExplosionPosition()

protected vector GetExplosionPosition ( )

inlineprivate

References CalculateExplosionPosition(), and m_ExplosionPos.

Referenced by OnExplode(), OnExplode(), SpawnLight(), SpawnSecondaryExplosion(), and AnniversaryFireworksLauncherClientEvent::SpawnSecondaryExplosion().

GetExplosionSoundSet()

protected string GetExplosionSoundSet ( )

inlineprivate

Referenced by PlayExplosionSound().

GetExplParticleFromSequence()

protected int GetExplParticleFromSequence ( )

inlineprivate

References ErrorEx, ParticleList::FIREWORKS_EXPLOSION_BLUE, ParticleList::FIREWORKS_EXPLOSION_GREEN, ParticleList::FIREWORKS_EXPLOSION_PINK, ParticleList::FIREWORKS_EXPLOSION_RED, ParticleList::FIREWORKS_EXPLOSION_YELLOW, and m_Color.

Referenced by OnExplode(), and OnExplode().

GetLightDelay()

protected int GetLightDelay ( )

inlineprivate

Referenced by OnExplode(), and OnExplode().

GetSecondaryExplosionCount()

int GetSecondaryExplosionCount ( )

inlineprivate

GetSecondaryExplosionDelay()

protected int GetSecondaryExplosionDelay ( )

inlineprivate

References Math::RandomIntInclusive().

Referenced by RequestSecondaryExplosion().

GetShotDispersionAngle()

protected float GetShotDispersionAngle ( )

inlineprivate

References Math::RandomFloatInclusive().

Referenced by OnFired().

GetShotPos()

protected vector GetShotPos ( )

inlineprivate

References Debug::LogError(), m_Index, and m_Item.

Referenced by CalculateExplosionPosition(), GetExplosionPosition(), and OnFired().

GetSoundDelay()

protected int GetSoundDelay ( )

inlineprivate

Referenced by OnExplode(), and OnExplode().

OnExplode()

protected void OnExplode ( )

inlineprivate

References CALL_CATEGORY_SYSTEM, ScriptCallQueue::CallLater(), CGame::GetCallQueue(), GetExplosionPosition(), GetExplParticleFromSequence(), GetGame(), GetLightDelay(), GetSoundDelay(), m_ParticleAfterBurnEnd, m_ParticleExplosion, ParticleManager(), PlayExplosionSound(), RequestSecondaryExplosion(), SpawnLight(), and Particle::Stop().

OnFired()

override protected void OnFired ( )

inlineprivate

References ParticleList::FIREWORKS_AFTERBURN_END, ParticleList::FIREWORKS_SHOT, GetExplosionDelay(), GetExplosionDistance(), GetShotDispersionAngle(), GetShotPos(), m_FireSound, m_Item, m_ParticleAfterBurnEnd, m_ParticleShot, m_ShotDir, m_Timer, ParticleManager(), Math::RandomFloatInclusive(), ParticleSource::SetOwner(), and Vector().

PlayExplosionSound()

protected void PlayExplosionSound ( )

inlineprivate

References GetExplosionSoundSet(), m_ExplosionSound, m_FireSound, m_Item, and EffectSound::Stop().

Referenced by OnExplode().

RequestSecondaryExplosion()

protected void RequestSecondaryExplosion ( )

inlineprivate

References CALL_CATEGORY_SYSTEM, ScriptCallQueue::CallLater(), CGame::GetCallQueue(), GetGame(), GetSecondaryExplosionDelay(), m_RemainingExplosions, and SpawnSecondaryExplosion().

Referenced by OnExplode(), SpawnSecondaryExplosion(), and AnniversaryFireworksLauncherClientEvent::SpawnSecondaryExplosion().

SetupLight()

protected void SetupLight ( PointLightBase  light )

inlineprivate

References ErrorEx, and m_Color.

Referenced by SpawnLight().

SpawnLight()

protected void SpawnLight ( )

inlineprivate

References GetExplosionPosition(), m_ExplosionLight, and SetupLight().

Referenced by OnExplode().

SpawnSecondaryExplosion()

protected void SpawnSecondaryExplosion ( )

inlineprivate

References GetExplosionPosition(), m_Events, m_Index, m_Item, and RequestSecondaryExplosion().

Referenced by RequestSecondaryExplosion().

Field Documentation

m_Color

protected string m_Color

private

Referenced by FireworksLauncherClientEvent(), GetExplParticleFromSequence(), AnniversaryFireworksLauncherClientEvent::GetExplParticleFromSequence(), SetupLight(), and AnniversaryFireworksLauncherClientEvent::SetupLight().

m_Events

protected ref array<ref FireworksLauncherClientEventBase> m_Events = new array<ref FireworksLauncherClientEventBase>

private

Referenced by SpawnSecondaryExplosion(), and AnniversaryFireworksLauncherClientEvent::SpawnSecondaryExplosion().

m_ExplosionLight

protected ExplosionLight m_ExplosionLight

private

Referenced by SpawnLight().

m_ExplosionPos

protected vector m_ExplosionPos

private

Referenced by CalculateExplosionPosition(), and GetExplosionPosition().

m_ExplosionSound

protected EffectSound m_ExplosionSound

private

Referenced by PlayExplosionSound(), and ~FireworksLauncherClientEvent().

m_FireSound

protected EffectSound m_FireSound

private

Referenced by OnFired(), PlayExplosionSound(), and ~FireworksLauncherClientEvent().

m_Index

protected int m_Index

private

Referenced by FireworksLauncherClientEvent(), GetShotPos(), SpawnSecondaryExplosion(), and AnniversaryFireworksLauncherClientEvent::SpawnSecondaryExplosion().

m_Item

protected FireworksLauncher m_Item

private

Referenced by FireworksLauncherClientEvent(), GetShotPos(), OnFired(), PlayExplosionSound(), SpawnSecondaryExplosion(), and AnniversaryFireworksLauncherClientEvent::SpawnSecondaryExplosion().

m_ParticleAfterBurnEnd

protected ParticleSource m_ParticleAfterBurnEnd

private

Referenced by OnExplode(), OnFired(), and ~FireworksLauncherClientEvent().

m_ParticleExplosion

protected ParticleSource m_ParticleExplosion

private

Referenced by OnExplode().

m_ParticleShot

protected ParticleSource m_ParticleShot

private

Referenced by OnFired().

m_RemainingExplosions

protected int m_RemainingExplosions = GetSecondaryExplosionCount()

private

Referenced by RequestSecondaryExplosion().

m_ShotDir

protected vector m_ShotDir

private

Referenced by CalculateExplosionPosition(), and OnFired().

m_Timer

protected ref Timer m_Timer = new Timer()

private

Referenced by OnFired().

---

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

• P:/scripts/4_World/Entities/ItemBase/Gear/Tools/FireworksLauncher.c