ef2gamesource/dlls/game/rangedCombatWithWeapon.hpp

//-----------------------------------------------------------------------------
//
//  $Logfile:: /Code/DLLs/game/rangedCombatWithWeapon.hpp					  $
// $Revision:: 169                                                            $
//   $Author:: Bschofield                                                     $
//     $Date:: 4/26/02 2:22p                                                  $
//
// 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:
// GeneralCombatWithMeleeWeapon Behavior Definition
//
//--------------------------------------------------------------------------------

//==============================
// Forward Declarations
//==============================
class GeneralCombatWithRangedWeapon;

#ifndef __RANGEDCOMBAT_WITH_WEAPON_HPP__
#define __RANGEDCOMBAT_WITH_WEAPON_HPP__

#include "behavior.h"
#include "behaviors_general.h"
#include "generalCombatWithRangedWeapon.hpp"
#include "corridorCombatWithRangedWeapon.hpp"
#include "coverCombatWithRangedWeapon.hpp"
#include "selectBestWeapon.hpp"


//------------------------- CLASS ------------------------------
//
// Name:          RangedCombatWithWeapon
// Base Class:    Behavior
//
// Description:   Template that can be copied and pasted to
//                generate new behavior
//
// Method of Use: State machine or another behavior
//--------------------------------------------------------------

class RangedCombatWithWeapon : public Behavior {
	public:
	//------------------------------------
	// States
	//------------------------------------
	typedef enum {
		RCWW_EVALUATE_OPTIONS,
		RCWW_CHANGE_WEAPON,
		RCWW_GENERAL_COMBAT,
		RCWW_CORRIDOR_COMBAT,
		RCWW_COVER_COMBAT,
		RCWW_FAILED,
	} RangedCombatWithWeapon_t;


	//-------------------------------------
	// Public Interface
	//-------------------------------------	
	CLASS_PROTOTYPE(RangedCombatWithWeapon);

	RangedCombatWithWeapon();
	~RangedCombatWithWeapon();

	void SetArgs(Event* ev);
	void AnimDone(Event* ev);
	void PostureDone(Event* ev);

	void Begin(Actor& self);
	BehaviorReturnCode_t Evaluate(Actor& self);
	void End(Actor& self);

	virtual void Archive(Archiver& arc);

	// Mutators       
	void SetFireAnim(const str& anim);

	protected:
	//-------------------------------------
	// Internal Functionality
	//-------------------------------------
	void transitionToState(RangedCombatWithWeapon_t state);
	void setInternalState(RangedCombatWithWeapon_t state, const str& stateName);
	void init(Actor& self);
	void think();
	void updateEnemy();

	bool checkShouldDoCorridorCombat();
	bool checkShouldDoGeneralCombat();
	bool checkShouldDoCoverCombat();
	bool checkShouldCheckWeapon();

	void setupStateEvaluateOptions();
	BehaviorReturnCode_t evaluateStateEvaluateOptions();
	void failureStateEvaluateOptions();

	void setupStateChangeWeapon();
	BehaviorReturnCode_t evaluateStateChangeWeapon();
	void failureStateChangeWeapon();

	void setupStateGeneralCombat();
	BehaviorReturnCode_t evaluateStateGeneralCombat();
	void failureStateGeneralCombat();

	void setupStateCoverCombat();
	BehaviorReturnCode_t evaluateStateCoverCombat();
	void failureStateCoverCombat();

	void setupStateCorridorCombat();
	BehaviorReturnCode_t evaluateStateCorridorCombat();
	void failureStateCorridorCombat();

	private:
	//------------------------------------
	// Parameters
	//------------------------------------
	str _aimAnim;       // --Animation used to aim the weapon
	str _fireAnim;		// --The animation used to fire the weapon
	float _approachDist;
	float _retreatDist;
	float _strafeChance;
	float _postureChangeChance;

	//-------------------------------------
	// Member Variables
	//-------------------------------------
	// Component Behaviors
	CloseInOnEnemy _gotoEnemy;
	GeneralCombatWithRangedWeapon _generalCombat;
	CorridorCombatWithRangedWeapon _corridorCombat;
	CoverCombatWithRangedWeapon _coverCombat;
	SelectBestWeapon _selectBestWeapon;

	// Member Vars
	int _state;          //-- Maintains our Behavior's current State
	Actor* _self;
	EntityPtr _currentEnemy;
	float _nextSelectWeaponTime;
	float _recheckTime;
	// Constants
};


inline void RangedCombatWithWeapon::Archive(Archiver& arc) {
	Behavior::Archive(arc);

	// Archive Parameters
	arc.ArchiveString(&_aimAnim);
	arc.ArchiveString(&_fireAnim);
	arc.ArchiveFloat(&_approachDist);
	arc.ArchiveFloat(&_retreatDist);
	arc.ArchiveFloat(&_strafeChance);
	arc.ArchiveFloat(&_postureChangeChance);

	// Archive Components
	arc.ArchiveObject(&_gotoEnemy);
	arc.ArchiveObject(&_generalCombat);
	arc.ArchiveObject(&_corridorCombat);
	arc.ArchiveObject(&_coverCombat);
	arc.ArchiveObject(&_selectBestWeapon);

	// Archive Member Variables
	arc.ArchiveInteger(&_state);
	arc.ArchiveObjectPointer((Class **)&_self);
	arc.ArchiveSafePointer(&_currentEnemy);
	arc.ArchiveFloat(&_nextSelectWeaponTime);
	arc.ArchiveFloat(&_recheckTime);
}

inline void RangedCombatWithWeapon::SetFireAnim(const str &anim) {
	_fireAnim = anim;
}

#endif /* __RANGEDCOMBAT_WITH_WEAPON_HPP__ */