[Enigma-cvs] enigma/doc/refman enigma-ref.texi,1.4,1.5

[Ralf Westram <address@hidden>]

Update of /cvsroot/enigma/enigma/doc/refman
In directory subversions:/tmp/cvs-serv4817/doc/refman

Modified Files:
        enigma-ref.texi 
Log Message:
- added enigma.AddConstantForce
- cosmetics



Index: enigma-ref.texi
===================================================================
RCS file: /cvsroot/enigma/enigma/doc/refman/enigma-ref.texi,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** enigma-ref.texi     23 Oct 2003 18:41:02 -0000      1.4
--- enigma-ref.texi     23 Oct 2003 20:21:21 -0000      1.5
***************
*** 782,785 ****
--- 782,786 ----
  * enigma.GetNamedObject::
  * enigma.SendMessage::
+ * enigma.AddConstantForce::
  @end menu
  
***************
*** 860,871 ****
  
  This function sends a @var{message} to an @var{object}.
- If the @var{object} is aware of the sent @var{message} it will react properly
- (e.g. toggle its state or change its direction).
- If the @var{message} is unknown to the @var{object} nothing will happen.
  
! @var{data} either contains a value expected by a specific message or 
@code{nil}.
! 
! Documentation about the messages known by a specific object can be found
! in the description of the @ref{Objects}.
  
  @end defun
--- 861,875 ----
  
  This function sends a @var{message} to an @var{object}.
  
! @table @var
! @item object
! message recipient
! @item message
! The message itself (e.g. "signal")
! You can see which messages are understood in the documentation of the single 
@ref{Objects}.
! @item data
! Some specific messages expect some additional data (e.g. message "direction" 
expects
! a direction like SOUTH or WEST).
! @end table
  
  @end defun
***************
*** 884,887 ****
--- 888,906 ----
  enigma.SendMessage(enigma.GetNamedObject("bolder1"), "direction", WEST)
  @end example
+ 
+ 
+ @node enigma.AddConstantForce,  , enigma.SendMessage, Functions
+ @section enigma.AddConstantForce
+ 
+ @defun enigma.AddConstantForce (gravity_x, gravity_y)
+ 
+ Adds global gravity to the current level.
+ 
+ @table @var
+ @item gravity_x
+ adds gravity in horizontal direction (positive means rightwards).
+ @item gravity_y
+ adds gravity in vertical direction (positive means downwards).
+ @end table
  
  @ignore