CAContinuousQuantityLiquidTransfer Class Reference

Private Member Functions
void	CAContinuousQuantityLiquidTransfer (float quantity_used_per_second, float time_to_progress, int drain=-1)
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
protected int	m_TendencyDrain
protected float	m_ItemQuantity
protected float	m_SpentQuantity
protected float	m_SpentQuantity_total
protected float	m_ItemMaxQuantity
protected float	m_TimeElpased
protected float	m_QuantityUsedPerSecond
protected float	m_AdjustedQuantityUsedPerSecond
protected float	m_DefaultTimeStep
protected ref Param1< float >	m_SpentUnits

Constructor & Destructor Documentation

CAContinuousQuantityLiquidTransfer()

void CAContinuousQuantityLiquidTransfer ( float  quantity_used_per_second, float  time_to_progress, int  drain = -1  )

inlineprivate

References m_DefaultTimeStep, m_QuantityUsedPerSecond, and m_TendencyDrain.

Member Function Documentation

CalcAndSetQuantity()

void CalcAndSetQuantity ( ActionData  action_data )

inlineprivate

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

Cancel()

override int Cancel ( ActionData  action_data )

inlineprivate

References CalcAndSetQuantity(), m_TendencyDrain, UA_CANCEL, and UA_ERROR.

Execute()

override int Execute ( ActionData  action_data )

inlineprivate

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

GetProgress()

override float GetProgress ( )

inlineprivate

References m_ItemMaxQuantity, m_SpentQuantity_total, and m_TendencyDrain.

Setup()

override void Setup ( ActionData  action_data )

inlineprivate

References ItemBase::GetLiquidThroughputCoef(), m_ItemMaxQuantity, m_ItemQuantity, m_QuantityUsedPerSecond, m_SpentQuantity, m_SpentUnits, m_TendencyDrain, m_TimeElpased, and Math::Min().

Field Documentation

m_AdjustedQuantityUsedPerSecond

protected float m_AdjustedQuantityUsedPerSecond

private

Referenced by Execute().

m_DefaultTimeStep

protected float m_DefaultTimeStep

private

Referenced by CAContinuousQuantityLiquidTransfer(), and Execute().

m_ItemMaxQuantity

protected float m_ItemMaxQuantity

private

Referenced by GetProgress(), and Setup().

m_ItemQuantity

protected float m_ItemQuantity

private

Referenced by Execute(), and Setup().

m_QuantityUsedPerSecond

protected float m_QuantityUsedPerSecond

private

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

m_SpentQuantity

protected float m_SpentQuantity

private

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

m_SpentQuantity_total

protected float m_SpentQuantity_total

private

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

m_SpentUnits

protected ref Param1<float> m_SpentUnits

private

Referenced by CalcAndSetQuantity(), and Setup().

m_TendencyDrain

protected int m_TendencyDrain

private

Referenced by CAContinuousQuantityLiquidTransfer(), CalcAndSetQuantity(), Cancel(), Execute(), GetProgress(), and Setup().

m_TimeElpased

protected float m_TimeElpased

private

Referenced by Execute(), and Setup().

---

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

• P:/scripts/4_World/Classes/UserActionsComponent/ActionComponents/CAContinuousQuantityLiquidTransfer.c