[wpdev-commits] wolfpack/python global.cpp,1.133,1.134

[Sebastian H. <dar...@us...>]

Update of /cvsroot/wpdev/wolfpack/python
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv22047/python

Modified Files:
	global.cpp 
Log Message:
Documentation

Index: global.cpp
===================================================================
RCS file: /cvsroot/wpdev/wolfpack/python/global.cpp,v
retrieving revision 1.133
retrieving revision 1.134
diff -C2 -d -r1.133 -r1.134
*** global.cpp	15 Jun 2004 02:44:46 -0000	1.133
--- global.cpp	27 Jun 2004 19:24:37 -0000	1.134
***************
*** 125,130 ****
  }
  
! /*!
! 	Log a string
  */
  static PyObject* wpConsole_log( PyObject* self, PyObject* args )
--- 125,134 ----
  }
  
! /*
! 	\function wolfpack.console.log
! 	\param loglevel The loglevel for this message. See the ERROR_ constants in wolfpack/consts.py for
! 	details.
! 	\param text The text of the message.
! 	\description Sends a string to the console and the logfile.
  */
  static PyObject* wpConsole_log( PyObject* self, PyObject* args )
***************
*** 143,148 ****
  }
  
! /*!
! 	Sends a string to the wolfpack console.
  */
  static PyObject* wpConsole_send( PyObject* self, PyObject* args )
--- 147,154 ----
  }
  
! /*
! 	\function wolfpack.console.send
! 	\param text The text of the message.
! 	\description Prints a string on the server console.
  */
  static PyObject* wpConsole_send( PyObject* self, PyObject* args )
***************
*** 162,167 ****
  }
  
! /*!
! 	Sends a progress-bar to the wolfpack console
  */
  static PyObject* wpConsole_sendprogress( PyObject* self, PyObject* args )
--- 168,175 ----
  }
  
! /*
! 	\function wolfpack.console.sendprogress
! 	\param text The progress identifier.
! 	\description Prints a string on the console that identifies the start of a progress display.
  */
  static PyObject* wpConsole_sendprogress( PyObject* self, PyObject* args )
***************
*** 169,174 ****
  	Q_UNUSED( self );
  	char* message;
! 	if ( !PyArg_ParseTuple( args, "es", "utf-8", &message ) )
! 	{
  		return 0;
  	}
--- 177,181 ----
  	Q_UNUSED( self );
  	char* message;
! 	if (!PyArg_ParseTuple( args, "es", "utf-8", &message)) {
  		return 0;
  	}
***************
*** 182,187 ****
  }
  
! /*!
! 	Sends a [done] progress section to the console
  */
  static PyObject* wpConsole_senddone( PyObject* self, PyObject* args )
--- 189,195 ----
  }
  
! /*
! 	\function wolfpack.console.senddone
! 	\description Indicates that a printed progress action is now done.
  */
  static PyObject* wpConsole_senddone( PyObject* self, PyObject* args )
***************
*** 194,199 ****
  }
  
! /*!
! 	Sends a [fail] progress section to the console
  */
  static PyObject* wpConsole_sendfail( PyObject* self, PyObject* args )
--- 202,208 ----
  }
  
! /*
! 	\function wolfpack.console.sendfail
! 	\description Indicates that a printed progress action has failed.
  */
  static PyObject* wpConsole_sendfail( PyObject* self, PyObject* args )
***************
*** 206,211 ****
  }
  
! /*!
! 	Sends a [skip] progress section to the console
  */
  static PyObject* wpConsole_sendskip( PyObject* self, PyObject* args )
--- 215,221 ----
  }
  
! /*
! 	\function wolfpack.console.sendskip
! 	\description Indicates that a printed progress action has been skipped.
  */
  static PyObject* wpConsole_sendskip( PyObject* self, PyObject* args )
***************
*** 218,223 ****
  }
  
! /*!
! 	Returns a list of Strings (the linebuffer)
  */
  static PyObject* wpConsole_getbuffer( PyObject* self, PyObject* args )
--- 228,234 ----
  }
  
! /*
! 	\function wolfpack.console.getbuffer
! 	\return A list of the strings that have been sent to the console previously.
  */
  static PyObject* wpConsole_getbuffer( PyObject* self, PyObject* args )
***************
*** 237,240 ****
--- 248,255 ----
  }
  
+ /*
+ 	\function wolfpack.console.shutdown
+ 	\description Shutdown the server.
+ */
  static PyObject* wpConsole_shutdown( PyObject* self, PyObject* args )
  {
***************
*** 252,263 ****
  static PyMethodDef wpConsole[] =
  {
! 	{ "send",		wpConsole_send,			METH_VARARGS,	"Prints something to the wolfpack console" },
! 	{ "progress",		wpConsole_sendprogress,		METH_VARARGS,	"Prints a .....[xxxx] block" },
! 	{ "progressDone",	wpConsole_senddone,		METH_NOARGS,	"Prints a [done] block" },
! 	{ "progressFail",	wpConsole_sendfail,		METH_NOARGS,	"Prints a [fail] block" },
! 	{ "progressSkip",	wpConsole_sendskip,		METH_NOARGS,	"Prints a [skip] block" },
! 	{ "getbuffer",		wpConsole_getbuffer,		METH_NOARGS,	"Gets the linebuffer of the console" },
! 	{ "log",		wpConsole_log,			METH_VARARGS,	NULL },
! 	{ "shutdown",		wpConsole_shutdown,		METH_NOARGS,	"Shut the server down" },
  	{ NULL, NULL, 0, NULL } // Terminator
  
--- 267,278 ----
  static PyMethodDef wpConsole[] =
  {
! 	{ "send",			wpConsole_send,			METH_VARARGS,	0 },
! 	{ "sendprogress",	wpConsole_sendprogress,	METH_VARARGS,	0 },
! 	{ "senddone",		wpConsole_senddone,		METH_NOARGS,	0 },
! 	{ "sendfail",		wpConsole_sendfail,		METH_NOARGS,	0 },
! 	{ "sendskip",		wpConsole_sendskip,		METH_NOARGS,	0 },
! 	{ "getbuffer",		wpConsole_getbuffer,	METH_NOARGS,	0 },
! 	{ "log",			wpConsole_log,			METH_VARARGS,	0 },
! 	{ "shutdown",		wpConsole_shutdown,		METH_NOARGS,	0 },
  	{ NULL, NULL, 0, NULL } // Terminator
  
***************
*** 487,492 ****
  }
  
! /*!
! 	Tries to find a region for a specific position.
  */
  static PyObject* wpRegion( PyObject* self, PyObject* args )
--- 502,516 ----
  }
  
! /*
! 	\function wolfpack.region
! 	\param x The x component of the coordinate.
! 	\param y The y component of the coordinate.
! 	\param map Which map should be looked on.
! 	<code>0 - Felucca
! 	1 - Trammel
! 	2 - Ilshenar
! 	3 - Malas</code>
! 	\return A region object or None if there is no region at the given coordinates.
! 	\description Finds a region at the given coordinates.
  */
  static PyObject* wpRegion( PyObject* self, PyObject* args )