Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMitchell Stokes <mogurijin@gmail.com>2010-07-16 13:10:46 +0400
committerMitchell Stokes <mogurijin@gmail.com>2010-07-16 13:10:46 +0400
commit952821dfd44ad9bbf674bbea2d7738556a46c663 (patch)
treef1d2e0b67ba1b9afb684871cc77cff7232bdf5b5 /source/gameengine/PyDoc
parent7ba821cab384f45691bb73bc0712926ae4c819de (diff)
BGE doc updates:
Fixed some typos and added docs for the following functions: startGame() endGame() restartGame() LibLoad() LibNew() LibFree()
Diffstat (limited to 'source/gameengine/PyDoc')
-rw-r--r--source/gameengine/PyDoc/bge.logic.rst62
-rw-r--r--source/gameengine/PyDoc/bge.render.rst4
2 files changed, 50 insertions, 16 deletions
diff --git a/source/gameengine/PyDoc/bge.logic.rst b/source/gameengine/PyDoc/bge.logic.rst
index 84b480e2ab9..a10733569f3 100644
--- a/source/gameengine/PyDoc/bge.logic.rst
+++ b/source/gameengine/PyDoc/bge.logic.rst
@@ -158,6 +158,48 @@ General functions
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 @@ General functions
.. 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 @@ General functions
.. warning: Not implimented yet
-.. function:: saveGlobalDict()
-
- Saves bge.logic.globalDict to a file.
-
-.. function:: loadGlobalDict()
-
- Loads bge.logic.globalDict from a file.
-
*****************
Utility functions
*****************
diff --git a/source/gameengine/PyDoc/bge.render.rst b/source/gameengine/PyDoc/bge.render.rst
index cea84f3b506..9f17455601b 100644
--- a/source/gameengine/PyDoc/bge.render.rst
+++ b/source/gameengine/PyDoc/bge.render.rst
@@ -230,7 +230,7 @@ Functions
.. 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 @@ Functions
.. function:: disableMotionBlur()
- Disable the motion blue effect.
+ Disable the motion blur effect.