nel/tools/logic/logic_editor_dll/State.h

   1 // State.h: interface for the CState class.
   2 // 2001 Fleury David, Nevrax
   3 //
   4 //////////////////////////////////////////////////////////////////////
   5
   6 #if !defined(AFX_STATE_H__8501C0A2_320A_42B9_BD7E_3D77F27301ED__INCLUDED_)
   7 #define AFX_STATE_H__8501C0A2_320A_42B9_BD7E_3D77F27301ED__INCLUDED_
   8
   9 #if _MSC_VER > 1000
  10 #pragma once
  11 #endif // _MSC_VER > 1000
  12
  13
  14 #include <afxtempl.h>
  15
  16
  17 namespace NLLOGIC
  18 {
  19 class CLogicState;
  20 }
  21
  22 /**
  23  * class CEvent
  24  */
  25 class CEvent
  26 {
  27 public:
  28         CEvent()
  29         {
  30                 m_bActionIsMessage = FALSE;
  31         }
  32
  33         virtual ~CEvent()
  34         {
  35         }
  36
  37         const CString &getEventAsString() const;
  38
  39 //attributes:
  40 public:
  41         CString         m_sConditionName;
  42
  43         /// bool, true if the event action is sending a message, false if it's changing state
  44         bool            m_bActionIsMessage;
  45
  46         /// \name event message
  47         //@{
  48         ///destination of the message (name of a .bot, .flaura, .var... file)
  49         CString         m_sMessageDestination;
  50         /// message ID (selected from valid ID for given destination (file extension))
  51         CString         m_sMessageID;
  52         /// message arguments, syntax defined for given message ID
  53         CString         m_sArguments;
  54         //@}
  55
  56         /// \name state change event
  57         //@{
  58         /// destination state (if m_bActionIsMessage == false)
  59         CString         m_sStateChange;
  60         //@]
  61
  62         /// temp string used to store the event as a string when requested
  63         mutable CString eventString;
  64
  65         friend bool operator==( const CEvent &ev1, const CEvent &ev2);
  66 };
  67
  68
  69 typedef CList< CEvent *, CEvent *&> TPEventList;
  70
  71
  72
  73
  74
  75 /**
  76  * class State
  77  */
  78 class CState
  79 {
  80 public:
  81         /// constructor
  82         CState( const CString &name = CString("") );
  83
  84         /// copy constructor
  85         CState( const CState &state );
  86
  87         virtual ~CState();
  88
  89         /// add an event to this State
  90         inline void addEvent( CEvent *event) { m_evEvents.AddTail( event ) ; }
  91
  92         /// remove the specified event from the state object, return TRUE if done, FALSE if event not found
  93         BOOL removeEvent( CEvent *event);
  94
  95
  96 // attributes
  97 //private:
  98 public:
  99         CString         m_sName;
 100
 101         /// list of pointers on CEvent objects
 102         TPEventList     m_evEvents;
 103 };
 104
 105
 106 /**
 107  * Set a CLogicState from a CState
 108  */
 109 void cStateToCLogicState( CState& state, NLLOGIC::CLogicState& logicState );
 110
 111 /**
 112  * Set a CState from a CLogicState
 113  */
 114 void cLogicStateToCState( const NLLOGIC::CLogicState& logicState, CState& state );
 115
 116
 117 #endif // !defined(AFX_STATE_H__8501C0A2_320A_42B9_BD7E_3D77F27301ED__INCLUDED_)