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

#include <CampaignMissionFighter.h>

+ +

List of all members.

+ + + + + +

+Public Member Functions

 CampaignMissionFighter (Campaign *c)
virtual ~CampaignMissionFighter ()
virtual void CreateMission (CampaignMissionRequest *request)
+ + +

+Static Public Member Functions

static const char * TYPENAME ()
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

virtual Mission * GenerateMission (int id)
virtual void SelectType ()
virtual void SelectRegion ()
virtual void GenerateStandardElements ()
virtual void GenerateMissionElements ()
virtual void CreateElements (CombatGroup *g)
virtual void CreateSquadron (CombatGroup *g)
virtual void CreatePlayer (CombatGroup *g)
virtual void CreatePatrols ()
virtual void CreateWards ()
virtual void CreateWardFreight ()
virtual void CreateWardShuttle ()
virtual void CreateWardStrike ()
virtual void CreateEscorts ()
virtual void CreateTargets ()
virtual void CreateTargetsPatrol ()
virtual void CreateTargetsSweep ()
virtual void CreateTargetsIntercept ()
virtual void CreateTargetsFreightEscort ()
virtual void CreateTargetsShuttleEscort ()
virtual void CreateTargetsStrikeEscort ()
virtual void CreateTargetsStrike ()
virtual void CreateTargetsAssault ()
virtual int CreateRandomTarget (const char *rgn, Point base_loc)
virtual bool IsGroundObjective (CombatGroup *obj)
virtual void PlanetaryInsertion (MissionElement *elem)
virtual void OrbitalInsertion (MissionElement *elem)
virtual MissionElement * CreateSingleElement (CombatGroup *g, CombatUnit *u)
virtual MissionElement * CreateFighterPackage (CombatGroup *squadron, int count, int role)
virtual CombatGroup * FindSquadron (int iff, int type)
virtual CombatUnit * FindCarrier (CombatGroup *g)
virtual void DefineMissionObjectives ()
virtual MissionInfo * DescribeMission ()
virtual void Exit ()
+ + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

Campaign * campaign
CampaignMissionRequest * request
MissionInfo * mission_info
CombatGroup * squadron
CombatGroup * strike_group
CombatGroup * strike_target
Mission * mission
MissionElement * player_elem
MissionElement * carrier_elem
MissionElement * ward
MissionElement * prime_target
MissionElement * escort
Text air_region
Text orb_region
bool airborne
bool airbase
int ownside
int enemy
int mission_type
+

Detailed Description

+
+

Definition at line 39 of file CampaignMissionFighter.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
CampaignMissionFighter::CampaignMissionFighter (Campaign * c)
+
+ +

Definition at line 44 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
CampaignMissionFighter::~CampaignMissionFighter ()
+ 		+virtual
+
+ +

Definition at line 93 of file CampaignMissionFighter.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
void CampaignMissionFighter::CreateElements (CombatGroup * g)
+ 		+protectedvirtual
+
+ +

Definition at line 480 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateEscorts ()
+ 		+protectedvirtual
+
+ +

Definition at line 1102 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
MissionElement * CampaignMissionFighter::CreateFighterPackage (CombatGroup * squadron,
int count,
int role 
)
+ 		+protectedvirtual
+
+ +

Definition at line 1946 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CampaignMissionFighter::CreateMission (CampaignMissionRequest * request)
+ 		+virtual
+
+ +

Definition at line 98 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreatePatrols ()
+ 		+protectedvirtual
+
+ +

Definition at line 769 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CampaignMissionFighter::CreatePlayer (CombatGroup * g)
+ 		+protectedvirtual
+
+ +

Definition at line 691 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
int CampaignMissionFighter::CreateRandomTarget (const char * rgn,
Point base_loc 
)
+ 		+protectedvirtual
+
+ +

Definition at line 1717 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
MissionElement * CampaignMissionFighter::CreateSingleElement (CombatGroup * g,
CombatUnit * u 
)
+ 		+protectedvirtual
+
+ +

Definition at line 511 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CampaignMissionFighter::CreateSquadron (CombatGroup * g)
+ 		+protectedvirtual
+
+ +

Definition at line 650 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateTargets ()
+ 		+protectedvirtual
+
+ +

Definition at line 1148 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateTargetsAssault ()
+ 		+protectedvirtual
+
+ +

Definition at line 1601 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateTargetsFreightEscort ()
+ 		+protectedvirtual
+
+ +

Definition at line 1404 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateTargetsIntercept ()
+ 		+protectedvirtual
+
+ +

Definition at line 1318 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateTargetsPatrol ()
+ 		+protectedvirtual
+
+ +

Definition at line 1167 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateTargetsShuttleEscort ()
+ 		+protectedvirtual
+
+ +

Definition at line 1455 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateTargetsStrike ()
+ 		+protectedvirtual
+
+ +

Definition at line 1487 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateTargetsStrikeEscort ()
+ 		+protectedvirtual
+
+ +

Definition at line 1463 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateTargetsSweep ()
+ 		+protectedvirtual
+
+ +

Definition at line 1225 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateWardFreight ()
+ 		+protectedvirtual
+
+ +

Definition at line 840 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateWards ()
+ 		+protectedvirtual
+
+ +

Definition at line 829 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateWardShuttle ()
+ 		+protectedvirtual
+
+ +

Definition at line 910 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::CreateWardStrike ()
+ 		+protectedvirtual
+
+ +

Definition at line 984 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::DefineMissionObjectives ()
+ 		+protectedvirtual
+
+ +

Definition at line 2080 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
MissionInfo * CampaignMissionFighter::DescribeMission ()
+ 		+protectedvirtual
+
+ +

Definition at line 2102 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::Exit ()
+ 		+protectedvirtual
+
+ +

Definition at line 2150 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
CombatUnit * CampaignMissionFighter::FindCarrier (CombatGroup * g)
+ 		+protectedvirtual
+
+ +

Definition at line 635 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
CombatGroup * CampaignMissionFighter::FindSquadron (int iff,
int type 
)
+ 		+protectedvirtual
+
+ +

Definition at line 2054 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
Mission * CampaignMissionFighter::GenerateMission (int id)
+ 		+protectedvirtual
+
+ +

Definition at line 172 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::GenerateMissionElements ()
+ 		+protectedvirtual
+
+ +

Definition at line 460 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::GenerateStandardElements ()
+ 		+protectedvirtual
+
+ +

Definition at line 397 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool CampaignMissionFighter::IsGroundObjective (CombatGroup * obj)
+ 		+protectedvirtual
+
+ +

Definition at line 265 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CampaignMissionFighter::OrbitalInsertion (MissionElement * elem)
+ 		+protectedvirtual
+
+ +

Definition at line 1932 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void CampaignMissionFighter::PlanetaryInsertion (MissionElement * elem)
+ 		+protectedvirtual
+
+ +

Definition at line 1881 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::SelectRegion ()
+ 		+protectedvirtual
+
+ +

Definition at line 323 of file CampaignMissionFighter.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void CampaignMissionFighter::SelectType ()
+ 		+protectedvirtual
+
+ +

Definition at line 295 of file CampaignMissionFighter.cpp.

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

Definition at line 42 of file CampaignMissionFighter.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
Text CampaignMissionFighter::air_region
+ 		+protected
+
+ +

Definition at line 111 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool CampaignMissionFighter::airbase
+ 		+protected
+
+ +

Definition at line 114 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
bool CampaignMissionFighter::airborne
+ 		+protected
+
+ +

Definition at line 113 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Campaign* CampaignMissionFighter::campaign
+ 		+protected
+
+ +

Definition at line 98 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
MissionElement* CampaignMissionFighter::carrier_elem
+ 		+protected
+
+ +

Definition at line 107 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int CampaignMissionFighter::enemy
+ 		+protected
+
+ +

Definition at line 116 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
MissionElement* CampaignMissionFighter::escort
+ 		+protected
+
+ +

Definition at line 110 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Mission* CampaignMissionFighter::mission
+ 		+protected
+
+ +

Definition at line 105 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
MissionInfo* CampaignMissionFighter::mission_info
+ 		+protected
+
+ +

Definition at line 100 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int CampaignMissionFighter::mission_type
+ 		+protected
+
+ +

Definition at line 117 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text CampaignMissionFighter::orb_region
+ 		+protected
+
+ +

Definition at line 112 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int CampaignMissionFighter::ownside
+ 		+protected
+
+ +

Definition at line 115 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
MissionElement* CampaignMissionFighter::player_elem
+ 		+protected
+
+ +

Definition at line 106 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
MissionElement* CampaignMissionFighter::prime_target
+ 		+protected
+
+ +

Definition at line 109 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
CampaignMissionRequest* CampaignMissionFighter::request
+ 		+protected
+
+ +

Definition at line 99 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
CombatGroup* CampaignMissionFighter::squadron
+ 		+protected
+
+ +

Definition at line 102 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
CombatGroup* CampaignMissionFighter::strike_group
+ 		+protected
+
+ +

Definition at line 103 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
CombatGroup* CampaignMissionFighter::strike_target
+ 		+protected
+
+ +

Definition at line 104 of file CampaignMissionFighter.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
MissionElement* CampaignMissionFighter::ward
+ 		+protected
+
+ +

Definition at line 108 of file CampaignMissionFighter.h.

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