CAContinuousWaterSlot Class Reference

Inheritance diagram for CAContinuousWaterSlot:

Collaboration diagram for CAContinuousWaterSlot:

Protected Member Functions
void	CAContinuousWaterSlot (float quantity_used_per_second)
override void	Setup (ActionData action_data)
override int	Execute (ActionData action_data)
override float	GetProgress ()

Protected Attributes
float	m_PlantThirstyness
float	m_TimeToComplete
float	m_SpentQuantityTotal
float	m_StartQuantity
Slot	m_Slot

Additional Inherited Members
Private Member Functions inherited from CAContinuousQuantity
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)
Private Attributes inherited from CAContinuousQuantity
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 CAContinuousWaterSlot.c.

Constructor & Destructor Documentation

CAContinuousWaterSlot()

void CAContinuousWaterSlot::CAContinuousWaterSlot ( float quantity_used_per_second )

inlineprotected

Definition at line 9 of file CAContinuousWaterSlot.c.

  {
    m_QuantityUsedPerSecond = quantity_used_per_second;
  }

References CAContinuousQuantity::m_QuantityUsedPerSecond.

Member Function Documentation

Execute()

override int CAContinuousWaterSlot::Execute ( ActionData action_data )

inlineprotected

Definition at line 53 of file CAContinuousWaterSlot.c.

  {
    GardenBase target_GB;
    Class.CastTo(target_GB, action_data.m_Target.GetObject());
    m_ItemQuantity = action_data.m_MainItem.GetQuantity();
    m_ItemMaxQuantity = action_data.m_MainItem.GetQuantityMax();
 
    if (!action_data.m_Player)
      return UA_ERROR;
 
    if (m_ItemQuantity <= 0)
      return UA_FINISHED;
    else
    {
      if (m_Slot && m_SpentQuantity < m_ItemQuantity)
      {
        m_SpentQuantity += m_QuantityUsedPerSecond * action_data.m_Player.GetDeltaT();
        float water = action_data.m_Player.GetSoftSkillsManager().AddSpecialtyBonus(m_SpentQuantity, m_Action.GetSpecialtyWeight(), true);
        m_Slot.GiveWater(water);
 
        m_SpentQuantityTotal += m_SpentQuantity;
        CalcAndSetQuantity(action_data);
 
        m_SpentQuantity = 0;
 
        return UA_PROCESSING;
      }
      else
      {
        CalcAndSetQuantity(action_data);
        OnCompletePogress(action_data);
 
        return UA_FINISHED;
      }
    }
  }

References CalcAndSetQuantity(), Class::CastTo(), CABase::m_Action, CAContinuousQuantity::m_ItemMaxQuantity, CAContinuousQuantity::m_ItemQuantity, CAContinuousQuantity::m_QuantityUsedPerSecond, m_Slot, CAContinuousQuantity::m_SpentQuantity, m_SpentQuantityTotal, CAContinuousBase::OnCompletePogress(), UA_ERROR, UA_FINISHED, and UA_PROCESSING.

GetProgress()

override float CAContinuousWaterSlot::GetProgress ( )

inlineprotected

Definition at line 90 of file CAContinuousWaterSlot.c.

  {
    if (m_ItemQuantity <= 0)
      return 1;
    float progress = -(m_SpentQuantityTotal / m_StartQuantity);
    return progress;
  }

References CAContinuousQuantity::m_ItemQuantity, m_SpentQuantityTotal, and m_StartQuantity.

Setup()

override void CAContinuousWaterSlot::Setup ( ActionData action_data )

inlineprotected

Definition at line 14 of file CAContinuousWaterSlot.c.

  {
    GardenBase target_GB;
 
    if (Class.CastTo(target_GB, action_data.m_Target.GetObject()))
    {
      m_SpentQuantity = 0;
      m_StartQuantity = action_data.m_MainItem.GetQuantity();
      if (!m_SpentUnits)
        m_SpentUnits = new Param1<float>(0);
      else
        m_SpentUnits.param1 = 0;
 
      if (action_data.m_MainItem)
        m_ItemQuantity = action_data.m_MainItem.GetQuantity();
 
      if (target_GB)
      {
        array<string> selections = new array<string>;
        target_GB.GetActionComponentNameList(action_data.m_Target.GetComponentIndex(), selections);
 
        for (int s = 0; s < selections.Count(); s++)
        {
          string selection = selections[s];
          m_Slot = target_GB.GetSlotBySelection(selection);
          if (m_Slot)
            break;
        }
 
        m_PlantThirstyness = m_Slot.GetWaterUsage() - m_Slot.GetWater();
      }
 
      m_TimeToComplete = (Math.Min(m_PlantThirstyness, m_ItemQuantity)) / m_QuantityUsedPerSecond;
 
      if (m_TimeToComplete <= 0.1) // Division by zero prevention
        m_TimeToComplete = 0.1;
    }
  }

References Class::CastTo(), CAContinuousQuantity::m_ItemQuantity, m_PlantThirstyness, CAContinuousQuantity::m_QuantityUsedPerSecond, m_Slot, CAContinuousQuantity::m_SpentQuantity, CAContinuousQuantity::m_SpentUnits, m_StartQuantity, m_TimeToComplete, and Math::Min().

Member Data Documentation

m_PlantThirstyness

float CAContinuousWaterSlot::m_PlantThirstyness

protected

Definition at line 3 of file CAContinuousWaterSlot.c.

Referenced by Setup().

m_Slot

Slot CAContinuousWaterSlot::m_Slot

protected

Definition at line 7 of file CAContinuousWaterSlot.c.

Referenced by Execute(), and Setup().

m_SpentQuantityTotal

float CAContinuousWaterSlot::m_SpentQuantityTotal

protected

Definition at line 5 of file CAContinuousWaterSlot.c.

Referenced by Execute(), and GetProgress().

m_StartQuantity

float CAContinuousWaterSlot::m_StartQuantity

protected

Definition at line 6 of file CAContinuousWaterSlot.c.

Referenced by GetProgress(), and Setup().

m_TimeToComplete

float CAContinuousWaterSlot::m_TimeToComplete

protected

Definition at line 4 of file CAContinuousWaterSlot.c.

Referenced by Setup().

---

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

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