RainProcurementComponentBase Class Reference

Private Member Functions
void	RainProcurementComponentBase (ItemBase procuringItem)
void	StartRainProcurement ()
	Called on server to queue rain procurement (on next cycle end)
void	StopRainProcurement ()
	Called on server to queue rain procurement removal (on next cycle end)
void	OnUpdate (float deltaTime, float amount)
protected void	Reset ()
protected void	ProcureLiquid (float amountBase, int liquidType=LIQUID_CLEANWATER)
protected void	UpdateIsUnderRoof ()
float	GetBaseLiquidAmount ()
	override this to get different amount per ProcureLiquid cycle
bool	IsActive ()
void	SetActive (bool run)

Private Attributes
protected ItemBase	m_ProcuringItem
protected RainProcurementHandler	m_Handler
protected bool	m_IsUnderRoof
protected bool	m_IsActive
protected int	m_UpdateCounter
protected const int	UPDATE_ROOFCHECK_COUNT = 3

Constructor & Destructor Documentation

RainProcurementComponentBase()

void RainProcurementComponentBase ( ItemBase  procuringItem )

inlineprivate

References GetGame(), m_Handler, m_ProcuringItem, and Reset().

Member Function Documentation

GetBaseLiquidAmount()

float GetBaseLiquidAmount ( )

inlineprivate

override this to get different amount per ProcureLiquid cycle

References GameConstants::LIQUID_RAIN_AMOUNT_COEF_BASE.

Referenced by ProcureLiquid().

IsActive()

bool IsActive ( )

inlineprivate

References m_IsActive.

Referenced by StopRainProcurement().

OnUpdate()

void OnUpdate ( float  deltaTime, float  amount  )

inlineprivate

References m_UpdateCounter, ProcureLiquid(), UPDATE_ROOFCHECK_COUNT, and UpdateIsUnderRoof().

ProcureLiquid()

protected void ProcureLiquid ( float  amountBase, int  liquidType = LIQUID_CLEANWATER  )

inlineprivate

References GetBaseLiquidAmount(), m_IsUnderRoof, and m_ProcuringItem.

Referenced by OnUpdate().

Reset()

protected void Reset ( )

inlineprivate

References m_UpdateCounter.

Referenced by RainProcurementComponentBase(), SetActive(), and StartRainProcurement().

SetActive()

void SetActive ( bool  run )

inlineprivate

References m_IsActive, and Reset().

StartRainProcurement()

void StartRainProcurement ( )

inlineprivate

Called on server to queue rain procurement (on next cycle end)

References m_Handler, RainProcurementHandler::QueueStart(), Reset(), and SetActive().

Referenced by Barrel_ColorBase::Open(), and Barrel_ColorBase::OpenLoad().

StopRainProcurement()

void StopRainProcurement ( )

inlineprivate

Called on server to queue rain procurement removal (on next cycle end)

References IsActive(), m_Handler, RainProcurementHandler::QueueStop(), and SetActive().

Referenced by Barrel_ColorBase::Close(), and Barrel_ColorBase::CloseLoad().

UpdateIsUnderRoof()

protected void UpdateIsUnderRoof ( )

inlineprivate

References m_IsUnderRoof, and m_ProcuringItem.

Referenced by OnUpdate().

Field Documentation

m_Handler

protected RainProcurementHandler m_Handler

private

Referenced by RainProcurementComponentBase(), StartRainProcurement(), and StopRainProcurement().

m_IsActive

protected bool m_IsActive

private

Referenced by IsActive(), and SetActive().

m_IsUnderRoof

protected bool m_IsUnderRoof

private

Referenced by ProcureLiquid(), and UpdateIsUnderRoof().

m_ProcuringItem

protected ItemBase m_ProcuringItem

private

Referenced by ProcureLiquid(), RainProcurementComponentBase(), and UpdateIsUnderRoof().

m_UpdateCounter

protected int m_UpdateCounter

private

Referenced by OnUpdate(), and Reset().

UPDATE_ROOFCHECK_COUNT

protected const int UPDATE_ROOFCHECK_COUNT = 3

private

Referenced by OnUpdate().

---

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

• P:/scripts/4_World/Classes/RainProcurementComponent.c