//-----------------------------------------------------------------------------
//
//  $Logfile:: /Code/DLLs/game/gotoHelperNodeEX.hpp							 $
// $Revision:: 169															 $
//   $Author:: sketcher														 $
//     $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:
// gotoHelperNodeEX Behavior Definition
//
//--------------------------------------------------------------------------------

//==============================
// Forward Declarations
//==============================
class GotoHelperNodeEX;

#ifndef __GOTO_HELPER_NODE_EX___
#define __GOTO_HELPER_NODE_EX___

#include "behavior.h"
#include "behaviors_general.h"

//------------------------- CLASS ------------------------------
//
// Name:           GotoHelperNodeEX
// Base Class:     Behavior
//
// Description:    Moves the Actor to the closest appropriate
//				   helper node, using data from the GPDB
//
// Method of Use:  Called From State Machine
//--------------------------------------------------------------
class GotoHelperNodeEX : public Behavior {
	public:
	//------------------------------------
	// States
	//------------------------------------
	typedef enum {
		GOTO_HNODE_FIND_NODE,
		GOTO_HNODE_MOVE_TO_NODE,
		GOTO_HNODE_SUCCESS,
		GOTO_HNODE_FAILED
	} GotoHelperNodeStates_t;

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

	GotoHelperNodeEX();
	~GotoHelperNodeEX();

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

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

	// Accessors
	void SetNode(HelperNode* node);
	void SetMovementAnim(const str& anim);


	virtual void Archive(Archiver& arc);

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

	void setupStateMoveToNode();
	BehaviorReturnCode_t evaluateStateMoveToNode();
	void failureStateFindNode(const str& failureReason);

	void setupStateFindNode();
	BehaviorReturnCode_t evaluateStateFindNode();
	void failureStateMoveToNode(const str& failureReason);

	private:
	//------------------------------------
	// Parameters
	//------------------------------------
	str _nodeType;
	str _movementAnim;
	HelperNodePtr _node;
	float _maxDistance;

	//-------------------------------------
	// Components
	//-------------------------------------
	GotoPoint _gotoPoint;

	//-------------------------------------
	// Member Variables
	//-------------------------------------
	GotoHelperNodeStates_t _state;

	static const float NODE_RADIUS;

};

inline void GotoHelperNodeEX::SetNode(HelperNode* node) {
	assert(node);
	_node = node;
}

inline void	GotoHelperNodeEX::SetMovementAnim(const str& anim) {
	_movementAnim = anim;
}


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

	//
	// Archive Parameters
	//
	arc.ArchiveString(&_nodeType);
	arc.ArchiveString(&_movementAnim);
	arc.ArchiveSafePointer(&_node);
	arc.ArchiveFloat(&_maxDistance);
	//
	// Archive Components
	//
	arc.ArchiveObject(&_gotoPoint);

	//
	// Archive Member Variables
	//
	ArchiveEnum(_state, GotoHelperNodeStates_t);
}

#endif /* __GOTO_HELPER_NODE_EX___ */