ChannelText Class Reference

#include <ChannelText.h>

Detailed Description

Definition at line 51 of file ChannelText.h.

Member Enumeration Documentation

enum ChannelText::Flags

Enumerator:

eNoLog
eNoSound

Definition at line 54 of file ChannelText.h.

Constructor & Destructor Documentation

ChannelText::ChannelText ( )

Definition at line 24 of file ChannelText.cpp.

ChannelText::ChannelText	(	const std::string &	channel,
		const LangString &	message
	)

Definition at line 30 of file ChannelText.cpp.

ChannelText::ChannelText	(	const std::string &	channel,
		const std::string &	key,
		const std::string &	value
	)

Definition at line 40 of file ChannelText.cpp.

ChannelText::ChannelText	(	const std::string &	channel,
		const std::string &	key,
		const std::string &	value,
		const LangStringConverter &	param1
	)

Definition at line 52 of file ChannelText.cpp.

References LangStringConverter::getValue(), and messageParams_.

ChannelText::ChannelText	(	const std::string &	channel,
		const std::string &	key,
		const std::string &	value,
		const LangStringConverter &	param1,
		const LangStringConverter &	param2
	)

Definition at line 66 of file ChannelText.cpp.

References LangStringConverter::getValue(), and messageParams_.

ChannelText::ChannelText	(	const std::string &	channel,
		const std::string &	key,
		const std::string &	value,
		const LangStringConverter &	param1,
		const LangStringConverter &	param2,
		const LangStringConverter &	param3
	)

Definition at line 82 of file ChannelText.cpp.

References LangStringConverter::getValue(), and messageParams_.

ChannelText::ChannelText	(	const std::string &	channel,
		const std::string &	key,
		const std::string &	value,
		const LangStringConverter &	param1,
		const LangStringConverter &	param2,
		const LangStringConverter &	param3,
		const LangStringConverter &	param4
	)

Definition at line 100 of file ChannelText.cpp.

References LangStringConverter::getValue(), and messageParams_.

Member Function Documentation

void ChannelText::setChannel ( const std::string & channel ) [inline]

Definition at line 95 of file ChannelText.h.

References channel_.

Referenced by ServerChannelManager::processMessage().

void ChannelText::setMessage ( const LangString & message ) [inline]

Definition at line 96 of file ChannelText.h.

References message_.

Referenced by ServerChannelManager::actualSend().

void ChannelText::setMessageKey ( const std::string & key ) [inline]

Definition at line 97 of file ChannelText.h.

References messageKey_.

Referenced by ServerChannelManager::processMessage().

void ChannelText::setMessageValue ( const std::string & value ) [inline]

Definition at line 98 of file ChannelText.h.

References messageValue_.

Referenced by ServerChannelManager::processMessage().

void ChannelText::setSrcPlayerId ( unsigned int srcPlayerId ) [inline]

Definition at line 99 of file ChannelText.h.

References srcPlayerId_.

Referenced by TankSay::init(), and ClientChannelManager::sendText().

void ChannelText::setDestPlayerId ( unsigned int destPlayerId ) [inline]

Definition at line 100 of file ChannelText.h.

References destPlayerId_.

void ChannelText::setFlags ( unsigned int flags ) [inline]

Definition at line 101 of file ChannelText.h.

References flags_.

Referenced by FrameTimer::simulate().

void ChannelText::setAdminPlayer ( const std::string & admin ) [inline]

Definition at line 102 of file ChannelText.h.

References admin_.

Referenced by ServerAdminCommon::adminSay(), and ServerChannelManager::processMessage().

const std::string& ChannelText::getChannel ( ) [inline]

Definition at line 104 of file ChannelText.h.

References channel_.

Referenced by ServerChannelManager::actualSend(), GLWChannelView::channelText(), ServerChannelManager::processMessage(), ClientChannelManager::processMessage(), ChannelManager::showText(), and ClientChannelManager::showText().

const LangString & ChannelText::getMessage ( )

Definition at line 120 of file ChannelText.cpp.

References Lang::getEntry(), ResourceBundleEntry::getString(), Lang::instance(), message_, messageKey_, messageParams_, and messageValue_.

Referenced by ServerChannelManager::actualSend(), GLWChannelText::buttonDown(), GLWChannelView::channelText(), MessageDialog::channelText(), GLWChannelText::itemSelected(), ServerChannelManager::processMessage(), ClientChannelManager::processMessage(), ChannelManager::showText(), and ClientChannelManager::showText().

const std::string& ChannelText::getAdminPlayer ( ) [inline]

Definition at line 106 of file ChannelText.h.

References admin_.

Referenced by ServerChannelManager::actualSend(), and GLWChannelView::channelText().

const std::string& ChannelText::getMessageKey ( ) [inline]

Definition at line 107 of file ChannelText.h.

References messageKey_.

const std::string& ChannelText::getMessageValue ( ) [inline]

Definition at line 108 of file ChannelText.h.

References messageValue_.

const std::vector<LangString>& ChannelText::getMessageParams ( ) [inline]

Definition at line 109 of file ChannelText.h.

References messageParams_.

unsigned int ChannelText::getSrcPlayerId ( ) [inline]

Definition at line 110 of file ChannelText.h.

References srcPlayerId_.

unsigned int ChannelText::getDestPlayerId ( ) [inline]

Definition at line 111 of file ChannelText.h.

References destPlayerId_.

Referenced by ServerChannelManager::processMessage().

unsigned int ChannelText::getFlags ( ) [inline]

Definition at line 112 of file ChannelText.h.

References flags_.

Referenced by GLWChannelView::channelText(), and ClientChannelManager::showText().

bool ChannelText::writeMessage ( NetBuffer & buffer ) [virtual]

Definition at line 152 of file ChannelText.cpp.

References NetBuffer::addToBuffer(), admin_, channel_, destPlayerId_, flags_, message_, messageKey_, messageParams_, messageValue_, and srcPlayerId_.

Referenced by ComsChannelTextMessage::writeMessage().

bool ChannelText::readMessage ( NetBufferReader & reader ) [virtual]

Definition at line 177 of file ChannelText.cpp.

References admin_, channel_, destPlayerId_, flags_, NetBufferReader::getFromBuffer(), message_, messageKey_, messageParams_, messageValue_, and srcPlayerId_.

Referenced by ComsChannelTextMessage::readMessage().

Member Data Documentation

unsigned int ChannelText::srcPlayerId_ [protected]

Definition at line 118 of file ChannelText.h.

Referenced by getSrcPlayerId(), readMessage(), setSrcPlayerId(), and writeMessage().

unsigned int ChannelText::destPlayerId_ [protected]

Definition at line 119 of file ChannelText.h.

Referenced by getDestPlayerId(), readMessage(), setDestPlayerId(), and writeMessage().

unsigned int ChannelText::flags_ [protected]

Definition at line 120 of file ChannelText.h.

Referenced by getFlags(), readMessage(), setFlags(), and writeMessage().

std::string ChannelText::messageKey_ [protected]

Definition at line 121 of file ChannelText.h.

Referenced by getMessage(), getMessageKey(), readMessage(), setMessageKey(), and writeMessage().

std::vector<LangString> ChannelText::messageParams_ [protected]

Definition at line 122 of file ChannelText.h.

Referenced by ChannelText(), getMessage(), getMessageParams(), readMessage(), and writeMessage().

std::string ChannelText::messageValue_ [protected]

Definition at line 123 of file ChannelText.h.

Referenced by getMessage(), getMessageValue(), readMessage(), setMessageValue(), and writeMessage().

std::string ChannelText::channel_ [protected]

Definition at line 124 of file ChannelText.h.

Referenced by getChannel(), readMessage(), setChannel(), and writeMessage().

LangString ChannelText::message_ [protected]

Definition at line 125 of file ChannelText.h.

Referenced by getMessage(), readMessage(), setMessage(), and writeMessage().

std::string ChannelText::admin_ [protected]

Definition at line 126 of file ChannelText.h.

Referenced by getAdminPlayer(), readMessage(), setAdminPlayer(), and writeMessage().

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

src/common/common/ChannelText.h
src/common/common/ChannelText.cpp

Generated on Mon Feb 16 15:15:00 2009 for Scorched3D by

1.5.3


Public Types
enum	Flags { eNoLog = 1, eNoSound = 2 }
Public Member Functions
	ChannelText ()
	ChannelText (const std::string &channel, const LangString &message)
	ChannelText (const std::string &channel, const std::string &key, const std::string &value)
	ChannelText (const std::string &channel, const std::string &key, const std::string &value, const LangStringConverter &param1)
	ChannelText (const std::string &channel, const std::string &key, const std::string &value, const LangStringConverter &param1, const LangStringConverter &param2)
	ChannelText (const std::string &channel, const std::string &key, const std::string &value, const LangStringConverter &param1, const LangStringConverter &param2, const LangStringConverter &param3)
	ChannelText (const std::string &channel, const std::string &key, const std::string &value, const LangStringConverter &param1, const LangStringConverter &param2, const LangStringConverter &param3, const LangStringConverter &param4)
void	setChannel (const std::string &channel)
void	setMessage (const LangString &message)
void	setMessageKey (const std::string &key)
void	setMessageValue (const std::string &value)
void	setSrcPlayerId (unsigned int srcPlayerId)
void	setDestPlayerId (unsigned int destPlayerId)
void	setFlags (unsigned int flags)
void	setAdminPlayer (const std::string &admin)
const std::string &	getChannel ()
const LangString &	getMessage ()
const std::string &	getAdminPlayer ()
const std::string &	getMessageKey ()
const std::string &	getMessageValue ()
const std::vector < LangString > &	getMessageParams ()
unsigned int	getSrcPlayerId ()
unsigned int	getDestPlayerId ()
unsigned int	getFlags ()
virtual bool	writeMessage (NetBuffer &buffer)
virtual bool	readMessage (NetBufferReader &reader)
Protected Attributes
unsigned int	srcPlayerId_
unsigned int	destPlayerId_
unsigned int	flags_
std::string	messageKey_
std::vector< LangString >	messageParams_
std::string	messageValue_
std::string	channel_
LangString	message_
std::string	admin_

ChannelText Class Reference

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation