ReGameDLL_CS/regamedll/dlls/tutor_cs_tutor.h

/*
*
*   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 2 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, write to the Free Software Foundation,
*   Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*
*   In addition, as a special exception, the author gives permission to
*   link the code of this program with the Half-Life Game Engine ("HL
*   Engine") and Modified Game Libraries ("MODs") developed by Valve,
*   L.L.C ("Valve").  You must obey the GNU General Public License in all
*   respects for all of the code used other than the HL Engine and MODs
*   from Valve.  If you modify this file, you may extend this exception
*   to your version of the file, but you are not obligated to do so.  If
*   you do not wish to do so, delete this exception statement from your
*   version.
*
*/

#ifndef TUTOR_CS_TUTOR_H
#define TUTOR_CS_TUTOR_H
#ifdef _WIN32
#pragma once
#endif

#include <map>
#include <vector>

enum TutorMessageClass
{
	TUTORMESSAGECLASS_NORMAL = 0,
	TUTORMESSAGECLASS_EXAMINE,
};

enum TutorMessageType
{
	TUTORMESSAGETYPE_DEFAULT = (1<<0),
	TUTORMESSAGETYPE_FRIEND_DEATH = (1<<1),
	TUTORMESSAGETYPE_ENEMY_DEATH = (1<<2),
	TUTORMESSAGETYPE_SCENARIO = (1<<3),
	TUTORMESSAGETYPE_BUY = (1<<4),
	TUTORMESSAGETYPE_CAREER = (1<<5),
	TUTORMESSAGETYPE_HINT = (1<<6),
	TUTORMESSAGETYPE_INGAME_HINT = (1<<7),
	TUTORMESSAGETYPE_END_GAME = (1<<8),
	TUTORMESSAGETYPE_LAST,
	TUTORMESSAGETYPE_ALL = 511
};

enum TutorMessageInterruptFlag
{
	TUTORMESSAGEINTERRUPTFLAG_DEFAULT = 0,
	TUTORMESSAGEINTERRUPTFLAG_NOW_DAMMIT,
};

enum TutorMessageKeepOldType
{
	TUTORMESSAGEKEEPOLDTYPE_DONT_KEEP_OLD = 0,
	TUTORMESSAGEKEEPOLDTYPE_KEEP_OLD,
	TUTORMESSAGEKEEPOLDTYPE_UPDATE_CONTENT,
};

struct TutorMessage
{
	char *m_text;
	unsigned char m_priority;
	unsigned char m_duration;
	TutorMessageKeepOldType m_keepOld;
	TutorMessageClass m_class;
	unsigned char m_decay;
	TutorMessageType m_type;
	int m_lifetime;
	TutorMessageInterruptFlag m_interruptFlag;
	int m_duplicateID;
	float m_examineStartTime;
	int m_timesShown;
	float m_minDisplayTimeOverride;
	float m_minRepeatInterval;
	float m_lastCloseTime;

};/* size: 56, cachelines: 1, members: 15 */

struct TutorMessageEventParam
{
	char *m_data;
	TutorMessageEventParam *m_next;

};/* size: 8, cachelines: 1, members: 2 */

enum TutorMessageID
{
	YOU_FIRED_A_SHOT,
	YOU_SHOULD_RELOAD,
	YOU_ARE_OUT_OF_AMMO,
	YOU_KILLED_A_TEAMMATE,
	YOU_KILLED_PLAYER,
	YOU_KILLED_PLAYER_ONE_LEFT,
	YOU_KILLED_LAST_ENEMY,
	YOU_KILLED_PLAYER_HEADSHOT,
	YOU_KILLED_PLAYER_HEADSHOT_ONE_LEFT,
	YOU_KILLED_LAST_ENEMY_HEADSHOT,
	YOU_DIED,
	YOU_DIED_HEADSHOT,
	YOU_FELL_TO_YOUR_DEATH,
	YOU_WERE_JUST_HURT,
	YOU_ARE_BLIND_FROM_FLASHBANG,
	YOU_ATTACKED_TEAMMATE,
	BUY_TIME_BEGIN,
	BOMB_PLANTED_T,
	BOMB_PLANTED_CT,
	TEAMMATE_KILLED,
	TEAMMATE_KILLED_ONE_LEFT,
	LAST_TEAMMATE_KILLED,
	ENEMY_KILLED,
	ENEMY_KILLED_ONE_LEFT,
	LAST_ENEMY_KILLED,
	YOU_SPAWNED,
	YOU_SEE_FRIEND,
	YOU_SEE_ENEMY,
	YOU_SEE_FRIEND_CORPSE,
	YOU_SEE_ENEMY_CORPSE,
	YOU_SEE_LOOSE_BOMB_T,
	YOU_SEE_LOOSE_BOMB_CT,
	YOU_SEE_BOMB_CARRIER_T,
	YOU_SEE_BOMB_CARRIER_CT,
	YOU_SEE_PLANTED_BOMB_T,
	YOU_SEE_PLANTED_BOMB_CT,
	YOU_ARE_BOMB_CARRIER,
	YOU_SEE_LOOSE_WEAPON,
	YOU_SEE_LOOSE_DEFUSER,
	YOU_SEE_BOMBSITE_T,
	YOU_SEE_BOMBSITE_CT,
	YOU_SEE_BOMBSITE_T_BOMB,
	YOU_SEE_HOSTAGE_T,
	YOU_SEE_HOSTAGE_CT,
	YOU_SEE_HOSTAGE_CT_EXAMINE,
	YOU_USED_HOSTAGE_MORE_LEFT,
	YOU_USED_HOSTAGE_NO_MORE_LEFT,
	ALL_HOSTAGES_FOLLOWING_T,
	ALL_HOSTAGES_FOLLOWING_CT,
	HOSTAGE_RESCUED_T,
	HOSTAGE_RESCUED_CT,
	YOU_RESCUED_HOSTAGE,
	YOU_ARE_IN_BOMBSITE_T,
	YOU_ARE_IN_BOMBSITE_CT,
	YOU_ARE_IN_BOMBSITE_T_BOMB,
	ALL_HOSTAGES_RESCUED_T,
	ALL_HOSTAGES_RESCUED_CT,
	YOU_DAMAGED_HOSTAGE,
	YOU_KILLED_HOSTAGE,
	ALL_HOSTAGES_DEAD,
	YOU_HAVE_BEEN_SHOT_AT,
	TIME_RUNNING_OUT_DE_T,
	TIME_RUNNING_OUT_DE_CT,
	TIME_RUNNING_OUT_CS_T,
	TIME_RUNNING_OUT_CS_CT,
	DEFUSING_WITHOUT_KIT,
	BOMB_DEFUSED_T,
	BOMB_DEFUSED_CT,
	YOU_DEFUSED_BOMB,
	BOMB_EXPLODED_T,
	BOMB_EXPLODED_CT,
	ROUND_START_DE_T,
	ROUND_START_DE_CT,
	ROUND_START_CS_T,
	ROUND_START_CS_CT,
	ROUND_OVER,
	ROUND_DRAW,
	CT_WIN,
	T_WIN,
	DEATH_CAMERA_START,
	RADIO_COVER_ME,
	RADIO_YOU_TAKE_THE_POINT,
	RADIO_HOLD_THIS_POSITION,
	RADIO_REGROUP_TEAM,
	RADIO_FOLLOW_ME,
	RADIO_TAKING_FIRE,
	RADIO_GO_GO_GO,
	RADIO_TEAM_FALL_BACK,
	RADIO_STICK_TOGETHER_TEAM,
	RADIO_GET_IN_POSITION_AND_WAIT,
	RADIO_STORM_THE_FRONT,
	RADIO_REPORT_IN_TEAM,
	RADIO_AFFIRMATIVE,
	RADIO_ENEMY_SPOTTED,
	RADIO_NEED_BACKUP,
	RADIO_SECTOR_CLEAR,
	RADIO_IN_POSITION,
	RADIO_REPORTING_IN,
	RADIO_GET_OUT_OF_THERE,
	RADIO_NEGATIVE,
	RADIO_ENEMY_DOWN,
	BUY_NEED_PRIMARY,
	BUY_NEED_PRIMARY_AMMO,
	BUY_NEED_SECONDARY_AMMO,
	BUY_NEED_ARMOR,
	BUY_NEED_DEFUSE_KIT,
	BUY_NEED_GRENADE,
	CAREER_TASK_DONE_MORE_LEFT,
	CAREER_TASK_DONE_ONE_LEFT,
	CAREER_TASK_DONE_ALL_DONE,
	HINT_BEGIN,
	HINT_1,
	HINT_2,
	HINT_3,
	HINT_4,
	HINT_5,
	HINT_10,
	HINT_11,
	HINT_12,
	HINT_13,
	HINT_14,
	HINT_15,
	HINT_20,
	HINT_21,
	HINT_22,
	HINT_23,
	HINT_24,
	HINT_25,
	HINT_26,
	HINT_30,
	HINT_31,
	HINT_32,
	HINT_33,
	HINT_34,
	HINT_40,
	HINT_50,
	HINT_51,
	HINT_52,
	HINT_53,
	HINT_BOMB_START,
	HINT_60 = 139,
	HINT_61,
	HINT_BOMB_END = 140,
	HINT_HOSTAGE_START,
	HINT_70 = 141,
	HINT_71,
	HINT_72,
	HINT_73,
	HINT_HOSTAGE_END = 144,
	HINT_END,
	INGAME_HINT_BEGIN,
	INGAME_HINT_1,
	INGAME_HINT_2,
	INGAME_HINT_END,
	TUTOR_NUM_MESSAGES
};

//typedef map<std::basic_string<char, std::char_traits<char>, std::allocator<char> >, TutorMessage*, std::less<std::basic_string<char, std::char_traits<char>, std::allocator<char> > >, std::allocator<std::pair<const std::basic_string<char, std::char_traits<char>, std::allocator<char> >, TutorMessage*> > > TutorMessageMap;
typedef std::map<TutorMessage *, TutorMessage *> TutorMessageMap;

struct ClientCorpseStruct
{
	Vector m_position;
	int m_team;

};/* size: 16, cachelines: 1, members: 2 */

typedef std::vector<ClientCorpseStruct *> ClientCorpseList;

class CCSTutor: public CBaseTutor
{
public:
	CCSTutor(void);

	struct PlayerDeathStruct
	{
		bool m_hasBeenShown;
		TutorMessageEvent *m_event;
	};

	virtual ~CCSTutor(void);

	virtual void TutorThink(float time);
	virtual void PurgeMessages(void);
	virtual void CallEventHandler(GameEventType event, CBaseEntity *entity, CBaseEntity *other);
	virtual void ShowTutorMessage(TutorMessageEvent *event);
	virtual void HandleShotFired(Vector source, Vector target);
	virtual TutorMessage *GetTutorMessageDefinition(int messageID);

	void CreateAndAddEventToList(TutorMessageID mid, CBaseEntity *entity, CBaseEntity *other);
	TutorMessageEvent *CreateTutorMessageEvent(TutorMessageID mid, CBaseEntity *entity, CBaseEntity *other);
	void AddToEventList(TutorMessageEvent *event);
	void DeleteEventFromEventList(TutorMessageEvent *event);
	void ClearEventList(void);
	void ClearCurrentEvent(bool closeWindow, bool processDeathsForEvent);
	void DeleteEvent(TutorMessageEvent *event);
	bool ShouldShowMessageEvent(TutorMessageEvent *event, float time);
	bool ShouldUpdateCurrentMessage(TutorMessageID messageID);
	void ComputeDisplayTimesForMessage(void);
	void UpdateCurrentMessage(TutorMessageEvent *event);
	void ConstructMessageAndDisplay(void);
	void LookupHotKey(TutorMessageID mid, int paramNum, wchar_t *buf, int buflen);
	void CheckForWindowClose(float time);
	void CheckForContentUpdate(void);
	bool HasCurrentWindowBeenActiveLongEnough(float time);
	void CheckForInterruptingMessageEvent(float time);
	void CheckForInactiveEvents(float time);
	void CancelEvent(TutorMessageID mid);
	void ProcessShownDeathsForEvent(TutorMessageEvent *event);
	void TransferDeathEvents(TutorMessageEvent *oldEvent, TutorMessageEvent *newEvent);
	TutorMessageEvent *GetTutorMessageUpdateEvent(void);
	bool GetDuplicateMessagesFromEventList(const TutorMessageEvent *&event1, const TutorMessageEvent *&event2);
	bool IsBombMap(void);
	bool IsHostageMap(void);
public:
	void HandleWeaponFired(CBaseEntity *entity, CBaseEntity *other);
	void HandleWeaponFiredOnEmpty(CBaseEntity *entity, CBaseEntity *other);
	void HandleWeaponReloaded(CBaseEntity *entity, CBaseEntity *other);
	void HandlePlayerDied(CBaseEntity *entity, CBaseEntity *other);
	void HandlePlayerSpawned(CBaseEntity *entity, CBaseEntity *other);
	void HandleClientCorpseSpawned(CBaseEntity *entity, CBaseEntity *other);
	void HandlePlayerTookDamage(CBaseEntity *entity, CBaseEntity *other);
	void HandlePlayerBlindedByFlashbang(CBaseEntity *entity, CBaseEntity *other);
	void HandleBuyTimeStart(CBaseEntity *entity, CBaseEntity *other);
	void HandlePlayerLeftBuyZone(CBaseEntity *entity, CBaseEntity *other);
	void HandleBombPlanted(CBaseEntity *entity, CBaseEntity *other);
	void HandleRoundStart(CBaseEntity *entity, CBaseEntity *other);
	void HandleBombDefused(CBaseEntity *entity, CBaseEntity *other);
	void HandleBombExploded(CBaseEntity *entity, CBaseEntity *other);
	void HandleHostageUsed(CBaseEntity *entity, CBaseEntity *other);
	void HandleHostageRescued(CBaseEntity *entity, CBaseEntity *other);
	void HandleHostageDamaged(CBaseEntity *entity, CBaseEntity *other);
	void HandleHostageKilled(CBaseEntity *entity, CBaseEntity *other);
	void HandleAllHostagesRescued(CBaseEntity *entity, CBaseEntity *other);
	void HandleBeingShotAt(CBaseEntity *entity, CBaseEntity *other);
	void HandleRoundDraw(CBaseEntity *entity, CBaseEntity *other);
	void HandleCTWin(CBaseEntity *entity, CBaseEntity *other);
	void HandleTWin(CBaseEntity *entity, CBaseEntity *other);
	void HandleDeathCameraStart(CBaseEntity *entity, CBaseEntity *other);
	void HandleBombDefusing(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioCoverMe(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioYouTakeThePoint(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioHoldThisPosition(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioRegroupTeam(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioFollowMe(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioTakingFire(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioGoGoGo(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioTeamFallBack(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioStickTogetherTeam(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioGetInPositionAndWait(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioStormTheFront(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioReportInTeam(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioAffirmative(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioEnemySpotted(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioNeedBackup(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioSectorClear(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioInPosition(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioReportingIn(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioGetOutOfThere(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioNegative(CBaseEntity *entity, CBaseEntity *other);
	void HandleRadioEnemyDown(CBaseEntity *entity, CBaseEntity *other);
	void HandleBuyMenuOpenned(CBaseEntity *entity, CBaseEntity *other);
	void HandleAutoBuy(CBaseEntity *entity, CBaseEntity *other);
	void HandleNotBuyingAnything(CBaseEntity *entity, CBaseEntity *other);
	void HandleNeedToBuyPrimaryWeapon(CBaseEntity *entity, CBaseEntity *other);
	void HandleNeedToBuyPrimaryAmmo(CBaseEntity *entity, CBaseEntity *other);
	void HandleNeedToBuySecondaryAmmo(CBaseEntity *entity, CBaseEntity *other);
	void HandleNeedToBuyArmor(CBaseEntity *entity, CBaseEntity *other);
	void HandleNeedToBuyDefuseKit(CBaseEntity *entity, CBaseEntity *other);
	void HandleNeedToBuyGrenade(CBaseEntity *entity, CBaseEntity *other);
	void HandleCareerTaskDone(CBaseEntity *entity, CBaseEntity *other);

	void GetNumPlayersAliveOnTeams(int &numT, int &numCT);
	void CheckForBombViewable(void);
	void CheckForLooseWeaponViewable(void);
	void CheckForLooseDefuserViewable(void);
	void CheckForBombsiteViewable(void);
	TutorMessageID CheckForInBombZone(void);
	void CheckForHostageViewable(void);
	void CheckForTimeRunningOut(void);
	void CheckForAllHostagesDead(void);
	bool CheckForAllHostagesFollowingSomeone(void);
	void CheckHintMessages(float time);
	void CheckInGameHintMessages(float time);
	void CheckExamineMessages(float time);
	void CheckForNeedToReload(bool isPassiveCheck);
	bool CanLocalPlayerBuyStuff(void);
	void CheckBuyZoneMessages(void);
	bool IsBombPlantedInBombsite(CBaseEntity *bombTarget);
	void ReadTutorMessageFile(void);
	void ApplyPersistentDecay(void);
	CBaseEntity *GetEntityForMessageID(int messageID, CBaseEntity *last);
	void ResetPlayerDeathInfo(void);
	void ConstructRecentDeathsList(TeamName team, char *buf, int buflen, TutorMessageEvent *event);

#ifdef HOOK_GAMEDLL

	void TutorThink_(float time);
	void PurgeMessages_(void);
	void CallEventHandler_(GameEventType event, CBaseEntity *entity, CBaseEntity *other);
	void ShowTutorMessage_(TutorMessageEvent *event);
	void HandleShotFired_(Vector source, Vector target);
	TutorMessage *GetTutorMessageDefinition_(int messageID);

#endif // HOOK_GAMEDLL

private:
	float m_nextViewableCheckTime;
	TutorMessageMap m_messageMap;			// Win: 16 | Lin - 20

#ifdef HOOK_GAMEDLL
#ifdef _WIN32
	int padding1[2];
#else
	int padding1[4];
#endif // _WIN32
#endif // HOOK_GAMEDLL

	TutorMessageID m_currentlyShownMessageID;
	float m_currentlyShownMessageCloseTime;
	float m_currentlyShownMessageStartTime;
	float m_currentlyShownMessageMinimumCloseTime;
	TutorMessageEvent *m_currentMessageEvent;
	TutorMessageEvent *m_lastScenarioEvent;
	TutorMessageID m_lastHintShown;
	TutorMessageID m_lastInGameHintShown;

	ClientCorpseList m_clientCorpseList;		// Win: 16 | Lin - 12

#if defined(HOOK_GAMEDLL) && defined(_WIN32)
	int padding2;
#endif // HOOK_GAMEDLL

	int m_messageTypeMask;
	bool m_haveSpawned;
	PlayerDeathStruct m_playerDeathInfo[32];

};/* size: 356, cachelines: 6, members: 15 */

#ifdef HOOK_GAMEDLL

#define TutorIdentifierList (*pTutorIdentifierList)

#endif // HOOK_GAMEDLL

extern const char *TutorIdentifierList[150];

NOBODY void ParseMessageParameters(const char *&messageData, TutorMessage *ret);
NOBODY TutorMessage *ConstructTutorMessage(const char *&messageData, TutorMessage *defaults);
NOBODY void ReadDefaultValues(const char *&messageData, TutorMessage *defaults);

#endif // TUTOR_CS_TUTOR_H