From 580345394eb58748fa6df527a095671ed3edc396 Mon Sep 17 00:00:00 2001 From: Dalai Felinto Date: Sun, 10 Jan 2010 19:35:42 +0000 Subject: BGE API_DOC: VideoTexture and PhysicsConstraints templates (need the functions to be filled with their description). PhysicsConstraints is documented in the Game Kit Book: http://download.blender.org/documentation/gamekit1/ VideoTexture is documented in the wiki: http://wiki.blender.org/index.php/Dev:Source/GameEngine/2.49/VideoTexture I don't think I will have time to fill the documentation. But I hope this commit helps someone interested in helping it. Therefore volunteers to document those modules are highly welcome !!! (let's give to BGE the documentation it deserves)! * + added GameLogic.Lave/LoadGlobalDict + some typo fixes --- source/gameengine/PyDoc/API_intro.py | 6 +- source/gameengine/PyDoc/GameLogic.py | 9 +- source/gameengine/PyDoc/GameTypes.py | 4 +- source/gameengine/PyDoc/PhysicsConstraints.py | 126 ++++++++++++++++++++++++ source/gameengine/PyDoc/VideoTexture.py | 133 ++++++++++++++++++++++++++ 5 files changed, 272 insertions(+), 6 deletions(-) create mode 100644 source/gameengine/PyDoc/PhysicsConstraints.py create mode 100644 source/gameengine/PyDoc/VideoTexture.py (limited to 'source/gameengine/PyDoc') diff --git a/source/gameengine/PyDoc/API_intro.py b/source/gameengine/PyDoc/API_intro.py index 0a687088627..abc8c83855b 100644 --- a/source/gameengine/PyDoc/API_intro.py +++ b/source/gameengine/PyDoc/API_intro.py @@ -16,10 +16,10 @@ The Blender Game Engine Python API Reference - L{Rasterizer} display and rendering. - L{GameTypes} contains all the python types spesific to the GameEngine. - Undocumented modules: + Modules with documentation in progress: --------------------- - - VideoTexture - - PhysicsConstraints + - L{VideoTexture} + - L{PhysicsConstraints} Additional Modules: ------------------- diff --git a/source/gameengine/PyDoc/GameLogic.py b/source/gameengine/PyDoc/GameLogic.py index d22b1690e74..3cf15636892 100644 --- a/source/gameengine/PyDoc/GameLogic.py +++ b/source/gameengine/PyDoc/GameLogic.py @@ -313,7 +313,6 @@ Documentation for the GameLogic Module. import GameTypes # TODO -# globalDict # error def getCurrentController(): @@ -446,6 +445,14 @@ def setPhysicsTicRate(ticrate): @param ticrate: The new update frequency (in Hz). @type ticrate: float """ +def saveGlobalDict(): + """ + Saves GameLogic.globalDict to a file. + """ +def loadGlobalDict(): + """ + Loads GameLogic.globalDict from a file. + """ #{ Utility functions def getAverageFrameRate(): diff --git a/source/gameengine/PyDoc/GameTypes.py b/source/gameengine/PyDoc/GameTypes.py index ba22dbd4e8f..e6d51e85af6 100644 --- a/source/gameengine/PyDoc/GameTypes.py +++ b/source/gameengine/PyDoc/GameTypes.py @@ -1581,7 +1581,7 @@ class KX_GameObject(SCA_IObject): """ def endObject(): """ - Delete this object, can be used inpace of the EndObject Actuator. + Delete this object, can be used in place of the EndObject Actuator. The actual removal of the object from the scene is delayed. """ def replaceMesh(mesh, useDisplayMesh=True, usePhysicsMesh=False): @@ -1682,7 +1682,7 @@ class KX_GameObject(SCA_IObject): def getAxisVect(vect): """ Returns the axis vector rotates by the objects worldspace orientation. - This is the equivalent if multiplying the vector by the orientation matrix. + This is the equivalent of multiplying the vector by the orientation matrix. @type vect: 3d vector. @param vect: a vector to align the axis. diff --git a/source/gameengine/PyDoc/PhysicsConstraints.py b/source/gameengine/PyDoc/PhysicsConstraints.py new file mode 100644 index 00000000000..d78a32f4f79 --- /dev/null +++ b/source/gameengine/PyDoc/PhysicsConstraints.py @@ -0,0 +1,126 @@ +# $Id$ +""" +Documentation for the PhysicsConstraints module. + +Example: + import PhysicsConstraints + import GameLogic + +""" +# TODO +# error + +def createConstraint(): + """ + Does something + + @rtype: + """ +def getAppliedImpulse(): + """ + Does something + + @rtype: + """ +def getVehicleConstraint(): + """ + Does something + + @rtype: + """ +def removeConstraint(): + """ + Does something + + @rtype: + """ +def setCcdMode(): + """ + Does something + + @rtype: + """ +def setContactBreakingTreshold(): + """ + Does something + + @rtype: + """ +def setDeactivationAngularTreshold(): + """ + Does something + + @rtype: + """ +def setDeactivationLinearTreshold(): + """ + Does something + + @rtype: + """ +def setDeactivationTime(): + """ + Does something + + @rtype: + """ +def setDebugMode(): + """ + Does something + + @rtype: + """ +def setGravity(): + """ + Does something + + @rtype: + """ +def setLinearAirDamping(): + """ + Does something + + @rtype: + """ +def setNumIterations(): + """ + Does something + + @rtype: + """ +def setNumTimeSubSteps(): + """ + Does something + + @rtype: + """ +def setSolverDamping(): + """ + Does something + + @rtype: + """ +def setSolverTau(): + """ + Does something + + @rtype: + """ +def setSolverType(): + """ + Does something + + @rtype: + """ +def setSorConstant(): + """ + Does something + + @rtype: + """ +def setUseEpa(): + """ + Does something + + @rtype: + """ \ No newline at end of file diff --git a/source/gameengine/PyDoc/VideoTexture.py b/source/gameengine/PyDoc/VideoTexture.py new file mode 100644 index 00000000000..cbcd28fb24c --- /dev/null +++ b/source/gameengine/PyDoc/VideoTexture.py @@ -0,0 +1,133 @@ +# $Id$ +""" +Documentation for the VideoTexture module. + +Example: + import VideoTexture + import GameLogic + +""" +def getLastError(): + """ + Does something + + @rtype: + """ +def imageToArray(image): + """ + Does something + + @param image: Image ID + @type image: integer + @rtype: array + """ +def materialID(material): + """ + Gets the ID of a material + + @param material: the name of the material + @type material: string + @rtype: + """ +def setLogFile(): + """ + Does something + + @rtype: + """ +def FilterBGR24(): + """ + Does something + + @rtype: + """ +def FilterBlueScreen(): + """ + Does something + + @rtype: + """ +def FilterColor(): + """ + Does something + + @rtype: + """ +def FilterGray(): + """ + Does something + + @rtype: + """ +def FilterLevel(): + """ + Does something + + @rtype: + """ +def FilterNormal(): + """ + Does something + + @rtype: + """ +def FilterRGB24(): + """ + Does something + + @rtype: + """ +def FilterRGBA32(): + """ + Does something + + @rtype: + """ +def ImageBuff(): + """ + Does something + + @rtype: + """ +def ImageFFmpeg(): + """ + Does something + + @rtype: + """ +def ImageMirror(): + """ + Does something + + @rtype: + """ +def ImageMix(): + """ + Does something + + @rtype: + """ +def ImageRender(): + """ + Does something + + @rtype: + """ +def ImageViewport(): + """ + Does something + + @rtype: + """ +def Texture(): + """ + Does something + + @rtype: + """ +def VideoFFmpeg(): + """ + Does something + + @rtype: + """ \ No newline at end of file -- cgit v1.2.3