[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [30405] trunk/blender/source/gameengine/ PyDoc: BGE doc updates:

[Mitchell Stokes]

Revision: 30405
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=30405
Author:   moguri
Date:     2010-07-16 11:10:46 +0200 (Fri, 16 Jul 2010)

Log Message:
-----------
BGE doc updates:
Fixed some typos and added docs for the following functions:

startGame()
endGame()
restartGame()
LibLoad()
LibNew()
LibFree()

Modified Paths:
--------------
    trunk/blender/source/gameengine/PyDoc/bge.logic.rst
    trunk/blender/source/gameengine/PyDoc/bge.render.rst

Modified: trunk/blender/source/gameengine/PyDoc/bge.logic.rst
===================================================================
--- trunk/blender/source/gameengine/PyDoc/bge.logic.rst	2010-07-16 08:37:28 UTC (rev 30404)
+++ trunk/blender/source/gameengine/PyDoc/bge.logic.rst	2010-07-16 09:10:46 UTC (rev 30405)
@@ -158,6 +158,48 @@
 
    Saves bge.logic.globalDict to a file.
 
+.. function:: startGame(blend)
+
+   Loads the blend file.
+   
+   :arg blend: The name of the blend file
+   :type blend: string
+
+.. function:: endGame()
+
+   Ends the current game.
+
+.. function:: restartGame()
+
+   Restarts the current game by reloading the .blend file (the last saved version, not what is currently running).
+   
+.. function:: LibLoad(blend, type)
+   
+   Converts the all of the datablocks of the given type from the given blend.
+   
+   :arg blend: The path to the blend file
+   :type blend: string
+   :arg type: The datablock type (currently only "Scene" and "Mesh" are supported)
+   :type type: string
+   
+.. function:: LibNew(name, type, data)
+
+   Uses existing datablock data and loads in as a new library.
+   
+   :arg name: A unique library name used for removal later
+   :type name: string
+   :arg type: The datablock type (currently only "Mesh" is supported)
+   :type type: string
+   :arg data: A list of names of the datablocks to load
+   :type data: list of strings
+   
+.. function:: LibFree(name)
+
+   Frees a library, removing all objects and meshes from the currently active scenes.
+
+   :arg name: The name of the library to free (the name used in LibNew)
+   :type name: string
+
 .. function:: addScene(name, overlay=1)
 
    Loads a scene into the game engine.
@@ -202,24 +244,24 @@
 
 .. function:: getMaxLogicFrame()
 
-   Gets the maximum number of logic frame per render frame.
+   Gets the maximum number of logic frames per render frame.
    
-   :return: The maximum number of logic frame per render frame
+   :return: The maximum number of logic frames per render frame
    :rtype: integer
 
 .. function:: setMaxLogicFrame(maxlogic)
 
-   Sets the maximum number of logic frame that are executed per render frame.
+   Sets the maximum number of logic frames that are executed per render frame.
    This does not affect the physic system that still runs at full frame rate.   
     
-   :arg maxlogic: The new maximum number of logic frame per render frame. Valid values: 1..5
+   :arg maxlogic: The new maximum number of logic frames per render frame. Valid values: 1..5
    :type maxlogic: integer
 
 .. function:: getMaxPhysicsFrame()
 
-   Gets the maximum number of physics frame per render frame.
+   Gets the maximum number of physics frames per render frame.
    
-   :return: The maximum number of physics frame per render frame
+   :return: The maximum number of physics frames per render frame
    :rtype: integer
 
 .. function:: setMaxPhysicsFrame(maxphysics)
@@ -270,14 +312,6 @@
 
    .. warning: Not implimented yet
 
-.. function:: saveGlobalDict()
-
-   Saves bge.logic.globalDict to a file.
-
-.. function:: loadGlobalDict()
-
-   Loads bge.logic.globalDict from a file.
-
 *****************
 Utility functions
 *****************

Modified: trunk/blender/source/gameengine/PyDoc/bge.render.rst
===================================================================
--- trunk/blender/source/gameengine/PyDoc/bge.render.rst	2010-07-16 08:37:28 UTC (rev 30404)
+++ trunk/blender/source/gameengine/PyDoc/bge.render.rst	2010-07-16 09:10:46 UTC (rev 30405)
@@ -230,7 +230,7 @@
 
 .. function:: enableMotionBlur(factor)
 
-   Enable the motion blue effect.
+   Enable the motion blur effect.
    
    :arg factor: the ammount of motion blur to display.
    :type factor: float [0.0 - 1.0]
@@ -238,5 +238,5 @@
 
 .. function:: disableMotionBlur()
 
-   Disable the motion blue effect.
+   Disable the motion blur effect.