Класс FireworksLauncherClientEvent

Граф наследования:FireworksLauncherClientEvent:

Защищенные члены
int	GetSoundDelay ()
int	GetLightDelay ()
float	GetExplosionDistance ()
float	GetShotDispersionAngle ()
string	GetExplosionSoundSet ()
float	GetExplosionDelay ()
void	FireworksLauncherClientEvent (FireworksLauncher item, int index)
void	~FireworksLauncherClientEvent ()
void	OnFired ()
vector	GetShotPos ()
void	CalculateExplosionPosition ()
vector	GetExplosionPosition ()
int	GetSecondaryExplosionCount ()
void	OnExplode ()
void	RequestSecondaryExplosion ()
void	SpawnSecondaryExplosion ()
int	GetSecondaryExplosionDelay ()
int	GetExplParticleFromSequence ()
void	SetupLight (PointLightBase light)
void	SpawnLight ()
void	PlayExplosionSound ()

Защищенные данные
ref Timer	m_Timer = new Timer()
FireworksLauncher	m_Item
int	m_Index
vector	m_ExplosionPos
EffectSound	m_FireSound
EffectSound	m_ExplosionSound
ParticleSource	m_ParticleShot
ParticleSource	m_ParticleExplosion
vector	m_ShotDir
ExplosionLight	m_ExplosionLight
ParticleSource	m_ParticleAfterBurnEnd
string	m_Color
int	m_RemainingExplosions = GetSecondaryExplosionCount()
ref array< ref FireworksLauncherClientEventBase >	m_Events = new ref array<ref FireworksLauncherClientEventBase>

Подробное описание

Конструктор(ы)

FireworksLauncherClientEvent()

void FireworksLauncherClientEvent ( FireworksLauncher item, int index )

inlineprotected

    {
        m_Item = item;
        m_Index = index;
        
        int colorSequenceLastIndex = m_Item.GetColorSequence().Length() - 1;
        int coloreSequenceIndex = m_Index - 1;//shot index(m_Index) starts at 1
        
        if (colorSequenceLastIndex >= coloreSequenceIndex)
        {
            m_Color = m_Item.GetColorSequence().Get(coloreSequenceIndex);
        }
        else
        {
            Debug.LogError("Failed to obtain color from color sequence");
            m_Color = "B";
        }
    }

Перекрестные ссылки string::Get(), FireworksLauncher::GetColorSequence(), string::Length(), Debug::LogError(), m_Color, m_Index и m_Item.

~FireworksLauncherClientEvent()

void ~FireworksLauncherClientEvent ( )

inlineprotected

    {
        SEffectManager.DestroyEffect(m_FireSound);
        SEffectManager.DestroyEffect(m_ExplosionSound);
        if (m_ParticleAfterBurnEnd)
        {
            m_ParticleAfterBurnEnd.StopParticle();
        }
    }

Перекрестные ссылки SEffectManager::DestroyEffect(), m_ExplosionSound, m_FireSound, m_ParticleAfterBurnEnd и ParticleSource::StopParticle().

Методы

CalculateExplosionPosition()

void CalculateExplosionPosition ( )

inlineprotected

    {
        m_ExplosionPos = GetShotPos() + m_ShotDir * GetExplosionDistance();
    }

Перекрестные ссылки GetExplosionDistance(), GetShotPos(), m_ExplosionPos и m_ShotDir.

Используется в GetExplosionPosition().

GetExplosionDelay()

float GetExplosionDelay ( )

inlineprotected

    {
        return Math.RandomFloatInclusive(1.5,1.75);
    }

Перекрестные ссылки Math::RandomFloatInclusive().

Используется в OnFired().

GetExplosionDistance()

float GetExplosionDistance ( )

inlineprotected

    {
        return Math.RandomFloatInclusive(35,40);
    }

Перекрестные ссылки Math::RandomFloatInclusive().

Используется в CalculateExplosionPosition() и OnFired().

GetExplosionPosition()

vector GetExplosionPosition ( )

inlineprotected

    {
        if (!m_ExplosionPos)
        {
            CalculateExplosionPosition();
        }
        return m_ExplosionPos;
    }

Перекрестные ссылки CalculateExplosionPosition() и m_ExplosionPos.

Используется в OnExplode(), SpawnLight(), SpawnSecondaryExplosion() и AnniversaryFireworksLauncherClientEvent::SpawnSecondaryExplosion().

GetExplosionSoundSet()

string GetExplosionSoundSet ( )

inlineprotected

    {
        return "FireworksLauncher_Explosion_SoundSet";
    }

Используется в PlayExplosionSound().

GetExplParticleFromSequence()

int GetExplParticleFromSequence ( )

inlineprotected

    {
        switch (m_Color)
        {
            case "R":
                return ParticleList.FIREWORKS_EXPLOSION_RED;
            case "G":
                return ParticleList.FIREWORKS_EXPLOSION_GREEN;
            case "B":
                return ParticleList.FIREWORKS_EXPLOSION_BLUE;
            case "Y":
                return ParticleList.FIREWORKS_EXPLOSION_YELLOW;
            case "P":
                return ParticleList.FIREWORKS_EXPLOSION_PINK;
            default:
                ErrorEx("Incorrect explosion particle color in the sequence");
        }
        return ParticleList.FIREWORKS_EXPLOSION_RED;
    }

Перекрестные ссылки ErrorEx, ParticleList::FIREWORKS_EXPLOSION_BLUE, ParticleList::FIREWORKS_EXPLOSION_GREEN, ParticleList::FIREWORKS_EXPLOSION_PINK, ParticleList::FIREWORKS_EXPLOSION_RED, ParticleList::FIREWORKS_EXPLOSION_YELLOW и m_Color.

Используется в OnExplode().

GetLightDelay()

int GetLightDelay ( )

inlineprotected

    {
        return 0;
    }

Используется в OnExplode().

GetSecondaryExplosionCount()

int GetSecondaryExplosionCount ( )

inlineprotected

    {
        return 4;
    }

GetSecondaryExplosionDelay()

int GetSecondaryExplosionDelay ( )

inlineprotected

    {
        return Math.RandomIntInclusive(100,250);
    }

Перекрестные ссылки Math::RandomIntInclusive().

Используется в RequestSecondaryExplosion().

GetShotDispersionAngle()

float GetShotDispersionAngle ( )

inlineprotected

    {
        return Math.RandomFloatInclusive(-25,25);//this is rotated 360 degrees around the UP vector too
    }

Перекрестные ссылки Math::RandomFloatInclusive().

Используется в OnFired().

GetShotPos()

vector GetShotPos ( )

inlineprotected

    {
        vector memPos; 
        string memName = "Shot_" + m_Index;
        
        if (m_Item.MemoryPointExists(memName))
        {
            memPos = m_Item.GetMemoryPointPos(memName);
            memPos = m_Item.ModelToWorld(memPos);
        }
        else
        {
            memPos = m_Item.GetPosition();//fallback to item's location
            Debug.LogError("Missing shot memory point on Fireworks");
        }
        return memPos;
    }

Перекрестные ссылки Debug::LogError(), m_Index и m_Item.

Используется в CalculateExplosionPosition() и OnFired().

GetSoundDelay()

int GetSoundDelay ( )

inlineprotected

    {
        return 0;
    }

Используется в OnExplode().

OnExplode()

void OnExplode ( )

inlineprotected

    {
        #ifdef DEVELOPER
        if (m_ShotTrajectory)
        {
            m_ShotTrajectory.Destroy();
            m_ShotTrajectory = null;
        }
        #endif
        m_ParticleAfterBurnEnd.Stop();
 
        GetGame().GetCallQueue( CALL_CATEGORY_SYSTEM ).CallLater( PlayExplosionSound, GetSoundDelay(), false);
        GetGame().GetCallQueue( CALL_CATEGORY_SYSTEM ).CallLater( SpawnLight, GetLightDelay(), false);
        m_ParticleExplosion = ParticleManager.GetInstance().PlayInWorld(GetExplParticleFromSequence(), GetExplosionPosition());
        
        RequestSecondaryExplosion();
        
    }

Перекрестные ссылки CALL_CATEGORY_SYSTEM, GetExplosionPosition(), GetExplParticleFromSequence(), GetGame(), GetLightDelay(), GetSoundDelay(), m_ParticleAfterBurnEnd, m_ParticleExplosion, ParticleManager(), PlayExplosionSound(), RequestSecondaryExplosion(), SpawnLight() и Particle::Stop().

OnFired()

void OnFired ( )

inlineprotected

    {
        m_Timer.Run(GetExplosionDelay(), this, "OnExplode", null);
        m_Item.PlaySoundSet( m_FireSound, "FireworksLauncher_Shot_SoundSet", 0, 0 );
        m_ParticleShot = ParticleManager.GetInstance().PlayInWorld(ParticleList.FIREWORKS_SHOT, GetShotPos());
        m_ParticleShot.SetYawPitchRoll(Vector(Math.RandomFloatInclusive(0,360),GetShotDispersionAngle(),0));
        
        m_ParticleAfterBurnEnd = ParticleManager.GetInstance().PlayInWorld(ParticleList.FIREWORKS_AFTERBURN_END, GetShotPos());
        if (m_ParticleAfterBurnEnd)
            m_ParticleAfterBurnEnd.SetOwner(this);
        m_ShotDir = m_ParticleShot.GetDirectionUp();
        
        #ifdef DEVELOPER
        vector pts[2];
        pts[0] = GetShotPos();
        pts[1] = GetShotPos() + m_ShotDir * GetExplosionDistance();
        //m_ShotTrajectory = Shape.CreateLines(COLOR_RED, ShapeFlags.TRANSP|ShapeFlags.NOOUTLINE|ShapeFlags.NOZBUFFER, pts, 2);
        #endif
    }

Перекрестные ссылки 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() и Vector().

PlayExplosionSound()

void PlayExplosionSound ( )

inlineprotected

    {
        if (m_FireSound)
        {
            m_FireSound.Stop();
        }
        m_Item.PlaySoundSet( m_ExplosionSound, GetExplosionSoundSet(), 0, 0 );
    }

Перекрестные ссылки GetExplosionSoundSet(), m_ExplosionSound, m_FireSound, m_Item и EffectSound::Stop().

Используется в OnExplode().

RequestSecondaryExplosion()

void RequestSecondaryExplosion ( )

inlineprotected

    {
        if (m_RemainingExplosions> 0)
        {
            m_RemainingExplosions--;
            GetGame().GetCallQueue( CALL_CATEGORY_SYSTEM ).CallLater( SpawnSecondaryExplosion, GetSecondaryExplosionDelay(), false);
        }
    }

Перекрестные ссылки CALL_CATEGORY_SYSTEM, GetGame(), GetSecondaryExplosionDelay(), m_RemainingExplosions и SpawnSecondaryExplosion().

Используется в OnExplode(), SpawnSecondaryExplosion() и AnniversaryFireworksLauncherClientEvent::SpawnSecondaryExplosion().

SetupLight()

void SetupLight ( PointLightBase light )

inlineprotected

    {
        switch (m_Color)
        {
            case "R":
                light.SetDiffuseColor(255,51,51);
                light.SetAmbientColor(255,51,51);
                
                break;
            case "G":
                light.SetDiffuseColor(0,255,128);
                light.SetAmbientColor(0,255,128);
                break;
            case "B":
                light.SetDiffuseColor(51,153,255);
                light.SetAmbientColor(51,153,255);
                break;
            case "Y":
                light.SetDiffuseColor(255,255,51);
                light.SetAmbientColor(255,255,51);
                break;
            case "P":
                light.SetDiffuseColor(255,102,255);
                light.SetAmbientColor(255,102,255);
                break;
            default:
                ErrorEx("Incorrect explosion particle color in the sequence");
        }
    }

Перекрестные ссылки ErrorEx и m_Color.

Используется в SpawnLight().

SpawnLight()

void SpawnLight ( )

inlineprotected

    {
        m_ExplosionLight = ExplosionLight.Cast( ScriptedLightBase.CreateLight( ExplosionLight, GetExplosionPosition()) );
        SetupLight(m_ExplosionLight);
    }

Перекрестные ссылки GetExplosionPosition(), m_ExplosionLight и SetupLight().

Используется в OnExplode().

SpawnSecondaryExplosion()

void SpawnSecondaryExplosion ( )

inlineprotected

    {
        FireworksLauncherClientEventSecondary evnt = new FireworksLauncherClientEventSecondary(m_Item,m_Index);
        evnt.Init(GetExplosionPosition());
        evnt.OnExplode();
        m_Events.Insert(evnt);
        RequestSecondaryExplosion();
    }

Перекрестные ссылки GetExplosionPosition(), m_Events, m_Index, m_Item и RequestSecondaryExplosion().

Используется в RequestSecondaryExplosion().

Поля

m_Color

string m_Color

protected

Используется в FireworksLauncherClientEvent(), GetExplParticleFromSequence(), AnniversaryFireworksLauncherClientEvent::GetExplParticleFromSequence(), SetupLight() и AnniversaryFireworksLauncherClientEvent::SetupLight().

m_Events

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

protected

Используется в SpawnSecondaryExplosion() и AnniversaryFireworksLauncherClientEvent::SpawnSecondaryExplosion().

m_ExplosionLight

ExplosionLight m_ExplosionLight

protected

Используется в SpawnLight().

m_ExplosionPos

vector m_ExplosionPos

protected

Используется в CalculateExplosionPosition() и GetExplosionPosition().

m_ExplosionSound

EffectSound m_ExplosionSound

protected

Используется в PlayExplosionSound() и ~FireworksLauncherClientEvent().

m_FireSound

EffectSound m_FireSound

protected

Используется в OnFired(), PlayExplosionSound() и ~FireworksLauncherClientEvent().

m_Index

int m_Index

protected

Используется в FireworksLauncherClientEvent(), GetShotPos(), SpawnSecondaryExplosion() и AnniversaryFireworksLauncherClientEvent::SpawnSecondaryExplosion().

m_Item

FireworksLauncher m_Item

protected

Используется в FireworksLauncherClientEvent(), GetShotPos(), OnFired(), PlayExplosionSound(), SpawnSecondaryExplosion() и AnniversaryFireworksLauncherClientEvent::SpawnSecondaryExplosion().

m_ParticleAfterBurnEnd

ParticleSource m_ParticleAfterBurnEnd

protected

Используется в OnExplode(), OnFired() и ~FireworksLauncherClientEvent().

m_ParticleExplosion

ParticleSource m_ParticleExplosion

protected

Используется в OnExplode().

m_ParticleShot

ParticleSource m_ParticleShot

protected

Используется в OnFired().

m_RemainingExplosions

int m_RemainingExplosions = GetSecondaryExplosionCount()

protected

Используется в RequestSecondaryExplosion().

m_ShotDir

vector m_ShotDir

protected

Используется в CalculateExplosionPosition() и OnFired().

m_Timer

ref Timer m_Timer = new Timer()

protected

Используется в OnFired().

---

Объявления и описания членов класса находятся в файле:

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