Класс AmmoEffects

Static data holder for certain ammo config values. Подробнее...

Закрытые статические члены
Ammo particles
Methods regarding getting/playing ammo particle
static int	GetAmmoParticleID (string ammoType)
	Get the ParticleList ID for the particle for this ammoType.
static bool	PlayAmmoParticle (string ammoType, vector pos)
	Attempt to play the ammo particle at pos if found, returns true on success.
Ammo effects
Methods regarding getting/playing ammo effect
static	GetAmmoEffectTypename (string ammoType)
	Get the typename for the effect for this ammoType.
static bool	PlayAmmoEffect (string ammoType, vector pos)
	Attempt to play the ammo effect at pos if found, returns true on success.
Lifetime
Creation and cleanup
static void	Init ()
	Initialize the containers: this is done this way, to have these not exist on server.
static void	Cleanup ()
	Clean up the data.

Закрытые статические данные
static ref map< string, int >	m_AmmoParticles
	Key: Ammo class name; Data: ParticleList ID.
static ref map< string, typename >	m_AmmoEffects
	Key: Ammo class name; Data: ParticleList ID.

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

Static data holder for certain ammo config values.

Заметки

Kept the names similar to what is in config, but it might be a little deceiving as this is mainly used for explosives

Методы

Cleanup()

static void Cleanup ( )

inlinestaticprivate

Clean up the data.

    {
        /* These ain't containing no refs, so whatever
        m_AmmoParticles.Clear();
        m_AmmoEffects.Clear();
        */
    }

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

GetAmmoEffectTypename()

static GetAmmoEffectTypename ( string ammoType )

inlinestaticprivate

Get the typename for the effect for this ammoType.

    {
        typename typeName;
        
        // Search for it in the static map
        if ( !m_AmmoEffects.Find(ammoType, typeName) )
        {
            // Load it in when we can't find it
            string effectName;
            GetGame().ConfigGetText(string.Format("cfgAmmo %1 effect", ammoType), effectName);
            
            // If we found a valid entry, try looking for it in ParticleList
            if ( effectName != "" )
            {
                typeName = effectName.ToType();
            }
            
            // Store it for next search
            m_AmmoEffects.Insert(ammoType, typeName);
        }
        
        return typeName;
    }

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

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

GetAmmoParticleID()

static int GetAmmoParticleID ( string ammoType )

inlinestaticprivate

Get the ParticleList ID for the particle for this ammoType.

    {
        int particleID;
        
        // Search for it in the static map
        if ( !m_AmmoParticles.Find(ammoType, particleID) )
        {
            // Load it in when we can't find it
            string particleFileName;
            GetGame().ConfigGetText(string.Format("cfgAmmo %1 particle", ammoType), particleFileName);
            
            // If we found a valid entry, try looking for it in ParticleList
            if ( particleFileName != "" )
            {
                particleID = ParticleList.GetParticleIDByName(particleFileName);
            }
            
            // Store it for next search
            m_AmmoParticles.Insert(ammoType, particleID);
        }
        
        return particleID;
    }

Перекрестные ссылки GetGame(), ParticleList::GetParticleIDByName() и m_AmmoParticles.

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

Init()

static void Init ( )

inlinestaticprivate

Initialize the containers: this is done this way, to have these not exist on server.

    {
        m_AmmoParticles = new map<string, int>();
        m_AmmoEffects = new map<string, typename>();
    }

Перекрестные ссылки m_AmmoEffects и m_AmmoParticles.

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

PlayAmmoEffect()

static bool PlayAmmoEffect ( string ammoType, vector pos )

inlinestaticprivate

Attempt to play the ammo effect at pos if found, returns true on success.

    {
        typename typeName = GetAmmoEffectTypename(ammoType);
        
        if ( typeName )
        {
            Effect eff = Effect.Cast(typeName.Spawn());
            
            if ( eff )
            {
                eff.SetAutodestroy(true);
                return SEffectManager.PlayInWorld( eff, pos );
            }
        }
        
        return false;
    }

Перекрестные ссылки GetAmmoEffectTypename() и SEffectManager::PlayInWorld().

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

PlayAmmoParticle()

static bool PlayAmmoParticle ( string ammoType, vector pos )

inlinestaticprivate

Attempt to play the ammo particle at pos if found, returns true on success.

    {
        int particleID = GetAmmoParticleID(ammoType);
        
        if (ParticleList.IsValidId(particleID))
        {
            return ParticleManager.GetInstance().PlayInWorld(particleID, pos) != null;
        }
        
        return false;
    }

Перекрестные ссылки GetAmmoParticleID(), ParticleList::IsValidId() и ParticleManager().

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

Поля

m_AmmoEffects

ref map<string, typename> m_AmmoEffects

staticprivate

Key: Ammo class name; Data: ParticleList ID.

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

m_AmmoParticles

ref map<string, int> m_AmmoParticles

staticprivate

Key: Ammo class name; Data: ParticleList ID.

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

---

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

• D:/Ishodniki/scripts/3_Game/AmmoEffects.c