ef2gamesource/dlls/game/mp_modeCtf.hpp

//-----------------------------------------------------------------------------
//
//  $Logfile:: /Code/DLLs/game/teamArena.h                                    $
// $Revision:: 20                                                             $
//   $Author:: Steven                                                         $
//     $Date:: 7/17/02 4:00p                                                  $
//
// Copyright (C) 2002 by Ritual Entertainment, Inc.
// All rights reserved.
//
// This source may not be distributed and/or modified without
// expressly written permission by Ritual Entertainment, Inc.
// 
// 
// Description:
//

#ifndef __MP_MODECTF_HPP__
#define __MP_MODECTF_HPP__

#include "mp_modeTeamBase.hpp"

class MultiplayerPlayerCtfData
{
public:
	int					_hasFlag;
	EntityPtr			_carriedFlag;
	MultiplayerItem *	_flag;

	MultiplayerPlayerCtfData() { _hasFlag = false; }
	void				init( void ) { _hasFlag = false; }
};

class CtfFlag
{
public:
	MultiplayerItem	*		_tempFlag;
	float					_tempFlagTime;
	MultiplayerItem	*		_realFlag;
	str						_teamName;
};

//---------------------------------------------------------------------
// ModeCaptureTheFlag -- Capture the Flag Multiplayer.  Classic CTF
//                        style gameplay.
//---------------------------------------------------------------------
//CLASS_ARENA( ModeCaptureTheFlag );
class ModeCaptureTheFlag : public ModeTeamBase
	{
	private:
		static const float					_maxGuardingDist;
		static const float					_ctfCapturePoints;
		static const float					_maxDroppedFlagTime;

		static const int					_pointsForFlagReturn;
		static const int					_pointsForKillingFlagCarrier;
		static const int					_pointsForAssist;
		static const int					_pointsForDefense;
		static const int					_pointsForTakingTheFlag;
		static const int					_pointsForCapturingTheFlag;

		Team*                               _redTeam;
		Team*                               _blueTeam;

		Container<CtfFlag>					_flags;

		MultiplayerPlayerCtfData			*_playerCtfData;

		int									_flagCarrierIconIndex;

		int									_oneFlagTakenIconIndex;
		int									_oneFlagMissingIconIndex;
		int									_oneFlagInBaseIconIndex;

		int									_redFlagTakenIconIndex;
		int									_redFlagMissingIconIndex;
		int									_redFlagInBaseIconIndex;

		int									_blueFlagTakenIconIndex;
		int									_blueFlagMissingIconIndex;
		int									_blueFlagInBaseIconIndex;

	protected:
		///* virtual */ void					_endMatch();    // Notifies teams of end of match

		void								grabTheFlag( Player *player, MultiplayerItem *item );
		void								score( Player *player );
		void								putFlagBack( Player *player );

		CtfFlag *							findFlag( MultiplayerItem *item );
		float								findNearestTeamFlagDist( const str &teamName, const Vector &position );
		float								findNearestTeamFlagCarrierDist( const str &teamName, const Vector &position );

		void								returnFlag( MultiplayerItem *item, Player *player );
		void								dropFlag( Player *player );
		void								attachFlag( Player *player, Entity *obj );

	public:
		CLASS_PROTOTYPE( ModeCaptureTheFlag );

											ModeCaptureTheFlag();
											~ModeCaptureTheFlag();

		/* virtual */ void					init( int maxPlayers );

		/* virtual */ bool					shouldKeepItem( MultiplayerItem *item );
		/* virtual */ void					itemKept( MultiplayerItem *item );

		/* virtual */ void					RemovePlayer( Player *player );

		/* virtual */ void					addPlayerToTeam( Player *player, Team *team );

		void								playerKilled( Player *killedPlayer, Player *attackingPlayer, Entity *inflictor, int meansOfDeath );
		/* virtual */ void					itemTouched( Player *player, MultiplayerItem *item );

		bool								isEndOfMatch( void );

		virtual int							getStat( Player *player, int statNum, int value );
		/* virtual */ int					getIcon( Player *player, int statNum, int value );
		/* virtual */ int					getScoreIcon( Player *player, int index, int value );

		/* virtual */ void					setupMultiplayerUI( Player *player );

		/* virtual */ void					score( const Player *player );

		/* virtual */ void					update( float frameTime );

		/* virtual */ bool					checkGameType( const char *rule );
		/* virtual */ bool					doesPlayerHaveItem( Player *player, const char *itemName );

		/* virtual */ void					playerEventNotification( const char *eventName, const char *eventItemName, Player *eventPlayer );

		/* virtual */ void					playerChangedModel( Player *player );
	};

#endif // __MP_MODECTF_HPP__