GeneralsZeroHour/GeneralsMD/Code/GameEngine/Include/GameLogic/Module/PowerPlantUpdate.h

/*
**	Command & Conquer Generals Zero Hour(tm)
**	Copyright 2025 Electronic Arts Inc.
**
**	This program is free software: you can redistribute it and/or modify
**	it under the terms of the GNU General Public License as published by
**	the Free Software Foundation, either version 3 of the License, or
**	(at your option) any later version.
**
**	This program is distributed in the hope that it will be useful,
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**	GNU General Public License for more details.
**
**	You should have received a copy of the GNU General Public License
**	along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

////////////////////////////////////////////////////////////////////////////////
//																																						//
//  (c) 2001-2003 Electronic Arts Inc.																				//
//																																						//
////////////////////////////////////////////////////////////////////////////////

// FILE: PowerPlantUpdate.h ////////////////////////////////////////////////////////////////////////////
// Author: Amit Kumar, August 2002
// Desc:   Updating the power plant
///////////////////////////////////////////////////////////////////////////////////////////////////

#pragma once

#ifndef __POWERPLANTUPDATE_H_
#define __POWERPLANTUPDATE_H_

// USER INCLUDES //////////////////////////////////////////////////////////////////////////////////
#include "GameLogic/Module/UpdateModule.h"

//-------------------------------------------------------------------------------------------------
//-------------------------------------------------------------------------------------------------
class PowerPlantUpdateModuleData : public UpdateModuleData
{

public:

	PowerPlantUpdateModuleData( void );

	static void buildFieldParse(MultiIniFieldParse& p) 
	{
    UpdateModuleData::buildFieldParse( p );

		static const FieldParse dataFieldParse[] = 
		{

			{ "RodsExtendTime", INI::parseDurationUnsignedInt, NULL, offsetof( PowerPlantUpdateModuleData, m_rodsExtendTime ) },
			{ 0, 0, 0, 0 }
		};
    p.add(dataFieldParse);

	}

  UnsignedInt m_rodsExtendTime;  ///< in frames, time it takes the rods to be built

};

// ------------------------------------------------------------------------------------------------
// ------------------------------------------------------------------------------------------------
class PowerPlantUpdateInterface
{

public:

	virtual void extendRods( Bool extend ) = 0;

};

//-------------------------------------------------------------------------------------------------
/** The Power Plant Update module */
//-------------------------------------------------------------------------------------------------
class PowerPlantUpdate : public UpdateModule,
												 public PowerPlantUpdateInterface
{

	MEMORY_POOL_GLUE_WITH_USERLOOKUP_CREATE( PowerPlantUpdate, "PowerPlantUpdate" )
	MAKE_STANDARD_MODULE_MACRO_WITH_MODULE_DATA( PowerPlantUpdate, PowerPlantUpdateModuleData );

public:

	PowerPlantUpdate( Thing *thing, const ModuleData* moduleData );
	// virtual destructor prototype defined by MemoryPoolObject

	// interface housekeeping
	virtual PowerPlantUpdateInterface* getPowerPlantUpdateInterface() { return this; }

	void extendRods( Bool extend );									 ///< extend the rods from this object
	virtual UpdateSleepTime update( void ); ///< Here's the actual work of Upgrading

protected:

	Bool m_extended;										 ///< TRUE when extend is all done

};

#endif  // end __POWERPLANTUPDATE_H_