CAContinuousEmpty Class Reference

Inheritance diagram for CAContinuousEmpty:

Collaboration diagram for CAContinuousEmpty:

Protected Member Functions
void	CAContinuousEmpty (float quantity_emptied_per_second)
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_TargetUnits
float	m_SpentQuantity
float	m_SpentQuantity_total
float	m_AdjustedQuantityEmptiedPerSecond
float	m_QuantityEmptiedPerSecond
bool	m_WringingClothes
ref Param1< float >	m_SpentUnits
float	m_TimeElpased
float	m_DefaultTimeStep = 0.25

Detailed Description

Definition at line 1 of file CAContinuousEmpty.c.

Constructor & Destructor Documentation

CAContinuousEmpty()

void CAContinuousEmpty::CAContinuousEmpty ( float quantity_emptied_per_second )

inlineprotected

Definition at line 13 of file CAContinuousEmpty.c.

  {
    m_QuantityEmptiedPerSecond = quantity_emptied_per_second;
  }

References m_QuantityEmptiedPerSecond.

Member Function Documentation

CalcAndSetQuantity()

void CAContinuousEmpty::CalcAndSetQuantity ( ActionData action_data )

inlineprotected

Definition at line 89 of file CAContinuousEmpty.c.

  {
    m_SpentQuantity_total += m_SpentQuantity;
    if (GetGame().IsServer())
    {
      if (m_SpentUnits)
      {
        m_SpentUnits.param1 = m_SpentQuantity;
        SetACData(m_SpentUnits);
      }
 
      action_data.m_MainItem.AddQuantity(-m_SpentQuantity);
    }
    m_SpentQuantity = 0;
  }

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

Cancel()

override int CAContinuousEmpty::Cancel ( ActionData action_data )

inlineprotected

Definition at line 73 of file CAContinuousEmpty.c.

  {
    if (!action_data.m_Player || !action_data.m_MainItem)
      return UA_ERROR;
 
    CalcAndSetQuantity(action_data);
    return UA_CANCEL;
  }

References CalcAndSetQuantity(), UA_CANCEL, and UA_ERROR.

Execute()

override int CAContinuousEmpty::Execute ( ActionData action_data )

inlineprotected

Definition at line 43 of file CAContinuousEmpty.c.

  {
    if (!action_data.m_Player)
      return UA_ERROR;
 
    if (m_WringingClothes && action_data.m_MainItem.GetWet() >= action_data.m_MainItem.GetWetMax())
      return UA_FINISHED;
    else
    {
      if (m_SpentQuantity_total <= m_TargetUnits)
      {
        m_SpentQuantity += m_AdjustedQuantityEmptiedPerSecond * action_data.m_Player.GetDeltaT();
        m_TimeElpased += action_data.m_Player.GetDeltaT();
 
        if (m_TimeElpased >= m_DefaultTimeStep)
        {
          CalcAndSetQuantity(action_data);
          m_TimeElpased = 0;
        }
        return UA_PROCESSING;
      }
      else
      {
        CalcAndSetQuantity(action_data);
        OnCompletePogress(action_data);
        return UA_FINISHED;
      }
    }
  }

References CalcAndSetQuantity(), m_AdjustedQuantityEmptiedPerSecond, m_DefaultTimeStep, m_SpentQuantity, m_SpentQuantity_total, m_TargetUnits, m_TimeElpased, m_WringingClothes, CAContinuousBase::OnCompletePogress(), UA_ERROR, UA_FINISHED, and UA_PROCESSING.

GetProgress()

override float CAContinuousEmpty::GetProgress ( )

inlineprotected

Definition at line 82 of file CAContinuousEmpty.c.

  {
    return m_SpentQuantity_total / m_TargetUnits;
  }

References m_SpentQuantity_total, and m_TargetUnits.

Setup()

override void CAContinuousEmpty::Setup ( ActionData action_data )

inlineprotected

Definition at line 18 of file CAContinuousEmpty.c.

  {
    if (!m_SpentUnits)
      m_SpentUnits = new Param1<float>(0);
    else
      m_SpentUnits.param1 = 0;
 
    if (action_data.m_MainItem.IsClothing())
    {
      m_WringingClothes = true;
 
      m_SpentQuantity = action_data.m_MainItem.GetWetMax() - action_data.m_MainItem.GetWet();
      m_TargetUnits = action_data.m_MainItem.GetWetMax();
    }
    else
    {
      m_WringingClothes = false;
 
      m_SpentQuantity = action_data.m_MainItem.GetQuantityMin();
      m_TargetUnits = action_data.m_MainItem.GetQuantity();
    }
 
    m_AdjustedQuantityEmptiedPerSecond = action_data.m_Player.GetSoftSkillsManager().AddSpecialtyBonus(m_QuantityEmptiedPerSecond, m_Action.GetSpecialtyWeight(), true);
  }

References CABase::m_Action, m_AdjustedQuantityEmptiedPerSecond, m_QuantityEmptiedPerSecond, m_SpentQuantity, m_SpentUnits, m_TargetUnits, and m_WringingClothes.

Member Data Documentation

m_AdjustedQuantityEmptiedPerSecond

float CAContinuousEmpty::m_AdjustedQuantityEmptiedPerSecond

protected

Definition at line 6 of file CAContinuousEmpty.c.

Referenced by Execute(), and Setup().

m_DefaultTimeStep

float CAContinuousEmpty::m_DefaultTimeStep = 0.25

protected

Definition at line 11 of file CAContinuousEmpty.c.

Referenced by Execute().

m_QuantityEmptiedPerSecond

float CAContinuousEmpty::m_QuantityEmptiedPerSecond

protected

Definition at line 7 of file CAContinuousEmpty.c.

Referenced by CAContinuousEmpty(), and Setup().

m_SpentQuantity

float CAContinuousEmpty::m_SpentQuantity

protected

Definition at line 4 of file CAContinuousEmpty.c.

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

m_SpentQuantity_total

float CAContinuousEmpty::m_SpentQuantity_total

protected

Definition at line 5 of file CAContinuousEmpty.c.

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

m_SpentUnits

ref Param1<float> CAContinuousEmpty::m_SpentUnits

protected

Definition at line 9 of file CAContinuousEmpty.c.

Referenced by CalcAndSetQuantity(), and Setup().

m_TargetUnits

float CAContinuousEmpty::m_TargetUnits

protected

Definition at line 3 of file CAContinuousEmpty.c.

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

m_TimeElpased

float CAContinuousEmpty::m_TimeElpased

protected

Definition at line 10 of file CAContinuousEmpty.c.

Referenced by Execute().

m_WringingClothes

bool CAContinuousEmpty::m_WringingClothes

protected

Definition at line 8 of file CAContinuousEmpty.c.

Referenced by Execute(), and Setup().

---

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

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