psChatBubbles Class Reference

Creates the effect of a chat bubble on top of character heads taking data from text chat. More...

#include <chatbubbles.h>

Public Member Functions
csArray< BubbleChatType >	GetBubbleChatTypes ()
size_t	GetBubbleLongPhraseLineCount ()
size_t	GetBubbleMaxLineLen ()
size_t	GetBubbleShortPhraseCharCount ()
virtual void	HandleMessage (MsgEntry *msg, Client *client)
	Interprets a received message and executes the command. More...
bool	Initialize (psEngine *engine)
bool	isEnabled ()
bool	isMixingActionColours ()
bool	Load (const char *filename, bool saveUserData=false)
	Load the chat bubble config file. More...
	psChatBubbles ()
void	SetBubbleChatTypes (csArray< BubbleChatType > chatTypes)
void	setEnabled (bool enable)
virtual bool	Verify (MsgEntry *msg, unsigned int flags, Client *&client)
virtual	~psChatBubbles ()

Detailed Description

Creates the effect of a chat bubble on top of character heads taking data from text chat.

Definition at line 54 of file chatbubbles.h.

Constructor & Destructor Documentation

psChatBubbles::psChatBubbles

(

)

virtual psChatBubbles::~psChatBubbles ( )

virtual

Member Function Documentation

csArray<BubbleChatType> psChatBubbles::GetBubbleChatTypes ( )

inline

Definition at line 86 of file chatbubbles.h.

size_t psChatBubbles::GetBubbleLongPhraseLineCount ( )

inline

Definition at line 95 of file chatbubbles.h.

size_t psChatBubbles::GetBubbleMaxLineLen ( )

inline

Definition at line 93 of file chatbubbles.h.

size_t psChatBubbles::GetBubbleShortPhraseCharCount ( )

inline

Definition at line 94 of file chatbubbles.h.

virtual void psChatBubbles::HandleMessage ( MsgEntry *  msg, Client *  client  )

virtual

Interprets a received message and executes the command.

Implements iNetSubscriber.

bool psChatBubbles::Initialize

(

psEngine *

engine

)

bool psChatBubbles::isEnabled ( )

inline

Definition at line 89 of file chatbubbles.h.

bool psChatBubbles::isMixingActionColours ( )

inline

Definition at line 90 of file chatbubbles.h.

bool psChatBubbles::Load	(	const char *	filename,
		bool	saveUserData = false
	)

Load the chat bubble config file.

Parameters

filename	The name of the file to load.
saveUserData	This is used to save the file loaded in the /userdata/ folder. This is normally done when the userdata config file has not been created yet.

Returns

true if the file loaded correctly. false if the file was not found or could not be loaded.

void psChatBubbles::SetBubbleChatTypes ( csArray< BubbleChatType >  chatTypes )

inline

Definition at line 87 of file chatbubbles.h.

void psChatBubbles::setEnabled ( bool  enable )

inline

Definition at line 91 of file chatbubbles.h.

virtual bool psChatBubbles::Verify ( MsgEntry *  msg, unsigned int  flags, Client *&  client  )

virtual

Implements iNetSubscriber.

---

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

• client/chatbubbles.h