CAContinuousFillCoolant Class Reference

Inheritance diagram for CAContinuousFillCoolant:

Collaboration diagram for CAContinuousFillCoolant:

Protected Member Functions
void	CAContinuousFillCoolant (float quantity_used_per_second, float time_to_progress)
override void	Setup (ActionData action_data)
override int	Execute (ActionData action_data)
override int	Cancel (ActionData action_data)
override float	GetProgress ()
void	CalcAndSetQuantity (ActionData action_data)

Protected Attributes
float	m_ItemQuantity
float	m_SpentQuantity
float	m_SpentQuantity_total
float	m_EmptySpace
float	m_TimeElpased
float	m_QuantityUsedPerSecond
float	m_AdjustedQuantityUsedPerSecond
float	m_DefaultTimeStep
ref Param1< float >	m_SpentUnits
PlayerBase	m_Player

Detailed Description

Definition at line 1 of file CAContinuousFillCoolant.c.

Constructor & Destructor Documentation

CAContinuousFillCoolant()

void CAContinuousFillCoolant::CAContinuousFillCoolant ( float quantity_used_per_second, float time_to_progress )

inlineprotected

Definition at line 15 of file CAContinuousFillCoolant.c.

  {
    m_QuantityUsedPerSecond = quantity_used_per_second;
    m_DefaultTimeStep = time_to_progress;
  }

References m_DefaultTimeStep, and m_QuantityUsedPerSecond.

Member Function Documentation

CalcAndSetQuantity()

void CAContinuousFillCoolant::CalcAndSetQuantity ( ActionData action_data )

inlineprotected

Definition at line 112 of file CAContinuousFillCoolant.c.

  {
 
    m_SpentQuantity_total += m_SpentQuantity;
 
    if (m_SpentUnits)
    {
      m_SpentUnits.param1 = m_SpentQuantity;
      SetACData(m_SpentUnits);
    }
 
    if (GetGame().IsServer())
    {
      if (action_data.m_MainItem)
        action_data.m_MainItem.AddQuantity(-m_SpentQuantity);
 
      Car car = Car.Cast(action_data.m_Target.GetParent());
      if (car)
        car.Fill(CarFluid.COOLANT, (m_SpentQuantity * 0.001));
    }
 
    m_SpentQuantity = 0;
  }

References GetGame(), m_SpentQuantity, m_SpentQuantity_total, m_SpentUnits, and CABase::SetACData().

Cancel()

override int CAContinuousFillCoolant::Cancel ( ActionData action_data )

inlineprotected

Definition at line 93 of file CAContinuousFillCoolant.c.

  {
    if (!action_data.m_Player)
      return UA_ERROR;
 
    CalcAndSetQuantity(action_data);
    return UA_INTERRUPT;
  }

References CalcAndSetQuantity(), UA_ERROR, and UA_INTERRUPT.

Execute()

override int CAContinuousFillCoolant::Execute ( ActionData action_data )

inlineprotected

Definition at line 54 of file CAContinuousFillCoolant.c.

  {
    Car car = Car.Cast(action_data.m_Target.GetParent());
 
    if (!car)
      return UA_ERROR;
 
    if (!action_data.m_Player)
      return UA_ERROR;
 
    if (m_ItemQuantity <= 0)
      return UA_FINISHED;
    else
    {
      if (m_SpentQuantity_total < m_ItemQuantity)
      {
        m_AdjustedQuantityUsedPerSecond = action_data.m_Player.GetSoftSkillsManager().SubtractSpecialtyBonus(m_QuantityUsedPerSecond, m_Action.GetSpecialtyWeight(), true);
        m_SpentQuantity += m_AdjustedQuantityUsedPerSecond * action_data.m_Player.GetDeltaT();
        m_TimeElpased += action_data.m_Player.GetDeltaT();
 
        if (m_TimeElpased >= m_DefaultTimeStep)
        {
          CalcAndSetQuantity(action_data);
          m_TimeElpased = 0;
          //Setup(action_data); //reset data after repeat
        }
 
        return UA_PROCESSING;
      }
      else
      {
        CalcAndSetQuantity(action_data);
        OnCompletePogress(action_data);
        return UA_FINISHED;
      }
    }
  }

References CalcAndSetQuantity(), CABase::m_Action, m_AdjustedQuantityUsedPerSecond, m_DefaultTimeStep, m_ItemQuantity, m_QuantityUsedPerSecond, m_SpentQuantity, m_SpentQuantity_total, m_TimeElpased, CAContinuousBase::OnCompletePogress(), UA_ERROR, UA_FINISHED, and UA_PROCESSING.

GetProgress()

override float CAContinuousFillCoolant::GetProgress ( )

inlineprotected

Definition at line 103 of file CAContinuousFillCoolant.c.

  {
    if (m_ItemQuantity <= 0)
      return 1;
 
    return -(m_SpentQuantity_total / m_ItemQuantity);
  }

References m_ItemQuantity, and m_SpentQuantity_total.

Setup()

override void CAContinuousFillCoolant::Setup ( ActionData action_data )

inlineprotected

Definition at line 22 of file CAContinuousFillCoolant.c.

  {
    m_Player = action_data.m_Player;
 
    Car car = Car.Cast(action_data.m_Target.GetParent());
 
    if (!car)
      return;
 
    m_TimeElpased = 0;
    m_SpentQuantity = 0;
 
    if (!m_SpentUnits)
      m_SpentUnits = new Param1<float>(0);
    else
      m_SpentUnits.param1 = 0;
 
    m_QuantityUsedPerSecond *= Math.Min(action_data.m_MainItem.GetLiquidThroughputCoef(), car.GetLiquidThroughputCoef());
 
    float coolCapacity = car.GetFluidCapacity(CarFluid.COOLANT);
    float currentCool = car.GetFluidFraction(CarFluid.COOLANT);
    currentCool = currentCool * coolCapacity;
 
    m_EmptySpace = (coolCapacity - currentCool) * 1000;
    m_ItemQuantity = action_data.m_MainItem.GetQuantity();
 
    if (m_EmptySpace <= m_ItemQuantity)
      m_ItemQuantity = m_EmptySpace;
 
  }

References m_EmptySpace, m_ItemQuantity, m_Player, m_QuantityUsedPerSecond, m_SpentQuantity, m_SpentUnits, m_TimeElpased, and Math::Min().

Member Data Documentation

m_AdjustedQuantityUsedPerSecond

float CAContinuousFillCoolant::m_AdjustedQuantityUsedPerSecond

protected

Definition at line 9 of file CAContinuousFillCoolant.c.

Referenced by Execute().

m_DefaultTimeStep

float CAContinuousFillCoolant::m_DefaultTimeStep

protected

Definition at line 10 of file CAContinuousFillCoolant.c.

Referenced by CAContinuousFillCoolant(), and Execute().

m_EmptySpace

float CAContinuousFillCoolant::m_EmptySpace

protected

Definition at line 6 of file CAContinuousFillCoolant.c.

Referenced by Setup().

m_ItemQuantity

float CAContinuousFillCoolant::m_ItemQuantity

protected

Definition at line 3 of file CAContinuousFillCoolant.c.

Referenced by Execute(), GetProgress(), and Setup().

m_Player

PlayerBase CAContinuousFillCoolant::m_Player

protected

Definition at line 13 of file CAContinuousFillCoolant.c.

Referenced by Setup().

m_QuantityUsedPerSecond

float CAContinuousFillCoolant::m_QuantityUsedPerSecond

protected

Definition at line 8 of file CAContinuousFillCoolant.c.

Referenced by CAContinuousFillCoolant(), Execute(), and Setup().

m_SpentQuantity

float CAContinuousFillCoolant::m_SpentQuantity

protected

Definition at line 4 of file CAContinuousFillCoolant.c.

Referenced by CalcAndSetQuantity(), Execute(), and Setup().

m_SpentQuantity_total

float CAContinuousFillCoolant::m_SpentQuantity_total

protected

Definition at line 5 of file CAContinuousFillCoolant.c.

Referenced by CalcAndSetQuantity(), Execute(), and GetProgress().

m_SpentUnits

ref Param1<float> CAContinuousFillCoolant::m_SpentUnits

protected

Definition at line 11 of file CAContinuousFillCoolant.c.

Referenced by CalcAndSetQuantity(), and Setup().

m_TimeElpased

float CAContinuousFillCoolant::m_TimeElpased

protected

Definition at line 7 of file CAContinuousFillCoolant.c.

Referenced by Execute(), and Setup().

---

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

• scripts/4_World/Classes/UserActionsComponent/ActionComponents/CAContinuousFillCoolant.c