Класс CAContinuousWaterSlot

Граф наследования:CAContinuousWaterSlot:

Защищенные члены
void	CAContinuousWaterSlot (float quantity_used_per_second)
override void	Setup (ActionData action_data)
override int	Execute (ActionData action_data)
override float	GetProgress ()

Защищенные данные
float	m_PlantThirstyness
float	m_TimeToComplete
float	m_SpentQuantityTotal
float	m_StartQuantity
Slot	m_Slot

Дополнительные унаследованные члены
Закрытые члены унаследованные от 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)
Закрытые данные унаследованные от CAContinuousQuantity
float	m_ItemQuantity
float	m_SpentQuantity
float	m_ItemMaxQuantity
float	m_QuantityUsedPerSecond
float	m_AdjustedQuantityUsedPerSecond
ref Param1< float >	m_SpentUnits

Подробное описание

Конструктор(ы)

CAContinuousWaterSlot()

void CAContinuousWaterSlot ( float quantity_used_per_second )

inlineprotected

    {
        m_QuantityUsedPerSecond = quantity_used_per_second;
    }

Перекрестные ссылки CAContinuousQuantity::m_QuantityUsedPerSecond.

Методы

Execute()

override int Execute ( ActionData action_data )

inlineprotected

    {
        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();
                if (m_SpentQuantity > m_ItemQuantity)   // dont transfer more water than the source's quantity
                    m_SpentQuantity = m_ItemQuantity;
                
                m_Slot.GiveWater( m_SpentQuantity );
                
                m_SpentQuantityTotal += m_SpentQuantity;
                CalcAndSetQuantity( action_data );
                
                m_SpentQuantity = 0;
                
                return UA_PROCESSING;
            }
            else
            {
                CalcAndSetQuantity( action_data );
                OnCompletePogress( action_data );
                
                return UA_FINISHED;
            }
        }
    }

Перекрестные ссылки CalcAndSetQuantity(), Class::CastTo(), CAContinuousQuantity::m_ItemMaxQuantity, CAContinuousQuantity::m_ItemQuantity, CAContinuousQuantity::m_QuantityUsedPerSecond, m_Slot, CAContinuousQuantity::m_SpentQuantity, m_SpentQuantityTotal, CAContinuousBase::OnCompletePogress(), UA_ERROR, UA_FINISHED и UA_PROCESSING.

GetProgress()

override float GetProgress ( )

inlineprotected

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

Перекрестные ссылки CAContinuousQuantity::m_ItemQuantity, m_SpentQuantityTotal и m_StartQuantity.

Setup()

override void Setup ( ActionData action_data )

inlineprotected

    {
        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;
            }
        }
    }

Перекрестные ссылки Class::CastTo(), CAContinuousQuantity::m_ItemQuantity, m_PlantThirstyness, CAContinuousQuantity::m_QuantityUsedPerSecond, m_Slot, CAContinuousQuantity::m_SpentQuantity, CAContinuousQuantity::m_SpentUnits, m_StartQuantity, m_TimeToComplete и Math::Min().

Поля

m_PlantThirstyness

float m_PlantThirstyness

protected

Используется в Setup().

m_Slot

Slot m_Slot

protected

Используется в Execute() и Setup().

m_SpentQuantityTotal

float m_SpentQuantityTotal

protected

Используется в Execute() и GetProgress().

m_StartQuantity

float m_StartQuantity

protected

Используется в GetProgress() и Setup().

m_TimeToComplete

float m_TimeToComplete

protected

Используется в Setup().

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/4_World/Classes/UserActionsComponent/ActionComponents/CAContinuousWaterSlot.c