RakNetCommandParser Class Reference

This allows a console client to call most of the functions in RakPeer. More...

#include <RakNetCommandParser.h>

Inheritance diagram for RakNetCommandParser:

List of all members.

Public Member Functions
bool	OnCommand (const char *command, unsigned numParameters, char **parameterList, TransportInterface *transport, PlayerID playerId, const char *originalString)
char *	GetName (void) const
void	SendHelp (TransportInterface *transport, PlayerID playerId)
void	SetRakPeerInterface (RakPeerInterface *rakPeer)
Protected Attributes
RakPeerInterface *	peer
	Which instance of RakPeer we are working on. Set from SetRakPeerInterface().

---

Detailed Description

This allows a console client to call most of the functions in RakPeer.

---

Member Function Documentation

char * RakNetCommandParser::GetName (  void   )  const [virtual]

You are responsible for overriding this function and returning a static string, which will identifier your parser. This should return a static string Returns: The name that you return. Implements CommandParserInterface.

bool RakNetCommandParser::OnCommand (  const char *  command, unsigned  numParameters, char **  parameterList, TransportInterface *  transport, PlayerID  playerId, const char *  originalString )  [virtual]

Given command with parameters parameterList , do whatever processing you wish. Parameters: [in]  command  The command to process [in]  numParameters  How many parameters were passed along with the command [in]  parameterList  The list of parameters. parameterList[0] is the first parameter and so on. [in]  transport  The transport interface we can use to write to [in]  playerId  The player that sent this command. [in]  originalString  The string that was actually sent over the network, in case you want to do your own parsing Implements CommandParserInterface.

void RakNetCommandParser::SendHelp (  TransportInterface *  transport, PlayerID  playerId )  [virtual]

A callback for when you are expected to send a brief description of your parser to playerId Parameters: [in]  transport  The transport interface we can use to write to [in]  playerId  The player that requested help. Implements CommandParserInterface.

void RakNetCommandParser::SetRakPeerInterface (  RakPeerInterface *  rakPeer  )

Records the instance of RakPeer to perform the desired commands on Parameters: [in]  rakPeer  The RakPeer instance, or a derived class (e.g. RakServer or RakClient)

---

The documentation for this class was generated from the following files:

• C:/RakNet 2.518/Include/RakNetCommandParser.h
• C:/RakNet 2.518/Source/RakNetCommandParser.cpp

---