CAContinuousTransferQuantity Class Reference

Private Member Functions
void	CAContinuousTransferQuantity (float quantity_filled_per_second)
override void	Setup (ActionData action_data)
override int	Execute (ActionData action_data)
override override int	Cancel (ActionData action_data)
override float	GetProgress ()
void	CalcAndSetQuantity (ActionData action_data)

Private Attributes
protected float	m_TargetUnits
protected float	m_SpentQuantity
protected float	m_ItemQuantity
protected float	m_SourceQuantity
protected float	m_QuantityFilledPerSecond
protected float	m_TimeToComplete
protected ref Param1< float >	m_SpentUnits

Constructor & Destructor Documentation

CAContinuousTransferQuantity()

void CAContinuousTransferQuantity ( float  quantity_filled_per_second )

inlineprivate

References m_QuantityFilledPerSecond.

Member Function Documentation

CalcAndSetQuantity()

void CalcAndSetQuantity ( ActionData  action_data )

inlineprivate

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

Cancel()

override override int Cancel ( ActionData  action_data )

inlineprivate

References CalcAndSetQuantity(), UA_CANCEL, and UA_ERROR.

Execute()

override int Execute ( ActionData  action_data )

inlineprivate

References CalcAndSetQuantity(), Class::CastTo(), CABase::m_Action, m_ItemQuantity, m_QuantityFilledPerSecond, m_SourceQuantity, m_SpentQuantity, m_TargetUnits, CAContinuousBase::OnCompletePogress(), ActionBase::SendMessageToClient(), float::ToString(), UA_ERROR, UA_FINISHED, and UA_PROCESSING.

GetProgress()

override float GetProgress ( )

inlineprivate

References m_QuantityFilledPerSecond, m_SpentQuantity, and m_TimeToComplete.

Setup()

override void Setup ( ActionData  action_data )

inlineprivate

References Class::CastTo(), m_ItemQuantity, m_QuantityFilledPerSecond, m_SourceQuantity, m_SpentQuantity, m_SpentUnits, m_TargetUnits, m_TimeToComplete, and Math::Min().

Field Documentation

m_ItemQuantity

protected float m_ItemQuantity

private

Referenced by Execute(), and Setup().

m_QuantityFilledPerSecond

protected float m_QuantityFilledPerSecond

private

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

m_SourceQuantity

protected float m_SourceQuantity

private

Referenced by Execute(), and Setup().

m_SpentQuantity

protected float m_SpentQuantity

private

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

m_SpentUnits

protected ref Param1<float> m_SpentUnits

private

Referenced by CalcAndSetQuantity(), and Setup().

m_TargetUnits

protected float m_TargetUnits

private

Referenced by Execute(), and Setup().

m_TimeToComplete

protected float m_TimeToComplete

private

Referenced by GetProgress(), and Setup().

---

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

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