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_action.html | 2039 +++++++++++++++++++++++++++++ 1 file changed, 2039 insertions(+) create mode 100644 Doc/doxygen/html/class_combat_action.html (limited to 'Doc/doxygen/html/class_combat_action.html') diff --git a/Doc/doxygen/html/class_combat_action.html b/Doc/doxygen/html/class_combat_action.html new file mode 100644 index 0000000..a50ad9a --- /dev/null +++ b/Doc/doxygen/html/class_combat_action.html @@ -0,0 +1,2039 @@ + + + + + +Starshatter_Open: CombatAction Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Types | +Public Member Functions | +Static Public Member Functions
+
+
CombatAction Class Reference
+
+
+ +

#include <CombatAction.h>

+ +

List of all members.

+ + + + +

+Public Types

enum  TYPE {
+  NO_ACTION, +STRATEGIC_DIRECTIVE, +ZONE_ASSIGNMENT, +SYSTEM_ASSIGNMENT, +
+  MISSION_TEMPLATE, +COMBAT_EVENT, +INTEL_EVENT, +CAMPAIGN_SITUATION, +
+  CAMPAIGN_ORDERS +
+ }
enum  STATUS {
+  PENDING, +ACTIVE, +SKIPPED, +FAILED, +
+  COMPLETE +
+ }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CombatAction (int id, int type, int subtype, int team)
 ~CombatAction ()
int operator== (const CombatAction &a) const
bool IsAvailable () const
void FireAction ()
void FailAction ()
void AddRequirement (int action, int stat, bool not=false)
void AddRequirement (Combatant *c1, Combatant *c2, int comp, int score)
void AddRequirement (Combatant *c1, int group_type, int group_id, int comp, int score, int intel=0)
int Identity () const
int Type () const
int Subtype () const
int OpposingType () const
int GetIFF () const
int Status () const
int Source () const
Point Location () const
const char * System () const
const char * Region () const
const char * Filename () const
const char * ImageFile () const
const char * SceneFile () const
int Count () const
int ExecTime () const
int StartBefore () const
int StartAfter () const
int MinRank () const
int MaxRank () const
int Delay () const
int Probability () const
int AssetType () const
int AssetId () const
List< Text > & AssetKills ()
int TargetType () const
int TargetId () const
int TargetIFF () const
List< Text > & TargetKills ()
const char * GetText () const
void SetType (int t)
void SetSubtype (int s)
void SetOpposingType (int t)
void SetIFF (int t)
void SetStatus (int s)
void SetSource (int s)
void SetLocation (const Point &p)
void SetSystem (Text sys)
void SetRegion (Text rgn)
void SetFilename (Text f)
void SetImageFile (Text f)
void SetSceneFile (Text f)
void SetCount (int n)
void SetExecTime (int t)
void SetStartBefore (int s)
void SetStartAfter (int s)
void SetMinRank (int n)
void SetMaxRank (int n)
void SetDelay (int d)
void SetProbability (int n)
void SetAssetType (int t)
void SetAssetId (int n)
void SetTargetType (int t)
void SetTargetId (int n)
void SetTargetIFF (int n)
void SetText (Text t)
+ + + + +

+Static Public Member Functions

static const char * TYPENAME ()
static int TypeFromName (const char *n)
static int StatusFromName (const char *n)
+

Detailed Description

+
+

Definition at line 31 of file CombatAction.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum CombatAction::STATUS
+
+
Enumerator:
+ + + + + +
PENDING  +
ACTIVE  +
SKIPPED  +
FAILED  +
COMPLETE  +
+
+
+ +

Definition at line 49 of file CombatAction.h.

+ +
+
+ +
+
+ + + + +
enum CombatAction::TYPE
+
+
Enumerator:
+ + + + + + + + + +
NO_ACTION  +
STRATEGIC_DIRECTIVE  +
ZONE_ASSIGNMENT  +
SYSTEM_ASSIGNMENT  +
MISSION_TEMPLATE  +
COMBAT_EVENT  +
INTEL_EVENT  +
CAMPAIGN_SITUATION  +
CAMPAIGN_ORDERS  +
+
+
+ +

Definition at line 36 of file CombatAction.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CombatAction::CombatAction (int id,
int type,
int subtype,
int team 
)
+
+ +

Definition at line 25 of file CombatAction.cpp.

+ +
+
+ +
+
+ + + + + + + +
CombatAction::~CombatAction ()
+
+ +

Definition at line 33 of file CombatAction.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void CombatAction::AddRequirement (int action,
int stat,
bool not = false 
)
+
+ +

Definition at line 209 of file CombatAction.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void CombatAction::AddRequirement (Combatant * c1,
Combatant * c2,
int comp,
int score 
)
+
+ +

Definition at line 215 of file CombatAction.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void CombatAction::AddRequirement (Combatant * c1,
int group_type,
int group_id,
int comp,
int score,
int intel = 0 
)
+
+ +

Definition at line 221 of file CombatAction.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::AssetId () const
+ 		+inline
+
+ +

Definition at line 95 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Text>& CombatAction::AssetKills ()
+ 		+inline
+
+ +

Definition at line 96 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::AssetType () const
+ 		+inline
+
+ +

Definition at line 94 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::Count () const
+ 		+inline
+
+ +

Definition at line 86 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::Delay () const
+ 		+inline
+
+ +

Definition at line 92 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::ExecTime () const
+ 		+inline
+
+ +

Definition at line 87 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + + + +
void CombatAction::FailAction ()
+
+ +

Definition at line 196 of file CombatAction.cpp.

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

Definition at line 83 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + + + +
void CombatAction::FireAction ()
+
+ +

Definition at line 182 of file CombatAction.cpp.

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

Definition at line 77 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* CombatAction::GetText () const
+ 		+inline
+
+ +

Definition at line 101 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::Identity () const
+ 		+inline
+
+ +

Definition at line 73 of file CombatAction.h.

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

Definition at line 84 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + + + +
bool CombatAction::IsAvailable () const
+
+ +

Definition at line 43 of file CombatAction.cpp.

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

Definition at line 80 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::MaxRank () const
+ 		+inline
+
+ +

Definition at line 91 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::MinRank () const
+ 		+inline
+
+ +

Definition at line 90 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int CombatAction::operator== (const CombatAction & a) const
+ 		+inline
+
+ +

Definition at line 61 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::OpposingType () const
+ 		+inline
+
+ +

Definition at line 76 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::Probability () const
+ 		+inline
+
+ +

Definition at line 93 of file CombatAction.h.

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

Definition at line 82 of file CombatAction.h.

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

Definition at line 85 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetAssetId (int n)
+ 		+inline
+
+ +

Definition at line 124 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetAssetType (int t)
+ 		+inline
+
+ +

Definition at line 123 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetCount (int n)
+ 		+inline
+
+ +

Definition at line 115 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetDelay (int d)
+ 		+inline
+
+ +

Definition at line 121 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetExecTime (int t)
+ 		+inline
+
+ +

Definition at line 116 of file CombatAction.h.

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

Definition at line 112 of file CombatAction.h.

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

Definition at line 106 of file CombatAction.h.

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

Definition at line 113 of file CombatAction.h.

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

Definition at line 109 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetMaxRank (int n)
+ 		+inline
+
+ +

Definition at line 120 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetMinRank (int n)
+ 		+inline
+
+ +

Definition at line 119 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetOpposingType (int t)
+ 		+inline
+
+ +

Definition at line 105 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetProbability (int n)
+ 		+inline
+
+ +

Definition at line 122 of file CombatAction.h.

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

Definition at line 111 of file CombatAction.h.

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

Definition at line 114 of file CombatAction.h.

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

Definition at line 108 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetStartAfter (int s)
+ 		+inline
+
+ +

Definition at line 118 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetStartBefore (int s)
+ 		+inline
+
+ +

Definition at line 117 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetStatus (int s)
+ 		+inline
+
+ +

Definition at line 107 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetSubtype (int s)
+ 		+inline
+
+ +

Definition at line 104 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetSystem (Text sys)
+ 		+inline
+
+ +

Definition at line 110 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetTargetId (int n)
+ 		+inline
+
+ +

Definition at line 126 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetTargetIFF (int n)
+ 		+inline
+
+ +

Definition at line 127 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetTargetType (int t)
+ 		+inline
+
+ +

Definition at line 125 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CombatAction::SetText (Text t)
+ 		+inline
+
+ +

Definition at line 128 of file CombatAction.h.

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

Definition at line 103 of file CombatAction.h.

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

Definition at line 79 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::StartAfter () const
+ 		+inline
+
+ +

Definition at line 89 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::StartBefore () const
+ 		+inline
+
+ +

Definition at line 88 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::Status () const
+ 		+inline
+
+ +

Definition at line 78 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int CombatAction::StatusFromName (const char * n)
+ 		+static
+
+ +

Definition at line 291 of file CombatAction.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::Subtype () const
+ 		+inline
+
+ +

Definition at line 75 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
const char* CombatAction::System () const
+ 		+inline
+
+ +

Definition at line 81 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::TargetId () const
+ 		+inline
+
+ +

Definition at line 98 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::TargetIFF () const
+ 		+inline
+
+ +

Definition at line 99 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
List<Text>& CombatAction::TargetKills ()
+ 		+inline
+
+ +

Definition at line 100 of file CombatAction.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int CombatAction::TargetType () const
+ 		+inline
+
+ +

Definition at line 97 of file CombatAction.h.

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

Definition at line 74 of file CombatAction.h.

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

Definition at line 229 of file CombatAction.cpp.

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

Definition at line 34 of file CombatAction.h.

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