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


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



\-Inheritance diagram for \-B\-W\-A\-P\-I\-:\-:\-Player\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=182pt]{classBWAPI_1_1Player__inherit__graph}
\end{center}
\end{figure}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
virtual int \hyperlink{classBWAPI_1_1Player_ae8aee9e47cbb3649be26e55f8f7eeb66}{get\-I\-D} () const =0
\item 
virtual std\-::string \hyperlink{classBWAPI_1_1Player_aea8d3827c2f4b9eeeda342b7234514d1}{get\-Name} () const =0
\item 
virtual const std\-::set$<$ \hyperlink{classBWAPI_1_1Unit}{\-Unit} $\ast$ $>$ \& \hyperlink{classBWAPI_1_1Player_acbb0ae5200ea3a661744358260f91f0c}{get\-Units} () const =0
\item 
virtual \hyperlink{classBWAPI_1_1Race}{\-Race} \hyperlink{classBWAPI_1_1Player_a78006845ba87adf917edac0a9e70d89d}{get\-Race} () const =0
\item 
virtual \hyperlink{classBWAPI_1_1PlayerType}{\-Player\-Type} \hyperlink{classBWAPI_1_1Player_a97cbeb58485914b04726b4ff3b885c5a}{get\-Type} () const =0
\item 
virtual \hyperlink{classBWAPI_1_1Force}{\-Force} $\ast$ \hyperlink{classBWAPI_1_1Player_a1e09a6471c4bd845af0c817bb119d0a7}{get\-Force} () const =0
\item 
virtual bool \hyperlink{classBWAPI_1_1Player_a2ebc13f8d76cd1c9112e0e492e4c89e4}{is\-Ally} (\hyperlink{classBWAPI_1_1Player}{\-Player} $\ast$player) const =0
\item 
virtual bool \hyperlink{classBWAPI_1_1Player_a9109318446cfb09707cd7f756e7277a1}{is\-Enemy} (\hyperlink{classBWAPI_1_1Player}{\-Player} $\ast$player) const =0
\item 
virtual bool \hyperlink{classBWAPI_1_1Player_ad0008609c55e6e954f1043a970b1aeaf}{is\-Neutral} () const =0
\item 
virtual \hyperlink{classBWAPI_1_1TilePosition}{\-Tile\-Position} \hyperlink{classBWAPI_1_1Player_adde672e1826a0579e9e30ab3d662cf5a}{get\-Start\-Location} () const =0
\item 
virtual bool \hyperlink{classBWAPI_1_1Player_a8e6c3f1c9ad684d56cb7aedec20e5f65}{is\-Victorious} () const =0
\item 
virtual bool \hyperlink{classBWAPI_1_1Player_a86ecbbf0a124e22a300c85c134a99210}{is\-Defeated} () const =0
\item 
virtual bool \hyperlink{classBWAPI_1_1Player_a395851d0a1ca28c258f720896a487235}{left\-Game} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a1e4250f05e5b05447c7c7bf06ba9348b}{minerals} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_ac83e79adbbed71002828bf270eeaef1a}{gas} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a9c13b0ea910272b2ee78cbb19172aab8}{cumulative\-Minerals} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a6d2d6ad617102e808ab8ed22555956ce}{cumulative\-Gas} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a41f4dd146a0b3138a3eb2f2d7f3e435f}{supply\-Total} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a698769da69dd4bcd71c021a0455ca6e2}{supply\-Total} (\hyperlink{classBWAPI_1_1Race}{\-Race} race) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a85c99c8f86a275ff52ddb3276689e47b}{supply\-Used} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a7890ecb7af9915939c23edb6f7d2a15f}{supply\-Used} (\hyperlink{classBWAPI_1_1Race}{\-Race} race) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a515c0c0ce42f9a779da60fb9899ec6eb}{all\-Unit\-Count} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_abfb2026846b872af653a420cf76db6f9}{visible\-Unit\-Count} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a271b9290e031ddc46bb2955a53e281cb}{completed\-Unit\-Count} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a3005d3f1e95ab637017c07f9ce9194ff}{incomplete\-Unit\-Count} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_aa43e2a87bce2f1750abb1883a8c59a43}{dead\-Unit\-Count} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a4454ce8bd27b9857a5eb07fda1c5a1e0}{killed\-Unit\-Count} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a738edf86a2be8c1181064d37f2fd6990}{get\-Upgrade\-Level} (\hyperlink{classBWAPI_1_1UpgradeType}{\-Upgrade\-Type} upgrade) const =0
\item 
virtual bool \hyperlink{classBWAPI_1_1Player_a924da973e22a5dcfb41cb3cd87bfc5cb}{has\-Researched} (\hyperlink{classBWAPI_1_1TechType}{\-Tech\-Type} tech) const =0
\item 
virtual bool \hyperlink{classBWAPI_1_1Player_a85c99e86246c8146bcf15bd9d92eb050}{is\-Researching} (\hyperlink{classBWAPI_1_1TechType}{\-Tech\-Type} tech) const =0
\item 
virtual bool \hyperlink{classBWAPI_1_1Player_a6319bedfa5f69812353d276450c5e340}{is\-Upgrading} (\hyperlink{classBWAPI_1_1UpgradeType}{\-Upgrade\-Type} upgrade) const =0
\item 
virtual \hyperlink{classBWAPI_1_1Color}{\-B\-W\-A\-P\-I\-::\-Color} \hyperlink{classBWAPI_1_1Player_a5b1c3958f7613b35e2c6c41ad345c08b}{get\-Color} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a92533e47e91fbfcc33001a1b31110b63}{get\-Text\-Color} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a23b9cf6404e55e43829214e161dfe012}{max\-Energy} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual double \hyperlink{classBWAPI_1_1Player_a5b22be8b9d0e96adb4c5677466dc4b00}{top\-Speed} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_aa74ae68a1b4da12a41b60f4a12fe2eb6}{ground\-Weapon\-Max\-Range} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_af71aaeff7e43dd00a898eca7b63b159b}{air\-Weapon\-Max\-Range} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a8ede6dd38069aa3d9d2056343d99e96c}{weapon\-Max\-Range} (\hyperlink{classBWAPI_1_1WeaponType}{\-Weapon\-Type} weapon) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a3f909c90cd635c984f688da26a56cc91}{sight\-Range} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a3fff9bc23ef7e902a8b255b82b44713a}{ground\-Weapon\-Damage\-Cooldown} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a13fffa3261302652ed99ec75e29d084e}{armor} (\hyperlink{classBWAPI_1_1UnitType}{\-Unit\-Type} unit) const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a0470bf98754dba79c5e3ebcf99d2121d}{get\-Unit\-Score} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_aea4bc1e2d080072651d6188c65b2d2b3}{get\-Kill\-Score} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_a2c61ce373928d1e5b30f2e9ea95fe879}{get\-Building\-Score} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_ad351268f8b594b42c785ed70123ec8cb}{get\-Razing\-Score} () const =0
\item 
virtual int \hyperlink{classBWAPI_1_1Player_ab9fa9d8a44a31c8183bfc290b4a536f2}{get\-Custom\-Score} () const =0
\item 
virtual bool \hyperlink{classBWAPI_1_1Player_a981cff67662ff95660a9764c7882db9d}{is\-Observer} () const =0
\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}
\-Each player in a match will have his or her own player instance. \-There is also a neutral player which owns all the neutral units. 

\subsection{\-Member \-Function \-Documentation}
\hypertarget{classBWAPI_1_1Player_af71aaeff7e43dd00a898eca7b63b159b}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!air\-Weapon\-Max\-Range@{air\-Weapon\-Max\-Range}}
\index{air\-Weapon\-Max\-Range@{air\-Weapon\-Max\-Range}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{air\-Weapon\-Max\-Range}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::air\-Weapon\-Max\-Range} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_af71aaeff7e43dd00a898eca7b63b159b}
\-Returns the max air weapon range of the given unit type, includes upgrades 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a969b94f0de3e77db603ce828854a5e27}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a515c0c0ce42f9a779da60fb9899ec6eb}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!all\-Unit\-Count@{all\-Unit\-Count}}
\index{all\-Unit\-Count@{all\-Unit\-Count}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{all\-Unit\-Count}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::all\-Unit\-Count} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a515c0c0ce42f9a779da60fb9899ec6eb}
\-Returns the number of all accessible units of the given type. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a2a5a61e2cb13d8231578651ca1500346}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a13fffa3261302652ed99ec75e29d084e}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!armor@{armor}}
\index{armor@{armor}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{armor}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::armor} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a13fffa3261302652ed99ec75e29d084e}
\-Returns the armor of the given unit type, includes upgrades 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a2dce65653e1838fe932c65675d9ecd87}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a271b9290e031ddc46bb2955a53e281cb}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!completed\-Unit\-Count@{completed\-Unit\-Count}}
\index{completed\-Unit\-Count@{completed\-Unit\-Count}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{completed\-Unit\-Count}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::completed\-Unit\-Count} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a271b9290e031ddc46bb2955a53e281cb}
\-Returns the number of completed units of the given type. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_ac3e7462a13325d5a4631b114b5a2725e}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a6d2d6ad617102e808ab8ed22555956ce}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!cumulative\-Gas@{cumulative\-Gas}}
\index{cumulative\-Gas@{cumulative\-Gas}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{cumulative\-Gas}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::cumulative\-Gas} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a6d2d6ad617102e808ab8ed22555956ce}
\-Returns the cumulative amount of gas the player has harvested up to this point. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_af69e07c0d4faf0d5f7c424c5b8b264a3}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a9c13b0ea910272b2ee78cbb19172aab8}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!cumulative\-Minerals@{cumulative\-Minerals}}
\index{cumulative\-Minerals@{cumulative\-Minerals}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{cumulative\-Minerals}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::cumulative\-Minerals} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a9c13b0ea910272b2ee78cbb19172aab8}
\-Returns the cumulative amount of minerals the player has mined up to this point (including the 50 minerals at the start of the game). 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a86b8fa6607412ffae9021f8d129cffa3}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_aa43e2a87bce2f1750abb1883a8c59a43}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!dead\-Unit\-Count@{dead\-Unit\-Count}}
\index{dead\-Unit\-Count@{dead\-Unit\-Count}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{dead\-Unit\-Count}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::dead\-Unit\-Count} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_aa43e2a87bce2f1750abb1883a8c59a43}
\-Returns the number of dead units of the given type. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_ab468c6f1afed4b74fde0fb27e726747e}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_ac83e79adbbed71002828bf270eeaef1a}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!gas@{gas}}
\index{gas@{gas}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{gas}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::gas} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_ac83e79adbbed71002828bf270eeaef1a}
\-Returns the amount of vespene gas the player has. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a965a2b71016692dd98772ec3e1b1ea6f}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a2c61ce373928d1e5b30f2e9ea95fe879}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Building\-Score@{get\-Building\-Score}}
\index{get\-Building\-Score@{get\-Building\-Score}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Building\-Score}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Building\-Score} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a2c61ce373928d1e5b30f2e9ea95fe879}
\-Returns the \hyperlink{classBWAPI_1_1Player}{\-Player}'s \-Total \-Buildings \-Score 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_add06fb212fd1649fb7a3cc7d5390363e}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a5b1c3958f7613b35e2c6c41ad345c08b}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Color@{get\-Color}}
\index{get\-Color@{get\-Color}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Color}]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf \-B\-W\-A\-P\-I\-::\-Color} {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Color} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a5b1c3958f7613b35e2c6c41ad345c08b}
\-Returns the color of the player for drawing 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_aeee403b375171bd21e30fa33b3a85bc3}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_ab9fa9d8a44a31c8183bfc290b4a536f2}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Custom\-Score@{get\-Custom\-Score}}
\index{get\-Custom\-Score@{get\-Custom\-Score}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Custom\-Score}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Custom\-Score} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_ab9fa9d8a44a31c8183bfc290b4a536f2}
\-Returns the \hyperlink{classBWAPI_1_1Player}{\-Player}'s \-Custom \-Score 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a56622f9ce7a122a3d963a803395b712b}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a1e09a6471c4bd845af0c817bb119d0a7}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Force@{get\-Force}}
\index{get\-Force@{get\-Force}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Force}]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf \-Force}$\ast$ {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Force} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a1e09a6471c4bd845af0c817bb119d0a7}
\-Returns the force the player is on. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_af9deea1e08e2503b5415d344792097b8}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

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

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a8262d5b200bebac060c47bc43187517b}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_aea4bc1e2d080072651d6188c65b2d2b3}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Kill\-Score@{get\-Kill\-Score}}
\index{get\-Kill\-Score@{get\-Kill\-Score}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Kill\-Score}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Kill\-Score} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_aea4bc1e2d080072651d6188c65b2d2b3}
\-Returns the \hyperlink{classBWAPI_1_1Player}{\-Player}'s \-Total \-Kill \-Score 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_aa7e144a30ffbdf2f89d2cef2ed53c029}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

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

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_ac07ccef145d6521e7677bd6c30f760b6}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a78006845ba87adf917edac0a9e70d89d}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Race@{get\-Race}}
\index{get\-Race@{get\-Race}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Race}]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf \-Race} {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Race} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a78006845ba87adf917edac0a9e70d89d}
\-Returns the race of the player. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a25ef9c6c3005d3da9c5f56bcbe8b51c2}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_ad351268f8b594b42c785ed70123ec8cb}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Razing\-Score@{get\-Razing\-Score}}
\index{get\-Razing\-Score@{get\-Razing\-Score}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Razing\-Score}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Razing\-Score} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_ad351268f8b594b42c785ed70123ec8cb}
\-Returns the \hyperlink{classBWAPI_1_1Player}{\-Player}'s \-Total \-Razings \-Score 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a63a4cf8f4657abadd17f8cf487fb0714}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_adde672e1826a0579e9e30ab3d662cf5a}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Start\-Location@{get\-Start\-Location}}
\index{get\-Start\-Location@{get\-Start\-Location}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Start\-Location}]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf \-Tile\-Position} {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Start\-Location} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_adde672e1826a0579e9e30ab3d662cf5a}
\-Returns the starting location of the player. \-If complete map information is disabled, this function will return \hyperlink{namespaceBWAPI_1_1TilePositions_a7e9fdad1975d735ff9f642f106b80264}{\-Tile\-Positions\-::\-Unknown} for enemy players. \-For the complete set of starting locations for the current map, see \hyperlink{classBWAPI_1_1Game_a4336bdb26306865fb309b078d00d0410}{\-Game\-::get\-Start\-Locations}. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a73754ebdd88d105759a34723d58a31d4}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a92533e47e91fbfcc33001a1b31110b63}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Text\-Color@{get\-Text\-Color}}
\index{get\-Text\-Color@{get\-Text\-Color}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Text\-Color}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Text\-Color} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a92533e47e91fbfcc33001a1b31110b63}
\-Returns the color of the player for text messages 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a93b5f9fed6324e198ea4651c9965267a}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a97cbeb58485914b04726b4ff3b885c5a}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Type@{get\-Type}}
\index{get\-Type@{get\-Type}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Type}]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf \-Player\-Type} {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Type} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a97cbeb58485914b04726b4ff3b885c5a}
\-Returns the type of the player. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a7592acb4c8529560565e9915c907a860}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_acbb0ae5200ea3a661744358260f91f0c}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Units@{get\-Units}}
\index{get\-Units@{get\-Units}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Units}]{\setlength{\rightskip}{0pt plus 5cm}virtual const std\-::set$<${\bf \-Unit}$\ast$$>$\& {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Units} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_acbb0ae5200ea3a661744358260f91f0c}
\-Returns the set of units the player own. \-Note that units loaded into \-Terran dropships, \-Terran bunkers, \-Terran refineries, \-Protoss assimilators, and \-Zerg extractors are not yet included in the set. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a8d819f5302634ae633a416aaef9da49d}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a0470bf98754dba79c5e3ebcf99d2121d}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Unit\-Score@{get\-Unit\-Score}}
\index{get\-Unit\-Score@{get\-Unit\-Score}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Unit\-Score}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Unit\-Score} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a0470bf98754dba79c5e3ebcf99d2121d}
\-Returns the \hyperlink{classBWAPI_1_1Player}{\-Player}'s \-Total \hyperlink{classBWAPI_1_1Unit}{\-Unit} \-Score 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a7ff36f8b18992b24005bf33ae4697bbe}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a738edf86a2be8c1181064d37f2fd6990}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!get\-Upgrade\-Level@{get\-Upgrade\-Level}}
\index{get\-Upgrade\-Level@{get\-Upgrade\-Level}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{get\-Upgrade\-Level}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::get\-Upgrade\-Level} (
\begin{DoxyParamCaption}
\item[{{\bf \-Upgrade\-Type}}]{upgrade}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a738edf86a2be8c1181064d37f2fd6990}
\-Returns the player's current upgrade level of the given upgrade. \-To order a unit to upgrade a given upgrade type, see \hyperlink{classBWAPI_1_1Unit_a9423c81efd5c269b955a723b664bddd9}{\-Unit\-::upgrade}. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_acece82d06657484657a1710dbfeae885}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a3fff9bc23ef7e902a8b255b82b44713a}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!ground\-Weapon\-Damage\-Cooldown@{ground\-Weapon\-Damage\-Cooldown}}
\index{ground\-Weapon\-Damage\-Cooldown@{ground\-Weapon\-Damage\-Cooldown}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{ground\-Weapon\-Damage\-Cooldown}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::ground\-Weapon\-Damage\-Cooldown} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a3fff9bc23ef7e902a8b255b82b44713a}
\-Returns the ground weapon cooldown of the given unit type, includes upgrades 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a060dac136460f9a0c6750847f50a0b39}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_aa74ae68a1b4da12a41b60f4a12fe2eb6}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!ground\-Weapon\-Max\-Range@{ground\-Weapon\-Max\-Range}}
\index{ground\-Weapon\-Max\-Range@{ground\-Weapon\-Max\-Range}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{ground\-Weapon\-Max\-Range}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::ground\-Weapon\-Max\-Range} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_aa74ae68a1b4da12a41b60f4a12fe2eb6}
\-Returns the max ground weapon range of the given unit type, includes upgrades 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a7c58a1e7bea025f6cc28ddaf5f59a511}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a924da973e22a5dcfb41cb3cd87bfc5cb}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!has\-Researched@{has\-Researched}}
\index{has\-Researched@{has\-Researched}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{has\-Researched}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool {\bf \-B\-W\-A\-P\-I\-::\-Player\-::has\-Researched} (
\begin{DoxyParamCaption}
\item[{{\bf \-Tech\-Type}}]{tech}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a924da973e22a5dcfb41cb3cd87bfc5cb}
\-Returns true if the player has finished researching the given tech. \-To order a unit to research a given tech type, see \hyperlink{classBWAPI_1_1Unit_a6d7ad38052b28cb8f359168d64a862b5}{\-Unit\-::research}. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_ad06c516aadbbcb0a4bf534d9eecf5b94}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a3005d3f1e95ab637017c07f9ce9194ff}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!incomplete\-Unit\-Count@{incomplete\-Unit\-Count}}
\index{incomplete\-Unit\-Count@{incomplete\-Unit\-Count}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{incomplete\-Unit\-Count}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::incomplete\-Unit\-Count} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a3005d3f1e95ab637017c07f9ce9194ff}
\-Returns the number of incomplete units of the given type. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a402277ecaa6854ab92cd33ee1f4ef8b1}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a2ebc13f8d76cd1c9112e0e492e4c89e4}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!is\-Ally@{is\-Ally}}
\index{is\-Ally@{is\-Ally}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{is\-Ally}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool {\bf \-B\-W\-A\-P\-I\-::\-Player\-::is\-Ally} (
\begin{DoxyParamCaption}
\item[{{\bf \-Player} $\ast$}]{player}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a2ebc13f8d76cd1c9112e0e492e4c89e4}
\-Returns true if other player is an ally of this player. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a442417f81b25352249c7bfe57e00a590}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a86ecbbf0a124e22a300c85c134a99210}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!is\-Defeated@{is\-Defeated}}
\index{is\-Defeated@{is\-Defeated}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{is\-Defeated}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool {\bf \-B\-W\-A\-P\-I\-::\-Player\-::is\-Defeated} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a86ecbbf0a124e22a300c85c134a99210}
\-Returns true if the player has been defeated. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a43160509ba903ff91c49015b11b37f14}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a9109318446cfb09707cd7f756e7277a1}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!is\-Enemy@{is\-Enemy}}
\index{is\-Enemy@{is\-Enemy}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{is\-Enemy}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool {\bf \-B\-W\-A\-P\-I\-::\-Player\-::is\-Enemy} (
\begin{DoxyParamCaption}
\item[{{\bf \-Player} $\ast$}]{player}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a9109318446cfb09707cd7f756e7277a1}
\-Returns true if other player is an enemy of this player. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a9b52c6b173b64811a621882ad6511866}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_ad0008609c55e6e954f1043a970b1aeaf}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!is\-Neutral@{is\-Neutral}}
\index{is\-Neutral@{is\-Neutral}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{is\-Neutral}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool {\bf \-B\-W\-A\-P\-I\-::\-Player\-::is\-Neutral} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_ad0008609c55e6e954f1043a970b1aeaf}
\-Returns true if the player is the neutral player. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a9faa1125861771147ec78a7775747339}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a981cff67662ff95660a9764c7882db9d}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!is\-Observer@{is\-Observer}}
\index{is\-Observer@{is\-Observer}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{is\-Observer}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool {\bf \-B\-W\-A\-P\-I\-::\-Player\-::is\-Observer} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a981cff67662ff95660a9764c7882db9d}
\-Returns true if the \hyperlink{classBWAPI_1_1Player}{\-Player} is only observing the game, and not participating 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a2cd80fd07d6fbcc1c9924fa402666f80}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a85c99e86246c8146bcf15bd9d92eb050}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!is\-Researching@{is\-Researching}}
\index{is\-Researching@{is\-Researching}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{is\-Researching}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool {\bf \-B\-W\-A\-P\-I\-::\-Player\-::is\-Researching} (
\begin{DoxyParamCaption}
\item[{{\bf \-Tech\-Type}}]{tech}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a85c99e86246c8146bcf15bd9d92eb050}
\-Returns true if the player is researching the given tech. \-To order a unit to research a given tech type, see \-Unit\-::reseach. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a7a8f4a7ba2b298cdc234ce6809d90dd6}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a6319bedfa5f69812353d276450c5e340}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!is\-Upgrading@{is\-Upgrading}}
\index{is\-Upgrading@{is\-Upgrading}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{is\-Upgrading}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool {\bf \-B\-W\-A\-P\-I\-::\-Player\-::is\-Upgrading} (
\begin{DoxyParamCaption}
\item[{{\bf \-Upgrade\-Type}}]{upgrade}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a6319bedfa5f69812353d276450c5e340}
\-Returns true if the player is upgrading the given upgrade. \-To order a unit to upgrade a given upgrade type, see \hyperlink{classBWAPI_1_1Unit_a9423c81efd5c269b955a723b664bddd9}{\-Unit\-::upgrade}. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a077a7e9a3d68bbb10a296a6758fbddea}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a8e6c3f1c9ad684d56cb7aedec20e5f65}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!is\-Victorious@{is\-Victorious}}
\index{is\-Victorious@{is\-Victorious}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{is\-Victorious}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool {\bf \-B\-W\-A\-P\-I\-::\-Player\-::is\-Victorious} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a8e6c3f1c9ad684d56cb7aedec20e5f65}
\-Returns true if the player has achieved victory. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a73c25cee03d6a5dcb66306878765e818}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a4454ce8bd27b9857a5eb07fda1c5a1e0}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!killed\-Unit\-Count@{killed\-Unit\-Count}}
\index{killed\-Unit\-Count@{killed\-Unit\-Count}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{killed\-Unit\-Count}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::killed\-Unit\-Count} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a4454ce8bd27b9857a5eb07fda1c5a1e0}
\-Returns the number of killed units of the given type. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a65c7433e26a0a4aa65dcc0aae0e612d9}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a395851d0a1ca28c258f720896a487235}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!left\-Game@{left\-Game}}
\index{left\-Game@{left\-Game}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{left\-Game}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool {\bf \-B\-W\-A\-P\-I\-::\-Player\-::left\-Game} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a395851d0a1ca28c258f720896a487235}
\-Returns true if the player left the game. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_afa4a65ccdc2d5715e1ecb406c3ad386f}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a23b9cf6404e55e43829214e161dfe012}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!max\-Energy@{max\-Energy}}
\index{max\-Energy@{max\-Energy}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{max\-Energy}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::max\-Energy} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a23b9cf6404e55e43829214e161dfe012}
\-Returns the max energy of the given unit type, taking into account upgrades 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a1cb0ad3f0de1f822c9598a2ec6a4709a}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a1e4250f05e5b05447c7c7bf06ba9348b}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!minerals@{minerals}}
\index{minerals@{minerals}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{minerals}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::minerals} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a1e4250f05e5b05447c7c7bf06ba9348b}
\-Returns the amount of minerals the player has. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a0cd6de9223d628a6a92fa4e3204d6f86}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a3f909c90cd635c984f688da26a56cc91}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!sight\-Range@{sight\-Range}}
\index{sight\-Range@{sight\-Range}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{sight\-Range}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::sight\-Range} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a3f909c90cd635c984f688da26a56cc91}
\-Returns the sight range of the given unit type, includes upgrades 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a035a00aa85b735916b41a936608e29ac}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a41f4dd146a0b3138a3eb2f2d7f3e435f}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!supply\-Total@{supply\-Total}}
\index{supply\-Total@{supply\-Total}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{supply\-Total}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::supply\-Total} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a41f4dd146a0b3138a3eb2f2d7f3e435f}
\-Returns the total amount of supply the player has. \-If a race is provided, the total supply for the given race will be returned, otherwise the player's initial race will be used. \-Supply counts returned by \hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} are double what you would expect to see from playing the game. \-This is because zerglings take up 0.\-5 in-\/game supply. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a8993f1a9d6368945d4a2f50d204cd187}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a698769da69dd4bcd71c021a0455ca6e2}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!supply\-Total@{supply\-Total}}
\index{supply\-Total@{supply\-Total}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{supply\-Total}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::supply\-Total} (
\begin{DoxyParamCaption}
\item[{{\bf \-Race}}]{race}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a698769da69dd4bcd71c021a0455ca6e2}


\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a44d972598234b327b2de1da75cd495a7}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a85c99c8f86a275ff52ddb3276689e47b}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!supply\-Used@{supply\-Used}}
\index{supply\-Used@{supply\-Used}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{supply\-Used}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::supply\-Used} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a85c99c8f86a275ff52ddb3276689e47b}
\-Returns how much of the supply is actually being used by units. \-If a race is provided, the used supply for the given race will be returned, otherwise the player's initial race will be used. \-Supply counts returned by \hyperlink{namespaceBWAPI}{\-B\-W\-A\-P\-I} are double what you would expect to see from playing the game. \-This is because zerglings take up 0.\-5 in-\/game supply. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a5e7cafbb7d972821224ed9534818f61b}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



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


\hypertarget{classBWAPI_1_1Player_a7890ecb7af9915939c23edb6f7d2a15f}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!supply\-Used@{supply\-Used}}
\index{supply\-Used@{supply\-Used}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{supply\-Used}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::supply\-Used} (
\begin{DoxyParamCaption}
\item[{{\bf \-Race}}]{race}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a7890ecb7af9915939c23edb6f7d2a15f}


\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a6a2c0f2a2b64410c44a457a345f51480}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a5b22be8b9d0e96adb4c5677466dc4b00}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!top\-Speed@{top\-Speed}}
\index{top\-Speed@{top\-Speed}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{top\-Speed}]{\setlength{\rightskip}{0pt plus 5cm}virtual double {\bf \-B\-W\-A\-P\-I\-::\-Player\-::top\-Speed} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a5b22be8b9d0e96adb4c5677466dc4b00}
\-Returns the top speed of the given unit type, includes upgrades 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a6969cd8cc2720e75c0b2ad871de31fe1}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_abfb2026846b872af653a420cf76db6f9}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!visible\-Unit\-Count@{visible\-Unit\-Count}}
\index{visible\-Unit\-Count@{visible\-Unit\-Count}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{visible\-Unit\-Count}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::visible\-Unit\-Count} (
\begin{DoxyParamCaption}
\item[{{\bf \-Unit\-Type}}]{unit}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_abfb2026846b872af653a420cf76db6f9}
\-Returns the number of visible units of the given type. 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_a1789d7fc20b1663f8ddc3195db96163d}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.

\hypertarget{classBWAPI_1_1Player_a8ede6dd38069aa3d9d2056343d99e96c}{\index{\-B\-W\-A\-P\-I\-::\-Player@{\-B\-W\-A\-P\-I\-::\-Player}!weapon\-Max\-Range@{weapon\-Max\-Range}}
\index{weapon\-Max\-Range@{weapon\-Max\-Range}!BWAPI::Player@{\-B\-W\-A\-P\-I\-::\-Player}}
\subsubsection[{weapon\-Max\-Range}]{\setlength{\rightskip}{0pt plus 5cm}virtual int {\bf \-B\-W\-A\-P\-I\-::\-Player\-::weapon\-Max\-Range} (
\begin{DoxyParamCaption}
\item[{{\bf \-Weapon\-Type}}]{weapon}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}\label{classBWAPI_1_1Player_a8ede6dd38069aa3d9d2056343d99e96c}
\-Returns the max range of the given weapon with upgrades 

\-Implemented in \hyperlink{classBWAPI_1_1PlayerImpl_acc019244b2e8122594e0c488c4d37cfb}{\-B\-W\-A\-P\-I\-::\-Player\-Impl}.



\-The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
quorum/include/\-B\-W\-A\-P\-I/\hyperlink{Player_8h}{\-Player.\-h}\end{DoxyCompactItemize}
