Grenade_Base Class Reference

Inheritance diagram for Grenade_Base:

Collaboration diagram for Grenade_Base:

Protected Member Functions
override void	CreateLight ()
void	~FlashGrenade ()
void	Pin ()
void	Unpin ()
override void	OnActivatedByTripWire ()
	DEPRECATED use OnActivatedByItem.
override void	OnActivatedByItem (notnull ItemBase item)
bool	IsPinned ()
bool	IsPinnable ()
void	ActivateImmediate ()
void	ActivateRandomTime ()
void	SetPinnable (bool state)
void	SetFuseDelay (float delay)
void	SetGrenadeType (EGrenadeType type)
EGrenadeType	GetGrenadeType ()
void	Activate ()
void	Deactivate ()
override void	InitiateExplosion ()
void	ExplodeGrenade (EGrenadeType grenade_type)
	DEPRECATED - for backward compatibility only.
void	OnPin ()
void	OnUnpin ()
void	OnActivateStarted ()
void	OnActivateFinished ()
void	OnActivateImmediate ()
void	OnDeactivate ()
override void	OnStoreSave (ParamsWriteContext ctx)
override bool	OnStoreLoad (ParamsReadContext ctx, int version)
override bool	CanBeArmed ()
override bool	CanBeDisarmed ()
override bool	CanExplodeInFire ()
override void	SetActions ()
override void	EEItemLocationChanged (notnull InventoryLocation oldLoc, notnull InventoryLocation newLoc)
override void	OnWasAttached (EntityAI parent, int slot_id)
void	Grenade_Base ()

Protected Attributes
const float	DEFAULT_FUSE_DELAY = 10
ref Timer	m_FuseTimer
float	m_FuseDelay
float	m_RemainingFuseTime
bool	m_Pinned
bool	m_Pinnable
EGrenadeType	m_GrenadeType

Private Member Functions
override void	OnExplosionEffects (Object source, Object directHit, int componentIndex, string surface, vector pos, vector surfNormal, float energyFactor, float explosionFactor, bool isWater, string ammoType)
void	FlashGrenade ()
void	M67Grenade ()
void	~M67Grenade ()
void	RGD5Grenade ()
void	~RGD5Grenade ()

Private Attributes
const float	FX_RANGE_MAX_MULT = 1.0

Detailed Description

Definition at line 1 of file FlashGrenade.c.

Constructor & Destructor Documentation

~FlashGrenade()

void Grenade_Base::~FlashGrenade ( )

inlineprotected

Definition at line 90 of file FlashGrenade.c.

{}

~M67Grenade()

void Grenade_Base::~M67Grenade ( )

inlineprivate

Definition at line 10 of file M67Grenade.c.

{}

~RGD5Grenade()

void Grenade_Base::~RGD5Grenade ( )

inlineprivate

Definition at line 10 of file RGD5Grenade.c.

{}

Grenade_Base()

void Grenade_Base::Grenade_Base ( )

inlineprotected

Definition at line 280 of file Grenade_Base.c.

  {
    m_Pinned = true;
    m_FuseTimer = new Timer;
    m_RemainingFuseTime = -1;
 
    SetPinnable(true);
    SetFuseDelay(DEFAULT_FUSE_DELAY);
    SetGrenadeType(EGrenadeType.FRAGMENTATION);
 
    RegisterNetSyncVariableBool("m_Pinned");
  }

References DEFAULT_FUSE_DELAY, m_FuseTimer, m_Pinned, m_RemainingFuseTime, SetFuseDelay(), SetGrenadeType(), and SetPinnable().

Member Function Documentation

Activate()

void Grenade_Base::Activate ( )

inlineprotected

run only the remaining part (already unpinned and pinned)

Definition at line 116 of file Grenade_Base.c.

  {
    if (!m_FuseTimer.IsRunning())
    {
      if (m_RemainingFuseTime > 0)
      {
        //Debug.Log(string.Format("Grenade activated num of seconds to explosion: %1", m_RemainingFuseTime));
        m_FuseTimer.Run(m_RemainingFuseTime, this, "OnActivateFinished");
      }
      else
      {
        //Debug.Log(string.Format("Grenade activated num of seconds to explosion: %1", m_FuseDelay));
        m_FuseTimer.Run(m_FuseDelay, this, "OnActivateFinished");
      }
 
    }
  }

References m_FuseDelay, m_FuseTimer, and m_RemainingFuseTime.

Referenced by EEItemLocationChanged().

ActivateImmediate()

void Grenade_Base::ActivateImmediate ( )

inlineprotected

Definition at line 84 of file Grenade_Base.c.

  {
    OnActivateImmediate();
  }

References OnActivateImmediate().

Referenced by ActivateRandomTime().

ActivateRandomTime()

void Grenade_Base::ActivateRandomTime ( )

inlineprotected

to millis

Definition at line 89 of file Grenade_Base.c.

  {
    float delay = Math.RandomFloat(1, 20);
    delay *= 1000; 
    GetGame().GetCallQueue(CALL_CATEGORY_GAMEPLAY).CallLater(ActivateImmediate, delay, false);
  }

References ActivateImmediate(), CALL_CATEGORY_GAMEPLAY, GetGame(), and Math::RandomFloat().

CanBeArmed()

override bool Grenade_Base::CanBeArmed ( )

inlineprotected

Definition at line 238 of file Grenade_Base.c.

  {
    return false;
  }

CanBeDisarmed()

override bool Grenade_Base::CanBeDisarmed ( )

inlineprotected

Definition at line 243 of file Grenade_Base.c.

  {
    return false;
  }

CanExplodeInFire()

override bool Grenade_Base::CanExplodeInFire ( )

inlineprotected

Definition at line 248 of file Grenade_Base.c.

  {
    return true;
  }

CreateLight()

override void Grenade_Base::CreateLight ( )

inlineprotected

Definition at line 85 of file FlashGrenade.c.

  {
    m_Light = ExplosiveLight.Cast(ScriptedLightBase.CreateLight(FlashGrenadeLight, GetPosition()));
  }

References FlashGrenadeLight(), GetPosition, and m_Light.

Deactivate()

void Grenade_Base::Deactivate ( )

inlineprotected

Definition at line 135 of file Grenade_Base.c.

  {
    if (m_FuseTimer.IsRunning())
    {
      m_RemainingFuseTime = m_FuseTimer.GetRemaining();
      m_FuseTimer.Stop();
      OnDeactivate();
    }
  }

References m_FuseTimer, m_RemainingFuseTime, and OnDeactivate().

Referenced by OnPin(), and OnWasAttached().

EEItemLocationChanged()

override void Grenade_Base::EEItemLocationChanged ( notnull InventoryLocation oldLoc, notnull InventoryLocation newLoc )

inlineprotected

activate grenade when it leaves player hands (safety handle released)

Definition at line 261 of file Grenade_Base.c.

  {
    super.EEItemLocationChanged(oldLoc, newLoc);
 
    if (newLoc.GetType() != InventoryLocationType.HANDS && !IsPinned())
      Activate();
  }

References Activate(), and IsPinned().

ExplodeGrenade()

void Grenade_Base::ExplodeGrenade ( EGrenadeType grenade_type )

inlineprotected

DEPRECATED - for backward compatibility only.

Definition at line 163 of file Grenade_Base.c.

  {
    InitiateExplosion();
  }

References InitiateExplosion().

FlashGrenade()

void Grenade_Base::FlashGrenade ( )

inlineprivate

Definition at line 77 of file FlashGrenade.c.

  {
    SetAmmoType("FlashGrenade_Ammo");
    SetFuseDelay(2);
    SetGrenadeType(EGrenadeType.ILLUMINATING);
    SetParticleExplosion(ParticleList.GRENADE_M84);
  }

References ParticleList::GRENADE_M84, SetAmmoType(), SetFuseDelay(), SetGrenadeType(), and SetParticleExplosion().

GetGrenadeType()

EGrenadeType Grenade_Base::GetGrenadeType ( )

inlineprotected

Definition at line 111 of file Grenade_Base.c.

  {
    return m_GrenadeType;
  }

References m_GrenadeType.

Referenced by InitiateExplosion().

InitiateExplosion()

override void Grenade_Base::InitiateExplosion ( )

inlineprotected

Definition at line 145 of file Grenade_Base.c.

  {
    switch (GetGrenadeType())
    {
    case EGrenadeType.FRAGMENTATION:
    case EGrenadeType.ILLUMINATING:
      for (int i = 0; i < m_AmmoTypes.Count(); i++)
        Explode(DamageType.EXPLOSION, m_AmmoTypes[i]);
      break;
    case EGrenadeType.CHEMICAL:
    case EGrenadeType.NON_LETHAL:
      break;
    }
 
    OnExplode();
  }

References Explode(), GetGrenadeType(), m_AmmoTypes, and OnExplode().

Referenced by ExplodeGrenade().

IsPinnable()

bool Grenade_Base::IsPinnable ( )

inlineprotected

cannot be pinned once the fuse has started

Definition at line 75 of file Grenade_Base.c.

  {
    if (m_FuseTimer.IsRunning())
      return false;
 
    return m_Pinnable;
  }

References m_FuseTimer, and m_Pinnable.

IsPinned()

bool Grenade_Base::IsPinned ( )

inlineprotected

Definition at line 70 of file Grenade_Base.c.

  {
    return m_Pinned;
  }

References m_Pinned.

Referenced by EEItemLocationChanged().

M67Grenade()

void Grenade_Base::M67Grenade ( )

inlineprivate

Definition at line 3 of file M67Grenade.c.

  {
    SetAmmoType("M67Grenade_Ammo");
    SetFuseDelay(4);
    SetParticleExplosion(ParticleList.M67);
  }

References ParticleList::M67, SetAmmoType(), SetFuseDelay(), and SetParticleExplosion().

OnActivatedByItem()

override void Grenade_Base::OnActivatedByItem ( notnull ItemBase item )

inlineprotected

Definition at line 59 of file Grenade_Base.c.

  {
    if (item == this)
    {
      OnActivateFinished();
      return;
    }
 
    Unpin();
  }

References OnActivateFinished(), and Unpin().

OnActivatedByTripWire()

override void Grenade_Base::OnActivatedByTripWire ( )

protected

DEPRECATED use OnActivatedByItem.

OnActivateFinished()

void Grenade_Base::OnActivateFinished ( )

inlineprotected

Definition at line 193 of file Grenade_Base.c.

  {
    if (GetGame().IsServer())
    {
      SetHealth("", "", 0.0); // causes explosion when grenade is destroyed
      SetTakeable(false);
    }
  }

References GetGame(), and SetTakeable().

Referenced by Grenade_ChemGas::EOnContact(), and OnActivatedByItem().

OnActivateImmediate()

void Grenade_Base::OnActivateImmediate ( )

inlineprotected

Definition at line 202 of file Grenade_Base.c.

  {
    if (GetGame().IsServer())
    {
      SetHealth("", "", 0.0); // causes explosion when grenade is destroyed
      SetTakeable(false);
    }
  }

References GetGame(), and SetTakeable().

Referenced by ActivateImmediate().

OnActivateStarted()

void Grenade_Base::OnActivateStarted ( )

protected

Referenced by OnUnpin().

OnDeactivate()

void Grenade_Base::OnDeactivate ( )

protected

Referenced by Deactivate().

OnExplosionEffects()

override void Grenade_Base::OnExplosionEffects ( Object source, Object directHit, int componentIndex, string surface, vector pos, vector surfNormal, float energyFactor, float explosionFactor, bool isWater, string ammoType )

inlineprivate

values less than 1.0 make no sense

removes possible obstacles made by items around the grenade(or on the same position)

Definition at line 5 of file FlashGrenade.c.

  {
    super.OnExplosionEffects(source, directHit, componentIndex, surface, pos, surfNormal, energyFactor, explosionFactor, isWater, ammoType);
 
    PlayerBase player = PlayerBase.Cast(GetGame().GetPlayer());
 
    if (player)
    {
      vector headPos = player.GetDamageZonePos("Head"); // animated position in the middle of the zone
      float ammoRangeKill = GetGame().ConfigGetFloat(string.Format("CfgAmmo %1 indirectHitRange", ammoType));
      float ammoRangeMaxMult = 4.0;
 
      string indirectHitRangeMultiplier = string.Format("CfgAmmo %1 indirectHitRangeMultiplier", ammoType);
      if (GetGame().ConfigIsExisting(indirectHitRangeMultiplier))
      {
        ammoRangeMaxMult = Math.Clamp(GetGame().ConfigGetFloat(indirectHitRangeMultiplier), 1.0, float.MAX);
      }
 
      float ammoRangeMax = ammoRangeKill * ammoRangeMaxMult;
      ammoRangeMax = Math.Clamp(ammoRangeMax * FX_RANGE_MAX_MULT, ammoRangeKill, ammoRangeMax);
 
      float dist = vector.Distance(headPos, pos);
      float distSq = vector.DistanceSq(headPos, pos);
      float radiusMaxSq = Math.SqrFloat(ammoRangeMax);
 
      if (distSq <= radiusMaxSq)
      {
        // ignore collisions with parent if fireplace
        InventoryItem invItem = InventoryItem.Cast(source);
        EntityAI parent = invItem.GetHierarchyParent();
        array<Object> excluded = new array<Object>;
 
        if (!parent || !parent.IsFireplace())
          parent = null;
        else if (parent)
          excluded.Insert(parent);
 
        array<ref RaycastRVResult> results = new array<ref RaycastRVResult>;
        excluded.Insert(this); //Ignore self for visibility check
 
        //There shouldn't be cases justifying we go further than first entry (if in fireplace, self does not impact)
        RaycastRVParams rayParams = new RaycastRVParams(pos, headPos, excluded[0]);
        rayParams.flags = CollisionFlags.ALLOBJECTS;
        DayZPhysics.RaycastRVProxy(rayParams, results, excluded);
 
        array<Object> hitObjects = new array<Object>;
        for (int i = 0; i < results.Count(); i++)
        {
          if (results[i].obj && !results[i].obj.IsInherited(ItemBase))
            hitObjects.Insert(results[i].obj);
        }
 
        //If player is not first index, object is between player and grenade
        if (hitObjects.Count() && PlayerBase.Cast(hitObjects[0]))
        {
          float effectCoef;
          if (ammoRangeMax == ammoRangeKill)
          {
            effectCoef = 1.0; //edge case, landed right on the edge
          }
          effectCoef = 1 - ((dist - ammoRangeKill) / (ammoRangeMax - ammoRangeKill));
          effectCoef = Math.Clamp(effectCoef, 0.1, 100.0);
 
          player.OnPlayerReceiveFlashbangHitStart(MiscGameplayFunctions.IsPlayerOrientedTowardPos(player, pos, 60));
          player.GetFlashbangEffect().SetupFlashbangValues(effectCoef, effectCoef, effectCoef);
        }
      }
    }
  }

References Math::Clamp(), vector::Distance(), vector::DistanceSq(), GetGame(), GetPlayer(), MAX, DayZPhysics::RaycastRVProxy(), and Math::SqrFloat().

OnPin()

void Grenade_Base::OnPin ( )

inlineprotected

Definition at line 168 of file Grenade_Base.c.

  {
    m_Pinned = true;
    if (GetGame().IsServer())
    {
      ForceFarBubble(false);
      SetSynchDirty();
    }
 
    Deactivate();
  }

References Deactivate(), GetGame(), and m_Pinned.

Referenced by Pin().

OnStoreLoad()

override bool Grenade_Base::OnStoreLoad ( ParamsReadContext ctx, int version )

inlineprotected

Definition at line 221 of file Grenade_Base.c.

  {
    if (!super.OnStoreLoad(ctx, version))
      return false;
 
    bool pinned;
    if (version >= 107)
    {
      if (!ctx.Read(pinned))
        return false;
 
      m_Pinned = pinned;
    }
 
    return true;
  }

References m_Pinned.

OnStoreSave()

override void Grenade_Base::OnStoreSave ( ParamsWriteContext ctx )

inlineprotected

Definition at line 213 of file Grenade_Base.c.

  {
    super.OnStoreSave(ctx);
 
    if (GetGame().SaveVersion() >= 107)
      ctx.Write(m_Pinned);
  }

References GetGame(), and m_Pinned.

OnUnpin()

void Grenade_Base::OnUnpin ( )

inlineprotected

Definition at line 180 of file Grenade_Base.c.

  {
    m_Pinned = false;
    if (GetGame().IsServer())
    {
      ForceFarBubble(true);
      SetSynchDirty();
    }
 
    OnActivateStarted();
  }

References GetGame(), m_Pinned, and OnActivateStarted().

Referenced by Unpin().

OnWasAttached()

override void Grenade_Base::OnWasAttached ( EntityAI parent, int slot_id )

inlineprotected

Definition at line 270 of file Grenade_Base.c.

  {
    super.OnWasAttached(parent, slot_id);
 
    if (parent.IsAnyInherited({TrapBase, ImprovisedExplosive}))
    {
      Deactivate();
    }
  }

References Deactivate().

Pin()

void Grenade_Base::Pin ( )

inlineprotected

Definition at line 44 of file Grenade_Base.c.

  {
    if (!m_Pinned && m_Pinnable)
      OnPin();
  }

References m_Pinnable, m_Pinned, and OnPin().

RGD5Grenade()

void Grenade_Base::RGD5Grenade ( )

inlineprivate

Definition at line 3 of file RGD5Grenade.c.

  {
    SetAmmoType("RGD5Grenade_Ammo");
    SetFuseDelay(4);
    SetParticleExplosion(ParticleList.RGD5);
  }

References ParticleList::RGD5, SetAmmoType(), SetFuseDelay(), and SetParticleExplosion().

SetActions()

override void Grenade_Base::SetActions ( )

inlineprotected

Definition at line 253 of file Grenade_Base.c.

  {
    super.SetActions();
 
    AddAction(ActionUnpin);
    AddAction(ActionPin);
  }

References AddAction().

SetFuseDelay()

void Grenade_Base::SetFuseDelay ( float delay )

inlineprotected

Definition at line 101 of file Grenade_Base.c.

  {
    m_FuseDelay = delay;
  }

References m_FuseDelay.

Referenced by FlashGrenade(), Grenade_Base(), M67Grenade(), and RGD5Grenade().

SetGrenadeType()

void Grenade_Base::SetGrenadeType ( EGrenadeType type )

inlineprotected

Definition at line 106 of file Grenade_Base.c.

  {
    m_GrenadeType = type;
  }

References m_GrenadeType.

Referenced by FlashGrenade(), Grenade_Base(), and Grenade_ChemGas::Grenade_ChemGas().

SetPinnable()

void Grenade_Base::SetPinnable ( bool state )

inlineprotected

Definition at line 96 of file Grenade_Base.c.

  {
    m_Pinnable = state;
  }

References m_Pinnable.

Referenced by Grenade_Base(), and Grenade_ChemGas::Grenade_ChemGas().

Unpin()

void Grenade_Base::Unpin ( )

inlineprotected

Definition at line 50 of file Grenade_Base.c.

  {
    if (m_Pinned)
      OnUnpin();
  }

References m_Pinned, and OnUnpin().

Referenced by OnActivatedByItem().

Member Data Documentation

DEFAULT_FUSE_DELAY

const float Grenade_Base::DEFAULT_FUSE_DELAY = 10

protected

Definition at line 32 of file Grenade_Base.c.

Referenced by Grenade_Base().

FX_RANGE_MAX_MULT

const float Grenade_Base::FX_RANGE_MAX_MULT = 1.0

private

Definition at line 3 of file FlashGrenade.c.

m_FuseDelay

float Grenade_Base::m_FuseDelay

protected

Definition at line 35 of file Grenade_Base.c.

Referenced by Activate(), and SetFuseDelay().

m_FuseTimer

ref Timer Grenade_Base::m_FuseTimer

protected

Definition at line 34 of file Grenade_Base.c.

Referenced by Activate(), Deactivate(), Grenade_Base(), and IsPinnable().

m_GrenadeType

EGrenadeType Grenade_Base::m_GrenadeType

protected

Definition at line 42 of file Grenade_Base.c.

Referenced by GetGrenadeType(), and SetGrenadeType().

m_Pinnable

bool Grenade_Base::m_Pinnable

protected

Definition at line 39 of file Grenade_Base.c.

Referenced by IsPinnable(), Pin(), and SetPinnable().

m_Pinned

bool Grenade_Base::m_Pinned

protected

Definition at line 38 of file Grenade_Base.c.

Referenced by Grenade_Base(), Grenade_ChemGas::Grenade_ChemGas(), IsPinned(), OnPin(), OnStoreLoad(), OnStoreSave(), OnUnpin(), Pin(), and Unpin().

m_RemainingFuseTime

float Grenade_Base::m_RemainingFuseTime

protected

Definition at line 36 of file Grenade_Base.c.

Referenced by Activate(), Deactivate(), and Grenade_Base().

---

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

• scripts/4_World/Entities/Grenade_Base/FlashGrenade.c
• scripts/4_World/Entities/ItemBase/Grenade_Base.c
• scripts/4_World/Entities/Grenade_Base/M67Grenade.c
• scripts/4_World/Entities/Grenade_Base/RGD5Grenade.c