CAContinuousQuantity Class Reference

Inheritance diagram for CAContinuousQuantity:

Collaboration diagram for CAContinuousQuantity:

Protected Member Functions
void	CAContinuousQuantity (float quantity_used_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_ItemQuantity
float	m_SpentQuantity
float	m_ItemMaxQuantity
float	m_QuantityUsedPerSecond
float	m_AdjustedQuantityUsedPerSecond
ref Param1< float >	m_SpentUnits

Detailed Description

Definition at line 1 of file CAContinuousQuantity.c.

Constructor & Destructor Documentation

CAContinuousQuantity()

void CAContinuousQuantity::CAContinuousQuantity ( float quantity_used_per_second )

inlineprotected

Definition at line 10 of file CAContinuousQuantity.c.

  {
    m_QuantityUsedPerSecond = quantity_used_per_second;
  }

References m_QuantityUsedPerSecond.

Member Function Documentation

CalcAndSetQuantity()

void CAContinuousQuantity::CalcAndSetQuantity ( ActionData action_data )

inlineprotected

Definition at line 69 of file CAContinuousQuantity.c.

  {
    if (GetGame().IsServer())
    {
      if (m_SpentUnits)
      {
        m_SpentUnits.param1 = m_SpentQuantity;
        SetACData(m_SpentUnits);
      }
 
      if (action_data.m_MainItem)
        action_data.m_MainItem.AddQuantity(- m_SpentQuantity, false, false);
    }
  }

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

Cancel()

override int CAContinuousQuantity::Cancel ( ActionData action_data )

inlineprotected

Definition at line 51 of file CAContinuousQuantity.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 CAContinuousQuantity::Execute ( ActionData action_data )

inlineprotected

Definition at line 27 of file CAContinuousQuantity.c.

  {
    if (!action_data.m_Player)
      return UA_ERROR;
 
    if (m_ItemQuantity <= 0)
      return UA_FINISHED;
    else
    {
      if (m_SpentQuantity < m_ItemQuantity)
      {
        m_AdjustedQuantityUsedPerSecond = action_data.m_Player.GetSoftSkillsManager().AddSpecialtyBonus(m_QuantityUsedPerSecond, m_Action.GetSpecialtyWeight(), true);
        m_SpentQuantity += m_AdjustedQuantityUsedPerSecond * action_data.m_Player.GetDeltaT();
        return UA_PROCESSING;
      }
      else
      {
        CalcAndSetQuantity(action_data);
        OnCompletePogress(action_data);
        return UA_FINISHED;
      }
    }
  }

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

GetProgress()

override float CAContinuousQuantity::GetProgress ( )

inlineprotected

Definition at line 60 of file CAContinuousQuantity.c.

  {
    //float progress = m_SpentQuantity/m_ItemQuantity;
    return m_SpentQuantity / m_ItemQuantity;
  }

References m_ItemQuantity, and m_SpentQuantity.

Setup()

override void CAContinuousQuantity::Setup ( ActionData action_data )

inlineprotected

Definition at line 15 of file CAContinuousQuantity.c.

  {
    m_SpentQuantity = 0;
    if (!m_SpentUnits)
      m_SpentUnits = new Param1<float>(0);
    else
      m_SpentUnits.param1 = 0;
    m_ItemMaxQuantity = action_data.m_MainItem.GetQuantityMax();
    m_ItemQuantity = action_data.m_MainItem.GetQuantity();
  }

References m_ItemMaxQuantity, m_ItemQuantity, m_SpentQuantity, and m_SpentUnits.

Member Data Documentation

m_AdjustedQuantityUsedPerSecond

float CAContinuousQuantity::m_AdjustedQuantityUsedPerSecond

protected

Definition at line 7 of file CAContinuousQuantity.c.

Referenced by Execute(), and CAContinuousWaterPlant::Execute().

m_ItemMaxQuantity

float CAContinuousQuantity::m_ItemMaxQuantity

protected

Definition at line 5 of file CAContinuousQuantity.c.

Referenced by CAContinuousWaterSlot::Execute(), and Setup().

m_ItemQuantity

float CAContinuousQuantity::m_ItemQuantity

protected

Definition at line 3 of file CAContinuousQuantity.c.

Referenced by CAContinuousDisinfectPlant::Execute(), CAContinuousFertilizeGardenSlot::Execute(), Execute(), CAContinuousWaterPlant::Execute(), CAContinuousWaterSlot::Execute(), GetProgress(), CAContinuousWaterSlot::GetProgress(), CAContinuousDisinfectPlant::Setup(), CAContinuousFertilizeGardenSlot::Setup(), Setup(), CAContinuousWaterPlant::Setup(), and CAContinuousWaterSlot::Setup().

m_QuantityUsedPerSecond

float CAContinuousQuantity::m_QuantityUsedPerSecond

protected

Definition at line 6 of file CAContinuousQuantity.c.

Referenced by CAContinuousDisinfectPlant::CAContinuousDisinfectPlant(), CAContinuousFertilizeGardenSlot::CAContinuousFertilizeGardenSlot(), CAContinuousQuantity(), CAContinuousWaterPlant::CAContinuousWaterPlant(), CAContinuousWaterSlot::CAContinuousWaterSlot(), CAContinuousDisinfectPlant::Execute(), CAContinuousFertilizeGardenSlot::Execute(), Execute(), CAContinuousWaterPlant::Execute(), CAContinuousWaterSlot::Execute(), CAContinuousWaterPlant::GetProgress(), CAContinuousDisinfectPlant::Setup(), CAContinuousFertilizeGardenSlot::Setup(), CAContinuousWaterPlant::Setup(), and CAContinuousWaterSlot::Setup().

m_SpentQuantity

float CAContinuousQuantity::m_SpentQuantity

protected

Definition at line 4 of file CAContinuousQuantity.c.

Referenced by CalcAndSetQuantity(), CAContinuousDisinfectPlant::Execute(), CAContinuousFertilizeGardenSlot::Execute(), Execute(), CAContinuousWaterPlant::Execute(), CAContinuousWaterSlot::Execute(), GetProgress(), CAContinuousWaterPlant::GetProgress(), CAContinuousDisinfectPlant::Setup(), CAContinuousFertilizeGardenSlot::Setup(), Setup(), CAContinuousWaterPlant::Setup(), and CAContinuousWaterSlot::Setup().

m_SpentUnits

ref Param1<float> CAContinuousQuantity::m_SpentUnits

protected

Definition at line 8 of file CAContinuousQuantity.c.

Referenced by CalcAndSetQuantity(), CAContinuousDisinfectPlant::Setup(), CAContinuousFertilizeGardenSlot::Setup(), Setup(), CAContinuousWaterPlant::Setup(), and CAContinuousWaterSlot::Setup().

---

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

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