From 8898ad9b25fca6afe2374d293a981db02a83d7e9 Mon Sep 17 00:00:00 2001 From: "FWoltermann@gmail.com" Date: Thu, 31 May 2012 14:46:27 +0000 Subject: Committing the documentation to svn to have it accessible online --- Doc/doxygen/html/class_combat_event.html | 1217 ++++++++++++++++++++++++++++++ 1 file changed, 1217 insertions(+) create mode 100644 Doc/doxygen/html/class_combat_event.html (limited to 'Doc/doxygen/html/class_combat_event.html') diff --git a/Doc/doxygen/html/class_combat_event.html b/Doc/doxygen/html/class_combat_event.html new file mode 100644 index 0000000..82e289f --- /dev/null +++ b/Doc/doxygen/html/class_combat_event.html @@ -0,0 +1,1217 @@ + + + + + +Starshatter_Open: CombatEvent Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions
+
+
CombatEvent Class Reference
+
+
+ +

#include <CombatEvent.h>

+ +

List of all members.

+ + + + +

+Public Types

enum  EVENT_TYPE {
+  ATTACK, +DEFEND, +MOVE_TO, +CAPTURE, +
+  STRATEGY, +CAMPAIGN_START, +STORY, +CAMPAIGN_END, +
+  CAMPAIGN_FAIL +
+ }
enum  EVENT_SOURCE {
+  FORCOM, +TACNET, +INTEL, +MAIL, +
+  NEWS +
+ }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CombatEvent (Campaign *c, int type, int time, int team, int source, const char *rgn)
int operator== (const CombatEvent &u) const
int Type () const
int Time () const
int GetIFF () const
int Points () const
int Source () const
Point Location () const
const char * Region () const
const char * Title () const
const char * Information () const
const char * Filename () const
const char * ImageFile () const
const char * SceneFile () const
Bitmap & Image ()
const char * SourceName () const
const char * TypeName () const
bool Visited () const
void SetType (int t)
void SetTime (int t)
void SetIFF (int t)
void SetPoints (int p)
void SetSource (int s)
void SetLocation (const Point &p)
void SetRegion (Text rgn)
void SetTitle (Text t)
void SetInformation (Text t)
void SetFilename (Text f)
void SetImageFile (Text f)
void SetSceneFile (Text f)
void SetVisited (bool v)
void Load ()
+ + + + + + +

+Static Public Member Functions

static const char * TYPENAME ()
static int TypeFromName (const char *n)
static int SourceFromName (const char *n)
static const char * TypeName (int n)
static const char * SourceName (int n)
+

Detailed Description

+
+

Definition at line 32 of file CombatEvent.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum CombatEvent::EVENT_SOURCE
+
+
Enumerator:
+ + + + + +
FORCOM  +
TACNET  +
INTEL  +
MAIL  +
NEWS  +
+
+
+ +

Definition at line 50 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + +
enum CombatEvent::EVENT_TYPE
+
+
Enumerator:
+ + + + + + + + + +
ATTACK  +
DEFEND  +
MOVE_TO  +
CAPTURE  +
STRATEGY  +
CAMPAIGN_START  +
STORY  +
CAMPAIGN_END  +
CAMPAIGN_FAIL  +
+
+
+ +

Definition at line 37 of file CombatEvent.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CombatEvent::CombatEvent (Campaign * c,
int type,
int time,
int team,
int source,
const char * rgn 
)
+
+ +

Definition at line 30 of file CombatEvent.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + +
const char* CombatEvent::Filename () const
+ 		+inline
+
+ +

Definition at line 72 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatEvent::GetIFF () const
+ 		+inline
+
+ +

Definition at line 65 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Bitmap& CombatEvent::Image ()
+ 		+inline
+
+ +

Definition at line 75 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* CombatEvent::ImageFile () const
+ 		+inline
+
+ +

Definition at line 73 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* CombatEvent::Information () const
+ 		+inline
+
+ +

Definition at line 71 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + + + +
void CombatEvent::Load ()
+
+ +

Definition at line 111 of file CombatEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Point CombatEvent::Location () const
+ 		+inline
+
+ +

Definition at line 68 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int CombatEvent::operator== (const CombatEvent & u) const
+ 		+inline
+
+ +

Definition at line 60 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatEvent::Points () const
+ 		+inline
+
+ +

Definition at line 66 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* CombatEvent::Region () const
+ 		+inline
+
+ +

Definition at line 69 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* CombatEvent::SceneFile () const
+ 		+inline
+
+ +

Definition at line 74 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetFilename (Text f)
+ 		+inline
+
+ +

Definition at line 89 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetIFF (int t)
+ 		+inline
+
+ +

Definition at line 82 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetImageFile (Text f)
+ 		+inline
+
+ +

Definition at line 90 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetInformation (Text t)
+ 		+inline
+
+ +

Definition at line 88 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetLocation (const Point & p)
+ 		+inline
+
+ +

Definition at line 85 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetPoints (int p)
+ 		+inline
+
+ +

Definition at line 83 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetRegion (Text rgn)
+ 		+inline
+
+ +

Definition at line 86 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetSceneFile (Text f)
+ 		+inline
+
+ +

Definition at line 91 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetSource (int s)
+ 		+inline
+
+ +

Definition at line 84 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetTime (int t)
+ 		+inline
+
+ +

Definition at line 81 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetTitle (Text t)
+ 		+inline
+
+ +

Definition at line 87 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetType (int t)
+ 		+inline
+
+ +

Definition at line 80 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatEvent::SetVisited (bool v)
+ 		+inline
+
+ +

Definition at line 92 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatEvent::Source () const
+ 		+inline
+
+ +

Definition at line 67 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int CombatEvent::SourceFromName (const char * n)
+ 		+static
+
+ +

Definition at line 69 of file CombatEvent.cpp.

+ +
+
+ +
+
+ + + + + + + +
const char * CombatEvent::SourceName () const
+
+ +

Definition at line 39 of file CombatEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
const char * CombatEvent::SourceName (int n)
+ 		+static
+
+ +

Definition at line 55 of file CombatEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatEvent::Time () const
+ 		+inline
+
+ +

Definition at line 64 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* CombatEvent::Title () const
+ 		+inline
+
+ +

Definition at line 70 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatEvent::Type () const
+ 		+inline
+
+ +

Definition at line 63 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int CombatEvent::TypeFromName (const char * n)
+ 		+static
+
+ +

Definition at line 99 of file CombatEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
static const char* CombatEvent::TYPENAME ()
+ 		+inlinestatic
+
+ +

Definition at line 35 of file CombatEvent.h.

+ +
+
+ +
+
+ + + + + + + +
const char * CombatEvent::TypeName () const
+
+ +

Definition at line 47 of file CombatEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
const char * CombatEvent::TypeName (int n)
+ 		+static
+
+ +

Definition at line 81 of file CombatEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool CombatEvent::Visited () const
+ 		+inline
+
+ +

Definition at line 78 of file CombatEvent.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.1