SuperSpaceInvaderTurboApoca.../doc/SAE102-SpaceInvaders/latex/d3/db1/struct_player.tex

207 lines
8.1 KiB
TeX

\hypertarget{struct_player}{}\doxysection{Player Struct Reference}
\label{struct_player}\index{Player@{Player}}
player data structure
{\ttfamily \#include $<$player.\+h$>$}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
bool \mbox{\hyperlink{struct_player_a45bd873fbf46cb105cb038b51251a812}{has\+Death\+Animation}} () const
\item
bool \mbox{\hyperlink{struct_player_a7aacef142ba14d6af7a6dfcb8ef327cd}{is\+Eliminated}} () const
\item
bool \mbox{\hyperlink{struct_player_a06b5d53d568f357f77df80d0859fe8db}{is\+Playing}} () const
\item
void \mbox{\hyperlink{struct_player_a2badc28b66b2380a978db9676fec644d}{damage}} ()
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
unsigned \mbox{\hyperlink{struct_player_af21f9d3b115801ee284a9c5e81bd3db5}{lives}} = 3
\begin{DoxyCompactList}\small\item\em player life points \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_player_a9edbd6fa228cf532b7a74fb45721c2e0}{x}}
\begin{DoxyCompactList}\small\item\em x coordinate of the player \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_player_a15bc878713e5b607357a0b6f3f56dff9}{id}}
\begin{DoxyCompactList}\small\item\em player\textquotesingle{}s unique identidier \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_player_a18afa2dfc1f6dfba7bbe08889f443da5}{score}} =0
\begin{DoxyCompactList}\small\item\em player\textquotesingle{}s personal score \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_player_a3f6353c84662c57d74aafa770773c409}{death\+Anim\+Counter}} =0
\begin{DoxyCompactList}\small\item\em counter used for the death animation of players undefined once the player is eliminated \end{DoxyCompactList}\item
unsigned \mbox{\hyperlink{struct_player_a68ea5bd892a77c115baff824c526b3d2}{fire\+Cooldown}} =0
\begin{DoxyCompactList}\small\item\em player\textquotesingle{}s shooting cooldown ~\newline
\end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
player data structure
Definition at line \mbox{\hyperlink{player_8h_source_l00019}{19}} of file \mbox{\hyperlink{player_8h_source}{player.\+h}}.
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{struct_player_a2badc28b66b2380a978db9676fec644d}\label{struct_player_a2badc28b66b2380a978db9676fec644d}}
\index{Player@{Player}!damage@{damage}}
\index{damage@{damage}!Player@{Player}}
\doxysubsubsection{\texorpdfstring{damage()}{damage()}}
{\footnotesize\ttfamily void Player\+::damage (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
Definition at line \mbox{\hyperlink{player_8cpp_source_l00026}{26}} of file \mbox{\hyperlink{player_8cpp_source}{player.\+cpp}}.
\mbox{\Hypertarget{struct_player_a45bd873fbf46cb105cb038b51251a812}\label{struct_player_a45bd873fbf46cb105cb038b51251a812}}
\index{Player@{Player}!hasDeathAnimation@{hasDeathAnimation}}
\index{hasDeathAnimation@{hasDeathAnimation}!Player@{Player}}
\doxysubsubsection{\texorpdfstring{hasDeathAnimation()}{hasDeathAnimation()}}
{\footnotesize\ttfamily bool Player\+::has\+Death\+Animation (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}
Definition at line \mbox{\hyperlink{player_8cpp_source_l00018}{18}} of file \mbox{\hyperlink{player_8cpp_source}{player.\+cpp}}.
Here is the caller graph for this function\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=336pt]{d3/db1/struct_player_a45bd873fbf46cb105cb038b51251a812_icgraph}
\end{center}
\end{figure}
\mbox{\Hypertarget{struct_player_a7aacef142ba14d6af7a6dfcb8ef327cd}\label{struct_player_a7aacef142ba14d6af7a6dfcb8ef327cd}}
\index{Player@{Player}!isEliminated@{isEliminated}}
\index{isEliminated@{isEliminated}!Player@{Player}}
\doxysubsubsection{\texorpdfstring{isEliminated()}{isEliminated()}}
{\footnotesize\ttfamily bool Player\+::is\+Eliminated (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}
Definition at line \mbox{\hyperlink{player_8cpp_source_l00022}{22}} of file \mbox{\hyperlink{player_8cpp_source}{player.\+cpp}}.
Here is the caller graph for this function\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=304pt]{d3/db1/struct_player_a7aacef142ba14d6af7a6dfcb8ef327cd_icgraph}
\end{center}
\end{figure}
\mbox{\Hypertarget{struct_player_a06b5d53d568f357f77df80d0859fe8db}\label{struct_player_a06b5d53d568f357f77df80d0859fe8db}}
\index{Player@{Player}!isPlaying@{isPlaying}}
\index{isPlaying@{isPlaying}!Player@{Player}}
\doxysubsubsection{\texorpdfstring{isPlaying()}{isPlaying()}}
{\footnotesize\ttfamily bool Player\+::is\+Playing (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}
Definition at line \mbox{\hyperlink{player_8cpp_source_l00014}{14}} of file \mbox{\hyperlink{player_8cpp_source}{player.\+cpp}}.
Here is the call graph for this function\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=336pt]{d3/db1/struct_player_a06b5d53d568f357f77df80d0859fe8db_cgraph}
\end{center}
\end{figure}
\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{struct_player_a3f6353c84662c57d74aafa770773c409}\label{struct_player_a3f6353c84662c57d74aafa770773c409}}
\index{Player@{Player}!deathAnimCounter@{deathAnimCounter}}
\index{deathAnimCounter@{deathAnimCounter}!Player@{Player}}
\doxysubsubsection{\texorpdfstring{deathAnimCounter}{deathAnimCounter}}
{\footnotesize\ttfamily unsigned Player\+::death\+Anim\+Counter =0}
counter used for the death animation of players undefined once the player is eliminated
Definition at line \mbox{\hyperlink{player_8h_source_l00045}{45}} of file \mbox{\hyperlink{player_8h_source}{player.\+h}}.
\mbox{\Hypertarget{struct_player_a68ea5bd892a77c115baff824c526b3d2}\label{struct_player_a68ea5bd892a77c115baff824c526b3d2}}
\index{Player@{Player}!fireCooldown@{fireCooldown}}
\index{fireCooldown@{fireCooldown}!Player@{Player}}
\doxysubsubsection{\texorpdfstring{fireCooldown}{fireCooldown}}
{\footnotesize\ttfamily unsigned Player\+::fire\+Cooldown =0}
player\textquotesingle{}s shooting cooldown ~\newline
Definition at line \mbox{\hyperlink{player_8h_source_l00050}{50}} of file \mbox{\hyperlink{player_8h_source}{player.\+h}}.
\mbox{\Hypertarget{struct_player_a15bc878713e5b607357a0b6f3f56dff9}\label{struct_player_a15bc878713e5b607357a0b6f3f56dff9}}
\index{Player@{Player}!id@{id}}
\index{id@{id}!Player@{Player}}
\doxysubsubsection{\texorpdfstring{id}{id}}
{\footnotesize\ttfamily unsigned Player\+::id}
player\textquotesingle{}s unique identidier
Definition at line \mbox{\hyperlink{player_8h_source_l00034}{34}} of file \mbox{\hyperlink{player_8h_source}{player.\+h}}.
\mbox{\Hypertarget{struct_player_af21f9d3b115801ee284a9c5e81bd3db5}\label{struct_player_af21f9d3b115801ee284a9c5e81bd3db5}}
\index{Player@{Player}!lives@{lives}}
\index{lives@{lives}!Player@{Player}}
\doxysubsubsection{\texorpdfstring{lives}{lives}}
{\footnotesize\ttfamily unsigned Player\+::lives = 3}
player life points
Definition at line \mbox{\hyperlink{player_8h_source_l00024}{24}} of file \mbox{\hyperlink{player_8h_source}{player.\+h}}.
\mbox{\Hypertarget{struct_player_a18afa2dfc1f6dfba7bbe08889f443da5}\label{struct_player_a18afa2dfc1f6dfba7bbe08889f443da5}}
\index{Player@{Player}!score@{score}}
\index{score@{score}!Player@{Player}}
\doxysubsubsection{\texorpdfstring{score}{score}}
{\footnotesize\ttfamily unsigned Player\+::score =0}
player\textquotesingle{}s personal score
Definition at line \mbox{\hyperlink{player_8h_source_l00039}{39}} of file \mbox{\hyperlink{player_8h_source}{player.\+h}}.
\mbox{\Hypertarget{struct_player_a9edbd6fa228cf532b7a74fb45721c2e0}\label{struct_player_a9edbd6fa228cf532b7a74fb45721c2e0}}
\index{Player@{Player}!x@{x}}
\index{x@{x}!Player@{Player}}
\doxysubsubsection{\texorpdfstring{x}{x}}
{\footnotesize\ttfamily unsigned Player\+::x}
x coordinate of the player
Definition at line \mbox{\hyperlink{player_8h_source_l00029}{29}} of file \mbox{\hyperlink{player_8h_source}{player.\+h}}.
The documentation for this struct was generated from the following files\+:\begin{DoxyCompactItemize}
\item
headers/\mbox{\hyperlink{player_8h}{player.\+h}}\item
src/\mbox{\hyperlink{player_8cpp}{player.\+cpp}}\end{DoxyCompactItemize}