[wpdev-commits] wolfpack/python socket.cpp,1.88,1.89

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

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

Modified Files:
	socket.cpp 
Log Message:
doc+python fixes

Index: socket.cpp
===================================================================
RCS file: /cvsroot/wpdev/wolfpack/python/socket.cpp,v
retrieving revision 1.88
retrieving revision 1.89
diff -C2 -d -r1.88 -r1.89
*** socket.cpp	1 Oct 2004 23:26:38 -0000	1.88
--- socket.cpp	2 Oct 2004 09:59:51 -0000	1.89
***************
*** 671,676 ****
  }
  
! /*!
! 	Returns the custom tag passed
  */
  static PyObject* wpSocket_gettag( wpSocket* self, PyObject* args )
--- 671,682 ----
  }
  
! /*
! 	\method socket.gettag
! 	\description Get a custom tag attached to the socket.
! 	Please keep in mind these tags are temporary in nature. 
! 	When the socket disconnects, the tag will be gone.
! 	\return None if there is no such tag, the tag value otherwise.
! 	Possible return types are: unicode (string), float, integer.
! 	\param name The name of the tag.
  */
  static PyObject* wpSocket_gettag( wpSocket* self, PyObject* args )
***************
*** 695,700 ****
  }
  
! /*!
! 	Sets a custom tag
  */
  static PyObject* wpSocket_settag( wpSocket* self, PyObject* args )
--- 701,712 ----
  }
  
! /*
! 	\method socket.settag
! 	\description Set a custom tag on the object.
! 	\param name The name of the tag.
! 	Please keep in mind these tags are temporary in nature. 
! 	When the socket disconnects, the tag will be gone.
! 	\param value The value of the tag. Possible value types
! 	are string, unicode, float and integer.
  */
  static PyObject* wpSocket_settag( wpSocket* self, PyObject* args )
***************
*** 722,727 ****
  }
  
! /*!
! 	Checks if a certain tag exists
  */
  static PyObject* wpSocket_hastag( wpSocket* self, PyObject* args )
--- 734,742 ----
  }
  
! /*
! 	\method socket.hastag
! 	\description Check if the socket has a certain custom tag attached to it.
! 	\return True if the tag is present. False otherwise.
! 	\param name The name of the tag.
  */
  static PyObject* wpSocket_hastag( wpSocket* self, PyObject* args )
***************
*** 741,746 ****
  }
  
! /*!
! 	Deletes a given tag
  */
  static PyObject* wpSocket_deltag( wpSocket* self, PyObject* args )
--- 756,763 ----
  }
  
! /*
! 	\method socket.deltag
! 	\description Deletes a tag attached to the socket.
! 	\param name The name of the tag.
  */
  static PyObject* wpSocket_deltag( wpSocket* self, PyObject* args )
***************
*** 761,766 ****
  }
  
! /*!
! 	Resends the status window to this client.
  */
  static PyObject* wpSocket_resendstatus( wpSocket* self, PyObject* args )
--- 778,785 ----
  }
  
! /*
! 	\method socket.resendstatus
! 	\description Resends the status window to this socket.
! 	Use this for updating weight and other properties.
  */
  static PyObject* wpSocket_resendstatus( wpSocket* self, PyObject* args )
***************
*** 771,775 ****
  }
  
! // Resend lightlevel
  static PyObject* wpSocket_updatelightlevel( wpSocket* self, PyObject* args )
  {
--- 790,799 ----
  }
  
! /*
! 	\method socket.updatelightlevel
! 	\description Send the current lightlevel to this socket.
! 	Use this for updating the lightlevel after you change the
! 	lightbonus property on character objects.
! */
  static PyObject* wpSocket_updatelightlevel( wpSocket* self, PyObject* args )
  {
***************
*** 779,782 ****
--- 803,813 ----
  }
  
+ /*
+ 	\method socket.questarrow
+ 	\param show This boolean flag indicates whether the questarrow should be shown.
+ 	\param x The x position the quest arrow points to.
+ 	\param y The y position the quest arrow points to.
+ 	\description This method shows a quest arrow that points to a given location on the map.
+ */
  static PyObject* wpSocket_questarrow( wpSocket* self, PyObject* args )
  {
***************
*** 789,795 ****
  
  	self->pSock->sendQuestArrow( show, x, y );
! 	return PyTrue();
  }
  
  static PyObject* wpSocket_log( wpSocket* self, PyObject* args )
  {
--- 820,832 ----
  
  	self->pSock->sendQuestArrow( show, x, y );
! 	Py_RETURN_NONE;
  }
  
+ /*
+ 	\method socket.log
+ 	\param level The loglevel for this event. Check <library id="wolfpack.consts">wolfpack.consts</library> for constants.
+ 	\param text The text that should be logged.
+ 	\description Sends a given text to the logfile and console and prepends a timestamp and the socket id.
+ */
  static PyObject* wpSocket_log( wpSocket* self, PyObject* args )
  {
***************
*** 801,814 ****
  
  	self->pSock->log( ( eLogLevel ) loglevel, text );
! 	return PyTrue();
  }
  
  static PyObject* wpSocket_updateplayer( wpSocket* self, PyObject* args )
  {
  	Q_UNUSED( args );
  	self->pSock->updatePlayer();
! 	return PyTrue();
  }
  
  static PyObject* wpSocket_updateskill( wpSocket* self, PyObject* args )
  {
--- 838,861 ----
  
  	self->pSock->log( ( eLogLevel ) loglevel, text );
! 	Py_RETURN_NONE;
  }
  
+ /*
+ 	\method socket.updateplayer
+ 	\description Resend the player of this socket only.
+ 	Handle with care.
+ */
  static PyObject* wpSocket_updateplayer( wpSocket* self, PyObject* args )
  {
  	Q_UNUSED( args );
  	self->pSock->updatePlayer();
! 	Py_RETURN_NONE;
  }
  
+ /*
+ 	\method socket.updateskill
+ 	\param skill The skill id.
+ 	\description Resends the value of one single skill.
+ */
  static PyObject* wpSocket_updateskill( wpSocket* self, PyObject* args )
  {
***************
*** 821,825 ****
  
  	self->pSock->sendSkill( skill );
! 	return PyTrue();
  }
  
--- 868,872 ----
  
  	self->pSock->sendSkill( skill );
! 	Py_RETURN_NONE;
  }