GeneralsZeroHour/GeneralsMD/Code/GameEngine/Include/GameLogic/Module/ObjectHelper.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: ObjectHelper.h ///////////////////////////////////////////////////////////////////////////
// Author: Steven Johnson, Colin Day - September 202
// Desc:   Object helpder
///////////////////////////////////////////////////////////////////////////////////////////////////

#pragma once

#ifndef __OBJECT_HELPER_H_
#define __OBJECT_HELPER_H_

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

// ------------------------------------------------------------------------------------------------
// ------------------------------------------------------------------------------------------------
class ObjectHelper : public UpdateModule
{

	MEMORY_POOL_GLUE_ABC( ObjectHelper )

protected:

	// snapshot methods
	virtual void crc( Xfer *xfer );
	virtual void xfer( Xfer *xfer );
	virtual void loadPostProcess( void );

public:

	ObjectHelper( Thing *thing, const ModuleData *modData ) : 
		UpdateModule( thing, modData ) 
	{ 
		setWakeFrame(getObject(), UPDATE_SLEEP_FOREVER);
	}

	// inherited from UpdateModuleInterface
	virtual UpdateSleepTime update() = 0;

	// custom to this class.
	void sleepUntil(UnsignedInt when);

};

#endif  // end __OBJECT_HELPER_H_