\section{TPProto::Login Class Reference}
\label{classTPProto_1_1Login}\index{TPProto::Login@{TPProto::Login}}
The \doxyref{Frame}{p.}{classTPProto_1_1Frame} for logging into a player on the server.  


{\tt \#include $<$login.h$>$}

Inheritance diagram for TPProto::Login::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classTPProto_1_1Login}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Login} ()\label{classTPProto_1_1Login_a34f1810fd38f9d23275bee331ea334c}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
virtual {\bf $\sim$Login} ()\label{classTPProto_1_1Login_0a376507fc394b99f6d6aa3f618f90fb}

\begin{CompactList}\small\item\em Required virtual destructor. \item\end{CompactList}\item 
void {\bf pack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Pack the login into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. \item\end{CompactList}\item 
bool {\bf unpack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Unpack from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, always false. \item\end{CompactList}\item 
void {\bf set\-User} (const std::string \&name)
\begin{CompactList}\small\item\em Sets the username to login as. \item\end{CompactList}\item 
void {\bf set\-Pass} (const std::string \&word)
\begin{CompactList}\small\item\em Sets the password to login with. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
The \doxyref{Frame}{p.}{classTPProto_1_1Frame} for logging into a player on the server. 



\subsection{Member Function Documentation}
\index{TPProto::Login@{TPProto::Login}!packBuffer@{packBuffer}}
\index{packBuffer@{packBuffer}!TPProto::Login@{TPProto::Login}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Login::pack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt  [virtual]}}\label{classTPProto_1_1Login_cdcc1a69f060ae97a06c5fb07010578f}


Pack the login into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer} to pack into. \end{description}
\end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_67b50ee76e90385e56f04202ce1da67e}.\index{TPProto::Login@{TPProto::Login}!unpackBuffer@{unpackBuffer}}
\index{unpackBuffer@{unpackBuffer}!TPProto::Login@{TPProto::Login}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool TPProto::Login::unpack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt  [virtual]}}\label{classTPProto_1_1Login_d9317e8a5625e42118a2607167a67b7f}


Unpack from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, always false. 

Since \doxyref{Login}{p.}{classTPProto_1_1Login} frames are only sent to the server, we should not receive them and therefore this method always returns false. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, ignored. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]False always. \end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_fe220a4229f471a3cc6a143f7a27e321}.\index{TPProto::Login@{TPProto::Login}!setUser@{setUser}}
\index{setUser@{setUser}!TPProto::Login@{TPProto::Login}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Login::set\-User (const std::string \& {\em name})}\label{classTPProto_1_1Login_54451ba003484328b5af88cbb871ad11}


Sets the username to login as. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]The username. \end{description}
\end{Desc}
\index{TPProto::Login@{TPProto::Login}!setPass@{setPass}}
\index{setPass@{setPass}!TPProto::Login@{TPProto::Login}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Login::set\-Pass (const std::string \& {\em word})}\label{classTPProto_1_1Login_8498a7eb2cff7f4bbf5215b75ff3b867}


Sets the password to login with. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em word}]The password. \end{description}
\end{Desc}


The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
tpproto/{\bf login.h}\item 
tpproto/login.cpp\end{CompactItemize}