CAContinuousTime Class Reference

Inheritance diagram for CAContinuousTime:

Collaboration diagram for CAContinuousTime:

Protected Member Functions
void	CAContinuousTime (float time_to_complete_action)
override void	Setup (ActionData action_data)
override int	Execute (ActionData action_data)
override int	Cancel (ActionData action_data)
override float	GetProgress ()

Protected Attributes
float	m_LocalTimeElpased
float	m_TimeElpased
float	m_AdjustedTimeToComplete
float	m_DefaultTimeToComplete
ref Param1< float >	m_SpentUnits

Detailed Description

Definition at line 1 of file CAContinuousTime.c.

Constructor & Destructor Documentation

CAContinuousTime()

void CAContinuousTime::CAContinuousTime ( float time_to_complete_action )

inlineprotected

Definition at line 9 of file CAContinuousTime.c.

  {
    m_DefaultTimeToComplete = time_to_complete_action;
  }

References m_DefaultTimeToComplete.

Member Function Documentation

Cancel()

override int CAContinuousTime::Cancel ( ActionData action_data )

inlineprotected

Definition at line 50 of file CAContinuousTime.c.

  {
    if (m_SpentUnits)
    {
      m_SpentUnits.param1 = m_TimeElpased;
      SetACData(m_SpentUnits);
    }
    if (m_DefaultTimeToComplete < 0) //for infinite actions
      return UA_FINISHED;
 
    return UA_CANCEL;
  }

References m_DefaultTimeToComplete, m_SpentUnits, m_TimeElpased, CABase::SetACData(), UA_CANCEL, and UA_FINISHED.

Execute()

override int CAContinuousTime::Execute ( ActionData action_data )

inlineprotected

Definition at line 25 of file CAContinuousTime.c.

  {
    if (m_DefaultTimeToComplete < 0) //for infinite actions
      return UA_PROCESSING;
 
    if (!action_data.m_Player)
      return UA_ERROR;
 
    if (m_TimeElpased < m_AdjustedTimeToComplete)
    {
      m_TimeElpased += action_data.m_Player.GetDeltaT();
      return UA_PROCESSING;
    }
    else
    {
      if (m_SpentUnits)
      {
        m_SpentUnits.param1 = m_TimeElpased;
        SetACData(m_SpentUnits);
      }
      OnCompletePogress(action_data);
      return UA_FINISHED;
    }
  }

References m_AdjustedTimeToComplete, m_DefaultTimeToComplete, m_SpentUnits, m_TimeElpased, CAContinuousBase::OnCompletePogress(), CABase::SetACData(), UA_ERROR, UA_FINISHED, and UA_PROCESSING.

GetProgress()

override float CAContinuousTime::GetProgress ( )

inlineprotected

Definition at line 63 of file CAContinuousTime.c.

  {
    if (m_AdjustedTimeToComplete != 0)
    {
      //progress = m_TimeElpased/m_AdjustedTimeToComplete;
      return m_TimeElpased / m_AdjustedTimeToComplete;
    }
    else
      Print("USER ACTION COMPONENT CONTINUOUS TIME - WRONG TIME TO COMPLETE CALCULATION - Incorrect data for progress bar!");
    return 1;
  }

References m_AdjustedTimeToComplete, m_TimeElpased, and Print().

Setup()

override void CAContinuousTime::Setup ( ActionData action_data )

inlineprotected

Definition at line 14 of file CAContinuousTime.c.

  {
    m_TimeElpased = 0;
    if (!m_SpentUnits)
      m_SpentUnits = new Param1<float>(0);
    else
      m_SpentUnits.param1 = 0;
 
    m_AdjustedTimeToComplete = action_data.m_Player.GetSoftSkillsManager().SubtractSpecialtyBonus(m_DefaultTimeToComplete, m_Action.GetSpecialtyWeight(), true);
  }

References CABase::m_Action, m_AdjustedTimeToComplete, m_DefaultTimeToComplete, m_SpentUnits, and m_TimeElpased.

Member Data Documentation

m_AdjustedTimeToComplete

float CAContinuousTime::m_AdjustedTimeToComplete

protected

Definition at line 5 of file CAContinuousTime.c.

Referenced by CAContinuousCraft::Execute(), Execute(), CAContinuousCraft::GetProgress(), GetProgress(), CAContinuousCraft::Setup(), and Setup().

m_DefaultTimeToComplete

float CAContinuousTime::m_DefaultTimeToComplete

protected

Definition at line 6 of file CAContinuousTime.c.

Referenced by CAContinuousTime(), Cancel(), Execute(), and Setup().

m_LocalTimeElpased

float CAContinuousTime::m_LocalTimeElpased

protected

Definition at line 3 of file CAContinuousTime.c.

m_SpentUnits

ref Param1<float> CAContinuousTime::m_SpentUnits

protected

Definition at line 7 of file CAContinuousTime.c.

Referenced by Cancel(), CAContinuousCraft::Execute(), Execute(), CAContinuousCraft::Setup(), and Setup().

m_TimeElpased

float CAContinuousTime::m_TimeElpased

protected

Definition at line 4 of file CAContinuousTime.c.

Referenced by Cancel(), CAContinuousCraft::Execute(), Execute(), CAContinuousCraft::GetProgress(), GetProgress(), CAContinuousCraft::Setup(), and Setup().

---

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

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