\hypertarget{classTestMap1}{\section{\-Test\-Map1 \-Class \-Reference}
\label{classTestMap1}\index{\-Test\-Map1@{\-Test\-Map1}}
}


{\ttfamily \#include $<$\-Test\-Map1.\-h$>$}



\-Inheritance diagram for \-Test\-Map1\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=184pt]{classTestMap1__inherit__graph}
\end{center}
\end{figure}


\-Collaboration diagram for \-Test\-Map1\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=184pt]{classTestMap1__coll__graph}
\end{center}
\end{figure}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
virtual void \hyperlink{classTestMap1_a0bad5ab64b7fc16fc030632adf25fefe}{on\-Start} ()
\item 
virtual void \hyperlink{classTestMap1_a1c32000b0b15fd9a1e2829947dab6275}{on\-End} (bool is\-Winner)
\item 
virtual void \hyperlink{classTestMap1_a60c4964dec3b9a1a534d0740485f5c34}{on\-Frame} ()
\item 
virtual void \hyperlink{classTestMap1_aa5d5d0d82f0e3c04cbdf3abf3ae7a82e}{on\-Send\-Text} (std\-::string text)
\item 
virtual void \hyperlink{classTestMap1_aebec646eeb703685108610ab945b4edc}{on\-Player\-Left} (\hyperlink{classBWAPI_1_1Player}{\-B\-W\-A\-P\-I\-::\-Player} $\ast$player)
\item 
virtual void \hyperlink{classTestMap1_a09c6e78d727e280c52c96f0b81e971ce}{on\-Nuke\-Detect} (\hyperlink{classBWAPI_1_1Position}{\-B\-W\-A\-P\-I\-::\-Position} target)
\item 
virtual void \hyperlink{classTestMap1_a0e7d329c955b97e34cffb3cfc10ca39c}{on\-Unit\-Create} (\hyperlink{classBWAPI_1_1Unit}{\-B\-W\-A\-P\-I\-::\-Unit} $\ast$unit)
\item 
virtual void \hyperlink{classTestMap1_aebb6a9681d6ca9448e43335af133ffcf}{on\-Unit\-Destroy} (\hyperlink{classBWAPI_1_1Unit}{\-B\-W\-A\-P\-I\-::\-Unit} $\ast$unit)
\item 
virtual void \hyperlink{classTestMap1_a1333d4b62607f7617a8254e4cae29c65}{on\-Unit\-Morph} (\hyperlink{classBWAPI_1_1Unit}{\-B\-W\-A\-P\-I\-::\-Unit} $\ast$unit)
\item 
virtual void \hyperlink{classTestMap1_aa0789f6a20480c28dc4143f7d16a07f8}{on\-Unit\-Show} (\hyperlink{classBWAPI_1_1Unit}{\-B\-W\-A\-P\-I\-::\-Unit} $\ast$unit)
\item 
virtual void \hyperlink{classTestMap1_abb71990ee809af4b897bce122a9c4362}{on\-Unit\-Hide} (\hyperlink{classBWAPI_1_1Unit}{\-B\-W\-A\-P\-I\-::\-Unit} $\ast$unit)
\item 
virtual void \hyperlink{classTestMap1_a710528df9a85977fd6eca8c727abb9e5}{on\-Unit\-Renegade} (\hyperlink{classBWAPI_1_1Unit}{\-B\-W\-A\-P\-I\-::\-Unit} $\ast$unit)
\item 
virtual void \hyperlink{classTestMap1_acb8264726c8c80cf9ada0a82915ea4f3}{on\-Save\-Game} (std\-::string game\-Name)
\end{DoxyCompactItemize}


\subsection{\-Member \-Function \-Documentation}
\hypertarget{classTestMap1_a1c32000b0b15fd9a1e2829947dab6275}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-End@{on\-End}}
\index{on\-End@{on\-End}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-End}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-End} (
\begin{DoxyParamCaption}
\item[{bool}]{is\-Winner}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_a1c32000b0b15fd9a1e2829947dab6275}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this at the end of the match. is\-Winner will be true if the \-A\-I\-Module won the game. \-If the game is a replay, is\-Winner will always be false. 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_a74ba6d08de9f7d4c4f8504ab32288d45}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_a60c4964dec3b9a1a534d0740485f5c34}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Frame@{on\-Frame}}
\index{on\-Frame@{on\-Frame}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Frame}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Frame} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_a60c4964dec3b9a1a534d0740485f5c34}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this on every logical frame in the game. 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_a4956c50e0d9d26128b34f679399fc89a}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.



\-Here is the call graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=550pt]{classTestMap1_a60c4964dec3b9a1a534d0740485f5c34_cgraph}
\end{center}
\end{figure}


\hypertarget{classTestMap1_a09c6e78d727e280c52c96f0b81e971ce}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Nuke\-Detect@{on\-Nuke\-Detect}}
\index{on\-Nuke\-Detect@{on\-Nuke\-Detect}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Nuke\-Detect}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Nuke\-Detect} (
\begin{DoxyParamCaption}
\item[{{\bf \-B\-W\-A\-P\-I\-::\-Position}}]{target}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_a09c6e78d727e280c52c96f0b81e971ce}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this when a nuclear launch has been detected. \-If the target position is visible, or if \-Complete \-Map \-Information is enabled, the target position will also be provided. \-If \-Complete \-Map \-Information is disabled and the target position is not visible, target will be set to \-Positions\-::\-Unknown. 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_ad04b2e1d279975c21b04ddea7cbeff31}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_aebec646eeb703685108610ab945b4edc}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Player\-Left@{on\-Player\-Left}}
\index{on\-Player\-Left@{on\-Player\-Left}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Player\-Left}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Player\-Left} (
\begin{DoxyParamCaption}
\item[{{\bf \-B\-W\-A\-P\-I\-::\-Player} $\ast$}]{player}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_aebec646eeb703685108610ab945b4edc}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this when a player leaves the game. 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_a9f52e00e397c49ffce2336046ef7a720}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_acb8264726c8c80cf9ada0a82915ea4f3}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Save\-Game@{on\-Save\-Game}}
\index{on\-Save\-Game@{on\-Save\-Game}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Save\-Game}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Save\-Game} (
\begin{DoxyParamCaption}
\item[{std\-::string}]{game\-Name}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_acb8264726c8c80cf9ada0a82915ea4f3}


\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_abb8179f251b940bc6b98962678917dcf}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_aa5d5d0d82f0e3c04cbdf3abf3ae7a82e}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Send\-Text@{on\-Send\-Text}}
\index{on\-Send\-Text@{on\-Send\-Text}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Send\-Text}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Send\-Text} (
\begin{DoxyParamCaption}
\item[{std\-::string}]{text}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_aa5d5d0d82f0e3c04cbdf3abf3ae7a82e}
\-If \-Flag\-::\-User\-Input is enabled, \hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} will call this each time a user enters a message into the chat. 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_adce1b1bf1227d5353c32aa16b3728a1e}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_a0bad5ab64b7fc16fc030632adf25fefe}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Start@{on\-Start}}
\index{on\-Start@{on\-Start}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Start}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Start} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_a0bad5ab64b7fc16fc030632adf25fefe}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this at the start of a match. \-Typically an \-A\-I will execute set up code in this method (initialize data structures, load build orders, etc). 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_aa4a6794e0c2d130b9128524f065a4d53}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_a0e7d329c955b97e34cffb3cfc10ca39c}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Unit\-Create@{on\-Unit\-Create}}
\index{on\-Unit\-Create@{on\-Unit\-Create}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Unit\-Create}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Unit\-Create} (
\begin{DoxyParamCaption}
\item[{{\bf \-B\-W\-A\-P\-I\-::\-Unit} $\ast$}]{unit}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_a0e7d329c955b97e34cffb3cfc10ca39c}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this when a unit is created. \-Note that this is \-N\-O\-T called when a unit changes type (such as larva into egg or egg into drone). \-Building a refinery/assimilator/extractor will not produce an on\-Unit\-Create call since the vespene geyser changes to the unit type of the refinery/assimilator/extractor. \-If \-Complete \-Map \-Information is enabled, this will also be called for new units that are hidden by the fog of war. \-If the unit is visible upon creation, on\-Unit\-Show will be called shortly after on\-Unit\-Create is called. 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_aa445d7eba03ab515c7e6e6f23628e761}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_aebb6a9681d6ca9448e43335af133ffcf}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Unit\-Destroy@{on\-Unit\-Destroy}}
\index{on\-Unit\-Destroy@{on\-Unit\-Destroy}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Unit\-Destroy}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Unit\-Destroy} (
\begin{DoxyParamCaption}
\item[{{\bf \-B\-W\-A\-P\-I\-::\-Unit} $\ast$}]{unit}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_aebb6a9681d6ca9448e43335af133ffcf}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this when a unit dies or otherwise removed from the game (i.\-e. a mined out mineral patch). \-When a zerg drone becomes an extractor, the \-Vespene geyser changes to the \-Zerg \-Extractor type and the drone is removed. \-If \-Complete \-Map \-Information is enabled, this will also be called for units that are hidden by the fog of war. \-If a unit that was visible gets destroyed, on\-Unit\-Hide will be called right before on\-Unit\-Destroy is called. 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_a32637d3e091a5fe7ee53e2de6caccfb6}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_abb71990ee809af4b897bce122a9c4362}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Unit\-Hide@{on\-Unit\-Hide}}
\index{on\-Unit\-Hide@{on\-Unit\-Hide}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Unit\-Hide}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Unit\-Hide} (
\begin{DoxyParamCaption}
\item[{{\bf \-B\-W\-A\-P\-I\-::\-Unit} $\ast$}]{unit}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_abb71990ee809af4b897bce122a9c4362}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this right before a unit becomes invisible, so if you want your non-\/cheating \-A\-I to remember where it last saw a unit, this callback would be a good place to implement it. \-The complete map information flag has no effect on this callback. 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_a9e7912b7e12fcc4f89b79210e7030b8e}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_a1333d4b62607f7617a8254e4cae29c65}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Unit\-Morph@{on\-Unit\-Morph}}
\index{on\-Unit\-Morph@{on\-Unit\-Morph}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Unit\-Morph}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Unit\-Morph} (
\begin{DoxyParamCaption}
\item[{{\bf \-B\-W\-A\-P\-I\-::\-Unit} $\ast$}]{unit}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_a1333d4b62607f7617a8254e4cae29c65}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this when a unit changes type, such as from a \-Zerg \-Drone to a \-Zerg \-Hatchery, or from a \-Terran \-Siege \-Tank \-Tank \-Mode to \-Terran \-Siege \-Tank \-Siege \-Mode. \-This is not called when the type changes to or from \-Unit\-Types\-::\-Unknown (which happens when a unit becomes visible or invisible). 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_aa3ce746650e8071250b252d1de65140f}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_a710528df9a85977fd6eca8c727abb9e5}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Unit\-Renegade@{on\-Unit\-Renegade}}
\index{on\-Unit\-Renegade@{on\-Unit\-Renegade}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Unit\-Renegade}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Unit\-Renegade} (
\begin{DoxyParamCaption}
\item[{{\bf \-B\-W\-A\-P\-I\-::\-Unit} $\ast$}]{unit}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_a710528df9a85977fd6eca8c727abb9e5}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this when an accessible unit changes ownership. 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_ae84881637231279476fea62655965c99}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.

\hypertarget{classTestMap1_aa0789f6a20480c28dc4143f7d16a07f8}{\index{\-Test\-Map1@{\-Test\-Map1}!on\-Unit\-Show@{on\-Unit\-Show}}
\index{on\-Unit\-Show@{on\-Unit\-Show}!TestMap1@{\-Test\-Map1}}
\subsubsection[{on\-Unit\-Show}]{\setlength{\rightskip}{0pt plus 5cm}void {\bf \-Test\-Map1\-::on\-Unit\-Show} (
\begin{DoxyParamCaption}
\item[{{\bf \-B\-W\-A\-P\-I\-::\-Unit} $\ast$}]{unit}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}virtual\mbox{]}}}}\label{classTestMap1_aa0789f6a20480c28dc4143f7d16a07f8}
\hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} calls this the instant a previously invisible unit becomes visible. \-The complete map information flag has no effect on this callback. 

\-Reimplemented from \hyperlink{classBWAPI_1_1AIModule_ab12d4ed441c6f26e2b84237918f816e0}{\-B\-W\-A\-P\-I\-::\-A\-I\-Module}.



\-The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
trunk/bwapi/\-Test\-A\-I\-Module/\-Source/\hyperlink{TestMap1_8h}{\-Test\-Map1.\-h}\item 
trunk/bwapi/\-Test\-A\-I\-Module/\-Source/\hyperlink{TestMap1_8cpp}{\-Test\-Map1.\-cpp}\end{DoxyCompactItemize}
