Класс FireworksLauncher

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

Защищенные члены
bool	UsesGlobalDeploy ()
override bool	IsDeployable ()
override float	GetDeployTime ()
	how long it takes to deploy this item in seconds
void	SetupColorSequences ()
string	GetColorSequence ()
void	OnPlacementComplete (Man player, vector position="0 0 0", vector orientation="0 0 0")
float	GetMaxAllowedWetness ()
float	GetEventDelay ()
string	GetFuseSoundSet ()
int	GetMaxShots ()
float	GetFuseDelay ()
string	GetAmmoType ()
int	GetDamageType ()
void	OnStateChangedServer (EFireworksState currentState)
void	OnStateChangedClient (EFireworksState currentState)
override void	OnIgnitedThis (EntityAI fire_source)
	Executed on Server when some item ignited this one.
bool	CanPutInCargo (EntityAI parent)
bool	CanPutIntoHands (EntityAI parent)
void	OnFuseIgnitedServer ()
void	OnFuseIgnitedClient ()
void	OnFiringStartServer ()
void	OnFiringStartClient ()
void	OnFiringStop ()
void	RestartEventTimer ()
	Starts event timer.
bool	IsIgnited ()
bool	CanIgniteItem (EntityAI ignite_target=NULL)
void	OnEventServer (int type)
	Called periodically but only after the entity gets ignited.
void	OnIndexChangedClient ()
FireworksLauncherClientEventBase	SpawnEvent ()
void	OnVariablesSynchronized ()
void	OnStoreSave (ParamsWriteContext ctx)
bool	OnStoreLoad (ParamsReadContext ctx, int version)
override string	GetDeploySoundset ()
override string	GetLoopDeploySoundset ()

Закрытые члены
void	FireworksLauncher ()
void	~FireworksLauncher ()

Закрытые данные
int	m_Index
int	m_IndexPrev
int	m_ColorSequenceIndex
ref Timer	m_TimerFuse
ref array< ref FireworksLauncherClientEventBase >	m_Events
EffectSound	m_FuseSoundStart
EffectSound	m_FuseSound
ParticleSource	m_ParticleFuse
ParticleSource	m_ParticleAfterBurnEnd
ref array< string >	m_ColorSequence

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

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

FireworksLauncher()

void FireworksLauncher ( )

inlineprivate

    {
        m_ColorSequence = new array<string>();
        SetupColorSequences();
        RegisterNetSyncVariableInt("m_State", 0, EnumTools.GetLastEnumValue(EFireworksState));
        RegisterNetSyncVariableInt("m_Index", 0, GetMaxShots());
        RegisterNetSyncVariableInt("m_RandomSeed", 0, 1023);
        int lastIndex = m_ColorSequence.Count() - 1;
        RegisterNetSyncVariableInt("m_ColorSequenceIndex", 0, lastIndex);
        m_RandomSeed = Math.RandomInt(0,1023);
        m_ColorSequenceIndex = Math.RandomIntInclusive(0, lastIndex);
    }

Перекрестные ссылки EnumTools::GetLastEnumValue(), GetMaxShots(), m_ColorSequence, m_ColorSequenceIndex, m_RandomSeed, Math::RandomInt(), Math::RandomIntInclusive() и SetupColorSequences().

~FireworksLauncher()

void ~FireworksLauncher ( )

inlineprivate

    {
        SEffectManager.DestroyEffect(m_FuseSound);
        SEffectManager.DestroyEffect(m_FuseSoundStart);
    }

Перекрестные ссылки SEffectManager::DestroyEffect(), m_FuseSound и m_FuseSoundStart.

Методы

CanIgniteItem()

bool CanIgniteItem ( EntityAI ignite_target = NULL )

inlineprotected

    {
        return false;
    }

CanPutInCargo()

bool CanPutInCargo ( EntityAI parent )

inlineprotected

    {
        return (GetState() == EFireworksState.DEFAULT || (GetState() == EFireworksState.PLACED) || (GetState() == EFireworksState.FINISHED);
    }

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

CanPutIntoHands()

bool CanPutIntoHands ( EntityAI parent )

inlineprotected

    {
        return (GetState() == EFireworksState.DEFAULT || (GetState() == EFireworksState.PLACED) || (GetState() == EFireworksState.FINISHED);
    }

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

GetAmmoType()

string GetAmmoType ( )

inlineprotected

    {
        return "Fireworks_Ammo";
    }

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

GetColorSequence()

string GetColorSequence ( )

inlineprotected

    {
        if (m_ColorSequence.IsValidIndex(m_ColorSequenceIndex))
        {
            return m_ColorSequence.Get(m_ColorSequenceIndex);
        }
        else
        {
            ErrorEx("Failed to obtain color sequence");
            return "RYPBYYPBRGBYPBRGBRBGBPBRGRGBRBGRYPYR";
        }
    }

Перекрестные ссылки ErrorEx, m_ColorSequence и m_ColorSequenceIndex.

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

GetDamageType()

int GetDamageType ( )

inlineprotected

    {
        return DamageType.EXPLOSION;
    }

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

GetDeploySoundset()

override string GetDeploySoundset ( )

inlineprotected

    {
        return "placeFireworks_SoundSet";
    }

GetDeployTime()

override float GetDeployTime ( )

inlineprotected

how long it takes to deploy this item in seconds

    {
        return 2;
    }

GetEventDelay()

float GetEventDelay ( )

inlineprotected

    {
        return Math.RandomFloatInclusive(3,3.35);
    }

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

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

GetFuseDelay()

float GetFuseDelay ( )

inlineprotected

    {
        return 3;
    }

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

GetFuseSoundSet()

string GetFuseSoundSet ( )

inlineprotected

    {
        return "FireworksLauncher_Ignition_Loop_SoundSet";
    }

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

GetLoopDeploySoundset()

override string GetLoopDeploySoundset ( )

inlineprotected

    {
        return "fireworks_deploy_SoundSet";
    }

GetMaxAllowedWetness()

float GetMaxAllowedWetness ( )

inlineprotected

    {
        return GameConstants.STATE_WET;
    }

Перекрестные ссылки GameConstants::STATE_WET.

GetMaxShots()

int GetMaxShots ( )

inlineprotected

    {
        return 16;
    }

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

IsDeployable()

override bool IsDeployable ( )

inlineprotected

    {
        return true;
    }

IsIgnited()

bool IsIgnited ( )

inlineprotected

    {
        return GetState()==EFireworksState.IGNITED;
    }

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

OnEventServer()

void OnEventServer ( int type )

inlineprotected

Called periodically but only after the entity gets ignited.

    {
        m_Index++;
        DamageSystem.ExplosionDamage(this, NULL, GetAmmoType(), GetPosition(), GetDamageType());
        
        SetSynchDirty();
        if (m_Index > GetMaxShots())
        {
            m_Index = GetMaxShots();
            m_TimerEvent = null;
            SetState(EFireworksState.FINISHED);
        }
        else
        {
            RestartEventTimer();
        }
    }

Перекрестные ссылки GetAmmoType(), GetDamageType(), GetMaxShots(), GetPosition, m_Index, m_TimerEvent, RestartEventTimer() и SetState().

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

OnFiringStartClient()

void OnFiringStartClient ( )

inlineprotected

    {
        if (m_ParticleFuse)
        {
            m_ParticleFuse.StopParticle(StopParticleFlags.IMMEDIATE);
        }
        if (m_FuseSound)
        {
            m_FuseSound.Stop();
        }
    }

Перекрестные ссылки m_FuseSound, m_ParticleFuse, EffectSound::Stop() и ParticleSource::StopParticle().

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

OnFiringStartServer()

void OnFiringStartServer ( )

inlineprotected

    {
        OnEventServer(0);
    }

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

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

OnFiringStop()

void OnFiringStop ( )

inlineprotected

    {
        SetHealth01("","",0);
    }

OnFuseIgnitedClient()

void OnFuseIgnitedClient ( )

inlineprotected

    {
        m_ParticleFuse = ParticleManager.GetInstance().PlayInWorld(ParticleList.FIREWORKS_FUSE, GetPosition() + "0 0.15 0");
        if (m_ParticleFuse)
            m_ParticleFuse.SetOwner(this);
        PlaySoundSet( m_FuseSoundStart, "FireworksLauncher_Ignition_Start_SoundSet", 0, 0 );
        vector fuseStart;
        vector fuseEnd;
        
        if (MemoryPointExists("Fuse_Start"))
        {
            fuseStart = GetMemoryPointPos("Fuse_Start");
            fuseStart = ModelToWorld(fuseStart);
        }
        if (MemoryPointExists("Fuse_End"))
        {
            fuseEnd = GetMemoryPointPos("Fuse_End");
            fuseEnd = ModelToWorld(fuseEnd);
        }
        
        vector fuseDir = fuseEnd - fuseStart;
        vector fuseOrientation[4];
        vector ori = fuseDir.VectorToAngles();
        m_ParticleFuse.SetOrientation(ori);
        m_ParticleFuse.SetPosition(fuseStart);
 
        PlaySoundSetLoop( m_FuseSound, GetFuseSoundSet(), 0, 0 );
    }

Перекрестные ссылки ParticleList::FIREWORKS_FUSE, GetFuseSoundSet(), GetPosition, m_FuseSound, m_FuseSoundStart, m_ParticleFuse, ParticleManager() и ParticleSource::SetOwner().

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

OnFuseIgnitedServer()

void OnFuseIgnitedServer ( )

inlineprotected

    {
        int state = EFireworksState.FIRING;
        GetGame().GetCallQueue( CALL_CATEGORY_SYSTEM ).CallLater( SetState, GetFuseDelay()*1000, false, state);
    }

Перекрестные ссылки CALL_CATEGORY_SYSTEM, GetFuseDelay(), GetGame() и SetState().

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

OnIgnitedThis()

override void OnIgnitedThis ( EntityAI fire_source )

inlineprotected

Executed on Server when some item ignited this one.

    {
        super.OnIgnitedThis(fire_source);
        if (m_Events)
        {
            m_Events.Clear();
        }
        m_Index = 0;
        
        if (m_TimerEvent)
        {
            m_TimerEvent.Stop();
        }
    }

Перекрестные ссылки m_Events, m_Index и m_TimerEvent.

OnIndexChangedClient()

void OnIndexChangedClient ( )

inlineprotected

    {
        if (!m_Events)
        {
            m_Events = new array<ref FireworksLauncherClientEventBase>;
        }
        if (m_Index != 0 && m_State == EFireworksState.FIRING)//can only be true when restarting the device during debug calls
        {
            FireworksLauncherClientEventBase fireEvent = SpawnEvent();
            m_Events.Insert(fireEvent);
        }
    }

Перекрестные ссылки m_Events, m_Index, m_State и SpawnEvent().

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

OnPlacementComplete()

void OnPlacementComplete ( Man player, vector position = "0 0 0", vector orientation = "0 0 0" )

inlineprotected

    {
        super.OnPlacementComplete(player, position, orientation);
        if (GetGame().IsServer())
        {
            if (GetState() == EFireworksState.DEFAULT)
            {
                SetState(EFireworksState.PLACED);
            }
        }
    }

Перекрестные ссылки GetGame(), GetState() и SetState().

OnStateChangedClient()

void OnStateChangedClient ( EFireworksState currentState )

inlineprotected

    {
        switch (currentState)
        {
            case EFireworksState.IGNITED:
                OnFuseIgnitedClient();
                break
            case EFireworksState.PLACED:
                break
            case EFireworksState.FIRING:
                OnFiringStartClient();
                break
            default: {};
        }
    }

Перекрестные ссылки OnFiringStartClient() и OnFuseIgnitedClient().

OnStateChangedServer()

void OnStateChangedServer ( EFireworksState currentState )

inlineprotected

    {
        switch (currentState)
        {
            case EFireworksState.PLACED:
                break
            case EFireworksState.IGNITED:
                OnFuseIgnitedServer();
                break
            case EFireworksState.FIRING:
                HideSelection("cover");
                OnFiringStartServer();
                break
            case EFireworksState.FINISHED:
                HideSelection("cover");//when loading from storage
                break
            default: {};
        }
    }

Перекрестные ссылки OnFiringStartServer() и OnFuseIgnitedServer().

OnStoreLoad()

bool OnStoreLoad ( ParamsReadContext ctx, int version )

inlineprotected

    {
        if (!super.OnStoreLoad(ctx, version))
        {
            return false;
        }
        
        if (version >= 130)
        {
            if (!ctx.Read(m_Index))
            {
                return false;
            }
        
            if (!ctx.Read(m_State))
            {
                return false;
            }
            
            SetState(m_State);
        }
        return true;
    }

Перекрестные ссылки m_Index, m_State и SetState().

OnStoreSave()

void OnStoreSave ( ParamsWriteContext ctx )

inlineprotected

    {
        super.OnStoreSave(ctx);
        ctx.Write(m_Index);
        ctx.Write(m_State);
    }

Перекрестные ссылки m_Index и m_State.

OnVariablesSynchronized()

void OnVariablesSynchronized ( )

inlineprotected

    {
        super.OnVariablesSynchronized();
        //Print("index: " + m_Index);
        if (m_Index != m_IndexPrev)
        {
            Math.Randomize(m_RandomSeed+m_Index);
            OnIndexChangedClient();
            m_IndexPrev = m_Index;
        }
    }

Перекрестные ссылки m_Index, m_IndexPrev, m_RandomSeed, OnIndexChangedClient() и Math::Randomize().

RestartEventTimer()

void RestartEventTimer ( )

inlineprotected

Starts event timer.

    {
        if (!m_TimerEvent)
        {
            m_TimerEvent = new Timer();
        }
        m_TimerEvent.Run(GetEventDelay(), this, "OnEventServer", new Param1<int>(0));
    }

Перекрестные ссылки GetEventDelay() и m_TimerEvent.

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

SetupColorSequences()

void SetupColorSequences ( )

inlineprotected

    {
        m_ColorSequence.Insert("RGBYPBRGBRGBYPBRGBRGBYPBRGBPBRGBRGBY");
        m_ColorSequence.Insert("PGPYPBYPYPBYYPBRPYPBYYPBRGBPBRGRGBRB");
        m_ColorSequence.Insert("YPBRPYPBYYPBRGBPBRGRGBRBGRPBRGBRYPBY");
        m_ColorSequence.Insert("YRBGPRYPGRYBGRGRGBRBBYPYPBYRYPGRYGRP");
        m_ColorSequence.Insert("BGRYPYRPBYYPYRBGPRYPGBYPBRGBPBRGBRGB");
        m_ColorSequence.Insert("RYGRPBRGBYPBRRPBRGBBRBBYPYPRGBRGBRPY");
        m_ColorSequence.Insert("GBRGBYRGBYPBRRPBRBYRYPGPYPRGBRGBRPYG");
        m_ColorSequence.Insert("RYPBYYPBRGBYPBRGBRBGBPBRGRGBRBGRYPYR");
        m_ColorSequence.Insert("PBRGBYPBRGBRBGBPBRGRGBRBGRYPYRRYPBYY");
        m_ColorSequence.Insert("RGRGBRBBYPYPBYRYPGRYGRPYRBGPRYPGRYBG");
        m_ColorSequence.Insert("RBYRYPGPYPRGBRGBRPYGGBRGBYRGBYPBRRPB");
        m_ColorSequence.Insert("PRGBRGBRPYGGBRRBYRYPGPYGBYRGBYPBRRPB");
    }

Перекрестные ссылки m_ColorSequence.

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

SpawnEvent()

FireworksLauncherClientEventBase SpawnEvent ( )

inlineprotected

    {
        FireworksLauncherClientEventBase evnt = new FireworksLauncherClientEvent(this,m_Index);
        evnt.OnFired();
        return evnt;
    }

Перекрестные ссылки m_Index.

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

UsesGlobalDeploy()

bool UsesGlobalDeploy ( )

inlineprotected

    {
        return true;
    }

Поля

m_ColorSequence

ref array<string> m_ColorSequence

private

Используется в FireworksLauncher(), GetColorSequence(), SetupColorSequences() и Anniversary_FireworksLauncher::SetupColorSequences().

m_ColorSequenceIndex

int m_ColorSequenceIndex

private

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

m_Events

ref array<ref FireworksLauncherClientEventBase> m_Events

private

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

m_FuseSound

EffectSound m_FuseSound

private

Используется в OnFiringStartClient(), OnFuseIgnitedClient() и ~FireworksLauncher().

m_FuseSoundStart

EffectSound m_FuseSoundStart

private

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

m_Index

int m_Index

private

Используется в OnEventServer(), Anniversary_FireworksLauncher::OnEventServer(), OnIgnitedThis(), OnIndexChangedClient(), OnStoreLoad(), OnStoreSave(), OnVariablesSynchronized(), SpawnEvent() и Anniversary_FireworksLauncher::SpawnEvent().

m_IndexPrev

int m_IndexPrev

private

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

m_ParticleAfterBurnEnd

ParticleSource m_ParticleAfterBurnEnd

private

m_ParticleFuse

ParticleSource m_ParticleFuse

private

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

m_TimerFuse

ref Timer m_TimerFuse

private

---

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

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