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/_mod_info_8h_source.html | 239 ++++++++++++++++++++++++++++++ 1 file changed, 239 insertions(+) create mode 100644 Doc/doxygen/html/_mod_info_8h_source.html (limited to 'Doc/doxygen/html/_mod_info_8h_source.html') diff --git a/Doc/doxygen/html/_mod_info_8h_source.html b/Doc/doxygen/html/_mod_info_8h_source.html new file mode 100644 index 0000000..2d57ea1 --- /dev/null +++ b/Doc/doxygen/html/_mod_info_8h_source.html @@ -0,0 +1,239 @@ + + + + + +Starshatter_Open: D:/SRC/StarshatterSVN/Stars45/ModInfo.h Source File + + + + + + + + + + + + + +
+
+ + + + + + +
+
Starshatter_Open +
+
Open source Starshatter engine
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+
ModInfo.h
+
+
+Go to the documentation of this file.
1 /* Project Starshatter 4.5
+
2  Destroyer Studios LLC
+
3  Copyright © 1997-2004. All Rights Reserved.
+
4 
+
5  SUBSYSTEM: Stars.exe
+
6  FILE: ModInfo.h
+
7  AUTHOR: John DiCamillo
+
8 
+
9 
+
10  OVERVIEW
+
11  ========
+
12  Information block for describing and deploying third party mods
+
13 */
+
14 
+
15 
+
16 #ifndef ModInfo_h
+
17 #define ModInfo_h
+
18 
+
19 #include "Types.h"
+
20 #include "Bitmap.h"
+
21 #include "Text.h"
+
22 #include "List.h"
+
23 
+
24 // +-------------------------------------------------------------------+
+
25 
+
26 class ModInfo;
+
27 class ModCampaign;
+
28 class ModCatalog;
+
29 
+
30 // +-------------------------------------------------------------------+
+
31 
+
32 class ModInfo
+
33 {
+
34 public:
+
35  static const char* TYPENAME() { return "ModInfo"; }
+
36 
+
37  ModInfo();
+
38  ModInfo(const char* filename);
+
39  ModInfo(const char* name, const char* version, const char* url);
+
40  ~ModInfo();
+
41 
+
42  int operator == (const ModInfo& m) const { return name.length() && name == m.name; }
+
43 
+
44  const Text& Name() const { return name; }
+
45  const Text& Description() const { return desc; }
+
46  const Text& Author() const { return author; }
+
47  const Text& URL() const { return url; }
+
48  const Text& Filename() const { return filename; }
+
49  const Text& Copyright() const { return copyright; }
+
50  Bitmap* LogoImage() const { return logo; }
+
51  const Text& Version() const { return version; }
+
52  bool Distribute() const { return distribute; }
+
53  bool IsEnabled() const { return enabled; }
+
54 
+
55  List<ModCampaign>& GetCampaigns() { return campaigns; }
+
56 
+
57  bool Load(const char* filename);
+
58  bool ParseModInfo(const char* buffer);
+
59 
+
60  bool Enable();
+
61  bool Disable();
+
62 
+
63 private:
+
64  Text name;
+
65  Text desc;
+
66  Text author;
+
67  Text url;
+
68  Text filename;
+
69  Text copyright;
+
70  Bitmap* logo;
+
71  Text logoname;
+
72  Text version;
+
73  bool distribute;
+
74  bool enabled;
+
75 
+
76  List<ModCampaign> campaigns;
+
77  ModCatalog* catalog;
+
78 };
+
79 
+
80 // +-------------------------------------------------------------------+
+
81 
+
82 class ModCampaign
+
83 {
+
84  friend class ModInfo;
+
85 
+
86 public:
+
87  static const char* TYPENAME() { return "ModCampaign"; }
+
88 
+
89  ModCampaign() : dynamic(false) { }
+
90  ~ModCampaign() { }
+
91 
+
92  const Text& Name() const { return name; }
+
93  const Text& Path() const { return path; }
+
94  bool IsDynamic() const { return dynamic; }
+
95 
+
96 private:
+
97  Text name;
+
98  Text path;
+
99  bool dynamic;
+
100 };
+
101 
+
102 // +-------------------------------------------------------------------+
+
103 
+
104 class ModCatalog
+
105 {
+
106  friend class ModInfo;
+
107 
+
108 public:
+
109  static const char* TYPENAME() { return "ModCatalog"; }
+
110 
+
111  ModCatalog() { }
+
112  ~ModCatalog() { }
+
113 
+
114  const Text& File() const { return file; }
+
115  const Text& Path() const { return path; }
+
116 
+
117 private:
+
118  Text file;
+
119  Text path;
+
120 };
+
121 
+
122 #endif ModInfo_h
+
+
+ + + + -- cgit v1.1