[Plib-cvs] plib/doc/js index.html,1.7,1.8

[<ud...@us...>]

Update of /cvsroot/plib/plib/doc/js
In directory usw-pr-cvs1:/tmp/cvs-serv2591/doc/js

Modified Files:
	index.html 
Log Message:
David Megginson: Added jsJoystick::getName ()

Index: index.html
===================================================================
RCS file: /cvsroot/plib/plib/doc/js/index.html,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- index.html	17 Apr 2002 22:02:48 -0000	1.7
+++ index.html	17 Apr 2002 22:29:51 -0000	1.8
@@ -45,9 +45,10 @@
      jsJoystick ( int id = 0 ) ;
     ~jsJoystick () ;
 
-     int  getNumAxes () const ;
-     int  notWorking () const ;
-     void setError   () ;
+     const char* getName () const ;
+     int   getNumAxes    () const ;
+     int   notWorking    () const ;
+     void  setError      () ;
 
      float getDeadBand ( int axis ) const     ;
      void  setDeadBand ( int axis, float db ) ;
@@ -78,6 +79,11 @@
 check for the existance of a particular stick, you can
 call <code>notWorking()</code> which returns JS_TRUE if
 there is some problem with that stick, JS_FALSE otherwise.
+<p>
+<code>getName()</code> tells you the device name of the
+joystick, if available through API calls in your OS. A
+typical value is "CH PRODUCTS CH PRO PEDALS USB ". If no
+name is available, this method will return the empty string.
 <p>
 <code>getNumAxes()</code> tells you how many axes the stick
 has. Note that it is NOT safe to assume that all sticks have