class GGZCoreRoom

A GGZCoreRoom stands for a room on a server, which is connected to a certain game type. More...

Definition#include <GGZCoreRoom.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods


Detailed Description

A GGZCoreRoom stands for a room on a server, which is connected to a certain game type.

enum GGZCoreRoomEvent { playerlist, tablelist, chatnormal, chatannounce, chatprivate, chatbeep, enter, leave, tableupdate, tablelaunched, tablelaunchfail, tablejoined, tablejoinfail, tableleft, tableleavefail, tabledata }

GGZCoreRoomEvent

Possible events which can occur when entering rooms and staying in them.

 GGZCoreRoom ()

GGZCoreRoom

Constructor

 GGZCoreRoom (GGZRoom* room)

GGZCoreRoom

Constructor, overloaded to assign an existant room.

 ~GGZCoreRoom ()

~GGZCoreRoom

Destructor

int  addHook (const GGZCoreRoomEvent event, const GGZHookFunc func)

addHook

Add a simple callback to the room.

int  addHook (const GGZCoreRoomEvent event, const GGZHookFunc func, void* data)

addHook

Add a callback with arguments.

int  removeHook (const GGZCoreRoomEvent event, const GGZHookFunc func)

removeHook

Remove a callback from the room.

int  removeHook (const GGZCoreRoomEvent event, const unsigned int id)

removeHook

Overloaded: Remove a callback on its id.

int  init (const GGZServer* server, const unsigned int id, const char* name, const unsigned int game, const char* description, const char *category)

init

Initialize a room with the required information.

char*  name ()

name

Return the name of the room.

char*  description ()

description

Return its description.

char*  category ()

category

Return its category

GGZCoreGametype*  gametype ()

gametype

Return the associated game type.

int  countPlayers ()

countPlayers

Return the number of players in this room.

GGZPlayer*  player (const unsigned int number)

player

Return specified player.

int  countTables ()

countTables

Count number of launched tables.

GGZCoreTable*  table (const unsigned int number)

table

Return the specified table.

int  launchTable (GGZTable* table)

launchTable

Launch a table

int  joinTable (const unsigned int number)

joinTable

Join an already launched table.

int  leaveTable ()

leaveTable

Leave a table again.

int  listPlayers ()

listPlayers

Invoke player listing.

int  listTables (const int type, const char global)

listTables

Invoke tables listing.

int  chat (const GGZChatOp opcode, const char* player, const char* message)

chat

Send a chat message to the other players.

int  sendData (char* buffer)

sendData

Send other data.

GGZRoom*  room ()

room

Return the internal GGZRoom structure

void  selfRegister (GGZCoreRoom **room)

selfRegister

Get a reference on itself.


Generated by: josef on athlon500 on Tue Mar 19 23:18:22 2002, using kdoc 2.0a53.