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

#include <MissionEvent.h>

+ +

List of all members.

+ + + + + +

+Public Types

enum  EVENT_TYPE {
+  MESSAGE, +OBJECTIVE, +INSTRUCTION, +IFF, +
+  DAMAGE, +JUMP, +HOLD, +SKIP, +
+  END_MISSION, +BEGIN_SCENE, +CAMERA, +VOLUME, +
+  DISPLAY, +FIRE_WEAPON, +END_SCENE, +NUM_EVENTS +
+ }
enum  EVENT_STATUS { PENDING, +ACTIVE, +COMPLETE, +SKIPPED + }
enum  EVENT_TRIGGER {
+  TRIGGER_TIME, +TRIGGER_DAMAGE, +TRIGGER_DESTROYED, +TRIGGER_JUMP, +
+  TRIGGER_LAUNCH, +TRIGGER_DOCK, +TRIGGER_NAVPT, +TRIGGER_EVENT, +
+  TRIGGER_SKIPPED, +TRIGGER_TARGET, +TRIGGER_SHIPS_LEFT, +TRIGGER_DETECT, +
+  TRIGGER_RANGE, +TRIGGER_EVENT_ALL, +TRIGGER_EVENT_ANY, +NUM_TRIGGERS +
+ }
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 MissionEvent ()
 ~MissionEvent ()
void ExecFrame (double seconds)
void Activate ()
virtual bool CheckTrigger ()
virtual void Execute (bool silent=false)
virtual void Skip ()
int EventID () const
int Status () const
bool IsPending () const
bool IsActive () const
bool IsComplete () const
bool IsSkipped () const
double Time () const
double Delay () const
int Event () const
const char * EventName () const
Text EventShip () const
Text EventSource () const
Text EventTarget () const
Text EventMessage () const
Text EventSound () const
int EventParam (int index=0) const
int NumEventParams () const
int EventChance () const
Point EventPoint () const
Rect EventRect () const
int Trigger () const
const char * TriggerName () const
Text TriggerShip () const
Text TriggerTarget () const
Text TriggerParamStr () const
int TriggerParam (int index=0) const
int NumTriggerParams () const
+ + + + + + +

+Static Public Member Functions

static const char * TYPENAME ()
static const char * EventName (int n)
static int EventForName (const char *n)
static const char * TriggerName (int n)
static int TriggerForName (const char *n)
+ + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

int id
int status
double time
double delay
int event
Text event_ship
Text event_source
Text event_target
Text event_message
Text event_sound
int event_param [10]
int event_nparams
int event_chance
Vec3 event_point
Rect event_rect
int trigger
Text trigger_ship
Text trigger_target
int trigger_param [10]
int trigger_nparams
Bitmap image
Sound * sound
+ + + + + +

+Friends

class Mission
class MissionTemplate
class MsnEditDlg
class MsnEventDlg
+

Detailed Description

+
+

Definition at line 42 of file MissionEvent.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum MissionEvent::EVENT_STATUS
+
+
Enumerator:
+ + + + +
PENDING  +
ACTIVE  +
COMPLETE  +
SKIPPED  +
+
+
+ +

Definition at line 73 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + +
enum MissionEvent::EVENT_TRIGGER
+
+
Enumerator:
+ + + + + + + + + + + + + + + + +
TRIGGER_TIME  +
TRIGGER_DAMAGE  +
TRIGGER_DESTROYED  +
TRIGGER_JUMP  +
TRIGGER_LAUNCH  +
TRIGGER_DOCK  +
TRIGGER_NAVPT  +
TRIGGER_EVENT  +
TRIGGER_SKIPPED  +
TRIGGER_TARGET  +
TRIGGER_SHIPS_LEFT  +
TRIGGER_DETECT  +
TRIGGER_RANGE  +
TRIGGER_EVENT_ALL  +
TRIGGER_EVENT_ANY  +
NUM_TRIGGERS  +
+
+
+ +

Definition at line 77 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + +
enum MissionEvent::EVENT_TYPE
+
+
Enumerator:
+ + + + + + + + + + + + + + + + +
MESSAGE  +
OBJECTIVE  +
INSTRUCTION  +
IFF  +
DAMAGE  +
JUMP  +
HOLD  +
SKIP  +
END_MISSION  +
BEGIN_SCENE  +
CAMERA  +
VOLUME  +
DISPLAY  +
FIRE_WEAPON  +
END_SCENE  +
NUM_EVENTS  +
+
+
+ +

Definition at line 52 of file MissionEvent.h.

+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
MissionEvent::MissionEvent ()
+
+ +

Definition at line 56 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + + + +
MissionEvent::~MissionEvent ()
+
+ +

Definition at line 64 of file MissionEvent.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
void MissionEvent::Activate ()
+
+ +

Definition at line 99 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool MissionEvent::CheckTrigger ()
+ 		+virtual
+
+ +

Definition at line 130 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double MissionEvent::Delay () const
+ 		+inline
+
+ +

Definition at line 106 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MissionEvent::Event () const
+ 		+inline
+
+ +

Definition at line 108 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MissionEvent::EventChance () const
+ 		+inline
+
+ +

Definition at line 119 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int MissionEvent::EventForName (const char * n)
+ 		+static
+
+ +

Definition at line 845 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MissionEvent::EventID () const
+ 		+inline
+
+ +

Definition at line 98 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Text MissionEvent::EventMessage () const
+ 		+inline
+
+ +

Definition at line 113 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + + + +
const char * MissionEvent::EventName () const
+
+ +

Definition at line 833 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
const char * MissionEvent::EventName (int n)
+ 		+static
+
+ +

Definition at line 839 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + + + + +
int MissionEvent::EventParam (int index = 0) const
+
+ +

Definition at line 762 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Point MissionEvent::EventPoint () const
+ 		+inline
+
+ +

Definition at line 120 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Rect MissionEvent::EventRect () const
+ 		+inline
+
+ +

Definition at line 121 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Text MissionEvent::EventShip () const
+ 		+inline
+
+ +

Definition at line 110 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Text MissionEvent::EventSound () const
+ 		+inline
+
+ +

Definition at line 114 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Text MissionEvent::EventSource () const
+ 		+inline
+
+ +

Definition at line 111 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Text MissionEvent::EventTarget () const
+ 		+inline
+
+ +

Definition at line 112 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + + + + +
void MissionEvent::ExecFrame (double seconds)
+
+ +

Definition at line 75 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void MissionEvent::Execute (bool silent = false)
+ 		+virtual
+
+ +

Definition at line 283 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool MissionEvent::IsActive () const
+ 		+inline
+
+ +

Definition at line 101 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool MissionEvent::IsComplete () const
+ 		+inline
+
+ +

Definition at line 102 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool MissionEvent::IsPending () const
+ 		+inline
+
+ +

Definition at line 100 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
bool MissionEvent::IsSkipped () const
+ 		+inline
+
+ +

Definition at line 103 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + + + +
int MissionEvent::NumEventParams () const
+
+ +

Definition at line 771 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + + + +
int MissionEvent::NumTriggerParams () const
+
+ +

Definition at line 788 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
void MissionEvent::Skip ()
+ 		+virtual
+
+ +

Definition at line 120 of file MissionEvent.cpp.

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

Definition at line 99 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
double MissionEvent::Time () const
+ 		+inline
+
+ +

Definition at line 105 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
int MissionEvent::Trigger () const
+ 		+inline
+
+ +

Definition at line 123 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
int MissionEvent::TriggerForName (const char * n)
+ 		+static
+
+ +

Definition at line 867 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + + + +
const char * MissionEvent::TriggerName () const
+
+ +

Definition at line 855 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
const char * MissionEvent::TriggerName (int n)
+ 		+static
+
+ +

Definition at line 861 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + + + + +
int MissionEvent::TriggerParam (int index = 0) const
+
+ +

Definition at line 779 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + + + +
Text MissionEvent::TriggerParamStr () const
+
+ +

Definition at line 723 of file MissionEvent.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Text MissionEvent::TriggerShip () const
+ 		+inline
+
+ +

Definition at line 125 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
Text MissionEvent::TriggerTarget () const
+ 		+inline
+
+ +

Definition at line 126 of file MissionEvent.h.

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

Definition at line 50 of file MissionEvent.h.

+ +
+
+

Friends And Related Function Documentation

+ +
+
+ + + + + +
+ + + + +
friend class Mission
+ 		+friend
+
+ +

Definition at line 44 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
friend class MissionTemplate
+ 		+friend
+
+ +

Definition at line 45 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
friend class MsnEditDlg
+ 		+friend
+
+ +

Definition at line 46 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
friend class MsnEventDlg
+ 		+friend
+
+ +

Definition at line 47 of file MissionEvent.h.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + + +
+ + + + +
double MissionEvent::delay
+ 		+protected
+
+ +

Definition at line 141 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MissionEvent::event
+ 		+protected
+
+ +

Definition at line 143 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MissionEvent::event_chance
+ 		+protected
+
+ +

Definition at line 151 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text MissionEvent::event_message
+ 		+protected
+
+ +

Definition at line 147 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MissionEvent::event_nparams
+ 		+protected
+
+ +

Definition at line 150 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MissionEvent::event_param[10]
+ 		+protected
+
+ +

Definition at line 149 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Vec3 MissionEvent::event_point
+ 		+protected
+
+ +

Definition at line 152 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Rect MissionEvent::event_rect
+ 		+protected
+
+ +

Definition at line 153 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text MissionEvent::event_ship
+ 		+protected
+
+ +

Definition at line 144 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text MissionEvent::event_sound
+ 		+protected
+
+ +

Definition at line 148 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text MissionEvent::event_source
+ 		+protected
+
+ +

Definition at line 145 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text MissionEvent::event_target
+ 		+protected
+
+ +

Definition at line 146 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MissionEvent::id
+ 		+protected
+
+ +

Definition at line 138 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Bitmap MissionEvent::image
+ 		+protected
+
+ +

Definition at line 161 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Sound* MissionEvent::sound
+ 		+protected
+
+ +

Definition at line 162 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MissionEvent::status
+ 		+protected
+
+ +

Definition at line 139 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
double MissionEvent::time
+ 		+protected
+
+ +

Definition at line 140 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MissionEvent::trigger
+ 		+protected
+
+ +

Definition at line 155 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MissionEvent::trigger_nparams
+ 		+protected
+
+ +

Definition at line 159 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
int MissionEvent::trigger_param[10]
+ 		+protected
+
+ +

Definition at line 158 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text MissionEvent::trigger_ship
+ 		+protected
+
+ +

Definition at line 156 of file MissionEvent.h.

+ +
+
+ +
+
+ + + + + +
+ + + + +
Text MissionEvent::trigger_target
+ 		+protected
+
+ +

Definition at line 157 of file MissionEvent.h.

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