\hypertarget{classBWAPI_1_1Race}{\section{\-B\-W\-A\-P\-I\-:\-:\-Race \-Class \-Reference}
\label{classBWAPI_1_1Race}\index{\-B\-W\-A\-P\-I\-::\-Race@{\-B\-W\-A\-P\-I\-::\-Race}}
}


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



\-Inheritance diagram for \-B\-W\-A\-P\-I\-:\-:\-Race\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=190pt]{classBWAPI_1_1Race__inherit__graph}
\end{center}
\end{figure}


\-Collaboration diagram for \-B\-W\-A\-P\-I\-:\-:\-Race\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=190pt]{classBWAPI_1_1Race__coll__graph}
\end{center}
\end{figure}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classBWAPI_1_1Race_ab94ae0378c9881b89f648b8f39b0302f}{\-Race} ()
\item 
\hyperlink{classBWAPI_1_1Race_a2f67be5264f7397fcd0d7c96dd9fa7bc}{\-Race} (\hyperlink{Detours_8h_ab5a791e918b09a41addbf5b813175633}{int} id)
\item 
const std\-::string \& \hyperlink{classBWAPI_1_1Race_abe4536b64ede5af240f5529acbb24a2f}{get\-Name} () const 
\item 
const char $\ast$ \hyperlink{classBWAPI_1_1Race_ae9b7e2283c736ef33afd8f43317bbedd}{c\-\_\-str} () const 
\item 
\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} \hyperlink{classBWAPI_1_1Race_a7c3e90cb9be7df168a50a174bd617a1c}{get\-Worker} () const 
\item 
\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} \hyperlink{classBWAPI_1_1Race_a0e70aa4bb18cb64aa4084ccafd12cf05}{get\-Center} () const 
\item 
\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} \hyperlink{classBWAPI_1_1Race_a779c8136019fdb1ef786ebf3439030b0}{get\-Refinery} () const 
\item 
\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} \hyperlink{classBWAPI_1_1Race_a5d51d17c3b250a87a73970d065f5520b}{get\-Transport} () const 
\item 
\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} \hyperlink{classBWAPI_1_1Race_a163b18a5841c696888d292389f6399de}{get\-Supply\-Provider} () const 
\end{DoxyCompactItemize}


\subsection{\-Constructor \& \-Destructor \-Documentation}
\hypertarget{classBWAPI_1_1Race_ab94ae0378c9881b89f648b8f39b0302f}{\index{\-B\-W\-A\-P\-I\-::\-Race@{\-B\-W\-A\-P\-I\-::\-Race}!\-Race@{\-Race}}
\index{\-Race@{\-Race}!BWAPI::Race@{\-B\-W\-A\-P\-I\-::\-Race}}
\subsubsection[{\-Race}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-B\-W\-A\-P\-I\-::\-Race\-::\-Race} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{classBWAPI_1_1Race_ab94ae0378c9881b89f648b8f39b0302f}
\hypertarget{classBWAPI_1_1Race_a2f67be5264f7397fcd0d7c96dd9fa7bc}{\index{\-B\-W\-A\-P\-I\-::\-Race@{\-B\-W\-A\-P\-I\-::\-Race}!\-Race@{\-Race}}
\index{\-Race@{\-Race}!BWAPI::Race@{\-B\-W\-A\-P\-I\-::\-Race}}
\subsubsection[{\-Race}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-B\-W\-A\-P\-I\-::\-Race\-::\-Race} (
\begin{DoxyParamCaption}
\item[{{\bf int}}]{id}
\end{DoxyParamCaption}
)}}\label{classBWAPI_1_1Race_a2f67be5264f7397fcd0d7c96dd9fa7bc}


\subsection{\-Member \-Function \-Documentation}
\hypertarget{classBWAPI_1_1Race_ae9b7e2283c736ef33afd8f43317bbedd}{\index{\-B\-W\-A\-P\-I\-::\-Race@{\-B\-W\-A\-P\-I\-::\-Race}!c\-\_\-str@{c\-\_\-str}}
\index{c\-\_\-str@{c\-\_\-str}!BWAPI::Race@{\-B\-W\-A\-P\-I\-::\-Race}}
\subsubsection[{c\-\_\-str}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ {\bf \-B\-W\-A\-P\-I\-::\-Race\-::c\-\_\-str} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Race_ae9b7e2283c736ef33afd8f43317bbedd}


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




\-Here is the caller graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classBWAPI_1_1Race_ae9b7e2283c736ef33afd8f43317bbedd_icgraph}
\end{center}
\end{figure}


\hypertarget{classBWAPI_1_1Race_a0e70aa4bb18cb64aa4084ccafd12cf05}{\index{\-B\-W\-A\-P\-I\-::\-Race@{\-B\-W\-A\-P\-I\-::\-Race}!get\-Center@{get\-Center}}
\index{get\-Center@{get\-Center}!BWAPI::Race@{\-B\-W\-A\-P\-I\-::\-Race}}
\subsubsection[{get\-Center}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-Unit\-Type} {\bf \-B\-W\-A\-P\-I\-::\-Race\-::get\-Center} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Race_a0e70aa4bb18cb64aa4084ccafd12cf05}
\-Returns the center unit type for the given race. \-For example \-Races\-::\-Terran.\-get\-Center() will return a pointer to \hyperlink{namespaceBWAPI_1_1UnitTypes_a8930f9641cdd63764dbc7f17db2b0f21}{\-Unit\-Types\-::\-Terran\-\_\-\-Command\-\_\-\-Center}. \-While there are three center types for \-Zerg (\-Hatchery, \-Lair, and \-Hive), \-Races\-::\-Zerg.\-get\-Center() will only return a pointer to \hyperlink{namespaceBWAPI_1_1UnitTypes_acff0f3ce54fb32b578343e0aa70ff4dd}{\-Unit\-Types\-::\-Zerg\-\_\-\-Hatchery}, since it is the unit type needed to make a new center. 

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


\hypertarget{classBWAPI_1_1Race_abe4536b64ede5af240f5529acbb24a2f}{\index{\-B\-W\-A\-P\-I\-::\-Race@{\-B\-W\-A\-P\-I\-::\-Race}!get\-Name@{get\-Name}}
\index{get\-Name@{get\-Name}!BWAPI::Race@{\-B\-W\-A\-P\-I\-::\-Race}}
\subsubsection[{get\-Name}]{\setlength{\rightskip}{0pt plus 5cm}const std\-::string \& {\bf \-B\-W\-A\-P\-I\-::\-Race\-::get\-Name} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Race_abe4536b64ede5af240f5529acbb24a2f}
\-Returns the name of the race. \-For example \-Races\-::\-Terran.\-get\-Name() will return a std\-::string object containing \char`\"{}\-Terran\char`\"{}. 

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




\-Here is the caller graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classBWAPI_1_1Race_abe4536b64ede5af240f5529acbb24a2f_icgraph}
\end{center}
\end{figure}


\hypertarget{classBWAPI_1_1Race_a779c8136019fdb1ef786ebf3439030b0}{\index{\-B\-W\-A\-P\-I\-::\-Race@{\-B\-W\-A\-P\-I\-::\-Race}!get\-Refinery@{get\-Refinery}}
\index{get\-Refinery@{get\-Refinery}!BWAPI::Race@{\-B\-W\-A\-P\-I\-::\-Race}}
\subsubsection[{get\-Refinery}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-Unit\-Type} {\bf \-B\-W\-A\-P\-I\-::\-Race\-::get\-Refinery} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Race_a779c8136019fdb1ef786ebf3439030b0}
\-Returns the refinery unit type for the given race. \-For example\-: \-Races\-::\-Zerg.\-get\-Refinery() will return a pointer to \hyperlink{namespaceBWAPI_1_1UnitTypes_aa206d759d328e72eed1064edcc1a7ea7}{\-Unit\-Types\-::\-Zerg\-\_\-\-Extractor}?. 

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


\hypertarget{classBWAPI_1_1Race_a163b18a5841c696888d292389f6399de}{\index{\-B\-W\-A\-P\-I\-::\-Race@{\-B\-W\-A\-P\-I\-::\-Race}!get\-Supply\-Provider@{get\-Supply\-Provider}}
\index{get\-Supply\-Provider@{get\-Supply\-Provider}!BWAPI::Race@{\-B\-W\-A\-P\-I\-::\-Race}}
\subsubsection[{get\-Supply\-Provider}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-Unit\-Type} {\bf \-B\-W\-A\-P\-I\-::\-Race\-::get\-Supply\-Provider} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Race_a163b18a5841c696888d292389f6399de}
\-Returns the main supply provider unit type for the given race. \-For example\-: \-Races\-::\-Terran.\-get\-Supply\-Provider() will return a pointer to \hyperlink{namespaceBWAPI_1_1UnitTypes_aa101d3cb97e574f7830a3bd1f88e2686}{\-Unit\-Types\-::\-Terran\-\_\-\-Supply\-\_\-\-Depot}?. 

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


\hypertarget{classBWAPI_1_1Race_a5d51d17c3b250a87a73970d065f5520b}{\index{\-B\-W\-A\-P\-I\-::\-Race@{\-B\-W\-A\-P\-I\-::\-Race}!get\-Transport@{get\-Transport}}
\index{get\-Transport@{get\-Transport}!BWAPI::Race@{\-B\-W\-A\-P\-I\-::\-Race}}
\subsubsection[{get\-Transport}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-Unit\-Type} {\bf \-B\-W\-A\-P\-I\-::\-Race\-::get\-Transport} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Race_a5d51d17c3b250a87a73970d065f5520b}
\-Returns the transport unit type for the given race. \-For example\-: \-Races\-::\-Protoss.\-get\-Transport() will return a pointer to \hyperlink{namespaceBWAPI_1_1UnitTypes_a83430007b5f8ad31ef402d1eb605a3fc}{\-Unit\-Types\-::\-Protoss\-\_\-\-Shuttle}. 

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


\hypertarget{classBWAPI_1_1Race_a7c3e90cb9be7df168a50a174bd617a1c}{\index{\-B\-W\-A\-P\-I\-::\-Race@{\-B\-W\-A\-P\-I\-::\-Race}!get\-Worker@{get\-Worker}}
\index{get\-Worker@{get\-Worker}!BWAPI::Race@{\-B\-W\-A\-P\-I\-::\-Race}}
\subsubsection[{get\-Worker}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-Unit\-Type} {\bf \-B\-W\-A\-P\-I\-::\-Race\-::get\-Worker} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Race_a7c3e90cb9be7df168a50a174bd617a1c}
\-Returns the worker unit type for the given race. \-For example \-Races\-::\-Protoss.\-get\-Worker() will return a pointer to \hyperlink{namespaceBWAPI_1_1UnitTypes_a8b8f20a2e6d98edb91b6be7122a5989f}{\-Unit\-Types\-::\-Protoss\-\_\-\-Probe}. 

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




\-Here is the caller graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classBWAPI_1_1Race_a7c3e90cb9be7df168a50a174bd617a1c_icgraph}
\end{center}
\end{figure}




\-The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
trunk/bwapi/include/\-B\-W\-A\-P\-I/\hyperlink{include_2BWAPI_2Race_8h}{\-Race.\-h}\item 
trunk/bwapi/\-B\-W\-A\-P\-I\-L\-I\-B/\-Source/\hyperlink{IB_2Source_2Race_8cpp}{\-Race.\-cpp}\end{DoxyCompactItemize}
