AreaDamageLooped Class Reference

Inheritance diagram for AreaDamageLooped:

Collaboration diagram for AreaDamageLooped:

Protected Member Functions
void	AreaDamageLooped (EntityAI parent, bool loopByObject=true)
override void	OnTriggerCreated ()
	Gets called when the trigger is spawned, so is the start and also a reset.
override void	SetLoopInterval (float time)
override void	OnEnterServerEvent (TriggerInsider insider)
override void	OnStayStartServerEvent (int nrOfInsiders)
override void	OnStayServerEvent (TriggerInsider insider, float deltaTime)
override void	OnStayFinishServerEvent ()
float	CalculateDamageScale (TriggerInsider insider, float deltaTime)

Protected Attributes
float	m_CurrentTime = 0.0
	Current start time in seconds.
float	m_PreviousTime = 0.0
	Previous start time in seconds.
float	m_AccumulatedTime = 0.0
	How much time has accumulated.
float	m_LoopInterval = 1.0
	Loop interval in seconds.
int	m_AmountOfLoops = 0
	Caching of the amount of loops that will be performed in this frame.
bool	m_LoopByObject = true
	Decides if the looping will be using the Object as reference or the time since last update loop.

Detailed Description

Definition at line 1 of file AreaDamageLooped.c.

Constructor & Destructor Documentation

AreaDamageLooped()

void AreaDamageLooped::AreaDamageLooped ( EntityAI parent, bool loopByObject = true )

inlineprotected

Definition at line 18 of file AreaDamageLooped.c.

  {
    m_LoopByObject = loopByObject;
  }

References m_LoopByObject.

Member Function Documentation

CalculateDamageScale()

float AreaDamageLooped::CalculateDamageScale ( TriggerInsider insider, float deltaTime )

inlineprotected

Definition at line 74 of file AreaDamageLooped.c.

  {
    // If we want the LoopInterval to be dependant on the Object, we will need their lastDamaged time
    if (m_LoopByObject)
    {
      float lastDamaged = 0;
 
      AreaDamageTriggerInsider dInsider;
      if (CastTo(dInsider, insider))
        lastDamaged = dInsider.lastDamaged;
 
      // First time it is damaged, do full damage
      if (lastDamaged == 0)
        return 1;
 
      // This way, in case the server lags, it will scale the damage to catch up if necessary
      // We want to wait until it is at least above 1, to not spam the network with hit messages
      float damageCoeff = (m_CurrentTime - lastDamaged) / m_LoopInterval;
      if (damageCoeff >= 1)
        return damageCoeff;
 
      return 0;
    }
    else
      return m_AmountOfLoops;
  }

References m_AmountOfLoops, m_CurrentTime, m_LoopByObject, and m_LoopInterval.

OnEnterServerEvent()

override void AreaDamageLooped::OnEnterServerEvent ( TriggerInsider insider )

inlineprotected

Definition at line 37 of file AreaDamageLooped.c.

  {
    super.OnEnterServerEvent(insider);
 
    // Do direct damaging first time on entering
    if (m_LoopByObject)
      OnEvaluateDamageEx(insider, 1);
  }

References m_LoopByObject, and OnEvaluateDamageEx().

OnStayFinishServerEvent()

override void AreaDamageLooped::OnStayFinishServerEvent ( )

inlineprotected

Definition at line 65 of file AreaDamageLooped.c.

  {
    super.OnStayFinishServerEvent();
 
    m_AccumulatedTime -= m_AmountOfLoops * m_LoopInterval;
  }

References m_AccumulatedTime, m_AmountOfLoops, and m_LoopInterval.

OnStayServerEvent()

override void AreaDamageLooped::OnStayServerEvent ( TriggerInsider insider, float deltaTime )

inlineprotected

Definition at line 57 of file AreaDamageLooped.c.

  {
    super.OnStayServerEvent(insider, deltaTime);
 
    // As we are using the Ex variant, we can put the logic in CalculateDamageScale
    OnEvaluateDamageEx(insider, deltaTime);
  }

References OnEvaluateDamageEx().

OnStayStartServerEvent()

override void AreaDamageLooped::OnStayStartServerEvent ( int nrOfInsiders )

inlineprotected

Definition at line 46 of file AreaDamageLooped.c.

  {
    super.OnStayStartServerEvent(nrOfInsiders);
 
    m_CurrentTime = g_Game.GetTickTime();
    m_AccumulatedTime += m_CurrentTime - m_PreviousTime;
    m_PreviousTime = m_CurrentTime;
 
    m_AmountOfLoops = m_AccumulatedTime / m_LoopInterval;
  }

References g_Game, m_AccumulatedTime, m_AmountOfLoops, m_CurrentTime, m_LoopInterval, and m_PreviousTime.

OnTriggerCreated()

override void AreaDamageLooped::OnTriggerCreated ( )

inlineprotected

Gets called when the trigger is spawned, so is the start and also a reset.

Definition at line 24 of file AreaDamageLooped.c.

  {
    super.OnTriggerCreated();
 
    m_PreviousTime = g_Game.GetTickTime();
    m_AccumulatedTime = 0.0;
  }

References g_Game, m_AccumulatedTime, and m_PreviousTime.

SetLoopInterval()

override void AreaDamageLooped::SetLoopInterval ( float time )

inlineprotected

Definition at line 32 of file AreaDamageLooped.c.

  {
    m_LoopInterval = time;
  }

References m_LoopInterval.

Member Data Documentation

m_AccumulatedTime

float AreaDamageLooped::m_AccumulatedTime = 0.0

protected

How much time has accumulated.

Definition at line 8 of file AreaDamageLooped.c.

Referenced by OnStayFinishServerEvent(), OnStayStartServerEvent(), and OnTriggerCreated().

m_AmountOfLoops

int AreaDamageLooped::m_AmountOfLoops = 0

protected

Caching of the amount of loops that will be performed in this frame.

Definition at line 13 of file AreaDamageLooped.c.

Referenced by CalculateDamageScale(), OnStayFinishServerEvent(), and OnStayStartServerEvent().

m_CurrentTime

float AreaDamageLooped::m_CurrentTime = 0.0

protected

Current start time in seconds.

Definition at line 4 of file AreaDamageLooped.c.

Referenced by CalculateDamageScale(), and OnStayStartServerEvent().

m_LoopByObject

bool AreaDamageLooped::m_LoopByObject = true

protected

Decides if the looping will be using the Object as reference or the time since last update loop.

Definition at line 16 of file AreaDamageLooped.c.

Referenced by AreaDamageLooped(), CalculateDamageScale(), and OnEnterServerEvent().

m_LoopInterval

float AreaDamageLooped::m_LoopInterval = 1.0

protected

Loop interval in seconds.

Definition at line 10 of file AreaDamageLooped.c.

Referenced by CalculateDamageScale(), OnStayFinishServerEvent(), OnStayStartServerEvent(), and SetLoopInterval().

m_PreviousTime

float AreaDamageLooped::m_PreviousTime = 0.0

protected

Previous start time in seconds.

Definition at line 6 of file AreaDamageLooped.c.

Referenced by OnStayStartServerEvent(), and OnTriggerCreated().

---

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

• scripts/4_World/Classes/AreaDamage/AreaDamageNew/AreaDamageLooped.c