199 lines
7.6 KiB
TeX
199 lines
7.6 KiB
TeX
\hypertarget{class_game}{}\doxysection{Game Class Reference}
|
|
\label{class_game}\index{Game@{Game}}
|
|
|
|
|
|
Main game class.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$game.\+h$>$}
|
|
|
|
\doxysubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{class_game_ad59df6562a58a614fda24622d3715b65}{Game}} ()
|
|
\begin{DoxyCompactList}\small\item\em constructor for the game class \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{class_game_a185d2ce9845c75b62064dc6d60f79eab}{managed\+Games}} ()
|
|
\begin{DoxyCompactList}\small\item\em start games managed by our class \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{class_game_ab684b380c7d3f3577e2fb80006415297}{init\+Game}} ()
|
|
\begin{DoxyCompactList}\small\item\em Set or reset all the setting for a new game. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{utils_8h_acd2eabcda2cfc7902077f1f9a9e318de}{Win\+Value}} \mbox{\hyperlink{class_game_a74570e2b1a4930b1ab1c957b5e60320e}{enter\+Game\+Loop}} ()
|
|
\begin{DoxyCompactList}\small\item\em enter the main gameplay game loop. Will block until the game ends \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{class_game_ac6c18f49964d49c3c5c826ef678f0792}{reload\+Config}} ()
|
|
\begin{DoxyCompactList}\small\item\em reload the configuration file (not dynamically used currently, but it was planned to be) \end{DoxyCompactList}\item
|
|
bool \mbox{\hyperlink{class_game_aef8202b79983c3b0f8d6db6c01d17fa6}{are\+Players\+Dead}} ()
|
|
\begin{DoxyCompactList}\small\item\em tells if all players are dead \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
Main game class.
|
|
|
|
Definition at line \mbox{\hyperlink{game_8h_source_l00034}{34}} of file \mbox{\hyperlink{game_8h_source}{game.\+h}}.
|
|
|
|
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\mbox{\Hypertarget{class_game_ad59df6562a58a614fda24622d3715b65}\label{class_game_ad59df6562a58a614fda24622d3715b65}}
|
|
\index{Game@{Game}!Game@{Game}}
|
|
\index{Game@{Game}!Game@{Game}}
|
|
\doxysubsubsection{\texorpdfstring{Game()}{Game()}}
|
|
{\footnotesize\ttfamily Game\+::\+Game (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
constructor for the game class
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{game_basics_8cpp_source_l00020}{20}} of file \mbox{\hyperlink{game_basics_8cpp_source}{game\+Basics.\+cpp}}.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\mbox{\Hypertarget{class_game_aef8202b79983c3b0f8d6db6c01d17fa6}\label{class_game_aef8202b79983c3b0f8d6db6c01d17fa6}}
|
|
\index{Game@{Game}!arePlayersDead@{arePlayersDead}}
|
|
\index{arePlayersDead@{arePlayersDead}!Game@{Game}}
|
|
\doxysubsubsection{\texorpdfstring{arePlayersDead()}{arePlayersDead()}}
|
|
{\footnotesize\ttfamily bool Game\+::are\+Players\+Dead (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
tells if all players are dead
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
true if all player are dead, false otherwise
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{game_basics_8cpp_source_l00175}{175}} of file \mbox{\hyperlink{game_basics_8cpp_source}{game\+Basics.\+cpp}}.
|
|
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{dd/d1f/class_game_aef8202b79983c3b0f8d6db6c01d17fa6_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_game_a74570e2b1a4930b1ab1c957b5e60320e}\label{class_game_a74570e2b1a4930b1ab1c957b5e60320e}}
|
|
\index{Game@{Game}!enterGameLoop@{enterGameLoop}}
|
|
\index{enterGameLoop@{enterGameLoop}!Game@{Game}}
|
|
\doxysubsubsection{\texorpdfstring{enterGameLoop()}{enterGameLoop()}}
|
|
{\footnotesize\ttfamily \mbox{\hyperlink{utils_8h_acd2eabcda2cfc7902077f1f9a9e318de}{Win\+Value}} Game\+::enter\+Game\+Loop (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
enter the main gameplay game loop. Will block until the game ends
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
the value of the winners can be the players, the invaders or god
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{game_basics_8cpp_source_l00115}{115}} of file \mbox{\hyperlink{game_basics_8cpp_source}{game\+Basics.\+cpp}}.
|
|
|
|
Here is the call graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=349pt]{dd/d1f/class_game_a74570e2b1a4930b1ab1c957b5e60320e_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{dd/d1f/class_game_a74570e2b1a4930b1ab1c957b5e60320e_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_game_ab684b380c7d3f3577e2fb80006415297}\label{class_game_ab684b380c7d3f3577e2fb80006415297}}
|
|
\index{Game@{Game}!initGame@{initGame}}
|
|
\index{initGame@{initGame}!Game@{Game}}
|
|
\doxysubsubsection{\texorpdfstring{initGame()}{initGame()}}
|
|
{\footnotesize\ttfamily void Game\+::init\+Game (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
Set or reset all the setting for a new game.
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{game_basics_8cpp_source_l00083}{83}} of file \mbox{\hyperlink{game_basics_8cpp_source}{game\+Basics.\+cpp}}.
|
|
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{dd/d1f/class_game_ab684b380c7d3f3577e2fb80006415297_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_game_a185d2ce9845c75b62064dc6d60f79eab}\label{class_game_a185d2ce9845c75b62064dc6d60f79eab}}
|
|
\index{Game@{Game}!managedGames@{managedGames}}
|
|
\index{managedGames@{managedGames}!Game@{Game}}
|
|
\doxysubsubsection{\texorpdfstring{managedGames()}{managedGames()}}
|
|
{\footnotesize\ttfamily void Game\+::managed\+Games (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
start games managed by our class
|
|
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{game_basics_8cpp_source_l00063}{63}} of file \mbox{\hyperlink{game_basics_8cpp_source}{game\+Basics.\+cpp}}.
|
|
|
|
Here is the call graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{dd/d1f/class_game_a185d2ce9845c75b62064dc6d60f79eab_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
Here is the caller graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=273pt]{dd/d1f/class_game_a185d2ce9845c75b62064dc6d60f79eab_icgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
\mbox{\Hypertarget{class_game_ac6c18f49964d49c3c5c826ef678f0792}\label{class_game_ac6c18f49964d49c3c5c826ef678f0792}}
|
|
\index{Game@{Game}!reloadConfig@{reloadConfig}}
|
|
\index{reloadConfig@{reloadConfig}!Game@{Game}}
|
|
\doxysubsubsection{\texorpdfstring{reloadConfig()}{reloadConfig()}}
|
|
{\footnotesize\ttfamily bool Game\+::reload\+Config (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
|
|
|
|
|
|
|
|
reload the configuration file (not dynamically used currently, but it was planned to be)
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
false if an error occurred, true otherwise
|
|
\end{DoxyReturn}
|
|
|
|
|
|
Definition at line \mbox{\hyperlink{config_management_8cpp_source_l00311}{311}} of file \mbox{\hyperlink{config_management_8cpp_source}{config\+Management.\+cpp}}.
|
|
|
|
Here is the call graph for this function\+:
|
|
\nopagebreak
|
|
\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[width=350pt]{dd/d1f/class_game_ac6c18f49964d49c3c5c826ef678f0792_cgraph}
|
|
\end{center}
|
|
\end{figure}
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
headers/\mbox{\hyperlink{game_8h}{game.\+h}}\item
|
|
src/\mbox{\hyperlink{config_management_8cpp}{config\+Management.\+cpp}}\item
|
|
src/game/\mbox{\hyperlink{display_8cpp}{display.\+cpp}}\item
|
|
src/game/\mbox{\hyperlink{game_basics_8cpp}{game\+Basics.\+cpp}}\item
|
|
src/game/\mbox{\hyperlink{game_managers_8cpp}{game\+Managers.\+cpp}}\item
|
|
src/game/\mbox{\hyperlink{god_manager_8cpp}{god\+Manager.\+cpp}}\end{DoxyCompactItemize}
|