SuperSpaceInvaderTurboApoca.../doc/SAE102-SpaceInvaders/latex/da/da7/struct_config_data.tex
2022-01-11 15:45:50 +01:00

392 lines
18 KiB
TeX

\hypertarget{struct_config_data}{}\doxysection{Config\+Data Struct Reference}
\label{struct_config_data}\index{ConfigData@{ConfigData}}
this struct stores all relevant data from the configuration file
{\ttfamily \#include $<$config\+Data.\+h$>$}
Collaboration diagram for Config\+Data\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=277pt]{d1/d4b/struct_config_data__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
string \mbox{\hyperlink{struct_config_data_a3c9baa529db8e439f903590f5a9bcce2}{theme}}
\begin{DoxyCompactList}\small\item\em theme to use. Valid values \+: good,bad \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_adb4b297d72ba060cbe54785d5791d6ea}{max\+FPS}}
\begin{DoxyCompactList}\small\item\em maximum framerate at which the game will run \end{DoxyCompactList}\item
\mbox{\hyperlink{class_invaders_grid}{Invaders\+Grid}} \mbox{\hyperlink{struct_config_data_a260272afae4d9a0cfdf683ce7b1bb5f0}{grid}}
\begin{DoxyCompactList}\small\item\em Invader type matrix. \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_a002e3aaf06ba352a9ff4e2f50895a65f}{start\+XPosition}}
\begin{DoxyCompactList}\small\item\em players horizontal start position \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_a199264aa6e6c3b267462f0a5427cd5db}{players\+Speed}}
\begin{DoxyCompactList}\small\item\em player movement speed \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_ad8c5d2876699ea9e451e6b3a15618707}{players\+Width}}
\begin{DoxyCompactList}\small\item\em player horizontal size in pixel \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_a641d7b2133165ce2eccaea972265f557}{players\+Fire\+Cooldown}}
\begin{DoxyCompactList}\small\item\em player shooting wait time \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_a09170415d0a4c525e546d6fd0ecb354c}{players\+Lives}}
\begin{DoxyCompactList}\small\item\em player life points \end{DoxyCompactList}\item
vector$<$ \mbox{\hyperlink{struct_player_def}{Player\+Def}} $>$ \mbox{\hyperlink{struct_config_data_a909ad90d692e87b2c93c3966d07ecc16}{player\+Defs}}
\begin{DoxyCompactList}\small\item\em players configuration \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_ad057123e1f1b7283b873eed8a07ead3f}{invaders\+Speed}}
\begin{DoxyCompactList}\small\item\em invader movement speed \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_ada929ea4a462c0bde376adf9fa3f4810}{invaders\+Size}}
\begin{DoxyCompactList}\small\item\em invader radius size in pixel \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_aadc245edaf3b28d82f9ce7b17c655943}{invaders\+Distance}}
\begin{DoxyCompactList}\small\item\em distance in pixel between two invader \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_a0a8ca410dbc6b6cd62d16d1fa19a83f9}{invaders\+Fire\+Cooldown}}
\begin{DoxyCompactList}\small\item\em wait time between two invader missile \end{DoxyCompactList}\item
map$<$ \mbox{\hyperlink{invaders_grid_8h_a28be5c0c3bae3518d94b2ede3633e018}{Invader\+Type}}, \mbox{\hyperlink{struct_invader_type_def}{Invader\+Type\+Def}} $>$ \mbox{\hyperlink{struct_config_data_af0c88560ab28fe51ef1743219633cfdc}{invaders\+Def}}
\begin{DoxyCompactList}\small\item\em link between an invader type, and its data \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_a4f8e7615d2619a3b37e97465ac143fee}{missiles\+Width}}
\begin{DoxyCompactList}\small\item\em invaders missiles width in pixel \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_ae736dc72056f45f4a3f0fef365bc54be}{missiles\+Length}}
\begin{DoxyCompactList}\small\item\em virtual value \+: invaders missiles length in pixel -\/ auto defined from width \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_ae5efc1b5a2b95b1a9c7ff60eee480e71}{missiles\+Speed}}
\begin{DoxyCompactList}\small\item\em invaders missiles movement speed \end{DoxyCompactList}\item
ns\+Graphics\+::\+RGBAcolor \mbox{\hyperlink{struct_config_data_abb41165730c7e25dffe63d2fb08022f4}{missiles\+Color}}
\begin{DoxyCompactList}\small\item\em invaders missiles color \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_aec2b163d49271a1a1654c903de9e45ff}{torpedos\+Width}}
\begin{DoxyCompactList}\small\item\em players torpedos width in pixel \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_a5de633401856c45fb3b8c3333d38804c}{torpedos\+Length}}
\begin{DoxyCompactList}\small\item\em virtual value \+: players torpedos length in pixel -\/ auto defined from width \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_config_data_aa491de435feeca58c85652f4961ddece}{torpedos\+Speed}}
\begin{DoxyCompactList}\small\item\em players topedos movement speed \end{DoxyCompactList}\item
ns\+Graphics\+::\+RGBAcolor \mbox{\hyperlink{struct_config_data_a7edb4693b5fb5036b09b95d314d29495}{torpedos\+Color}}
\begin{DoxyCompactList}\small\item\em players torpedos color \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
this struct stores all relevant data from the configuration file
Definition at line \mbox{\hyperlink{config_data_8h_source_l00027}{27}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{struct_config_data_a260272afae4d9a0cfdf683ce7b1bb5f0}\label{struct_config_data_a260272afae4d9a0cfdf683ce7b1bb5f0}}
\index{ConfigData@{ConfigData}!grid@{grid}}
\index{grid@{grid}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{grid}{grid}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_invaders_grid}{Invaders\+Grid}} Config\+Data\+::grid}
Invader type matrix.
Definition at line \mbox{\hyperlink{config_data_8h_source_l00042}{42}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_af0c88560ab28fe51ef1743219633cfdc}\label{struct_config_data_af0c88560ab28fe51ef1743219633cfdc}}
\index{ConfigData@{ConfigData}!invadersDef@{invadersDef}}
\index{invadersDef@{invadersDef}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{invadersDef}{invadersDef}}
{\footnotesize\ttfamily map$<$\mbox{\hyperlink{invaders_grid_8h_a28be5c0c3bae3518d94b2ede3633e018}{Invader\+Type}}, \mbox{\hyperlink{struct_invader_type_def}{Invader\+Type\+Def}}$>$ Config\+Data\+::invaders\+Def}
link between an invader type, and its data
Definition at line \mbox{\hyperlink{config_data_8h_source_l00097}{97}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_aadc245edaf3b28d82f9ce7b17c655943}\label{struct_config_data_aadc245edaf3b28d82f9ce7b17c655943}}
\index{ConfigData@{ConfigData}!invadersDistance@{invadersDistance}}
\index{invadersDistance@{invadersDistance}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{invadersDistance}{invadersDistance}}
{\footnotesize\ttfamily unsigned Config\+Data\+::invaders\+Distance}
distance in pixel between two invader
Definition at line \mbox{\hyperlink{config_data_8h_source_l00087}{87}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_a0a8ca410dbc6b6cd62d16d1fa19a83f9}\label{struct_config_data_a0a8ca410dbc6b6cd62d16d1fa19a83f9}}
\index{ConfigData@{ConfigData}!invadersFireCooldown@{invadersFireCooldown}}
\index{invadersFireCooldown@{invadersFireCooldown}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{invadersFireCooldown}{invadersFireCooldown}}
{\footnotesize\ttfamily unsigned Config\+Data\+::invaders\+Fire\+Cooldown}
wait time between two invader missile
Definition at line \mbox{\hyperlink{config_data_8h_source_l00092}{92}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_ada929ea4a462c0bde376adf9fa3f4810}\label{struct_config_data_ada929ea4a462c0bde376adf9fa3f4810}}
\index{ConfigData@{ConfigData}!invadersSize@{invadersSize}}
\index{invadersSize@{invadersSize}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{invadersSize}{invadersSize}}
{\footnotesize\ttfamily unsigned Config\+Data\+::invaders\+Size}
invader radius size in pixel
Definition at line \mbox{\hyperlink{config_data_8h_source_l00082}{82}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_ad057123e1f1b7283b873eed8a07ead3f}\label{struct_config_data_ad057123e1f1b7283b873eed8a07ead3f}}
\index{ConfigData@{ConfigData}!invadersSpeed@{invadersSpeed}}
\index{invadersSpeed@{invadersSpeed}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{invadersSpeed}{invadersSpeed}}
{\footnotesize\ttfamily unsigned Config\+Data\+::invaders\+Speed}
invader movement speed
Definition at line \mbox{\hyperlink{config_data_8h_source_l00077}{77}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_adb4b297d72ba060cbe54785d5791d6ea}\label{struct_config_data_adb4b297d72ba060cbe54785d5791d6ea}}
\index{ConfigData@{ConfigData}!maxFPS@{maxFPS}}
\index{maxFPS@{maxFPS}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{maxFPS}{maxFPS}}
{\footnotesize\ttfamily unsigned Config\+Data\+::max\+FPS}
maximum framerate at which the game will run
Definition at line \mbox{\hyperlink{config_data_8h_source_l00037}{37}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_abb41165730c7e25dffe63d2fb08022f4}\label{struct_config_data_abb41165730c7e25dffe63d2fb08022f4}}
\index{ConfigData@{ConfigData}!missilesColor@{missilesColor}}
\index{missilesColor@{missilesColor}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{missilesColor}{missilesColor}}
{\footnotesize\ttfamily ns\+Graphics\+::\+RGBAcolor Config\+Data\+::missiles\+Color}
invaders missiles color
Definition at line \mbox{\hyperlink{config_data_8h_source_l00117}{117}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_ae736dc72056f45f4a3f0fef365bc54be}\label{struct_config_data_ae736dc72056f45f4a3f0fef365bc54be}}
\index{ConfigData@{ConfigData}!missilesLength@{missilesLength}}
\index{missilesLength@{missilesLength}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{missilesLength}{missilesLength}}
{\footnotesize\ttfamily unsigned Config\+Data\+::missiles\+Length}
virtual value \+: invaders missiles length in pixel -\/ auto defined from width
Definition at line \mbox{\hyperlink{config_data_8h_source_l00107}{107}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_ae5efc1b5a2b95b1a9c7ff60eee480e71}\label{struct_config_data_ae5efc1b5a2b95b1a9c7ff60eee480e71}}
\index{ConfigData@{ConfigData}!missilesSpeed@{missilesSpeed}}
\index{missilesSpeed@{missilesSpeed}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{missilesSpeed}{missilesSpeed}}
{\footnotesize\ttfamily unsigned Config\+Data\+::missiles\+Speed}
invaders missiles movement speed
Definition at line \mbox{\hyperlink{config_data_8h_source_l00112}{112}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_a4f8e7615d2619a3b37e97465ac143fee}\label{struct_config_data_a4f8e7615d2619a3b37e97465ac143fee}}
\index{ConfigData@{ConfigData}!missilesWidth@{missilesWidth}}
\index{missilesWidth@{missilesWidth}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{missilesWidth}{missilesWidth}}
{\footnotesize\ttfamily unsigned Config\+Data\+::missiles\+Width}
invaders missiles width in pixel
Definition at line \mbox{\hyperlink{config_data_8h_source_l00102}{102}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_a909ad90d692e87b2c93c3966d07ecc16}\label{struct_config_data_a909ad90d692e87b2c93c3966d07ecc16}}
\index{ConfigData@{ConfigData}!playerDefs@{playerDefs}}
\index{playerDefs@{playerDefs}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{playerDefs}{playerDefs}}
{\footnotesize\ttfamily vector$<$\mbox{\hyperlink{struct_player_def}{Player\+Def}}$>$ Config\+Data\+::player\+Defs}
players configuration
Definition at line \mbox{\hyperlink{config_data_8h_source_l00072}{72}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_a641d7b2133165ce2eccaea972265f557}\label{struct_config_data_a641d7b2133165ce2eccaea972265f557}}
\index{ConfigData@{ConfigData}!playersFireCooldown@{playersFireCooldown}}
\index{playersFireCooldown@{playersFireCooldown}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{playersFireCooldown}{playersFireCooldown}}
{\footnotesize\ttfamily unsigned Config\+Data\+::players\+Fire\+Cooldown}
player shooting wait time
Definition at line \mbox{\hyperlink{config_data_8h_source_l00062}{62}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_a09170415d0a4c525e546d6fd0ecb354c}\label{struct_config_data_a09170415d0a4c525e546d6fd0ecb354c}}
\index{ConfigData@{ConfigData}!playersLives@{playersLives}}
\index{playersLives@{playersLives}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{playersLives}{playersLives}}
{\footnotesize\ttfamily unsigned Config\+Data\+::players\+Lives}
player life points
Definition at line \mbox{\hyperlink{config_data_8h_source_l00067}{67}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_a199264aa6e6c3b267462f0a5427cd5db}\label{struct_config_data_a199264aa6e6c3b267462f0a5427cd5db}}
\index{ConfigData@{ConfigData}!playersSpeed@{playersSpeed}}
\index{playersSpeed@{playersSpeed}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{playersSpeed}{playersSpeed}}
{\footnotesize\ttfamily unsigned Config\+Data\+::players\+Speed}
player movement speed
Definition at line \mbox{\hyperlink{config_data_8h_source_l00052}{52}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_ad8c5d2876699ea9e451e6b3a15618707}\label{struct_config_data_ad8c5d2876699ea9e451e6b3a15618707}}
\index{ConfigData@{ConfigData}!playersWidth@{playersWidth}}
\index{playersWidth@{playersWidth}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{playersWidth}{playersWidth}}
{\footnotesize\ttfamily unsigned Config\+Data\+::players\+Width}
player horizontal size in pixel
Definition at line \mbox{\hyperlink{config_data_8h_source_l00057}{57}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_a002e3aaf06ba352a9ff4e2f50895a65f}\label{struct_config_data_a002e3aaf06ba352a9ff4e2f50895a65f}}
\index{ConfigData@{ConfigData}!startXPosition@{startXPosition}}
\index{startXPosition@{startXPosition}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{startXPosition}{startXPosition}}
{\footnotesize\ttfamily unsigned Config\+Data\+::start\+XPosition}
players horizontal start position
Definition at line \mbox{\hyperlink{config_data_8h_source_l00047}{47}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_a3c9baa529db8e439f903590f5a9bcce2}\label{struct_config_data_a3c9baa529db8e439f903590f5a9bcce2}}
\index{ConfigData@{ConfigData}!theme@{theme}}
\index{theme@{theme}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{theme}{theme}}
{\footnotesize\ttfamily string Config\+Data\+::theme}
theme to use. Valid values \+: good,bad
Definition at line \mbox{\hyperlink{config_data_8h_source_l00032}{32}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_a7edb4693b5fb5036b09b95d314d29495}\label{struct_config_data_a7edb4693b5fb5036b09b95d314d29495}}
\index{ConfigData@{ConfigData}!torpedosColor@{torpedosColor}}
\index{torpedosColor@{torpedosColor}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{torpedosColor}{torpedosColor}}
{\footnotesize\ttfamily ns\+Graphics\+::\+RGBAcolor Config\+Data\+::torpedos\+Color}
players torpedos color
Definition at line \mbox{\hyperlink{config_data_8h_source_l00137}{137}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_a5de633401856c45fb3b8c3333d38804c}\label{struct_config_data_a5de633401856c45fb3b8c3333d38804c}}
\index{ConfigData@{ConfigData}!torpedosLength@{torpedosLength}}
\index{torpedosLength@{torpedosLength}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{torpedosLength}{torpedosLength}}
{\footnotesize\ttfamily unsigned Config\+Data\+::torpedos\+Length}
virtual value \+: players torpedos length in pixel -\/ auto defined from width
Definition at line \mbox{\hyperlink{config_data_8h_source_l00127}{127}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_aa491de435feeca58c85652f4961ddece}\label{struct_config_data_aa491de435feeca58c85652f4961ddece}}
\index{ConfigData@{ConfigData}!torpedosSpeed@{torpedosSpeed}}
\index{torpedosSpeed@{torpedosSpeed}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{torpedosSpeed}{torpedosSpeed}}
{\footnotesize\ttfamily unsigned Config\+Data\+::torpedos\+Speed}
players topedos movement speed
Definition at line \mbox{\hyperlink{config_data_8h_source_l00132}{132}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
\mbox{\Hypertarget{struct_config_data_aec2b163d49271a1a1654c903de9e45ff}\label{struct_config_data_aec2b163d49271a1a1654c903de9e45ff}}
\index{ConfigData@{ConfigData}!torpedosWidth@{torpedosWidth}}
\index{torpedosWidth@{torpedosWidth}!ConfigData@{ConfigData}}
\doxysubsubsection{\texorpdfstring{torpedosWidth}{torpedosWidth}}
{\footnotesize\ttfamily unsigned Config\+Data\+::torpedos\+Width}
players torpedos width in pixel
Definition at line \mbox{\hyperlink{config_data_8h_source_l00122}{122}} of file \mbox{\hyperlink{config_data_8h_source}{config\+Data.\+h}}.
The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item
headers/\mbox{\hyperlink{config_data_8h}{config\+Data.\+h}}\end{DoxyCompactItemize}