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


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



\-Inheritance diagram for \-B\-W\-A\-P\-I\-:\-:\-Force\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=178pt]{classBWAPI_1_1Force__inherit__graph}
\end{center}
\end{figure}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
virtual int \hyperlink{classBWAPI_1_1Force_afa60948570356ad3feec5bc08ba4f9f4}{get\-I\-D} () const =0
\item 
virtual std\-::string \hyperlink{classBWAPI_1_1Force_ac9981cf804e0a58cd2163775e44bf2e2}{get\-Name} () const =0
\item 
virtual std\-::set$<$ \hyperlink{classBWAPI_1_1Player}{\-Player} $\ast$ $>$ \hyperlink{classBWAPI_1_1Force_a7c2f8d8c3821a163efdbc3d7c75566ec}{get\-Players} () const =0
\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}
\-The \hyperlink{classBWAPI_1_1Force}{\-Force} class is used to get information about each force in the match, such as the name of the force and the set of players in the force. 

\subsection{\-Member \-Function \-Documentation}
\hypertarget{classBWAPI_1_1Force_afa60948570356ad3feec5bc08ba4f9f4}{\index{\-B\-W\-A\-P\-I\-::\-Force@{\-B\-W\-A\-P\-I\-::\-Force}!get\-I\-D@{get\-I\-D}}
\index{get\-I\-D@{get\-I\-D}!BWAPI::Force@{\-B\-W\-A\-P\-I\-::\-Force}}
\subsubsection[{get\-I\-D}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Force\-::get\-I\-D} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Force_afa60948570356ad3feec5bc08ba4f9f4}
\-Returns a unique \-I\-D for the force. 

\-Implemented in \hyperlink{classBWAPI_1_1ForceImpl_a7f6ae18a5b84b22c075d721e25211d37}{\-B\-W\-A\-P\-I\-::\-Force\-Impl}.

\hypertarget{classBWAPI_1_1Force_ac9981cf804e0a58cd2163775e44bf2e2}{\index{\-B\-W\-A\-P\-I\-::\-Force@{\-B\-W\-A\-P\-I\-::\-Force}!get\-Name@{get\-Name}}
\index{get\-Name@{get\-Name}!BWAPI::Force@{\-B\-W\-A\-P\-I\-::\-Force}}
\subsubsection[{get\-Name}]{\setlength{\rightskip}{0pt plus 5cm}virtual std\-::string {\bf \-B\-W\-A\-P\-I\-::\-Force\-::get\-Name} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Force_ac9981cf804e0a58cd2163775e44bf2e2}
\-Returns the name of the force. 

\-Implemented in \hyperlink{classBWAPI_1_1ForceImpl_aa004b165706ef27a2df4e6b513cbe7ae}{\-B\-W\-A\-P\-I\-::\-Force\-Impl}.

\hypertarget{classBWAPI_1_1Force_a7c2f8d8c3821a163efdbc3d7c75566ec}{\index{\-B\-W\-A\-P\-I\-::\-Force@{\-B\-W\-A\-P\-I\-::\-Force}!get\-Players@{get\-Players}}
\index{get\-Players@{get\-Players}!BWAPI::Force@{\-B\-W\-A\-P\-I\-::\-Force}}
\subsubsection[{get\-Players}]{\setlength{\rightskip}{0pt plus 5cm}virtual std\-::set$<${\bf \-Player}$\ast$$>$ {\bf \-B\-W\-A\-P\-I\-::\-Force\-::get\-Players} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Force_a7c2f8d8c3821a163efdbc3d7c75566ec}
\-Returns the set of players in the force. 

\-Implemented in \hyperlink{classBWAPI_1_1ForceImpl_a42758d2e867824af02608dd812242692}{\-B\-W\-A\-P\-I\-::\-Force\-Impl}.



\-The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
\-U\-Alberta\-Bot\-\_\-src/\-B\-W\-A\-P\-I\-\_\-3\-\_\-6/include/\-B\-W\-A\-P\-I/\hyperlink{Force_8h}{\-Force.\-h}\end{DoxyCompactItemize}
