CASingleUseQuantity Class Reference

Inheritance diagram for CASingleUseQuantity:

Collaboration diagram for CASingleUseQuantity:

Protected Member Functions
void	CASingleUseQuantity (float quantity_used_per_action)
override void	Setup (ActionData action_data)
override int	Execute (ActionData action_data)
void	CalcAndSetQuantity (ActionData action_data)

Protected Attributes
float	m_QuantityUsedPerAction
float	m_ItemQuantity
ref Param1< float >	m_SpentUnits

Detailed Description

Definition at line 1 of file CASingleUseQuantity.c.

Constructor & Destructor Documentation

CASingleUseQuantity()

void CASingleUseQuantity::CASingleUseQuantity ( float quantity_used_per_action )

inlineprotected

Definition at line 7 of file CASingleUseQuantity.c.

  {
    m_QuantityUsedPerAction = quantity_used_per_action;
  }

References m_QuantityUsedPerAction.

Member Function Documentation

CalcAndSetQuantity()

void CASingleUseQuantity::CalcAndSetQuantity ( ActionData action_data )

inlineprotected

Definition at line 33 of file CASingleUseQuantity.c.

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

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

Execute()

override int CASingleUseQuantity::Execute ( ActionData action_data )

inlineprotected

Definition at line 21 of file CASingleUseQuantity.c.

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

References CalcAndSetQuantity(), UA_ERROR, and UA_FINISHED.

Setup()

override void CASingleUseQuantity::Setup ( ActionData action_data )

inlineprotected

Definition at line 12 of file CASingleUseQuantity.c.

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

References m_ItemQuantity, and m_SpentUnits.

Member Data Documentation

m_ItemQuantity

float CASingleUseQuantity::m_ItemQuantity

protected

Definition at line 4 of file CASingleUseQuantity.c.

Referenced by Setup().

m_QuantityUsedPerAction

float CASingleUseQuantity::m_QuantityUsedPerAction

protected

Definition at line 3 of file CASingleUseQuantity.c.

Referenced by CalcAndSetQuantity(), CASingleUseQuantityEdible::CalcAndSetQuantity(), CASingleUseQuantity(), and CASingleUseQuantityEdible::CASingleUseQuantityEdible().

m_SpentUnits

ref Param1<float> CASingleUseQuantity::m_SpentUnits

protected

Definition at line 5 of file CASingleUseQuantity.c.

Referenced by CalcAndSetQuantity(), CASingleUseQuantityEdible::CalcAndSetQuantity(), and Setup().

---

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

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